Aurora Multimedia WACI NX Jr. Reference Manual & Programming Manual Download Page 132

Page: 132 / 180

132

Syntax

HRESULT WaitOnChangeEvent(
  [in]long ChangeMask,
  [in]long TimeOut,
  [out, retval]long* Result
);

Parameters

ChangeMask

[in] A bit mask that defines which Events to watch for.

TimeOut

[in] Number of milliseconds to wait for an Event. If the timeout expires, the function returns
with Result set to 0.

Result

[out, retval] A bit-mask representing the Event(s) that cause the wait to terminate.

Remarks

This function will not return until one of the specified Events has happened. To be notified of a change, an
Event of the hardware type your interested in must already exist.

Or the following bits together to set the

ChangeMask

as desired. The

ChangeMask

bits are defined as

follows:

Bit Value

Bit # Description

0x00000001 Bit 0

One of the Variables changed

0x00000002 Bit 1

Serial data received on one of the serial ports

0x00000004 Bit 2

One of the digital input ports changed state

0x00000008 Bit 3

The input voltage on one of the A/D inputs changed

The Result parameter will contain either a mask of the triggered events, or one of the following values:

Error Value

Description

0xFFFFFFFF (-1)

Error occurred when trying to create the wait event.

0x00010000 (65536) The TimeOut expired. No events triggered.

0x00010001 (65537) The Wait aborted due to some error.

Summary of Contents for WACI NX Jr.

Page 1: ...Reference Manual Programming Guide WACI NX WACI NX Jr Revision 2007 01 09 Aurora Multimedia 205 Commercial Court Morganville NJ 07751 732 591 5800 732 591 5801 Fax www auroramultimedia com ...

Page 2: ...t to reproduce this guide or parts thereof in any form without the express written permission of Aurora Multimedia Inc Trademarks and registered trademarks are the properties of their respective owners Software and hardware features and specifications subject to change without notice ...

Page 3: ...PANSION HARDWARE 21 VII FACTORY DEFAULT CONFIGURATIONS 24 VIII QUICK START 25 IX USING THE WACI 29 X WEB SERVER FEATURES 33 XI BOOT MENU REFERENCE 34 XII ADMIN WEB PAGES 38 XIII THE EVENT MANAGER 60 XIV REMOTE PROCEDURE CALLS 92 XV ERROR CODES 176 XVI LIMITED LIFETIME WARRANTY 177 XVII FCC PART 15 STATEMENT 178 XVIII INDEX 179 ...

Page 4: ...ACI CONNECTION 26 STEP 3A CONNECTING THE WACI NX TO A LAN 26 STEP 3B DIRECT CONNECTION IF STATIC IP IS SET 27 STEP 3C DIRECT CONNECTION WITH A SERIAL CABLE 27 STEP 4 ACCESS THE WACI 28 STEP 5 CONFIGURE WACI USING THE ADMIN WEB PAGES 28 IX USING THE WACI 29 TESTING HARDWARE 29 UPLOADING FIRMWARE UPGRADES 30 VIEWING SERVER LOGS 30 AUTOMATING TASKS THE EVENT MANAGER 31 UPLOADING CUSTOM WEB PAGES 31 U...

Page 5: ...ACROMEDIA FLASH 95 VISUAL BASIC SCRIPTING 97 NOTE ON ERROR CHECKING 97 RPC QUICK REFERENCE 98 ERROR INFORMATION METHODS 100 GENERAL INFORMATION METHODS 101 NETWORK METHODS 104 TELNET METHODS 108 BUZZER METHODS 109 LOGGING METHODS 110 SERIAL METHODS 113 RELAY METHODS WACI NX ONLY 116 DIGITAL I O METHODS WACI NX ONLY 118 A D CONVERTER METHODS WACI NX ONLY 121 IR METHODS 125 EVENT MANAGER METHODS 131...

Page 6: ...he WACI does all this with a powerful 32 bit engine with 32 bit pipeline memory in a small box that can fit just about anywhere The power guarantees that small or large files can be processed without delay in a real time application with network traffic Systems with less power and less memory bog down quickly on server requests but this is no problem for the WACI which has enough power to support ...

Page 7: ...Contents for the WACI NX 12v 15 Watt Supply International Supply Kit WACI NX Device Power Adapter 4 IR Port Emitters Box Contents for the WACI NX Jr 12v 15 Watt Supply International Supply Kit WACI NX Jr Device Power Adapter ...

Page 8: ...ES AES ARC 4 SHA 1 MD5 Implements entire IPsec packet processing in hardware no CPU burden True Random Number Generator RNG in hardware Robust security is ideal for most business network environments meets U S government and banking industry requirements IR True Trigger Highly Accurate IR Capture and reproduction Memory Total RAM 32M 64M 500DDR 32 bit wide Total Flash 16M 32M Available Flash 5M 20...

Page 9: ...d Input 1 1 IR input device triggers DSP 4 modes of Operation Analog to Digital Input A D Digital to Analog D A Digital Input Digital Output 4 12 Bit Accuracy 16 Bit Accuracy High Impedance 200ma Sink Open Drain Relay SPDT 4 C Type NO NC CP Monitoring 32 Bit Internal Clock Calendar IR Learner 30KHz 2MHz Internal Temp Sensor Beeper Expansion CF Type II Memory and wireless NX_PANSION Bus 32bit NX ad...

Page 10: ... ratings only Operation of the device at or above these ratings for extended periods of time may affect reliability Min Typ Max Units Notes WACI Input Voltage 8 12 18 V WACI NX Min 15watt supply Storage Temperature 20 55 C Digital I O Input 5 5 V Digital I O Output 0 5 V Can source up to 20mA at 5V A D Input 5 5 V Relay 0 2 A Max 30V DC ...

Page 11: ...r Parts Overview NX Jr Parts Overview Shorts Description More Info 1 Power Adapter Port 2 Two 10 100 Auto MDX LAN Ports 3 USB 1 1 On The Go Port 4 Two RS 232 422 485 Serial Ports 5 LED Indicators for Serial Ports 1 2 6 Built in LCD display for setup and diagnostics 7 Six button menu navigation ...

Page 12: ...12 8 Type 2 Compact Flash expansion port 9 IR Ports 1 2 10 IR Learner Port 11 IR In Port 12 IR In LED 13 LED Indicators for IR Ports 1 2 14 LED Power Status ...

Page 13: ... Power Adapter Port 2 Two 10 100 Auto MDX LAN Ports 3 USB 1 1 On The Go Port 4 Two RS 232 422 485 Serial Ports 5 LED Indicators for Serial Ports 1 2 6 Built in LCD display for setup and diagnostics 7 Six button menu navigation 8 Type 2 Compact Flash expansion port 9 LED Indicators for DSP 1 4 10 DSP 5V Line 11 DSP Ports 1 4 ...

Page 14: ...ine 13 Relay Ports 1 4 Normally Open Center Pin Normally Closed 14 LED Indicators for Relays Ports 1 4 15 IR Ports 1 4 16 IR Learner Port 17 IR In Port 18 IR In LED 19 LED Indicators for IR Ports 1 4 20 LED Power Status ...

Page 15: ...into this port You should plug the Power Adapter into this port after the network cable has been attached Green Power Status LED The green LED indicates that the WACI is powered and operating LCD Display The 106 x 56 backlit pixel based display helps with the diagnostic and setup of the WACI NX Access Boot Menu Press and hold the any of the 6 buttons for 5 seconds to bring up the Boot Menu while p...

Page 16: ...d DSR pins When using RS 422 485 communications the LEDs indicate activity on the corresponding TX TX RX and RX pins RS 422 Operation When using RS 422 operation the RX and RX should have a 120 Ohm resistor across the two pins Also RS 422 operation must be selected in the diagnostics page in order for it to properly work RS 485 Operation When using the RS 485 operation the RX and TX should be tied...

Page 17: ...d through the port Relays Relays Relays Relays WACI NX Only WACI NX Only WACI NX Only WACI NX Only The Relays on the WACI NX have two connection types N O Normally Open and N C Normally Closed The Normal position is the state of the relay when it is not turned on not energized You can turn the relays on and off using the relay diagnostic page see Relay Diagnostics page 51 using an Event Manager Re...

