Aurora Multimedia WACI NX+ Reference Manual & Programming Manual
  1. Manuals
  2. Brands
  3. Aurora Multimedia Manuals
  4. Control Systems
  5. WACI NX+
  6. Reference manual & programming manual

Aurora Multimedia WACI NX+ Reference Manual & Programming Manual

Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
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

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the WACI NX+ and is the answer not in the manual?

Questions and answers

Related Manuals for Aurora Multimedia WACI NX+

Summary of Contents for Aurora Multimedia WACI NX+

  • Page 1 Reference Manual & Programming Guide WACI NX+ WACI NX Revision 2007.01.09 Aurora Multimedia 205 Commercial Court Morganville, NJ 07751 (732) 591-5800 (732) 591-5801 (Fax) www.auroramultimedia.com...
  • Page 2 © Copyright 2003, 2004, Aurora Multimedia, Inc. All rights reserved, including the right 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...

  • Page 3: Table Of Contents

    Quick Contents QUICK CONTENTS ............................3 FULL CONTENTS ............................4 III. INTRODUCTION............................6 BOX CONTENTS ............................7 HARDWARE SPECIFICATIONS.........................8 EXPANSION HARDWARE .........................21 VII. FACTORY DEFAULT CONFIGURATIONS ....................24 VIII. QUICK START..............................25 USING THE WACI ............................29 WEB SERVER FEATURES .........................33 BOOT MENU REFERENCE ........................34 XII. ADMIN WEB PAGES ...........................38 XIII.

  • Page 4: Full Contents

    Full Contents QUICK CONTENTS ............................3 FULL CONTENTS ............................4 III. INTRODUCTION............................6 BOX CONTENTS ............................7 WACI NX+ ........................7 ONTENTS FOR THE WACI NX J ........................7 ONTENTS FOR THE HARDWARE SPECIFICATIONS.........................8 ............................8 ENERAL PECIFICATIONS ....................10 BSOLUTE AXIMUM ATINGS FOR ARDWARE ..........................11 ARDWARE ARTS VERVIEW ........................15...
  • Page 5 9: OEM F ..............................37 UNCTIONS XII. ADMIN WEB PAGES ...........................38 ..................................39 ETUP ................................45 IAGNOSTICS ) ......................55 VENTS EE SECTION VENT ANAGER ..................................55 ILES XIII. THE EVENT MANAGER..........................60 , & V .....................60 VERVIEW OF VENTS CTIONS ARIABLES ...........................61 VENT ANAGER ..................................63 VENTS ..................................69 CTIONS...

  • Page 6: Iii. Introduction

    With the WACI NX+ and WACI NX Jr., Aurora Multimedia takes the control system industry to a new era of easy-to-use, powerful, and cost-effective tools, paving the way for new possibilities in the way...

  • Page 7: Iv. Box Contents

    IV. Box Contents Box 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: Hardware Specifications

    Hardware Specifications General Specifications WACI NX Jr. WACI NX+ Notes √ √ Size 5.8” H x 4.9” W x 0.9” D √ √ Weight 0.6 lbs. Power 12V DC 15watt 15watt Adapter √ √ Processor 32-Bit 750 MIPS Normal Mode 1 BIPS Super Mode √...
  • Page 9 √ √ Display 106 x 56 Pixels Backlit Ports LAN Network Adapter (RJ-45 10/100MBits Auto MDX / Ethernet) POE add-on available USB OTG (On-The-Go) v1.1 11MBits Host or Client RS-232/422/485 (DB-9) 15KV Protection, 115KB Infrared Outputs (IR) 30KHz – 2MHz RS-232 TX as well Infrared Input IR input device triggers...
  • Page 10 Absolute Maximum Ratings for Hardware Below is a summary of the minimum, maximum, and typical values for the hardware. These are maximum ratings only. Operation of the device at or above these ratings for extended periods of time may affect reliability. Units Notes WACI Input Voltage...
  • Page 11 Hardware Parts Overview WACI WACI WACI WACI NX Jr. Parts Overview NX Jr. Parts Overview NX Jr. Parts Overview NX Jr. Parts Overview Shorts Description More Info Power Adapter Port Two 10/100 Auto-MDX LAN Ports USB 1.1 On-The-Go Port Two RS-232/422/485 Serial Ports LED Indicators for Serial Ports 1 &...
  • Page 12 Type 2 Compact Flash expansion port IR Ports 1-2 IR Learner Port IR In Port IR In LED LED Indicators for IR Ports 1-2 LED Power Status...
  • Page 13 WACI NX+ Parts Overview WACI NX+ Parts Overview WACI NX+ Parts Overview WACI NX+ Parts Overview Short Description More Info Power Adapter Port Two 10/100 Auto-MDX LAN Ports USB 1.1 On-The-Go Port Two RS-232/422/485 Serial Ports LED Indicators for Serial Ports 1 & 2 Built-in LCD display for setup and diagnostics Six button menu navigation Type 2 Compact Flash expansion port...
  • Page 14 DSP Ground Line Relay Ports 1-4 (Normally Open, Center Pin, Normally Closed) LED Indicators for Relays Ports 1-4 IR Ports 1-4 IR Learner Port IR In Port IR In LED LED Indicators for IR Ports 1-4 LED Power Status...
  • Page 15 Detailed Hardware Descriptions Power Indicator and LCD Power Indicator and LCD Power Indicator and LCD Power Indicator and LCD A green power indicator is available on both the WACI NX+ and WACI NX Jr. The power indicator is lit whenever power is applied to the WACI. The LED will stay solid if the system is ok. If a problem occurs the advanced internal diagnostics will flash the LED to indicate the type of problem occurring.
  • Page 16 Serial Port Pin-Out Diagram Port RS-232 RS-422/485 LED Indicators for Serial Ports 1 & 2 There are two (2) sets of LEDs, one set for each serial port. Each set consists of six (6) red LEDs that indicate activity on the pins. When using RS-232 communications, the six LEDs indicate activity on the (from top to bottom) TX, RX, CTS, RTS, DTR, and DSR pins.
  • Page 17 Network Interface Network Interface Network Interface Network Interface The WACI NX has two 10/100 Auto MDX Ethernet ports. They are also POE (power over Ethernet) capable with the NX-POE add-on module. The Auto MDX allows the use of null or straight through LAN cables to the ports.
  • Page 18 LED Indicators for Relay Ports 1-4 4 red LEDs indicate activity for each Relay Port. DSP (WACI NX+ Only) (WACI NX+ Only) (WACI NX+ Only) (WACI NX+ Only) The WACI NX+ is the first of its kind to have a DSP coprocessor. Each DSP port is capable of being used in one of four different configurations;...
  • Page 19 output can be used for triggering relays, LEDs, or any device that will not require more then 200ma of current. You can change the state of the Digital Output port using the DIO diagnostic page (see Diagnostics, page 52) or through an RPC method call (see Digital I/O Methods (WACI NX+ Only), page 118).
  • Page 20 The IR Learner is used to learn the IR codes from a device’s remote control. It can read many different types of remotes. If it has trouble with your remote, you may need to download from Aurora Multimedia a .WIR file that is specific to the device.

  • Page 21: Vi. Expansion Hardware

    VI. Expansion Hardware The WACI NX control system has the ability to expand (NX-PANSION modules) its capabilities using the docking connector located on the bottom of the unit. This expansion bus is a 32 bit wide high speed connection to pass through small or large amounts of data for advanced applications like video streaming, additional ports, touch panel interfacing, and much more.
  • Page 22 NX- - - - STREAM STREAM STREAM STREAM • Encodes and Decodes MPEG2 and MPEG4 in high and standard definition • MJPEG at 1280 x 1024 @ 60Hz • H.263, H.264 Capability • Composite Video Input and Output, supports NTSC/PAL/SECAM •...
  • Page 23 NX- - - - BAT • Charged via power supply or the NX-POE (Power Over Ethernet) module • Battery Gauge via WACI NX diagnostics screen with e-mail warning of power failure • Provides a true inline redundant power source for the connected WACI NX control unit tasked with a mission critical application in the event of power interruptions (such as brownouts and blackouts) NX- - - - POE The power over Ethernet module docks inside the WACI NX and not on the expansion bus.

  • Page 24: Vii. Factory Default Configurations

    VII. Factory Default Configurations Default Network Settings for LAN 1 & 2 DHCP Enabled 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 Parity bits None Stop Bits Signal Level...

  • Page 25: Viii. Quick Start

    VIII. Quick Start STEP 1: Powering Up Locate the power adapter that came with your WACI. Plug the small end into the power supply port (labeled “Power”) on the lower left side of the WACI, and the large plug into a wall socket or compatible power supply.
  • Page 26 STEP 2: Determining WACI Connection Decide how you would like to connect to your WACI to configure it: Connection Type Why use this connection What do I do next to type? connect my WACI this way? This is the typical set up for STEP 3A: Connecting general WACI NX use.
  • Page 27 Some networks use DHCP to automatically issue IP addresses to machines connected to it. If your network is setup to use DHCP, then you’ll need to configure the WACI to use DHCP. There are two methods for doing this: 1) press and hold any of the 6 buttons for 5 seconds while plugging in the power for the boot menu 2) go into Setup page of the Admin Web Pages (see Admin Web Pages, page 38).
  • Page 28 STEP 4: Access the WACI Once the WACI is physically connected to the network, and the IP address for the appropriate LAN port is displayed on the front LCD, you may access the WACI through your web browser, FTP client, and other network clients.

  • Page 29: Ix. Using The Waci

    IX. Using the WACI This section summarizes common administrative tasks for running your WACI and refers you to appropriate sections of this manual for further details. Testing Hardware From the Boot Menu (see Boot Menu Reference, page 34), you may: •...
  • Page 30 • Infrared , page 47). • Serial Ports (see Serial Port Diagnostics, page 49). • Relay Ports (WACI NX+ only) (see Relay Diagnostics, page 51). • DSP Ports (WACI NX+ only) (see Diagnostics, page 52). • Total Memory (see Error! Reference source not found., page Error! Bookmark not defined.).
  • Page 31 • The log for the Web Server (see Server, page 53) allows you to monitor activity on the WACI's Web server. It is typically used to examine user access, determine network needs, and debug custom web pages. Automating Tasks (The Event Manager) The WACI has built-in, self-monitoring capabilities that will allow you to automate many tasks without developing web pages or applications.
  • Page 32 Using Remote Procedure Calls (RPCs) In the development 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).

  • Page 33: Web Server Features

    Web Server Features One of the greatest benefits of the WACI is its ability to serve up custom web pages that you upload to the device. The WACI has built-in support for the following web features: Content Type Notes Active Server Pages .ASP File Extension Hyper Text Markup Language .HTML File Extension...

  • Page 34: Xi. Boot Menu Reference

    XI. Boot Menu Reference Accessing the Boot Menu with a Serial Connection Connect the Serial 1 Port of the WACI to your computer with an RS-232 Data Transfer Cable (also known as a Null Modem Cable). Using Hyper Terminal (or similar software), connect to the WACI with the default Serial Settings: Baud Rate: 9600, Data bits: 8, Parity: None, Stop bits: 1, and Flow control: None.
  • Page 35 Gateway : [Automatic] Ethernet Port 2 Settings MAC address : [00-11-02-01-00-03] Host Name : [WACINX2] DHCP Enabled : Yes IP address : [Automatic] Subnet Mask : [Automatic] Gateway : [Automatic] Password : [admin] OS Loaded : Yes OS Filename : nk.bin <Press Enter>...
  • Page 36 Note: The TFTP client is available on Linux, Windows NT, 2000, and XP. Windows 9x, Windows ME, and the Macintosh O/S’s don’t come with a TFTP client. You’ll need to acquire a third-party client to upgrade your WACI using these operating systems. Contact Aurora Multimedia for a list of clients that will work with your O/S.

  • Page 37: 9: Oem Functions

    8: Erase All Files Deletes all files 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: Admin Web

    XII. Admin Web Pages Admin web pages include setup and diagnostic options, and may be accessed at: http://[IP Address or Host Name]/setup/ From this web page, you may click on: • SETUP - for firmware version, date/time setting, network settings, and network security settings.
  • Page 39 Setup This web page allows you to set several administrative options. Many of these options are also available from the Boot Menu. Firmware Firmware Version Version Firmware Firmware Version Version The firmware version installed on the WACI is displayed.
  • Page 40 Date / Time Date / Time Date / Time Date / Time The current date and time is displayed. You may also set the date and time using the pull-down menus. Once you have made new selections, use the “Set Date and Time” button next to the pull-downs to save the new date and time.
  • Page 41 MAC Address MAC Address MAC Address MAC Address The WACI Ethernet adapter’s MAC address is displayed to the right of the MAC Address label. You can use this to validate the IP address assigned in the DHCP server’s address table. Network Settings Network Settings Network Settings...
  • Page 42 [SMTP Name] System Password System Password System Password System Password The password allows 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 Port 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 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 Diagnostics Four of the Diagnostics described in this section (IR, Serial, 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.
  • Page 46 The Diagnostics web page for the WACI NX+ 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 System Information System Information System Information 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 is useful after making changes to some settings or modifying EventManager file.
  • Page 48 In step 1, choosing a File Name allows you to “group” all of your IR commands by device. For your convenience, you may choose a File Name that indicates which device you have chosen to support (such as “acmeDVD” or “acmeVCR”. You may also enter the Make, Model, Remote Model, and any Comments about your device (this information is optional).
  • Page 49 IR Learning Tips • Hold the remote steady. • Hold the remote 6” from learner port. • Do not confuse the learner port with the emitter or IrDA ports. • Turn off fluorescent lights. Managing Learned Commands You may view all learned commands at the bottom of the page: Once a command is selected from the menus, you may send the command out the selected port to the attached IR emitter.
  • Page 50 The serial send and receive histories logs the bytes being output or input through the ports. First, select which port to log (1 or 2), and then specify the display. The bytes passing through the port may be displayed as printable ASCII characters, hex values, or decimal values. If you select ASCII characters, you must also choose how you wish to view non-printable characters.
  • Page 51 value of a byte, you MUST either convert it to a printable ASCII characters or the hex equivalents. For example, the decimal byte stream “103 111 111 100 32 100 111 103” is equivalent to the hex byte stream “67 6F 6F 64 20 64 6F 67”. It is also equivalent to the ASCII string “good dog”. However, to send the string to the serial port, you must use a combination of printable ASCII characters and hex values only.
  • Page 52 D D D D SP Diagnostics SP Diagnostics SP Diagnostics SP Diagnostics Digital I/O is available on the WACI NX+ only. Each port may be configured and tested as: • A/D Analog to Digital (-5v to +5v) 12 bit (0 to 4096) •...
  • Page 53 RPC Server Info Displays the build date and version number of the RPC server. Also displays all tokens and methods available from the server. You may notice that the methods that support the additional ports on the WACI NX+ are not available on the WACI NX Jr. RPC Server Commands Logs all HTTP Post calls to the server.
  • Page 54 Firmware Firmware Firmware Firmware The Firmware page, available on both the WACI + and the WACI NX Jr., will walk you through a WACI firmware update: 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.

  • Page 55: E (S E M )

    tftp -i [IP Address] put [Filename with Full Path] If ActiveX is enabled for your web browser, you may also request that the WACI create a batch file waciload.bat that will execute this command. The batch file will be placed at the root of your local drive.
  • Page 56 You may be prompted for password, which is the same as the administrative password for the WACI. Any user name, such as “user”, is valid as long as the password is correct. NOTE: While this is a convenient way to access the WACI's FTP directories, any standard FTP client (such WFTP for Windows, Fetch for Macintosh, or “ftp”...
  • Page 57 Note that you may not see the EventManager or IR directories until you have started using the Event Manager and IR Learning features, as explained in the following subsections. EventManager This directory is created when you create a custom Event, Action, or Variable from the Event Manager web page (see The Event Manager Web Page, page 61).
  • Page 58 Allowable File Types Allowable File Types Allowable File Types Allowable File Types In the EventManager directory, the active Event Manager data file is named EventManager.wem. This file is read on startup. Command files for IR Learning are stored in the IR directory, and have extension *.WIR. The WACI's built-in web server supports many Internet standards such as HTML, XML, DHTML, Visual Basic, Active Server Pages, Java, JavaScript, server-side includes, and Macromedia Flash.
  • Page 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: Xiii. The Event Manager

    XIII. The Event Manager The Event Manager is a feature of the WACI that allows you to program the WACI to perform operations autonomously. With the Event Manager, you can associate different hardware or software events with actions to be performed directly on the WACI. There is then no need to continuously control the WACI using some client side software.

  • Page 61: The Event Manager Web Page

    The Event Manager Web Page The Event Manager page may be accessed by clicking on “Events“ at the top of any page. This page is organized by Events, Actions, and Variables. Note that Actions are always associated with its Event. Selecting an Event will highlight the Event and display all its associated Actions.
  • Page 62 Disabling the Event Manager renders all triggers inactive without deleting them. This is often useful, sometimes necessary, while: • Configuring 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”...

  • Page 63: Events

    Events Creating and Editing Events Creating and Editing Events Creating and Editing Events Creating and Editing Events Selecting the “Add event” button from the Event Manager page will create a new Event, while selecting the “Edit” button above the Event list will allow you to edit whichever Event is highlighted. You will be prompted for the name of the Event, the type of Event, and any options associated with the Event, as described in the next two sections.
  • Page 64 Timer The timer operates by counting down from a value specified by hours:minutes:seconds. When the timer “runs out”, the Timer Event is triggered, and the timer is restarted at the specified value. While Clock Events allow you to schedule recurring tasks based on fixed, regular calendar periods (daily, weekly, etc,), Timer Events allow you to schedule recurring tasks based on user-defined time periods.
  • Page 65 DSP DIO (Digital Input/Output) (Available for the WACI NX+ only.) A DSP DIO Event is triggered when the INPUT or OUTPUT value at a specified Digital I/O port reaches the desired state, either low or high. If an expression is defined for a DSP DIO Event, then the expression is evaluated whenever the state of DSP DIO port changes.
  • Page 66 Telnet The Telnet Event connects via TCP to a Telnet server and monitors any incoming data. The connection to the Telnet server will be continuously maintained, and if the connection is dropped, the Event will attempt to reconnect once per minute. The WACI also supports incoming Telnet connections, and will accept those connections if an Event exists having an “Origin”...
  • Page 67 IR Input The IR Input Event allows you to trigger events based on the IR command received from the external device connected to WACI using IR In port. Named Event The Named Event is the Event that can be only triggered manually. Other Event Options Other Event Options Other Event Options...
  • Page 68 Execute Actions Concurrently When the “Execute actions concurrently” check box is CHECKED, all the actions associated with the Event will be executed concurrently at the time the Event is triggered. Use the Action’s “Delay By” value to offset the start time of a particular Action. If this check box is UNCHECKED when the Event is triggered, its actions will be executed sequentially, one at a time, and in the order displayed on the Event Manager web page.

  • Page 69: Actions

    Actions Creating and Editing Actions Creating and Editing Actions Creating and Editing Actions Creating and Editing Actions Actions are the tasks performed when an Event is triggered, so they are always associated and displayed with their Events. Actions may be created from the main Event Manager web page by first selecting an Event, highlighting it, and then selecting the “Add action”...
  • Page 70 The “Output Value” may be set to a constant, such as Hello or 5, or an expression, such as Counter+1. If the “(expression)” check box is UNCHECKED, the value will be interpreted as a constant of the same type as the Variable. If the “(expression)”...
  • Page 71 NOTE: When an Event is triggered, it remains triggered until all Actions have been completed. Once the Actions are complete, the Event’s “triggered” flag is reset. E-Mail The E-mail Action sends an e-mail to a set of recipients. There are fields for the To, Cc, and Bcc addresses, as well as, a field for the message body.
  • Page 72 The HTTP Post Action can be used to make RPC calls to other WACIs. Set the “Output to” field to the /rpc directory of the other WACI, e.g. 192.168.0.120/rpc. The “Output value” should be the RPC call (see Syntax for HTTP Post). Use the Log Action to write information about the status of the system, or about a specific Event to a text log file.
  • Page 73 DSP DIO (Available for the WACI NX+ only.) A DSP DIO Action sends an Output Value of “High” or “Low” to the specified port. The state of the DIO port will change only if the port is set as an output. You can check whether a port is set as an input or output using the DSP DIO diagnostics (see Diagnostics, page 52).
  • Page 74 IR Port IR Port Actions send learned IR Commands (see Learn IR Command, page 47) to the specified port. The IR Command to execute must be specified by its Group name and Command name. Buzzer Buzzer Action enables and disables an internal buzzer. It can be used to let users know about anything important, when they do not have an easy access to the device.
  • Page 75 • Executed a particular number of times. Actions may be specified to execute as many as 2 times. This field is not used if the “Infinite” check box is CHECKED. • Delayed by as many as 2 seconds. The value can be a real number, e.g. 2.5 for 2500 milliseconds.

  • Page 76: Variables

    Variables Variables are used to store information that can be retrieved or acted upon by the Event Manager, or by calls to RPC functions (see Variable Methods, page 167). You can create Variables that hold temporary data, or configure them to keep their value even when the WACI is reset. You can also use Variables to store data to be used by your own Web interface or Flash application stored on the WACI.
  • Page 77 The storage of the Current Value does take some time, since it is stored into flash. Therefore, if a Variable is changed often, such as a counter, the WACI will perform more efficiently if you set a Default Value, and UNCHECK the “Persist” check box. Default Value The “Default value”...

  • Page 78: Expressions

    Range A Range Variable specifies a range of values between a minimum and maximum value. Each value can be a number between -2 and +2 -1. The maximum value should be greater than the minimum. Range Variables have one other parameter, which is calculated from the minimum and maximum values. The de-bounce value, displayed after the maximum value, is used to provide a small measure of hysteresis to prevent flutter.
  • Page 79 • HEX (Char) Returns a HEX string that represents the character value passed in. Example: HEX(“A”), HEX(var_name). • LStr(string, integer) Returns string Return integer number of characters from the left of string. Example: LStr(“abcdef”,3) returns “abc” • ltoa(integer) or itoa(integer) Returns string Converts an integer to a string representation of the integer.
  • Page 80 • strstr(string, string2find) Returns integer Searching Left to Right, finds string2find inside of string and returns the beginning location of string2find. Failure to find returns -1. Example: string=“abcdef” string2find=“bc” = returns 1 • strupr(string) Returns string Returns the upper case version of a string. Example: strupr(“test”) returns “TEST”...
  • Page 81 In addition, the type of operation (string, integer, etc) and the final value of the expression are determined by the first token. If a string cannot be resolved to an integer during an integer operation, it takes on the value of 0 (zero). Some examples: This expression...
  • Page 82 Addition/Plus (+) Operator The ‘+’ operator is used to append one string to another, or to add two integer values together. Adding a number to a string will produce a string with the number (as text) appended to the end. Adding a string to a number results in just the number (unless the string contains a value that can be converted to a number).
  • Page 83 Division/Divide (/) Operator The divide operator is valid only for numerical values and Variables. Use this operator to divide one numerical value by another. The resultant type is an integer value. If the denominator is 0, then the operation evaluates to 0. For example: This expression...
  • Page 84 This expression..resolves to this value. MyNumber!=4 MyNumber!=“4” MyNumber!=5 MyName!=“John” MyName!=“??ul” 0!=“John” Greater-Than Comparison (>) Operator The greater-than 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 a larger integer value than the second, and 0 if the second value is larger or equal.
  • Page 85 For example, assuming MyNumber has an integer value of 4: This expression..resolves to this value. MyNumber<5 MyNumber<4 MyNumber<3 Less Than or Equal Comparison (<=) Operator The less-than or equal comparison operator will compare two tokens, which can be integers or strings (assuming the string represents an integer value).
  • Page 86 This expression..resolves to this value. (3==3)&&(4==4) 1&&(4==5) 0&&(4==4) (3==6)&&0 Logical-Or (||) Operator Assume you have two Boolean expressions, Expression1 and Expression2, each returning true (1) or false (0). The logical-or operator determines the true or false state of the complex expression Expression1||Expression2 using the rules applying to a traditional logical OR statement: Expression1&&Expression2 If Expression1...
  • Page 87 This expression..resolves to this value. !(“Hello”==“Hello”) Bitwise-And (&) Operator The bitwise-and operator performs the logical AND operation bit by bit between two integers. This is better understood by looking at the example of 12&10. The binary value of 12 is 1100, and the binary value of 10 is 1010.
  • Page 88 Range (in) Operator The ‘in’ operator compares a numerical value or Variable against a range Variable. The resultant type is an integer value of either 0 or 1. If the value is within the range, 1 is returned; otherwise, 0 is returned. For example, assume Count has a value of 15, Range10 has a value of 1 to 10, and Range20 has a value of 1 to 20 This expression...
  • Page 89 This expression..resolves to this value. 3+=“6” Illegal (L-Value not a Variable) Subtraction Assignment (-=) Operator The subtraction assignment operator works with both numerical values and strings values. Use this operator with strings to remove a sub-string from a string Variable, or use this operator to subtract an integer value from a numeric Variable.
  • Page 90 This expression..resolves to this value. MyNumber/=3 1 (MyNumber is also 1) MyNumber/=0 0 (MyNumber is also 0) Bitwise-And Assignment (&=) Operator The bitwise-and assignment operator performs the logical AND operation bit by bit between an integer Variable and another integer. The result of the operation is stored in the L-Value of the operator. Refer to the Bitwise-And operator for an example of the bitwise AND.
  • Page 91 Code Name Description Date Represents the date as a string: MM/DD/YYYY Form feed Character code: 0x0C Trigger data Data that triggered the current Event Time Time that the current Event was triggered at: HH:MM:SS in 24hr format New line or linefeed Character code: 0x0D Origin that triggered Port number, Variable name, etc.

  • Page 92: Xiv. Remote Procedure Calls

    XIV. Remote Procedure Calls Remote procedure calls (RPCs) are used to control a WACI using another WACI, or using a client computer. You can turn on and off the relays, send e-mail, add Events and Actions, etc. Anything the WACI can do can be configured or controlled through the RPC interface. The WACI supports RPCs for most web interfaces, including HTML, Flash (.fla), and Active Server Pages (.asp).
  • Page 93 General format for a call using HTTP Post: [version=[ RPC Server Version ]&]method=[ Method to Call ][&encoding=[ Count ]][&param1=[ Value for Parameter 1 ]&param2=[ Value for Parameter 2 ]&param3=[ Value for Parameter 3, etc...]] See the detailed list of methods at the end of this reference for the method name and the values for param1, param2, etc.
  • Page 94 EXAMPLE #2: Net_GetSubnetMask EXAMPLE #2: Net_GetSubnetMask EXAMPLE #2: Net_GetSubnetMask EXAMPLE #2: Net_GetSubnetMask The call for the Net_GetSubnetMask method: method=Net_GetSubnetMask Sample response: status=1&response1=255.255.255.0 Fault Codes Fault Code Fault Description Function parameter out of range / item specified does not exist Timed out waiting for a mutex or shared resource Memory allocation failure Configuration does not support action (i.e.

  • Page 95: Using Macromedia Flash

    Using Macromedia Flash You may access all WACP RPCs using HTTP post. In Flash, you may accomplish this using LoadVars{} and sendAndLoad(). An example for making these calls follows. STEP 1: Pass WACI IP Address to Flash STEP 1: Pass WACI IP Address to Flash STEP 1: Pass WACI IP Address to Flash STEP 1: Pass WACI IP Address to Flash To begin, you must pass the IP address of WACI to your Flash file.
  • Page 96 STEP 2: Call RPC with HTTP Post STEP 2: Call RPC with HTTP Post STEP 2: Call RPC with HTTP Post STEP 2: Call RPC with HTTP Post Once you have the IP address, you are able to access the RPC server. Load the method and it's parameters into a LoadVars() object as shown below, then make the call with sendAndLoad().

  • Page 97: Visual Basic Scripting

    Visual Basic Scripting To access an RPC using Visual Basic, first create a WACI object of type “WACI.UserAPI.1”. Then, call the method with the object, specifying any parameters in parentheses. For example, this script in an Active Server Page retrieves the IP address of the WACI and the settings for serial ports 1 and 2. Dim waciUser Dim strIP, strErr Dim strPort1, strPort2...

  • Page 98: Rpc Quick Reference

    RPC Quick Reference Serial_GetPortCount ( )........115 (WACI NX+ O ).....116 ELAY ETHODS ......100 RROR NFORMATION ETHODS Relay_On ( Port )..........116 GetLastErrorCode ( )...........100 Relay_Off ( Port )..........116 GetLastErrorString ( ) .........100 Relay_GetState ( Port ) ........116 GetLastExtendedErrorString ( )......100 Relay_GetPortCount ( ) ........117 ......101 ENERAL NFORMATION...
  • Page 99 GetEventGroup ( EventId ) ........137 GetActionDutyCycle ( ActionId ) ......156 GetEventNetCard ( EventId ).......137 GetActionHost ( ActionId )........156 GetEventHost ( EventId ) ........137 GetActionIds ( EventId ) ........156 GetEventIds ( ) .............138 GetActionInfo ( ActionId )........157 GetEventIdxById ( EventId ) ........138 GetActionName ( ActionId ).........157 GetEventInfo ( EventId ) ........138 GetActionOption ( ActionId, OptionType ) ..158...

  • Page 100: Error Information Methods

    Error Information Methods GetLastErrorCode ( ) GetLastErrorCode ( ) GetLastErrorCode ( ) GetLastErrorCode ( ) Returns the fault code from the last failed method call. Syntax HRESULT GetLastErrorCode( [out, retval] long* Code Parameters Code [out, retval] Integer representing fault code. Remarks The value of Code corresponds to faultCode of an HTTP Post response when status is 0 (failure).

  • Page 101: General Information Methods

    General Information Methods AllState_Get ( ) AllState_Get ( ) AllState_Get ( ) AllState_Get ( ) Returns the entire hardware state Syntax HRESULT AllState_Get( [out, retval] VARIANT* Array Parameters Array [out, retval] Array representing entire hardware state. Remarks The array is filled as follows. Each port value is separated from the next port value by a comma. Element Field Type...

  • Page 102: Validatepassword ( Password )

    HRESULT GetFirmwareVersion( [out, retval] BSTR* Version Parameters Version [out, retval] A returned string of the format “DEVICE #.# DATE”, where “DEVICE” is the name of the device, #.# represents the version number, and DATE represents the build date for the firmware image in MMM DD YYYY format. ValidatePassword ( Password ) ValidatePassword ( Password ) ValidatePassword ( Password )
  • Page 103 Syntax HRESULT Time_Sleep( [in] long Milliseconds, [out, retval] VARIANT_BOOL* Success Parameters 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: Network Methods

    Network Methods Net_GetNetCardCount ( ) Net_GetNetCardCount ( ) Net_GetNetCardCount ( ) Net_GetNetCardCount ( ) Returns the number of Ethernet ports on the device. Syntax HRESULT Net_GetNetCardCount( [out, retval] long* Count Parameters Count [out, retval] The response send back from the server. Net_GetIPAddress ( ) Net_GetIPAddress ( ) Net_GetIPAddress ( )

  • Page 105: Net_Getsubnetmaskex ( Netcard )

    Parameters SubnetMask [out, retval] String containing the current subnet mask of the device, such as “255.255.255.0”. Net_GetSubnetMaskEx ( NetCard ) Net_GetSubnetMaskEx ( NetCard ) Net_GetSubnetMaskEx ( NetCard ) Net_GetSubnetMaskEx ( NetCard ) Returns the current subnet mask of the network interface specified. Syntax HRESULT Net_GetSubnetMask( [in] long NetCard...

  • Page 106: Net_Sendmail( Senderid, Toids, Ccids, Bccids, Subject, Messagebody )

    [in] The server address to post to, e.g. http://192.168.0.100/rpc. IsExpression [in] Flag indicating whether PostData contains simple text or an expression. Set to 1, if PostData is an expression; otherwise, set to 0. PostData [in] A string or expression that represents the data to send to the server. Timeout [in] The number of milliseconds to wait for a response from the web server before the call aborts.
  • Page 107 Syntax HRESULT Net_SendMailEx( [in] long NetCard, [in] BSTR SenderId, [in] BSTR ToIds, [in] BSTR CcIds, [in] BSTR BccIds, [in] BSTR ReturnPathId, [in] BSTR ReturnRcpId, [in] BSTR MsgComment, [in] BSTR Subject, [in] long IsExpression, [in] BSTR MessageBody, [out, retval] long *Result Parameters NetCard [in] The ID of the Network port to send the mail through...

  • Page 108: Telnet Methods

    Telnet Methods Telnet_Send ( NetCard, Msg, MaxWaitMS ) Telnet_Send ( NetCard, Msg, MaxWaitMS ) Telnet_Send ( NetCard, Msg, MaxWaitMS ) Telnet_Send ( NetCard, Msg, MaxWaitMS ) Writes a string to the log file identified by FileName. Syntax HRESULT Telnet_Send( [in] long NetCard, [in] BSTR Msg, [in] long MaxWaitMS [out, retval] long* NotSent...

  • Page 109: Buzzer Methods

    Parameters Netcard [in] ID of network port to use. Read [out, retval] Returns the data in the buffer. Telnet_ClearReadBuffer ( NetCard ) Telnet_ClearReadBuffer ( NetCard ) Telnet_ClearReadBuffer ( NetCard ) Telnet_ClearReadBuffer ( NetCard ) Clears the telnet buffer of the specified network port. Syntax HRESULT Telnet_ClearReadBuffer( [in] long NetCard,...

  • Page 110: Logging Methods

    Syntax HRESULT Buzzer_Off ( [out, retval] VARIANT_BOOL* Success Parameters Success [out, retval] Returns TRUE if the buzzer was turned off. Buzzer_GetState ( ) Buzzer_GetState ( ) Buzzer_GetState ( ) Buzzer_GetState ( ) Emits a beeping noise from inside the WACI. Syntax HRESULT Buzzer_Off ( [out, retval] long* State...

  • Page 111: Log_Readfile ( Filename, Maxlength )

    Log_ReadFile ( FileName, MaxLength ) Log_ReadFile ( FileName, MaxLength ) Log_ReadFile ( FileName, MaxLength ) Log_ReadFile ( FileName, MaxLength ) Writes a string to the specified log file. Syntax HRESULT Log_ReadFile( [in]BSTR FileName, [in]long MaxLength, [out, retval]BSTR* RetData Parameters FileName [in] Name of the log file.
  • Page 112 Log_NextFile ( Wildcard ) Log_NextFile ( Wildcard ) Log_NextFile ( Wildcard ) Log_NextFile ( Wildcard ) Read the name of the last 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,...

  • Page 113: Serial Methods

    Serial Methods Serial_GetSettings ( Port ) Serial_GetSettings ( Port ) Serial_GetSettings ( Port ) Serial_GetSettings ( Port ) Returns the port settings for the specified serial port. Use the WACI DIP switches or Web interface to set these parameters. Syntax HRESULT Serial_GetSettings( [in] long Port, [out, retval] BSTR* Settings...

  • Page 114: Serial_Sendexpression ( Port, Expression, Data )

    Remarks The Msg parameter text should be passed in as a URL encoded string. To have a Nul character sent out the serial port, pass a “%00” as part of the Msg string. Serial_SendExpression ( Port, Expression, D Serial_SendExpression ( Port, Expression, Data ) ata ) Serial_SendExpression ( Port, Expression, D Serial_SendExpression ( Port, Expression, D...

  • Page 115: Serial_Readbuffercount ( Port )

    Syntax HRESULT Serial_ClearReadBuffer( [in] long Port, [out, retval] VARIANT_BOOL* Success Parameters Port [in] Port number for the serial port. Valid values are 1 and 2. Success [out, retval] TRUE if the buffer was cleared, FALSE if buffer failed to clear. Remarks If you wish to read a specific response to a sent command, then make a call to this function just prior to calling Serial_Send.

  • Page 116: Relay Methods (Waci Nx+ Only)

    Relay Methods (WACI NX+ Only) Relay_On ( Port ) Relay_On ( Port ) Relay_On ( Port ) Relay_On ( Port ) Switches on the relay at the specified port. Syntax HRESULT Relay_On( [in] long Port, [out, retval] VARIANT_BOOL* Success Parameters Port [in] Port number for the relay.

  • Page 117: Relay_Getportcount ( )

    State [out, retval] 1 if the relay is on, 0 if is off. Relay_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: Digital I/O Methods (Waci Nx+ Only)

    Digital I/O Methods (WACI NX+ Only) Available for the WACI + Only DIO_Read ( Port ) DIO_Read ( Port ) DIO_Read ( Port ) DIO_Read ( Port ) Reads the digital I/O at the specified port. Syntax HRESULT DIO_Read( [in] long Port, [out, retval] long* State Parameters Port...

  • Page 119: Dio_Isoutput ( Port )

    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 high, and FALSE if the port was not set. Remarks The voltage is a reference from the GND line of the DIO connector block. DIO_IsOutput ( Port ) DIO_IsOutput ( Port ) DIO_IsOutput ( Port )
  • Page 120 Parameters NumPorts [out, retval] Number of digital I/O ports supported by the hardware.

  • Page 121: A/D Converter Methods (Waci Nx+ Only)

    A/D Converter Methods (WACI NX+ Only) Available for WACI NX+ ONLY. AD_ReadVoltage ( Port ) AD_ReadVoltage ( Port ) AD_ReadVoltage ( Port ) AD_ReadVoltage ( Port ) Reads the analog voltage across the specified A/D converter port. Syntax HRESULT AD_ReadVoltage( [in] long Port, [out, retval] double* Val Parameters...

  • Page 122: Ad_Maxvoltage ( Port )

    Syntax HRESULT AD_DigitalToVoltage( [in] long Port, [in] long Digital, [out, retval] double* Volts Parameters Port [in] Port number for the A/D converter. Valid values are 1, 2, 3, and 4. Digital [in] A value between 0 and 1023 (default) to convert to a voltage value. Volts [out, retval] A real number (default: 0 to 10.0) representing a voltage level.

  • Page 123: Ad_Maxdigital ( Port )

    Remarks When the voltage is applied to the port that meets or exceeds the minimum voltage value returned by this call, then a read of the digital value of the port will yield the minimum digital value. Use AD_MinDigital to get the A/D minimum digital value.

  • Page 124: Ad_Setvoltage ( Port, Val )

    Parameters NumPorts [out, retval] Number of A/D input ports supported by the hardware. AD_SetVoltage ( Port, Val ) AD_SetVoltage ( Port, Val ) AD_SetVoltage ( Port, Val ) AD_SetVoltage ( Port, Val ) Sets the output voltage of the specified port. Syntax HRESULT AD_GetPortCount( [in] long Port,...

  • Page 125: Ir Methods

    IR Methods IR_SendCommand ( Port, Group, Command ) IR_SendCommand ( Port, Group, Command ) IR_SendCommand ( Port, Group, Command ) IR_SendCommand ( Port, Group, Command ) Sends an IR command out the specified IR port. Syntax HRESULT IR_SendCommand( [in] long Port, [in] BSTR Group, [in] BSTR Command, [out, retval] VARIANT_BOOL* Success...

  • Page 126: Ir_Senddata ( Port, Sequence, Data )

    Remarks Commands are typically grouped together by device. IR_SendData ( Port, Sequence, Data ) IR_SendData ( Port, Sequence, Data ) IR_SendData ( Port, Sequence, Data ) IR_SendData ( Port, Sequence, Data ) Converts the supplied Data to a valid IR command and sends the command out the specified IR port. Syntax HRESULT IR_SendData( [in] long Port,...

  • Page 127: Ir_Listallgroups ( )

    The sequence is formatted as follows: Offset Size (in 16 Ident. Name Description Sample bit words) wFormat Format. 0100: No carrier 0000 0000: Use carrier wFreq Carrier The formula below is 005C frequency used to calculate this value. wOnce Once size The number of on/off 0000 pairs in the sequence...

  • Page 128: Ir_Listallcommandsingroup ( Group )

    Parameters List [out, retval] String containing a list of all group names. Commas separate the group names. Remarks A group typically represents a device, or more specifically, a group of commands for a device. Each group is stored in its own .WIR file. IR_ListAllCommandsInGroup ( Group ) IR_ListAllCommandsInGroup ( Group ) IR_ListAllCommandsInGroup ( Group )

  • Page 129: Ir_Getgroupmodel ( Group )

    Syntax HRESULT IR_GetGroupMake( [in] BSTR Group, [out, retval] BSTR* Make Parameters Group [in] Name of the group representing the specified device. Make [out, retval] String containing the make of the device. Remarks This function returns the string that follows the “Make:” label in the .WIR file associated with the specified Group.

  • Page 130: Ir_Getgroupcomment ( Group )

    IR_GetGroupComment ( Group ) IR_GetGroupComment ( Group ) IR_GetGroupComment ( Group ) IR_GetGroupComment ( Group ) Returns any stored comments about a device. The device is specified by its group name. Syntax HRESULT IR_GetGroupComment( [in] BSTR Group, [out, retval] BSTR* Comment Parameters Group [in] Name of group representing the specified device.

  • Page 131: Event Manager Methods

    Event Manager Methods IsEventManagerEnabled ( ) IsEventManagerEnabled ( ) IsEventManagerEnabled ( ) IsEventManagerEnabled ( ) Returns whether the Event Manager is active. When active, the Event Manager monitors the system hardware and triggers Events to run. Syntax HRESULT IsEventManagerEnabled( [out, retval]long* Enabled Parameters Enabled [out, retval] Returned as TRUE if the Event Manager is enabled and active, and returns...
  • Page 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.

  • Page 133: Event Methods

    Event Methods Most of the Event methods use the Event’s ID to retrieve information about an Event. The Event’s ID is set when an Event is created, and is unique to the Event. The ID is re-issued when the system is powered up or the reset button is pressed.

  • Page 134: Cloneeventbyid ( Eventid, Cloneactions, Newname )

    Parameters Client [in] IP address or host name of the remote WACI. EventRecord [in] Text string that contains the information about the Event record (see Error! Reference source not found., page Error! Bookmark not defined.) for the format of the record) EventId [out, retval] ID of the Event on the remote host.

  • Page 135: Deleteeventbyname ( Name )

    Remarks Calling this function deletes the Event as well as all Actions belonging to the Event. DeleteEventByName ( Name ) DeleteEventByName ( Name ) DeleteEventByName ( Name ) DeleteEventByName ( Name ) Delete an Event specified by its name. Syntax HRESULT DeleteEventByName( [in] BSTR Name, [out, retval] VARIANT_BOOL* Success...

  • Page 136: Geteventconcurrent ( Eventid )

    Syntax HRESULT GetEventByName( [in] BSTR Name, [out, retval] long* EventId Parameters Name [in] Name of the Event to identify. EventId [out, retval] Event ID of the specified Event. Remarks The ID returned by GetEventByName is used by the Event functions to retrieve information about the named Event, e.g.

  • Page 137: Geteventgroup ( Eventid )

    Syntax HRESULT GetEventCount( [out, retval] long* NumEvents Parameters NumEvents [out, retval] Total number of Events in the system. Remarks This function is used in conjunction with GetEventByIdx to get a list of the available Events. GetEventGroup ( EventId ) GetEventGroup ( EventId ) GetEventGroup ( EventId ) GetEventGroup ( EventId ) Returns the group name for the Event with a specified ID.

  • Page 138: Geteventids ( )

    Parameters EventId [in] ID for the specified Event. Host [out, retval] The name of the remote WACI that the Event is monitoring. Remarks Use SetEventHost to set the name of the remote host. When a remote host name is specified, then the local Event is triggered on a change in the remote WACI’s hardware or a change in one of the remote WACI’s Variables.

  • Page 139: Geteventmatch ( Eventid )

    Syntax HRESULT GetEventInfo( [in]long EventId, [out, retval] VARIANT* Info Parameters EventId [in] ID of the Event of interest. Info [out, retval] An array of data values that define the Event. Remarks The Info array is filled with the following: Element Field Type Info[0]...

  • Page 140: Geteventname ( Eventid )

    GetEventName ( EventId ) GetEventName ( EventId ) GetEventName ( EventId ) GetEventName ( EventId ) Returns the name of the Event with a specified ID. Syntax HRESULT GetEventName( [in] long EventId, [out, retval] BSTR* Name Parameters EventId [in] ID for the specified Event. [out, retval] Name of the specified Event.

  • Page 141: Geteventschrecurtype ( Eventid )

    Syntax HRESULT GetEventSchClockType( [in] long EventId, [out, retval] long* ClockType Parameters EventId [in] ID for the specified Event. ClockType [out, retval] Is set to 1, if the Event is a scheduled Event, and 0, if the Event is a timer based Event.

  • Page 142: Geteventschmonth ( Eventid )

    Syntax HRESULT GetEventSchMaskOrDay( [in] long EventId, [out, retval] long* MaskDay Parameters EventId [in] ID for the specified Event. MaskDay [out, retval] Day of the month, or a mask of bits for the days of the week. MaskDay values for weekly Events: Value Bit # 0x00000001 (1)

  • Page 143: Geteventschrecureveryn ( Eventid )

    Syntax HRESULT GetEventSchYear( [in] long EventId, [out, retval] long* Year Parameters EventId [in] ID for the specified Event. Year [out, retval] Integer representing the scheduled year (for example, “1984” or “2003”). Remarks This function gets a value that is not used by the Event Manager. GetEventSchRecurEveryN ( EventId ) GetEventSchRecurEveryN ( EventId ) GetEventSchRecurEveryN ( EventId )

  • Page 144: Geteventschminute ( Eventid )

    GetEventSchMinute ( EventId ) GetEventSchMinute ( EventId ) GetEventSchMinute ( EventId ) GetEventSchMinute ( EventId ) Returns the minute that the Event is to be triggered. Syntax HRESULT GetEventSchMinute( [in] long EventId, [out, retval] long* Minute Parameters EventId [in] ID for the specified Event. Minute [out, retval] Integer representing the scheduled minute.

  • Page 145: Geteventtype ( Eventid )

    Remarks An Event monitors its Source for changes. When new data arrives, or the data changes, the Event is notified. The setting of the Event’s match value determines whether the Event is signaled to execute on this change in data. The value of Source depends on the type of Event.

  • Page 146: Seteventbyname ( Name, Type, Concurrent, Source, Match )

    Syntax HRESULT SetEventById( [in] long EventId, [in] BSTR Name, [in] long Type, [in] long Concurrent, [in] BSTR Source, [in] BSTR Match, [out, retval] VARIANT_BOOL* Success Parameters EventId [in] ID for the specified Event. Name [in] Name of the specified Event. Type [in] Type of the Event, e.g.

  • Page 147: Seteventnetcard ( Eventid, Netcard )

    Match [in] Value to match to trigger the Event. If the Match value is an expression, then the expression will need to evaluate to 1 to cause the Event to trigger. Success [out, retval] TRUE if specified Event was successfully set, FALSE if setting the Event failed. Remarks Call this function to set up an Event.
  • Page 148 Value Option Set OptionVal to Concurrent 0 – Event’s Actions will execute serially 1 – Event’s Actions will execute concurrently Expression 0 – The trigger value is a simple text string 1 – The trigger value is an expression Disable 0 –...

  • Page 149: Seteventschedule ( Eventid, Recur, Maskorday, Month, Year, Recureveryn, Hour, Minute, Second )

    SetEventSchedule ( EventId, Recur, MaskOrDay, Month, Year, SetEventSchedule ( EventId, Recur, MaskOrDay, Month, Year, SetEventSchedule ( EventId, Recur, MaskOrDay, Month, Year, SetEventSchedule ( EventId, Recur, MaskOrDay, Month, Year, RecurEveryN, Hour, Minute, Second ) RecurEveryN, Hour, Minute, Second ) RecurEveryN, Hour, Minute, Second ) RecurEveryN, Hour, Minute, Second ) Modify the schedule settings of a specified Event.

  • Page 150: Sortevents ( Sorttype, Direction )

    RecurEveryN [in] Number of periods between successive triggers of the Event. Hour [in] Hour setting for the schedule. An integer between 0 and 23. Minute [in] Minute setting for the schedule. An integer between 0 and 60. Second [in] Second setting for schedule. An integer between 0 and 60. Success [out, retval] TRUE if schedule was successfully set, FALSE if setting the schedule failed.
  • Page 151 Success [out, retval] 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: Action Methods

    Action Methods AddActionByEvId ( Ev AddActionByEvId ( Ev AddActionByEvId ( Ev AddActionByEvId ( EventId, Name, Type, Delay, DutyCycle, StopAfter, entId, Name, Type, Delay, DutyCycle, StopAfter, entId, Name, Type, Delay, DutyCycle, StopAfter, entId, Name, Type, Delay, DutyCycle, StopAfter, Port, Output ) Port, Output ) Port, Output ) Port, Output )

  • Page 153: Deleteactionbyid ( Actionid )

    AddActionByEvName ( EventName, Name, Type, Dela AddActionByEvName ( EventName, Name, Type, Dela AddActionByEvName ( EventName, Name, Type, Dela AddActionByEvName ( EventName, Name, Type, Delay, DutyCycle, y, DutyCycle, y, DutyCycle, y, DutyCycle, StopAfter, Port, Output ) StopAfter, Port, Output ) StopAfter, Port, Output ) StopAfter, Port, Output ) Creates an Action for an Event, specified by the Event name.

  • Page 154: Deleteactionbyidx ( Eventid, Idx )

    Syntax HRESULT DeleteActionById( [in] long ActionId, [out, retval] VARIANT_BOOL* Success Parameters ActionId [in] ID of the Action to delete. Success [out, retval] TRUE if the specified Action was successfully deleted, FALSE if deleting the Action failed. Remarks Using the Action’s ID, this function locates the owning Event and removes the Action from the Event’s list of Actions.

  • Page 155: Getactionbyidx ( Eventid, Idx )

    GetActionByIdx ( EventId, Idx ) GetActionByIdx ( EventId, Idx ) GetActionByIdx ( EventId, Idx ) GetActionByIdx ( EventId, Idx ) Returns the Action ID for a specified Event ID and Action index number. Syntax HRESULT GetActionByIdx( [in] long EventId, [in] long Idx, [out, retval] long* ActionId Parameters EventId...

  • Page 156: Getactiondutycycle ( Actionid )

    NumActions [out, retval] Total number of Actions owned by specified Event. GetActionDe GetActionDe GetActionDe GetActionDelay ( ActionId ) lay ( ActionId ) lay ( ActionId ) lay ( ActionId ) Returns the “Delay before start” value for the specified Action. Syntax HRESULT GetActionDelay( [in] long ActionId,...

  • Page 157: Getactionids ( Eventid )

    Remarks A return value of ““ indicates that the Action will be executed locally GetActionIds ( EventId ) GetActionIds ( EventId ) GetActionIds ( EventId ) GetActionIds ( EventId ) Returns the IDs of the Actions owned by the specified Event. Syntax HRESULT GetActionIds( [in]long EventId,...

  • Page 158: Getactionname ( Actionid )

    Info[8] Host BSTR Info[9] Group BSTR GetActionName ( ActionId ) GetActionName ( ActionId ) GetActionName ( ActionId ) GetActionName ( ActionId ) Returns the name of an Action specified by its ID. Syntax HRESULT GetActionName( [in] long ActionId, [out, retval] BSTR* Name Parameters ActionId [in] ID for specified Action.

  • Page 159: Getactionport ( Actionid )

    Syntax HRESULT GetActionOutput( [in] long ActionId, [out, retval] BTSR* Output Parameters ActionId [in] ID of the Action to examine. Output [out, retval] Value to be output Remarks The value for Output depends on the type of Action. Action Type Values to set Output to Variable Depends on the type of Variable being assigned (see below) Serial...

  • Page 160: Getactionstopafter ( Actionid )

    Syntax HRESULT GetActionPort( [in] long ActionId, [out, retval] BTSR* Port Parameters ActionId [in] ID of the Action to examine. Port [out, retval] Port to output to Remarks The value of Port represents where the Action is going to send its output. Action Type Value for Port Variable...

  • Page 161: Moveactionbyidx ( Eventid, Idx, Where )

    Syntax HRESULT GetActionType( [in] long ActionId, [out, retval] long* Type Parameters ActionId [in] ID for specified Action. Type [out, retval] Type of the specified Action. Remarks Action types that the WACI supports, depends on the device’s hardware capabilities. Type values are: Value Action Type Supported on...

  • Page 162: Dutycycle, Stopafter, Port, Output )

    Remarks If Where == 0, and the Action is already at the top of the execution list (Idx == 0), then the function returns an error. Similarly, if Where == 1 and the Action is at the bottom of the list, then an error is returned. SetActionB SetActionB SetActionB...

  • Page 163: Setactionbyname ( Eventid, Name, Type, Delay, Dutycycle, Stopafter, Port, Output )

    SetActionByIdx ( EventId, Idx, Name, Type, Delay, DutyCycle, SetActionByIdx ( EventId, Idx, Name, Type, Delay, DutyCycle, SetActionByIdx ( EventId, Idx, Name, Type, Delay, DutyCycle, SetActionByIdx ( EventId, Idx, Name, Type, Delay, DutyCycle, StopAfter, Port, Output ) pAfter, Port, Output ) pAfter, Port, Output ) pAfter, Port, Output ) Modifies an Action specified by its associated Event ID and index.

  • Page 164: Setactionhost ( Actionid )

    Syntax HRESULT SetActionByName( [in] long EventId, [in] BSTR Name, [in] long Type, [in] double Delay, [in] double DutyCycle, [in] long StopAfter, [in] BSTR Port, [in] BSTR Output, [out, retval] VARIANT_BOOL* Success Parameters Event ID [in] ID of the Event that contains the Action. Name [in] Name of the desired Action.

  • Page 165: Setactionoption ( Actionid, Optiontype, Optionval )

    Host [in] Host name or IP address of the remote WACI. Success [out, retval] TRUE if the specified Action option was updated, FALSE if updating the option failed. Remarks When an Action’s host name is set to the name or IP address of a remote WACI, then the Action will be performed as if it were running locally on the remote WACI.
  • Page 166 Direction [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: Variable Methods

    Variable Methods AddVariable AddVariable AddVariable AddVariable ( Name, Type, ( Name, Type, ( Name, Type, ( Name, Type, Default, Value, Persist ) Default, Value, Persist ) Default, Value, Persist ) Default, Value, Persist ) Creates a new Variable Syntax HRESULT AddVariable( [in] BSTR Name, [in] long Type, [in] BSTR Default,...

  • Page 168: Assignvariable ( Varname, Isexpression, Value )

    Persistence If 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 persistent, then the Variable’s value is set to its default whenever the system restarts.

  • Page 169: Getvariablebyidx ( Idx )

    Syntax HRESULT DeleteVariableByName( [in] BSTR Name, [out, retval] VARIANT_BOOL* Success Parameters Name [in] Name of the Variable to delete. Success [out, retval] TRUE if the specified Variable was successfully deleted, FALSE if deleting the Variable failed. GetVariableByIdx ( Idx ) GetVariableByIdx ( Idx ) GetVariableByIdx ( Idx ) GetVariableByIdx ( Idx )

  • Page 170: Getvariabledefault ( Varid )

    Parameters NumVariables [out, retval] Total number of Variables in the system. Remarks Use GetVariableCount in conjunction with GetVariableByIdx to enumerate the list of available Variables. GetVariableDefault GetVariableDefault GetVariableDefault GetVariableDefault ( VarId ) ( VarId ) ( VarId ) ( VarId ) Returns the default value of the specified Variable.

  • Page 171: Getvariablepersist ( Varid )

    Syntax HRESULT GetVariableByName( [in] long VarId, [out, retval] BSTR* Name Parameters VarId [in] ID of the Variable to get the name of. Name [out, retval] Name of specified Variable. Remarks Variable names consist of letters, numbers, and the underscore. All other characters are not permitted. The Variable name should start with a non-number.

  • Page 172: Getvariablevalue ( Varid )

    Type Value Description Number Schedule String Range GetVariableValue GetVariableValue GetVariableValue GetVariableValue ( VarId ) ( VarId ) ( VarId ) ( VarId ) Returns the current value of the specified Variable. Syntax HRESULT GetVariableValue( [in] long VarId, [out, retval] BSTR* Value Parameters VarId [in] ID of specified Variable.

  • Page 173: Setvariablebyid ( Varid, Name, Type, Default, Value, Persist )

    SetVariableById SetVariableById ( VarId, Name, Type, Defau ( VarId, Name, Type, Default, Value, Persist ) lt, Value, Persist ) SetVariableById SetVariableById ( VarId, Name, Type, Defau ( VarId, Name, Type, Defau lt, Value, Persist ) lt, Value, Persist ) Modifies a Variable, specified by its ID. Syntax HRESULT SetVariableById( [in] long VarId,...

  • Page 174: Setvariablegroup ( Varid, Group )

    Syntax HRESULT SetVariableByName( [in] BSTR Name, [in] long Type, [in] BSTR Default, [in] BSTR Value, [in] long Persist, [out, retval] VARIANT_BOOL* Success Parameters Name [in] Name of the Variable to change. Type [in] Variable type. Default [in] Default value for the specified Variable. Value [in] Current value for the Variable.

  • Page 175: Sortvariables ( Sorttype, Direction )

    Remarks The group name is an arbitrary value, and is used only to help manage and sort Variables within the Event Manager web pages. SortVariables SortVariables ( SortType, Direction ) ( SortType, Direction ) SortVariables SortVariables ( SortType, Direction ) ( SortType, Direction ) Sorts all Variables by the sort type and direction.

  • Page 176: Error Codes

    XV. Error Codes The following table lists the error codes shown by the blue Status LED. Number of Blinks Error Description RAM self-test failed Real-time clock failed to stabilize Non-volatile RAM failed self-test No firmware loaded in Flash ROM Failed to initialize Ethernet adapter Failed during download of firmware image Failure when writing to Flash ROM Failed to relocate and initialize Kernel...

  • Page 177: Limited Lifetime Warranty

    XVI. Limited Lifetime Warranty Aurora Multimedia Corp. (“Manufacturer”) warrants that this product is free of defects in both materials and workmanship for the product lifetime as defined herein for parts and labor from date of purchase. This Limited Lifetime warranty covers products purchased in the year of 2003 and after. Product lifetime is defined as 7 years from discontinuance of product.

  • Page 178: Fcc Part 15 Statement

    XVII. FCC Part 15 Statement RADIO AND TELEVISION INTERFERENCE This equipment has been tested and found to comply with the limits for a Class A digital device, pursuant to Part 15 of the FCC rules. These limits are designed to provide reasonable protection against harmful interference in a residential installation.

  • Page 179: Index

    XVIII. Index IP Settings, 33, 34 A/D, 6, 9, 10, 18, 19, 40, 47, 61 IR Emitters, 19, 20 AD_SetDigital, 119 IR Learner, 9, 12, 14, 19, 20, 43 AddVariable, 162 IR Ports, 12, 14, 19, 20 Boot Menu Reference, 33 Lamp Test, 33, 35 LAN Port, 17 Contents, 3, 4, 7...
  • Page 180 Using the WACI, 29 WACI NX Jr. Parts Overview, 11 WACI NX+ Parts Overview, 13 Variables, 47, 51, 56, 57, 63, 64, 72, 73, 74, 77, Web Server Features, 32...

This manual is also suitable for:

Waci nx jr.

Table of Contents