Page 18: ...efore the D A Converter may be used for applications where varying output voltage ranges of 5v to 5v are required The port will produce a value of 5v when the port is set to 0 and 5v will with a value of 65536 Voltage levels between 5v and 5v can be sent by using a proportional numeric value You can set the output from a D A port using the DSP Diagnostics see DSP Diagnostics page 52 or using an RP...

Page 19: ...orts IR Ports IR Ports IR Ports The four 4 IR ports on the WACI NX and 2 IR ports on the WACI NX Jr are used to send infrared commands to devices that can be controlled using a standard IR remote control To control a device connect one of the IR emitters to the IR sensor of the device to be controlled In addition the IR port can be used a one way RS 232C TX only at rates up to 115k To program the ...

Page 20: ...is specific to the device IR Learner Port Point your remote at the window on the lower right front of the WACI NX to learn an IR command for your remote You ll need to use the IR diagnostics page to learn the command see Learn IR Command page 47 IR Learner LED The LED is lit during the learning process when an IR signal is detected on the IR sensor within the WACI NX When the process is first star...

Page 21: ...s of data for advanced applications like video streaming additional ports touch panel interfacing and much more Up to two expansion modules can be dock to any one WACI NX Always check with the latest specification of the expansion model to see feature power and docking requirements Specifications are subject to change without notice One unit docked with a WACI NX NX NX NX NX PAND PAND PAND PAND Fo...

Page 22: ... HDMI Input and Output SPDIF Input and Output Standard 40GB hard drive storage with options up to 120GB L R RCA Audio Pair Input and Output Connections Controlled via WACI NX Event Manager and Content Manager Create play lists and automate media delivery NX NX NX NX HDD HDD HDD HDD Can be ordered with up to 120GB of hard drive storage capacity Storage of web pages audio video or almost anything th...

Page 23: ...ts and blackouts NX NX NX NX POE POE POE POE The power over Ethernet module docks inside the WACI NX and not on the expansion bus This leaves the expansion bus free for additional modules The NX POE is docked inside the WACI NX near the LAN connectors on a connector specific for this function Provides 13 watts of power Installs seamlessly in the WACI NX as an internal module Can be used simultaneo...

Page 24: ... Enabled Yes IP Address From DHCP Subnet Mask From DHCP Gateway From DHCP Host Name WACI Password admin Default Serial Settings Baud rate 9600 baud Data bits 8 Parity bits None Stop Bits 1 Signal Level RS232 Handshaking None Default DSP Settings WACI NX Only DSP Port Digital Input ...

Page 25: ...l other LEDs will be off and the LCD will have a message initializing The WACI will run through its internal hardware diagnostics If an error occurs the power LED will flash an error code or display it on the LCD screen see Error Codes page 176 After approximately 5 seconds assuming the self test passes on the LCD will display firmware version and current IP addresses for the LAN ports If a LAN po...

Page 26: ... You do not have a LAN network and you only need to access to the basic setup configuration found in the Boot Menu or You need to set up the manual IP address for a static LAN network SKIP to STEP 3C Direct Connection with a Serial Cable Ignore steps 3A 3B STEP 3A Connecting the WACI NX to a LAN The WACI can be configured to use either a static IP or a dynamically allocated one By default the WACI...

Page 27: ...use a static IP address Set the PC to an IP address in the same range but different from the WACI A typical configuration is to manually set the Local Connection on your computer to if the WACI LAN was set to 10 10 10 10 IP Address 10 10 10 9 Subnet Mask 255 255 255 0 Gateway 10 10 10 1 STEP 3C Direct Connection with a Serial Cable You may also configure WACI directly from your computer with a ser...

Page 28: ...t A third party driver needs to be installed on the Macintosh computer for it to access the WACI via its host name You can use the WACI s host name or IP address to Upload User Defined Web pages to ftp IP Address or Host Name wwwpub View User Defined Web Pages http IP Address or Host Name Access Admin Web Pages Setup Diagnostics etc at http IP Address or Host Name setup Some examples are http 10 1...

Page 29: ...est page 36 Check your RAM see 7 Hardware Test page 36 From the Diagnostic web pages see Diagnostics page 45 you may check the IR Emitter Ports see System Information System information is available for the WACI NX and WACI NX Jr It shows available memory current network settings IR Port Serial Port Relay Port and DSP Port settings By clicking System Reset button you can remotely restart WACI It i...

Page 30: ... Firmware can be uploaded only one file at a time and the WACI cannot be used for any other purpose while in the upgrade mode Viewing Server Logs Logs for the RPC Web and FTP servers may be monitored in the Logs section see Log Files page 52 of the Admin Web Pages RPC Server Info see RPC Server Info page 53 tells you the version of the RPC server and the available methods The RPC Server Commands l...

Page 31: ...e 60 in the Admin Web Pages Uploading Custom Web Pages If you have frequently used tasks or want to facilitate administration of tasks you may decide to develop your own custom web pages Typical reasons for custom web page development Streamlining operations performing tasks efficiently Custom graphical user interface is required Reducing training costs for employees who operate the system control...

Page 32: ...nt of your custom web pages or application you may wish to get a state from the WACI or command it to perform some task The WACI supports many programmable functions through remote procedure calls RPCs For full details see see RPC Server Commands page 53 ...

Page 33: ...rver Pages ASP File Extension Hyper Text Markup Language HTML File Extension Flash Programs SWF File Extension Java Script JS File Extension Server Side Includes For example use include file MyInclude txt within your ASP page or HTML page VB Script Embedded into the ASP pages FTP Sever Access using an FTP client RPC Server Access using HTML post In addition the WACI can store virtually any type of...

Page 34: ...onnector The WACI Boot Menu will appear on the terminal screen WACI Boot Menu 0 Display Current Settings 1 Restore Factory Defaults 2 Configure IP Settings 3 Set Password 4 Set Host Name 5 Download New Firmware 6 Lamp Test 7 Hardware Test 8 Erase All Files 9 OEM Functions x Exit menu and boot Selection The boot menu will prompt you through setup and diagnostics Details about the options follow in ...

Page 35: ...figure IP Settings Use to enable DHCP or manually set an IP address subnet mask and gateway IP address Configure which network card 1 or 2 1 Enable DHCP Y N N Enter new IP address 192 168 3 165 Enter new Subnet mask 255 255 0 0 Enter Gateway IP address 192 168 1 1 Successfully changed IP settings Press Enter Configure which network card 1 or 2 1 Enable DHCP Y N Y Successfully changed IP settings P...

Page 36: ...ss put File Path Upgrade File Example tftp i 10 10 10 10 put c temp waciplus20 afw You may only upgrade one file at a time and you may not do anything else with the WACI in this mode During the file transfer the serial LEDs will blink one at a time and you will see the status on the boot menu screen The WACI will reset on completion Continue to use WACI as normal or press hold the reset button 5 s...

Page 37: ...s downloaded to the WACI These are normally the files that have been downloaded using an FTP client to ftp Host Name 9 OEM Functions These are factory options that are configured by the manufacturer and are not applicable for the end user ...

Page 38: ...click on SETUP for firmware version date time setting network settings and network security settings DIAGNOSTIC firmware upgrade instructions logs options and other diagnostic tools for using and or monitoring WACI hardware EVENT MANAGER powerful non programming tool to automate WACI tasks see The Event Manager page 60 FILES opens an ftp connection to the WACI ...

Page 39: ...ws you to set several administrative options Many of these options are also available from the Boot Menu Firmware Firmware Firmware Firmware Version Version Version Version The firmware version installed on the WACI is displayed ...

Page 40: ...one Time Zone Time Zone Time Zone The time zone setting is used when the WACI communicates with outside computers and servers Setting the time zone also allows the WACI to appropriately apply corrections for Daylight Savings Time You can set the active time zone by simply choosing one from the list of time zones Check the Automatically adjust for Daylight Savings check box to have the clock automa...

Page 41: ... the IP Address Subnet Mask and Default Gateway are automatically assigned and the values will be grey and un editable If the DHCP is disabled the values for IP Address Subnet Mask and Default Gateway will be black and editable Host Name By setting the host name your WACI s web server may be accessed at http Host Name Similarly the FTP server may be reached at ftp Host Name SMTP Server Address SMT...

Page 42: ...ows you to access the Admin Web Pages and FTP server No password is required to access web pages downloaded into the wwwpub directory IP Access Table IP Access Table IP Access Table IP Access Table When specified your WACI will only accept network requests from computers with these IP addresses ...

Page 43: ...Setup Port Setup Port Setup Port Setup This page allows you to change Serial Port IR Port and DSP settings WACI NX has 2 Serial ports 4 IR ports and 4 DSP ports and WACI NX JR has 2 Serial ports and 2 IR ports ...

Page 44: ...44 SQL Setup SQL Setup SQL Setup SQL Setup Using SQL Setup users are able to create tables make queries and store data in a WACI s database ...

Page 45: ... Memory Log and F W are available to both the WACI NX Jr and the WACI NX The remaining four Diagnostics Relay and DSP are available only for the WACI NX which supports the additional hardware The Diagnostics web page for the WACI NX Jr reflects its five supported diagnostics ...

Page 46: ...X reflects all seven diagnostics Clicking on either the button or the link on the web page will take you to the available diagnostic tools All the diagnostics are presented in this section in the order found on the WACI NX Diagnostics web page ...

Page 47: ...is useful after making changes to some settings or modifying EventManager file Infrared Infrared Infrared Infrared Settings Settings Settings Settings This page allows you to teach your WACI various IR commands for a device such as a VCR using the remote control for the device In addition a complete list of devices and commands may be reviewed tested and or deleted in the IR Commands section at th...

Page 48: ... your Command such as Play or Eject Use letters and numbers only no spaces should be included in the name This Command will be associated with the device File Name you specified in step 1 There is also a learn x commands where x is the number of commands to be learned This allows multiple entries of commands to be entered before learning which in turn will speed the process Finally look for the IR...

Page 49: ...p You may also refresh the file and command lists by selecting Refresh Lists delete the selected command by selecting Delete Command or delete the selected group including all its associated commands by selecting Delete Group Depending on your web browser you may need to scroll down to view all of these buttons Serial Port Diagnostics Serial Port Diagnostics Serial Port Diagnostics Serial Port Dia...

Page 50: ...CII space character which is non printable may be displayed as decimal value 32 or hex value 20 Send String The second diagnostic allows you to send a byte stream through the port specified at the top of the page The byte stream you wish to send must be a URL encoded send string To send a URL encoded string follow these three rules for encoding 1 Enter your byte values as a string of printable ASC...

Page 51: ...ing rules 2 and 3 above you may add hex or decimal values using the hex and decimal fields just below the Send String text box Adding a hex number to your Send String with the Add tool simply places the prefix in front of the value you enter with no conversions Adding a decimal number first converts the decimal number to the hex equivalent and correctly places the prefix in front of it within the ...

Page 52: ...to Analog 5v to 5v 16 bit 0 to 65536 Digital Input 0 to 5v Digital Output Open Drain sink up to 200ma When the state of the port is High the LED light will be on otherwise if it is an A D or D A the LED will vary intensity based on level Log Files Log Files Log Files Log Files Log files for the WACI servers are available for both the WACI and the WACI NX Jr An admin may review or clear reset the l...

Page 53: ...TP Post calls to the server Active X calls are not logged Use this log to monitor calls made to the WACI by your custom web applications It is quite useful when debugging your application Event Manager Log Logs information about the status and execution of Events and Actions Errors generated during the execution of the Events and Actions are also written to this log FTP Server Connections Commands...

Page 54: ...First you will be prompted for the firmware files Firmware upgrade files will have either the extension AFW for operating system upgrades or ABT for bootstrap loader upgrades Once your upgrade file has been located the web page will tell you the tftp command line you will need to execute to upload the file into your WACI It will look something like ...

Page 55: ...le click on the batch file While the file is uploading the serial LEDs will blink one at a time Once the file is uploaded the WACI will reset and you will be able to access the WACI s web pages again Two important notes You will not be able use the WACI for anything else while it is in the firmware upgrade mode You may only update one firmware file at a time If you wish to update both the boot str...

Page 56: ...or Windows Fetch for Macintosh or ftp from a UNIX or DOS command line may be used to manage files on the WACI s FTP server File Structure File Structure File Structure File Structure The WACI automatically creates three directories at the root level of its FTP server EventManager holds data for your custom Events Actions and Variables IR holds IR Learning data for any learned commands wwwpub holds...

Page 57: ...nager wem file that has been copied moved into this directory IR When the WACI learns one or more IR commands for a device see Learn IR Command page 47 all the commands for that device are saved as a group in one file you choose a name for this Group File in Step 1 of the IR learning process These groups of commands are stored as data files in the IR directory with the extension WIR For example if...

Page 58: ...it etc are correctly handled by the WACI s web server This allows a huge number of file types such as pdf mov wav sit and zip to be easily accessed from custom web pages At this time the WACI does not support PERL PHP or built in databases Uploading Files Uploading Files Uploading Files Uploading Files You may use any FTP client or web browser to manage the files in the WACI s FTP directories For ...

Page 59: ...59 Next double click on the directory to which you would like to upload your files Finally drag and drop selected files from your File Explorer ...

Page 60: ...w of Events Actions Variables In the simplest terms when certain conditions in hardware or variables are met the WACI may be programmed to automatically perform specified tasks To put this into the context of EVENTS ACTIONS and VARIABLES An EVENT is triggered when conditions in hardware reach a user defined state or when a value of a user defined VARIABLE matches a user defined constant or express...

Page 61: ...th its Event Selecting an Event will highlight the Event and display all its associated Actions Events Actions and Variables may be added edited and deleted from this page Clicking on the heading at the top of the Event or Variable list will sort the respective list You can use groups to help organize your Events and Variables In addition you may Clone duplicate an Event with or without its associ...

Page 62: ...ring or reconfiguring your WACI with a device Debugging configurations Restoring copying or updating an Event Manager file see EventManager page 57 Disable the Event Manager by selecting the Disabled radio button at the top of the page Enable the Event Manager to reactivate all triggers when you are finished with your WACI administration ...

Page 63: ...options associated with the Event as described in the next two sections Types of Events Types of Events Types of Events Types of Events As mentioned earlier Events are triggered when a condition is met in the hardware a Variable matches a specific value or an expression evaluates to a non zero value The options for triggering an Event depend on its type The system recognizes the following types of...

Page 64: ...ry 27 seconds or 36 hours Variable A Variable Event is triggered when the value of a Variable matches a constant or expression If the expression check box is checked then the expression defined by Trigger value is evaluated whenever the Variable specified in Origin is modified Serial Serial Events are triggered when the INPUT value at a specified port matches a constant or expression If the expres...

Page 65: ...P DIO port changes DSP A D D A Analog Digital and Digital Analog Converters Available for the WACI NX only DSP A D D A Events are triggered when the INPUT value at a specified A D or D A Converter port matches a constant or expression The trigger value is normally stated as a range e g 0 to 150 Startup Startup Events are triggered while the WACI is booting up typically from reset or power on These...

Page 66: ...in that matches the incoming connection Fill the Origin field with the IP address or machine name of the Telnet server Use the Trigger Value to define the value to match to cause the Event to be executed The Trigger value used by a Telnet Event is similar in format to a Serial Event s Network The Network Event allows you to trigger when the status of one of the Ethernet Ports changes Temperature T...

Page 67: ...he Event that can be only triggered manually Other Event Options Other Event Options Other Event Options Other Event Options Group Name To help organize Events into meaningful groups a Group field is available Enter any text into this field On the main Event Manager page you can click on the Group label at the top of the Event list s Group column to sort the Events by their Group name ...

Page 68: ... Events that are triggered by matches on a user defined constant or expression Like Variables constants may be strings numbers schedules or ranges To trigger an Event using an expression the result of the expression must be resolved to an integer value not equal to 0 An expression that results in a string value will not trigger unless the string can be converted to an integer value that is not equ...

Page 69: ...tion button Similarly to edit an Action first select an Event and then select the associated Action When the desired Event and Action are both highlighted the Edit button above the list of Actions may be selected From the edit action page you will have several options based on the type of Action Types of Actions Types of Actions Types of Actions Types of Actions Variable A Variable Action allows y...

Page 70: ...the expression check box is UNCHECKED the value in the Output Value text box will be sent as a string to the specified port If the expression check box is CHECKED the expression in the Output Value text box will first be interpreted as described in the Expressions section and the resulting string value will then be sent to the specified port If the result of the expression is a number then it will...

Page 71: ... Mail Actions The Action will execute only once per Event trigger Use the Timeout in value to have the Action abort if it doesn t complete before the time out period expires HTTP Post An HTTP Post Action can be used to post data to a web server The format of the posted data is dependent on the capabilities of the server receiving the post The data returned by the server is discarded HTTP Post Acti...

Page 72: ...o the file you can use FTP or the Log_ReadFile RPC function There are no repeat values for Log Actions The Action will execute only once each time the owning Event is triggered Telnet A Telnet Action can be used to send data to a Telnet enabled network server device The format of the telnet data is dependent on the capabilities of the server receiving the data The data returned by the server can b...

Page 73: ... diagnostics see DSP Diagnostics page 52 DSP D A Available for the WACI NX only The DSP D A action outputs a voltage of 5v to 5v to the specified port The voltage level of the DSP D A port will change only if the port is set as a D A You can check how a port is set using the DSP diagnostics see DSP Diagnostics page 52 Relay Available for the WACI NX only A Relay Action turns a relay on or off Set ...

Page 74: ... used to let users know about anything important when they do not have an easy access to the device Action Timing Options Action Timing Options Action Timing Options Action Timing Options Actions may be Infinite execute forever or until another Action cancels the Event Two notes first checking the Infinite checkbox will override the Execute number of times field Second the associated Event will re...

Page 75: ... set an Action to be performed on the remote WACI check the Remote check box and specify the host name or IP address of the remote WACI To make setup easier make sure that both the controlling WACI and remote WACI are connected to the network and powered up Ne Ne Ne Network Timeouts twork Timeouts twork Timeouts twork Timeouts By default Actions that communicate over a network E mail Telnet HTTP P...

Page 76: ...riables Variables may be created from the main Event Manager web page see The Event Manager Web Page page 61 by selecting the Add variable button To edit an existing Variable first select it so that it is highlighted then select the Edit button above the list of Variables The edit variable screen allows you to specify options and values for a Variable Some options for Variables will differ by the ...

Page 77: ...alue is not used Current Value The Current value is the working value of the Variable It is the value accessed in all Event and Action expressions In addition Variable Actions see Variable page 69 send their outputs to the Current value The Current value is set to the Default value during system start up if the Persistent flag is not set Types of Variables Types of Variables Types of Variables Typ...

Page 78: ... D A IR Serial HTTP Post Email Log and Telnet interpreting Values as Expressions ASCII Char Returns the ASCII numeric value for a character passed in Example ASCII A ASCII var_name atof string Returns floating point number Converts a numeric string with floating point to a floating point number Example atof test atol string or atoi string Returns integer Converts a numeric string to a number Range...

Page 79: ...n the length of String then String is returned Example Padr test 6 replace String S1 S2 Search string for findstr and replace with newstr If the string S1 cannot be found inside of String just return the original string Example replace abcdef xyz abc returns abcdef If the string to replace occurs more than once replace each instance Example replace abcabcabc bc Z returns aZaZaZ RStr string integer...

Page 80: ...xpressions If the expression option is UNCHECKED the trigger and output values are treated as simple strings and no quotation marks are needed NOTE Variable Events and Actions automatically interpret the value based on its output or input Variable s type see Types of Variables page 77 On the other hand if the expression option is CHECKED the WACI will treat the values as an expression and evaluate...

Page 81: ...y parentheses Hello 3 HelloHelloHello is a string operator here Hello 3 Hello3 The number 3 becomes part of the Hello string because the string comes first Hello 3 7 Assuming Hello is a number Variable holding a value of 4 3 6 9 The string 6 is valued as 6 a number and 3 is a number 3 Hello 3 The string is treated as 0 because Hello has no integer interpretation Operators Operators Operators Opera...

Page 82: ...Hello 3 Hello3 3 Hello 3 3 6 9 Subtraction Minus Operator The subtraction operator works with both numerical values and strings values Use this operator with strings to remove a sub string from a source string or use this operator to subtract two integer values For example This expression resolves to this value 6 2 4 Hello ll Heo 10 3 7 Multiplication Times Operator This operator multiplies two nu...

Page 83: ...ring values can be compared against wildcard values e g Hello For example assuming MyNumber has an integer value of 4 and MyName has a string value of John This expression resolves to this value MyNumber 4 1 MyNumber 4 1 MyNumber 5 0 MyName John 1 MyName J 1 0 John 1 Not Equal Comparison Operator The not equal comparison operator will compare two tokens which can be strings or integers Exactly opp...

Page 84: ...reater Than or Equal Comparison Operator The greater than or equal comparison operator will compare two tokens which can be integers or strings assuming the string represents an integer value The expression will return 1 if the first token has an integer value larger than or equal to the second and 0 if the second value is larger For example assuming MyNumber has an integer value of 4 This express...

Page 85: ...ller For example assuming MyNumber has an integer value of 4 This expression resolves to this value MyNumber 5 1 MyNumber 4 1 MyNumber 3 0 Logical And Operator Assume you have two Boolean true false expressions Expression1 and Expression2 each returning true 1 or false 0 The logical and operator determines the true or false state of the complex expression Expression1 Expression2 using the rules ap...

Page 86: ... to a traditional logical OR statement If Expression1 is and Expression2 is Expression1 Expression2 resolves to True 1 True 1 True 1 True 1 False 0 True 1 False 0 True 1 True 1 False 0 False 0 False 0 In other words This expression resolves to this value 3 3 4 4 1 1 4 5 1 0 4 4 1 3 5 0 0 Logical Not Operator The logical not is a prefix operator that negates the Boolean expression that follows it I...

Page 87: ... the example of 12 10 The binary value of 12 is 1100 and the binary value of 10 is 1010 12I10 is computed by performing an OR between each of the corresponding four bits 12 1 1 0 0 10 1 0 1 0 12 10 1 1 1 0 Therefore 12 10 Binary 1110 Decimal 14 One s Complement Operator The one s complement operator is a bitwise not prefix operator that performs a logical NOT to each bit of an integer This is bett...

Page 88: ...d in another assignment though it can be used as the result of an expression For example This expression resolves to this value 3 4 Illegal L Value not a Variable MyCounter 1 1 also stores 1 into the MyCounter Variable 5 MyCounter 1 0 stores 1 into MyCounter as well Addition Assignment Operator The operator is used to append one string to another or to add two integer values together Adding a numb...

Page 89: ...llegal L Value not a Variable Multiplication Assignment Operator This operator multiplies two numbers or can be used for creating a string with a repeating value The numbers and strings can be either Variables or literals For example assuming MyNumber has an integer value of 4 and MyString has a value of Hello This expression resolves to this value MyNumber 5 20 MyNumber set to 20 MyString 3 Hello...

Page 90: ...atches any single character Either character can be used anywhere within a string constant When used with a comparison operator he llo he o and he o will all match the string hello When used to compare g data within a serial or Telnet stream the use of is more efficient since the total number of comparison characters can be known Use of the could require buffering large amounts of the incoming dat...

Page 91: ...inefeed Character code 0x0D o Origin that triggered Event Port number Variable name etc The value depends on the type of Event r Carriage return Character code 0x0A t Horizontal tab Character code 0x09 v Vertical tab Character code 0x0B Single quote Character code 0x27 Double quote Character code 0x22 Backslash Character code 0x5C Question mark this is needed because wild cards will be identified ...

Page 92: ...PC Quick Reference to Methods Detailed List of All Methods RPC Server Logs As noted in Diagnostics web pages section key information regarding the RPC server can be retrieved from the Log Files web page This information includes the RPC server version and a list of available methods The Log Files web page also allows you to enable logging for the RPC commands Syntax for HTTP Post Call Tokens Call ...

Page 93: ...eference for details about the returned values for any given method These returned values are denoted by the text out retval in the Syntax and Parameters sections The response to the HTTP Post will be a string in the format status 0 or 1 faultCode Fault Code response1 Value for Response 1 response2 Value for Response 2 response3 Value for Response 3 etc EXAMPLE 1 Serial_GetSettings EXAMPLE 1 Seria...

Page 94: ...iting for a mutex or shared resource 3 Memory allocation failure 4 Configuration does not support action i e setting a Digital I O output when it is configured as an input 5 Failed to find entry in database registry or FRAM 6 Failed to store persistent database registry or FRAM settings might not be saved 7 Some internal error occurred that does not fit another category Must use extended error inf...

Page 95: ...t type text javascript language JavaScript thispage location href URLarr thispage split theIP URLarr 2 theFILE MyWACIShockWaveFlashFile swf script Next use this bit of script to embed the flash file in the desired area of the web page script type text javascript language JavaScript document write object id WACI classid clsid D27CDB6E AE6D 11cf 96B8 444553540000 codebase http download macromedia co...

Page 96: ...ay assign values based on buttons text fields constants or whatever else is appropriate for your page WACI_Call method Desired RPC Method WACI_Call param1 Parameter 1 for the Method WACI_Call param2 Parameter 2 for the Method WACI_Call param3 Parameter 3 for the Method etc Call the RPC using HTTP Post WACI_Call sendAndLoad http RPCServerIP RPC WACI_Response POST STEP 3 Response Tokens STEP 3 Respo...

Page 97: ...its return value Strings will return the null string integers will return 1 and Booleans will return FALSE See the detailed list of methods at the end of this reference for details about the parameters and return values for any given method Parameter values are denoted by the text in in the Syntax and Parameters sections Similarly the return value is denoted by the text out retval String values sh...

Page 98: ... Port Expression Data 114 Serial_Read Port 114 Serial_ClearReadBuffer Port 114 Serial_ReadBufferCount Port 115 Serial_GetPortCount 115 RELAY METHODS WACI NX ONLY 116 Relay_On Port 116 Relay_Off Port 116 Relay_GetState Port 116 Relay_GetPortCount 117 DIGITAL I O METHODS WACI NX ONLY 118 DIO_Read Port 118 DIO_OutputMode_Close Port 118 DIO_OutputMode_Open Port 118 DIO_IsOutput Port 119 DIO_IsPulledUp...

Page 99: ...tId Name 154 GetActionByIdx EventId Idx 154 GetActionByName EventId Name 155 GetActionCount EventId 155 GetActionDelay ActionId 155 GetActionDutyCycle ActionId 156 GetActionHost ActionId 156 GetActionIds EventId 156 GetActionInfo ActionId 157 GetActionName ActionId 157 GetActionOption ActionId OptionType 158 GetActionOutput ActionId 158 GetActionPort ActionId 159 GetActionStopAfter ActionId 160 Ge...

Page 100: ...astErrorString Returns the description of the error from the last failed method call Syntax HRESULT GetLastErrorString out retval BSTR ErrorString Parameters ErrorString out retval String describing an error Remarks ErrorString corresponds to response1 of an HTTP Post response when status is 0 failure GetLastExtended GetLastExtended GetLastExtended GetLastExtendedErrorString ErrorString ErrorStrin...

Page 101: ...ain to the WACI NX only 2 Relays BSTR 1 0 0 1 3 DIO IsOutput BSTR 0 1 0 0 4 DIO State BSTR 1 1 1 1 5 DIO Is Pulled Up BSTR 1 0 0 0 6 AD Digital Readings BSTR 128 54 2096 8194 7 AD Voltages BSTR 0 2 0 1 2 2 4 GetMachineType GetMachineType GetMachineType GetMachineType Returns the type of WACI either Plus or Junior Syntax HRESULT GetMachineType out retval long Type Parameters Type out retval The par...

Page 102: ...f this function is called with an invalid password more than 25 times then ValidatePassword will return FALSE for the next 15 minutes regardless of whether the password passed into subsequent calls is valid or not Time_GetDate Time_GetDate Time_GetDate Time_GetDate Returns current time and date on the device Syntax HRESULT Time_GetDate out retval DATE Date Parameters Date out retval DATE object Re...

Page 103: ...s Milliseconds in The number of milliseconds to wait Success out retval TRUE if the Milliseconds value is greater than or equal to 0 and less than or equal to 999999 and FALSE if value is outside this range Remarks The call to this function will not return until after the wait time has expired ...

Page 104: ...eters IP out retval String containing the current IP address of the device such as 10 0 1 3 Net_GetIPAddressEx Net_GetIPAddressEx Net_GetIPAddressEx Net_GetIPAddressEx NetCard NetCard NetCard NetCard Returns the current IP address of the device Syntax HRESULT Net_GetIPAddress in long NetCard out retval BSTR IP Parameters NetCard in The ID of the netcard to get the IP address from IP out retval Str...

Page 105: ...st mechanism Syntax HRESULT Net_PostHtmlData in BSTR Url in BSTR PostData out retval BSTR RetData Parameters Url in The server address to post to e g http waci rpc PostData in A string that represents the data to send to the server RetData out retval The response send back from the server Net_PostHtmlDataEx Net_PostHtmlDataEx Net_PostHtmlDataEx Net_PostHtmlDataEx NetCard NetCard NetCard NetCard Ur...

Page 106: ...ses to be included in the To line of the email Separate each email address with a semicolon CcIds in Email addresses to include on the Cc line of the email BccIds in Email addresses placed in the Bcc line of the email Subject in Subject line for the email MessageBody in Body text of the email Result out retval Returned as 0 if no error occurred otherwise the return value is the error returned from...

Page 107: ...PathId in Email address to send server errors and responses to This parameter is normally set to the same address as the SenderId ReturnRcpId in Email address to send return receipt requests to Pass an empty string if a return receipt is not needed MsgComment in Sets the comment field for the email Subject in Subject line for the email IsExpression in Pass a 1 if the MessageBody parameter contains...

Page 108: ...axWaitMS Telnet_SendExpression NetCard Expression MaxWaitMS Telnet_SendExpression NetCard Expression MaxWaitMS Telnet_SendExpression NetCard Expression MaxWaitMS Writes a string to the log file identified by FileName Syntax HRESULT Telnet_SendExpression in long NetCard in BSTR Expression in long MaxWaitMS out retval long NotSent Parameters Netcard in ID of network port to use Expression in Express...

Page 109: ...ccessfully Telnet_ReadBufferCount NetCard Telnet_ReadBufferCount NetCard Telnet_ReadBufferCount NetCard Telnet_ReadBufferCount NetCard Counts the number of characters in the buffer Syntax HRESULT Telnet_ReadBufferCount in long NetCard out retval long Count Parameters Netcard in ID of network port to use Count out retval Number of characters in the buffer Buzzer Methods Buzzer_On Buzzer_On Buzzer_O...

Page 110: ... MaxSize Writes a string to the log file identified by FileName Syntax HRESULT Log_Write in BSTR FileName in long IsExpression in BSTR Buffer in long MaxSize out retval VARIANT_BOOL Success Parameters FileName in Name of the log file IsExpression in Set to 0 if Buffer is a simple string and 1 if Buffer contains an expression Buffer in String to write to the log file MaxSize in The maximum size the...

Page 111: ...g on the number of bytes contained in the log file Log_ClearFile FileName Log_ClearFile FileName Log_ClearFile FileName Log_ClearFile FileName Clears the contents of the named log file Syntax HRESULT Log_ClearFile in BSTR FileName out retval VARIANT_BOOL Success Parameters FileName in Name of the log file Success out retval TRUE if the log file was cleared FALSE on failure Log_FirstFile Wildcard L...

Page 112: ...t file in the Logs directory Use this to loop through all filenames and use wildcards to filter results Syntax HRESULT Log_ClearFile in BSTR Wildcard out retval BSTR FileName Parameters Wildcard in Filter the list of log names returned Leave blank for all Filename out retval The name of the next file in the directory ...

Page 113: ...RDWARE Remarks Valid values for the different settings are Baud 300 600 1200 2400 4800 9600 19200 38400 57600 and 115200 Parity ODD EVEN NONE Stop Bits 1 2 Flow Control HARDWARE SOFTWARE NONE Serial_Send Port Msg Serial_Send Port Msg Serial_Send Port Msg Serial_Send Port Msg MaxWaitMS MaxWaitMS MaxWaitMS MaxWaitMS Sends a string to the specified port Syntax HRESULT Serial_Send in long Port in BSTR...

Page 114: ... serial data before timing out NotSent out retval If an error occurred or the timeout expired then this is the number of bytes not sent otherwise this value is set to 0 Remarks The rules applied for Expression are the same as those for any expression defined for a Serial Action Serial_Read Port Serial_Read Port Serial_Read Port Serial_Read Port Returns the contents of the serial read buffer for th...

Page 115: ..._ReadBufferCount Port Returns the number of characters in the read buffer for the specified port The maximum number of characters stored by the circular buffer is 4K Syntax HRESULT Serial_ReadBufferCount in long Port out retval long Count Parameters Port in Port number for the serial port Valid values are 1 and 2 Count out retval Number of characters currently in the receive buffer Serial_GetPortC...

Page 116: ...ort Relay_Off Port Relay_Off Port Switches off the relay at the specified port Syntax HRESULT Relay_Off in long Port out retval VARIANT_BOOL Success Parameters Port in Port number for the relay Valid values are 1 2 3 and 4 Success out retval TRUE if the relay was switched off FALSE if the relay failed to switch off Remarks This function de energizes the specified relay The switch sense depends on ...

Page 117: ...GetPortCount Relay_GetPortCount Relay_GetPortCount Relay_GetPortCount Returns the number of relays supported by the WACI hardware Syntax HRESULT Relay_GetPortCount out retval long NumPorts Parameters NumPorts out retval Number of relays supported by the hardware ...

Page 118: ...utputMode_Close Port DIO_OutputMode_Close Port DIO_OutputMode_Close Port Sets the Digital I O port to an active low state approximately 0 3v Syntax HRESULT DIO_OutputMode_Close in long Port out retval VARIANT_BOOL Success Parameters Port in Port number for the digital I O Valid values are 1 2 3 and 4 Success out retval TRUE if the digital I O port was successfully set low and FALSE if the port was...

Page 119: ...PulledUp Port DIO_IsPulledUp Port Used to determine whether a pull up or pull down resistor is connected to the input of the specified DIO line Syntax HRESULT DIO_IsPulledUp in long Port out retval long Result Parameters Port in Port number for the digital I O Valid values are 1 2 3 and 4 Result out retval If the returned value is 1 then the input port has an internal pull up resistor connected to...

Page 120: ...120 Parameters NumPorts out retval Number of digital I O ports supported by the hardware ...

Page 121: ...dDigital Port AD_ReadDigital Port Returns the integer value 0 to 1023 that is proportional to the voltage applied to the specified port Syntax HRESULT AD_ReadDigital in long Port out retval long Val Parameters Port in Port number for the A D converter Valid values are 1 2 3 and 4 Val out retval An integer value between 0 and 1023 Remarks The Analog to Digital ports convert voltage values to intege...

Page 122: ...lts Parameters Port in Port number for the A D converter Valid values are 1 2 3 and 4 MaxVolts out retval The voltage that must be applied to the specified port to cause AD_ReadDigital to return the maximum digital value Remarks When the voltage is applied to the port that meets or exceeds the maximum voltage value returned by this call then a read of the digital value of the port will yield the m...

Page 123: ... port s input voltage is at the maximum voltage level Use AD_MaxVoltage to get the A D maximum voltage level By default the maximum digital value is 1023 AD_MinDigital Port AD_MinDigital Port AD_MinDigital Port AD_MinDigital Port Gets the maximum A D digital value Syntax HRESULT AD_MaxDigital in long Port out retval long MaxDigital Parameters Port in Port number for the A D converter Valid values ...

Page 124: ... 2 3 and 4 Val in The voltage level Success out retval Returns true if the change was successful AD_SetDigital AD_SetDigital AD_SetDigital AD_SetDigital Port Val Port Val Port Val Port Val Sets the digital value of the A D Port Syntax HRESULT AD_GetPortCount in long Port in long Val out retval VARIANT_BOOL Success Parameters Port in Port number for the A D converter Valid values are 1 2 3 and 4 Va...

Page 125: ...ically grouped together by device IR_SendCommandEx Port Group Command Sequence Re IR_SendCommandEx Port Group Command Sequence Re IR_SendCommandEx Port Group Command Sequence Re IR_SendCommandEx Port Group Command Sequence Repeat peat peat peat Sends an IR command out the specified IR port Syntax HRESULT IR_SendCommandEx in long Port in BSTR Group in BSTR Command in BSTR Sequence in BSTR Repeat ou...

Page 126: ...Parameters Port in Port number for the A D converter Valid values are 1 2 3 and 4 Sequence in Denotes which of the two sequences in the IR data stream should be output Set to 1 to output the one time stream and 2 for the repeat stream DATA in A string containing the IR data to send The format is defined below Success out retval TRUE if data was successfully sent FALSE if sending the data failed Re...

Page 127: ...30 03CC 0034 00D4 wFreq Calculation wFreq 4 145146 106 Carrier_Freq or Carrier_Freq 4 145146 106 wFreq In the above example the wFreq value was 005C or 92 decimal So the carrier frequency would be Carrier_Freq 4 145146 106 92 45 kHz The data sequences consist of on off timing pairs and represent the number of cycles the emitter is turned on and the number of cycles the emitter is turned off The nu...

Page 128: ...specified group Remarks If a group contains no commands then the returned string is IR_ListAllCommands IR_ListAllCommands IR_ListAllCommands IR_ListAllCommands Returns an array containing all commands from all groups Syntax HRESULT IR_ListAllCommands out retval VARIANT Array Parameters Array out retval Array containing all commands from all groups Remarks The returned array is an array of strings ...

Page 129: ...he specified device Model out retval String containing the model name or number of the device Remarks This function returns the string that follows the Model label in the WIR file associated with the specified Group The Model for the specified Group can also be changed in the IR Diagnostics page IR_GetGroupRemote Group IR_GetGroupRemote Group IR_GetGroupRemote Group IR_GetGroupRemote Group Returns...

Page 130: ...out retval String containing comments about the specified device Remarks This function returns the string that follows the Comment label in the WIR file associated with the specified Group The Comment for the specified Group can also be changed in the IR Diagnostics page IR_GetPort IR_GetPort IR_GetPort IR_GetPortCount Count Count Count Returns the number of IR output ports supported by the WACI h...

Page 131: ...nager When disabled the Event Manager will not execute any Events Syntax HRESULT EnableEventManager in VARIANT_BOOL Enable out retval VARIANT_BOOL Success Parameters Enable in Set to TRUE to enable the Event Manager and FALSE to disable the Event Manager Disabling the Event Manager will stop the processing of all Events and Actions Success out retval TRUE if the Event Manager was successfully enab...

Page 132: ...ype your interested in must already exist Or the following bits together to set the ChangeMask as desired The ChangeMask bits are defined as follows Bit Value Bit Description 0x00000001 Bit 0 One of the Variables changed 0x00000002 Bit 1 Serial data received on one of the serial ports 0x00000004 Bit 2 One of the digital input ports changed state 0x00000008 Bit 3 The input voltage on one of the A D...

Page 133: ...he new Event Type in Type of the Event e g Serial see GetEventType EventId page 145 for a list of types Concurrent in Set to 1 to execute Actions concurrently and 0 otherwise Source in Port Variable etc to be used for the source of the Event s trigger see GetEventSource EventId page 144 for details on valid Source values Match in Value to match to trigger the Event EventId out retval ID of the new...

Page 134: ...ById EventId CloneActions NewName Clone duplicate an Event specified by its ID Syntax HRESULT CloneEventById in long EventId in long CloneActions in BSTR NewName out retval long CloneID Parameters EventId in ID of the Event to modify CloneActions in Duplicate all the Event s Actions too NewName in Name of the new duplicate Event CloneID out retval ID of the new duplicate Event Remarks The name of ...

Page 135: ...x number Syntax HRESULT GetEventByIdx in long Idx out retval long EventId Parameters Idx in The index of the Event in the Event list EventId out retval Event ID of the specified Event Remarks GetEventByIdx is normally used as part of a loop for getting the list of created Events Use GetEventCount to get the number of Events Use GetEventByIdx to get the ID of the next Event in the list Then use the...

Page 136: ...Event Concurrent out retval 1 if Actions should be executed concurrently 0 if Actions should be executed sequentially Remarks When Actions are set to execute sequentially the next Action in the list will not execute until the previous Action has completely executed So if the first Action is set as one that executes an infinite number of times the second Action will never execute Use the Up Dn hype...

Page 137: ...etval A returned string filled in with the group for the specified Event GetEventNetCard EventId GetEventNetCard EventId GetEventNetCard EventId GetEventNetCard EventId Returns the group name for the Event with a specified ID Syntax HRESULT GetEventGroup in long EventId out retval BSTR Netcard Parameters EventId in ID of the Event Netcard out retval The ID of the Network port the event is assigned...

Page 138: ...et the complete list of Event IDs stored by the Event Manager This function is more efficient than calling GetEventCount and GetEventByIdx GetEventIdxById EventId GetEventIdxById EventId GetEventIdxById EventId GetEventIdxById EventId Returns the index into the Event list for an Event with a specified ID Syntax HRESULT GetEventIdxById in long EventId out retval long Idx Parameters EventId in ID fo...

Page 139: ... when the Event is notified of a change in data Syntax HRESULT GetEventMatch in long EventId out retval BSTR Match Parameters EventId in ID for the specified Event Match out retval The value that incoming data should be compared against to determine whether the Event should be triggered Remarks The Match value is either an expression or simple text value How the Match value is evaluated depends on...

Page 140: ...n long EventId in long OptionType out retval long OptionVal Parameters EventId in ID for the specified Event OptionType in Type of option for the Event OptionVal out retval Value of the specified option for the Event Remarks Pass one of the following values into OptionType Value Option OptionVal returned 1 Concurrent 0 Event s Actions are executed serially 1 Event s Actions are executed concurrent...

Page 141: ...SchRecurType EventId Returns the type of schedule used by the specified Event Syntax HRESULT GetEventSchRecurType in long EventId out retval long RecurType Parameters EventId in ID for the specified Event RecurType out retval Type of schedule to apply Valid values for RecurType are Value Description 0 Once 1 Daily 2 Weekly 3 Monthly 4 Yearly Remarks This function is valid for Clock Events only Get...

Page 142: ...lid only for Clock Events GetEventS GetEventS GetEventS GetEventSchMonth EventId chMonth EventId chMonth EventId chMonth EventId Returns the month value for the Event s schedule Syntax HRESULT GetEventSchMonth in long EventId out retval long Month Parameters EventId in ID for the specified Event Month out retval Integer representing the scheduled month of the year Values will range from 1 to 12 Re...

Page 143: ...in ID for the specified Event EveryN out retval Repeat every N periods The period depends on the type of schedule e g Weekly Monthly etc Remarks This function is valid only for Clock Events The Recur Every value EveryN is used by all the Event schedules except one The Once schedule does not repeat therefore it does not need the EveryN value GetEventSchHour EventId GetEventSchHour EventId GetEventS...

Page 144: ...Id GetEventSchSecond EventId Returns the second that the Event is to be triggered Syntax HRESULT GetEventSchSecond in long EventId out retval long Second Parameters EventId in ID for the specified Event Second out retval Integer representing the scheduled second Values range from 0 to 59 Remarks This function is valid only for Clock and Timer Events GetEventSource EventId GetEventSource EventId Ge...

Page 145: ...entId GetEventType EventId GetEventType EventId GetEventType EventId Returns the type of the Event with a specified ID Syntax HRESULT GetEventType in long EventId out retval long Type Parameters EventId in ID for the specified Event Type out retval Type of the indicated Event Remarks Type is returned as one of the following values Value Type 0 Unknown 1 Scheduled 2 Timer 3 Variable 4 Serial Input ...

Page 146: ...this function to set up an Event After making this call a call to SetEventSchedule is required for all Events of type Clock or Timer A call to SetEventOption should also to be made to set or clear the expression flag for the Event s match value SetEventByName Name Type Concurrent Source Match SetEventByName Name Type Concurrent Source Match SetEventByName Name Type Concurrent Source Match SetEvent...

Page 147: ... NetCard out retval VARIANT_BOOL Success Parameters EventId in Name of the Event to set the information for NetCard in The ID of the network port the event should monitor Success out retval TRUE if specified Event was successfully set FALSE if setting the Event failed Remarks If NetCard is set to 0 the event will monitor all network ports SetEventOption EventId OptionType OptionVal SetEventOption ...

Page 148: ...l execute concurrently 2 Expression 0 The trigger value is a simple text string 1 The trigger value is an expression 3 Disable 0 The Event is enabled 1 The Event is disabled If both SetEventSchedule and SetEventOption need to be called for an Event then SetEventOption should be called before SetEventSchedule ...

Page 149: ...in long Hour in long Minute in long Second out retval VARIANT_BOOL Success Parameters EventId in ID of the Event to modify the schedule of Recur in The recurrence pattern used for this schedule Recur value Description 0 Once 1 Daily 2 Weekly 3 Monthly 4 Yearly MaskOrDay in Mask of days or specific day of the month MaskDay values for weekly Events Value Bit Day 0x00000001 1 0 Sunday 0x00000002 2 1 ...

Page 150: ...s by the sort type and direction Syntax HRESULT SortEvents in long SortType in long Direction out retval VARIANT_BOOL Success Parameters SortType in Type of sort to apply to the list Direction in Direction of the sort ascending 1 or descending 0 Success out retval TRUE if the Events are successfully sorted FALSE if sorting the Events failed Remarks This function is no longer supported TriggerEvent...

Page 151: ...l TRUE if the Events are successfully sorted FALSE if sorting the Events failed Remarks An Action executed by the triggered Event has access to the Data value by using the g escape sequence within the Action s output value ...

Page 152: ... before sending Output to Port This is a real number and non integer values are allowed DutyCycle in Number of seconds to delay between each successive execution of the Action This is a real number and non integer values are allowed StopAfter in Number of times to repeat the Action Set to 1 to repeat infinitely Port in Location where the output is sent Output in Data that should be output Success ...

Page 153: ... are allowed DutyCycle in Number of seconds to delay between each successive executions of the Action This is a real number and non integer values are allowed StopAfter in Number of times to repeat the Action Set to 1 to repeat infinitely Port in Location where the output is sent Output in The value of this parameter depends on the value of Type Success out retval TRUE if specified Action settings...

Page 154: ...ntId in long Idx out retval VARIANT_BOOL Success Parameters EventId in ID of the Event that owns the Action Idx in Index into the Event s list of Actions that identifies which Action to delete Success out retval TRUE if the specified Action was successfully deleted FALSE if deleting the Action failed DeleteActionByName EventId Name DeleteActionByName EventId Name DeleteActionByName EventId Name De...

Page 155: ...etActionByName EventId Name GetActionByName EventId Name GetActionByName EventId Name GetActionByName EventId Name Returns the Action ID for a specified Event ID and Action name Syntax HRESULT GetActionByName in long EventId in BSTR Name out retval long ActionId Parameters EventId in ID of specified Event Name in Name of the Action ActionId out retval Action ID of the named Action Remarks The name...

Page 156: ...For Actions that execute serially the value is the amount of time to wait after the previous Action completed GetActionDutyCycle ActionId GetActionDutyCycle ActionId GetActionDutyCycle ActionId GetActionDutyCycle ActionId Returns the number of seconds to wait between successive executions of an Action Syntax HRESULT GetActionDutyCycle in long ActionId out retval double Duty Cycle Parameters Action...

Page 157: ...owned by an Event This function is more efficient than calling GetActionCount and GetActionByIdx GetActionInfo ActionId GetActionInfo ActionId GetActionInfo ActionId GetActionInfo ActionId Returns an array filled with the data for an Action Syntax HRESULT GetActionInfo in long ActionId out retval VARIANT Info Parameters ActionId in ID for the specified Action Info out retval An array of data value...

Page 158: ...he option type Syntax HRESULT GetActionOption in long ActionId in long OptionType out retval long OptionVal Parameters ActionId in ID for specified Action OptionType in Type of option to examine OptionVal out retval Value of the specified option Remarks Three option types are supported for Actions Value Description Returned OptionVal 1 Expression 0 output is a simple string 1 output is an expressi...

Page 159: ...ng value is a combination of the name of the IR group a and the name of a command within that group e g VCR Play HTTP Post A simple string or complex expression This value is posted to the URL specified in Port E mail The simple string or complex expression that makes up the body of the e mail message Log A simple string or complex expression Telnet A simple string or complex expression Valid valu...

Page 160: ... file to write the logged information to Telnet The IP address or host name of the Telnet server to command All other cases The name of the port of the associated device e g Port1 GetActionStopAfter ActionId GetActionStopAfter ActionId GetActionStopAfter ActionId GetActionStopAfter ActionId Returns the number of times to repeat the Action Syntax HRESULT GetActionStopAfter in long ActionId out retv...

Page 161: ...t command WACI NX and WACI NX Jr 8 Email message WACI NX and WACI NX Jr 9 Log to file WACI NX and WACI NX Jr 10 Telnet command WACI NX and WACI NX Jr MoveActionByIdx EventId Idx Where MoveActionByIdx EventId Idx Where MoveActionByIdx EventId Idx Where MoveActionByIdx EventId Idx Where Changes the order of execution for the Actions under the specified Event Syntax HRESULT MoveActionByIdx in long Ev...

Page 162: ...specified Action Type in Type of Action e g Serial Variable etc Delay in Number of seconds to delay before sending Output to Port This is a real number and non integer values are allowed DutyCycle in Number of seconds to delay between each successive execution of the Action This is a real number and non integer values are allowed StopAfter in Number of times to repeat the Action Set to 1 to repeat...

Page 163: ...ach successive execution of the Action This is a real number and non integer values are allowed StopAfter in Number of times to repeat the Action Set to 1 to repeat infinitely Port in Location where the output is sent Output in Data that should be output Success out retval TRUE if specified Action s settings were updated FALSE if updating the Action failed Remarks Action types that the WACI suppor...

Page 164: ...y Port in Location where the output is sent Output in Data that should be output Success out retval TRUE if specified Action settings were updated FALSE if updating the Action failed Remarks Action types that the WACI supports depend on the device s hardware capabilities see GetActionType ActionId page 160 for valid type values The value of Port represents where the Action is going to send its out...

Page 165: ... ActionId in long OptionType in long OptionVal out retval VARIANT_BOOL Success Parameters ActionId in ID for specified Action OptionType in Type of option to modify OptionVal in Updated value for the option Success out retval TRUE if the specified Action option was updated FALSE if updating the option failed Remarks Two options are supported for Actions OptionType Description OptionVal 1 Expressio...

Page 166: ...tion in Direction of the sort 1 for ascending and 0 for descending Success out retval TRUE if the Actions were successfully sorted FALSE if sorting the Actions failed Remarks This function is no longer supported ...

Page 167: ...Number 2 Schedule 3 String 4 Range Default in Default value of the new Variable Value in Current value of the new Variable Persist in Set to 1 to make the Variable persistent 0 if not VarId out retval ID for the new Variable Remarks Default and Value The returned value is a string that represents the stored value of the Variable The string value will need to be converted by the caller into the act...

Page 168: ...ue to be given to the Variable The format of this parameter should match the type of the Variable to be assigned see GetVariableValue VarId page 172 Success out retval TRUE if specified Variable s value was updated FALSE if updating the Variable failed Remarks AssignVariable does not change the type of the Variable when the assignment is made If the Value parameter does not match the Variable s ty...

Page 169: ...iables VarID out retval ID of specified Variable Remarks Use this function within a loop to get a list of all Variables on the system The first Variable in the list has an index of 0 Call GetVariableCount to get the number of Variables in the list GetVariableByName Name GetVariableByName Name GetVariableByName Name GetVariableByName Name Returns a Variable s ID not the value from its name Syntax H...

Page 170: ...le s default value The string value will need to be converted by the caller into the actual type e g a Variable of type long The format for the returned string depends on the Variable s type see GetVariableType VarId page 171 GetVariableGroup VarId GetVariableGroup VarId GetVariableGroup VarId GetVariableGroup VarId Returns the group name for the Variable Syntax HRESULT GetVariableGroup in long Va...

Page 171: ... of specified Variable Persist out retval Returns 1 if the Variable is persistent and 0 if it is not Remarks When a Variable is persistent the value of the Variable is stored to permanent storage after each time it is changed So if the device is reset or the power is turned off the Variable will still have its last value when the system restarts If the Variable is not persistent then the Variable ...

Page 172: ...g VarId out retval BSTR Value Parameters VarId in ID of specified Variable Value out retval String containing the current value of the specified Variable Remarks The returned value is a string that represents the stored value of the Variable The string value will need to be converted by the caller into the actual type e g a Variable of type long The format for the returned string depends on the Va...

Page 173: ...iable names consist of letters numbers and the underscore All other characters are not permitted Default and Value The returned value is a string that represents the stored value of the Variable The string value will need to be converted by the caller into the actual type e g a Variable of type long The format for the returned string depends on the Variable s type see GetVariableType VarId page 17...

Page 174: ...ype e g a Variable of type long The format for the returned string depends on the Variable s type see GetVariableType VarId page 171 Persistence When a Variable is persistent the value of the Variable is stored to permanent storage each time it is changed So if the device is reset or the power is turned off the Variable will still have its last value when the system restarts If the Variable is not...

Page 175: ...irection SortType Direction Sorts all Variables by the sort type and direction Syntax HRESULT SortVariables in long SortType in long Direction out retval VARIANT_BOOL Success Parameters SortType in Type of sort to perform Direction in Direction of the sort 1 for ascending and 0 for descending Success out retval TRUE if the Variables are successfully sorted FALSE if sorting the Variables failed Rem...

Page 176: ...rror Description 1 RAM self test failed 2 Real time clock failed to stabilize 3 Non volatile RAM failed self test 4 No firmware loaded in Flash ROM 5 Failed to initialize Ethernet adapter 6 Failed during download of firmware image 7 Failure when writing to Flash ROM 9 Failed to relocate and initialize Kernel ...

Page 177: ...riginal serial number has been modified or removed or E External equipment other than supplied by manufacturer in determination of manufacturer shall have affected the performance safety or reliability of the product F Part s are no longer available for product In the event that the product needs repair or replacement during the specified warranty period product should be shipped back to Manufactu...

Page 178: ...rect the interference by one or more of the following measures Reorient or relocate the receiving antenna Increase the separation between the equipment and the receiver Connect the equipment into an outlet on a circuit different from that to which the receiver is connected Consult the dealer or an experienced radio TV technician for help You may also find helpful the following booklet prepared by ...

Page 179: ...163 167 Green Status Power LED 15 H Hardware Parts Overview 11 Hardware Test 33 35 Host Name 24 28 30 31 33 35 36 37 39 50 52 53 I Introduction 6 21 IP Access Table 39 IP Settings 33 34 IR Emitters 19 20 IR Learner 9 12 14 19 20 43 IR Ports 12 14 19 20 L Lamp Test 33 35 LAN Port 17 LCD Display 15 Log Files 47 M MAC Address 39 Maximum Ratings 10 Memory Information 47 N Network Interface 17 Network ...

Page 180: ...180 U Using the WACI 29 V Variables 47 51 56 57 63 64 72 73 74 77 84 W WACI NX Jr Parts Overview 11 WACI NX Parts Overview 13 Web Server Features 32 ...

Search results

Summary of Contents for WACI NX Jr.

Reviews:

Related manuals for WACI NX Jr.

Brands by name

Popular brands

Aurora Multimedia WACI NX Jr., Reference Manual & Programming Manual

Search results

Summary of Contents for WACI NX Jr.

Reviews:

Related manuals for WACI NX Jr.

Brands by name

Popular brands