Aurora Multimedia WACI NX-22 Reference Manual & Programming Manual Download Page 119

Page: 119 / 174

IR Methods

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
);

Parameters

Port

[in] Port number of the IR Port of interest. Valid values are 1 and 2.

Group

[in] Name of the file that contains the command.

Command

[in] Name of the command to send.

Success

[out, retval] TRUE if command was successfully sent, and FALSE if the WACI failed to send
the command.

Remarks

Commands are typically grouped together by device.

IR_SendCommandEx ( Port, Group, Command, Sequence, Repeat )

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,
[out, retval] VARIANT_BOOL* Success

);

Parameters

Port

[in] Port number of the IR Port of interest. Valid values are 1 and 2.

Group

[in] Name of the file that contains the command.

Command

[in] Name of the command to send.

Sequence

[in] The sequence of IR commands to send.

Repeat

[in] Number of times to Repeat the IR command.

Success

[out, retval] TRUE if command was successfully sent, and FALSE if the WACI failed to send
the command.

Summary of Contents for WACI NX-22

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

Page 2: ...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 So...

Page 3: ...S 8 VI EXPANSION HARDWARE 17 VII FACTORY DEFAULT CONFIGURATIONS 18 VIII QUICK START 19 IX USING THE WACI 23 X WEB SERVER FEATURES 26 XI BOOT MENU REFERENCE 27 XII ADMIN WEB PAGES 31 XIII THE EVENT MAN...

Page 4: ...THE NX 22 TO A LAN 20 STEP 3B DIRECT CONNECTION IF STATIC IP IS SET 21 STEP 3C DIRECT CONNECTION WITH A SERIAL CABLE 21 STEP 4 ACCESS THE WACI 21 STEP 5 CONFIGURE WACI USING THE ADMIN WEB PAGES 22 IX...

Page 5: ...87 SYNTAX FOR HTTP POST 87 FAULT CODES 89 USING MACROMEDIA FLASH 90 VISUAL BASIC SCRIPTING 92 NOTE ON ERROR CHECKING 92 RPC QUICK REFERENCE 93 ERROR INFORMATION METHODS 100 GENERAL INFORMATION METHODS...

Page 6: ...uipped with a standard web browser be it PC Pocket PC Palm or Mac is now enabled to access your system The WACI does all this with a powerful 32 bit engine with 32 bit pipeline memory in a small box t...

Page 7: ...IV Box Contents Box Contents for the NX 22 12v 15 Watt Supply International Supply Kit 2 IR Port Emitters NX 22 Device Power Adapters IR Emitters...

Page 8: ...ardware 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...

Page 9: ...Impedance 200ma Sink Open Drain Relay SPDT 2 C Type NO NC CP Audio Unbalance Input 1 20Hz 20Khz Unbalanced Output 1 20Hz 20Khz Monitoring 32 Bit Internal Clock Calendar IR Learner 30KHz 2MHz Expansio...

Page 10: ...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 Inp...

Page 11: ...enu navigation 4 IR Learner Port 5 Reset paperclip button hole 6 Micro SD Memory Expansion 7 USB 2 0 Host 8 IR In Port 9 Power Adapter Port 10 Two 10 100 Auto MDX LAN Ports LAN1 has capability POE 11...

Page 12: ...reen 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 an...

Page 13: ...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 t...

Page 14: ...lays The Relays on the NX 22 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 r...

Page 15: ...t to ground Setting the port as a 1 will put the port into a high impedance state The digital output can be used for triggering relays LEDs or any device that will not require more then 200mA of curre...

Page 16: ...lit IR Learner 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...

Page 17: ...h speed connection up to 400Mbps to pass through small or large amounts of data for additional features like additional ports Bluetooth Voice Lift WIFI and much more With the use of a USB Hub even mor...

Page 18: ...DHCP 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...

Page 19: ...LED will immediately light as well as the LCD backlight It will remain lit while the WACI is plugged in All other LEDs will be off and the LCD will have a message Initializing The WACI will run throug...

Page 20: ...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 NX 22 to a LAN The...

Page 21: ...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 serial connection...

Page 22: ...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 Diag...

Page 23: ...Information IR Emitter Ports see page 39 Serial Ports see Serial Port Diagnostics page 43 Relay Ports see Relay Diagnostics page 45 DIO Ports see Digital I O Diagnostics page 46 System Logs see Log F...

Page 24: ...TP server It is typically used to examine user access and determine network needs The log for the Web Server see Web Server page 47 allows you to monitor activity on the WACI s Web server It is typica...

Page 25: ...ame wwwpub These custom web pages may be viewed with a web browser at http IP Address or Host Name For more information about the FTP server and uploading files see the Files section page 49 in the Ad...

Page 26: ...r 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 tx...

Page 27: ...power connector 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 Change Password 4 Set Host Name 5...

Page 28: ...ctory Defaults This option restores the WACI s network settings to the factory defaults see Factory Default Configurations page 18 2 Configure IP Settings Use to enable DHCP or manually set an IP addr...

Page 29: ...th ports will be on You will now need to upload the OS or boot file using a tfpt client To use the default Windows tftp client open a Command Prompt or DOS shell window and execute tftp i IP Address p...

Page 30: ...o validate the integrity of the system RAM 8 Erase File System 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 OE...

Page 31: ...ick 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 mon...

Page 32: ...etup This web page allows you to set several administrative options Many of these options are also available from the Boot Menu Firmware Version The firmware version installed on the WACI is displayed...

Page 33: ...tting 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 Auto...

Page 34: ...ateway 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 Addre...

Page 35: ...ed privileges The URL for user account setup is the IP address of the unit user ex 10 10 10 10 user Entering this URL address will bring up the user log on access which is limited by the access grante...

Page 36: ......

Page 37: ...This page allows you to change Serial Port and IR Port settings NX 22 has 2 Serial ports and 2 IR ports SQL Setup Using SQL Setup users are able to create tables make queries and store data in a WACI...

Page 38: ...NX 22 reflects its supported 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...

Page 39: ...ion is available for the NX 22 It shows available memory current network settings IR Port Serial Port Relay Port and I O Port settings By clicking System Reset button you can remotely restart WACI It...

Page 40: ...ed commands or to send RS 232 commands out the IR if used as a serial device The other selection is to learn a new remote or to add commands to an existing one IR Diagnostics This page allows you to t...

Page 41: ...e 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 dow...

Page 42: ...ame should contain letters and numbers only no spaces In Step 2 select the learn mode Standard is a simple sample of the incoming IR Try this mode first If it does not work then try alternate mode whi...

Page 43: ...from the sensors and press the desired remote button you wish the WACI to learn The IR LED will glow slowly while the WACI is waiting for an IR signal and turn solid when it detects a signal If the r...

Page 44: ...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...

Page 45: ...encoding 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 pla...

Page 46: ...as Digital Input 0 to 3V Digital Output Open Drain sink up to 200mA When the state of the port is High the LED light will be on Log Files Log files for the WACI servers are available for the WACI NX...

Page 47: ...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 Even...

Page 48: ...s 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 tf...

Page 49: ...e 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 w...

Page 50: ...ne may be used to manage files on the WACI s FTP server File Structure The WACI automatically creates three directories at the root level of its FTP server EventManager holds data for your custom Even...

Page 51: ...mands 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...

Page 52: ...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 You may use any FTP client or web browser to manage the files in...

Page 53: ...Finally drag and drop selected files from your File Explorer...

Page 54: ...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 cont...

Page 55: ...ent 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 re...

Page 56: ...ng configurations Restoring copying or updating an Event Manager file see EventManager page 51 Disable the Event Manager by selecting the Disabled radio button at the top of the page Enable the Event...

Page 57: ...th the Event as described in the next two sections 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 expressio...

Page 58: ...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 Trigge...

Page 59: ...ined initial state 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...

Page 60: ...of one of the Ethernet Ports changes 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 T...

Page 61: ...ression page 73 When the expression evaluates to a value not equal to 0 then the Event triggers and executes its Actions If the expression check box is UNCHECKED the value specified in the Trigger val...

Page 62: ...the Event is place on the remote WACI This remote copy cannot be changed but can be seen if you open the Event Manager web page on the remote WACI The copy will have the IP address of the local WACI...

Page 63: ...o 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 e...

Page 64: ...Variable s type is not changed by the assignment Prior to assigning the result of the expression to the Variable the result is converted to the Variable s type e g a number The interpretation and calc...

Page 65: ...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 The message body can be either a simple text string or...

Page 66: ...Output to field The content of the Output value field is written to the log file The Output value can contain either an expression or a simple piece of text Log files are created in a logs directory...

Page 67: ...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 DIO diagnosti...

Page 68: ...sent to a device which use the UDP as its means of communication via LAN PJLink PJLink action also known as Projector link is an action that allows easy communication to a PJLink device via LAN Inste...

Page 69: ...tions 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 Eve...

Page 70: ...x 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 Network Timeouts...

Page 71: ...ariables may be created from the main Event Manager web page see The Event Manager Web Page page 55 by selecting the Add variable button To edit an existing Variable first select it so that it is high...

Page 72: ...r failure If a Variable has the persistent flag set the Default value 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...

Page 73: ...10 CHAR 0o102 B The following functions are available for use when the expression check box is checked in one of the supported actions The following types of actions support expressions Variable Seria...

Page 74: ...ing gives the date and time in text form Example GetSystemTime HEX Char Returns a HEX string that represents the character value passed in Example HEX A HEX var_name LStr string integer Returns string...

Page 75: ...2find bc returns 4 Rtrim string Returns string Removes trailing spaces from string Example Rtrim test returns test strlen string Returns Integer Returns the number of characters in the string Example...

Page 76: ...dentifier For example Hello in quotes is a string value in the expression Hello without quotes is an identifier for a Variable Special characters inside string values inside quotes must be escaped see...

Page 77: ...comparison operators Logical operators Bitwise operators Range operator in Assignments Addition Plus Operator The operator is used to append one string to another or to add two integer values together...

Page 78: ...es to this value 4 5 20 Hello 3 HelloHelloHello 3 Hello 0 Division Divide Operator The divide operator is valid only for numerical values and Variables Use this operator to divide one numerical value...

Page 79: ...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 0 MyNumber 4 0 MyNumber 5 1 MyName John 0 MyName ul 1 0 John...

Page 80: ...e The expression will return 1 if the first token has a smaller value than the second and 0 if the second value is smaller or equal For example assuming MyNumber has an integer value of 4 This express...

Page 81: ...esolves to this value 3 3 4 4 1 1 4 5 0 0 4 4 0 3 6 0 0 Logical Or Operator Assume you have two Boolean expressions Expression1 and Expression2 each returning true 1 or false 0 The logical or operator...

Page 82: ...g four bits 12 1 1 0 0 10 1 0 1 0 12 10 1 0 0 0 Therefore 12 10 Binary 1000 Decimal 8 Bitwise Or Operator The bitwise OR operator performs the logical OR operation bit by bit between two integers This...

Page 83: ...t Operator The operator stores a value R Value into a Variable L Value The value on the left of the assignment operator is the L Value The result of the assignment is an R value and cannot be used in...

Page 84: ...er also contains 3 MyString ll Heo MyString also contains Heo 10 3 Illegal L Value not a Variable Multiplication Assignment Operator This operator multiplies two numbers or can be used for creating a...

Page 85: ...string Matches one or more characters Matches 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 mat...

Page 86: ...feed 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...

Page 87: ...Error Checking RPC 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...

Page 88: ...the end of this reference 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...

Page 89: ...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 per...

Page 90: ...on 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 javasc...

Page 91: ...es 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...

Page 92: ...s 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...

Page 93: ...1 2 12 Serial Port Pin Out Diagram 13 LED Indicators for Serial Ports 1 2 13 RS 422 Operation 13 RS 485 Operation 13 Network Interface 14 LAN Port 14 LED Indicators 14 Relays 14 Relay Ports 1 2 14 LE...

Page 94: ...NU WITH A SERIAL CONNECTION 27 0 DISPLAY CURRENT SETTINGS 27 1 RESTORE FACTORY DEFAULTS 28 2 CONFIGURE IP SETTINGS 28 3 CHANGE PASSWORD 29 4 SET HOST NAME 29 5 DOWNLOAD NEW FIRMWARE 29 6 LAMP TEST 30...

Page 95: ...ents 57 Clock 57 Timer 58 Variable 58 Serial 58 DIO Digital Input Output 59 Startup 59 Telnet 59 Network 60 IR Input 60 Named Event 60 Other Event Options 61 Group Name 61 Execute Actions Concurrently...

Page 96: ...ator 79 Greater Than or Equal Comparison Operator 80 Less Than Comparison Operator 80 Less Than or Equal Comparison Operator 80 Logical And Operator 80 Logical Or Operator 81 Logical Not Operator 82 B...

Page 97: ...endExpression NetCard Expression MaxWaitMS 108 Telnet_Read NetCard 108 Telnet_ClearReadBuffer NetCard 109 Telnet_ReadBufferCount NetCard 109 LOGGING METHODS 109 Log_Write FileName IsExpression Buffer...

Page 98: ...d 133 GetEventName EventId 134 GetEventOption EventId OptionType 134 GetEventSchClockType EventId 134 GetEventSchRecurType EventId 135 GetEventSchMaskOrDay EventId 135 GetEventSchMonth EventId 136 Get...

Page 99: ...me Type Delay DutyCycle StopAfter Port Output 157 SetActionHost ActionId 158 SetActionOption ActionId OptionType OptionVal 159 SortActions SortType Direction 159 VARIABLE METHODS 161 AddVariable Name...

Page 100: ...ng 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 Rema...

Page 101: ...parated from the next port value by a comma Element Field Type Example 0 Date DATE 1 Serial Rcv Buffer Count BSTR 0 1092 2 Relays BSTR 1 0 0 1 3 DIO IsOutput BSTR 0 1 0 0 4 DIO State BSTR 1 1 1 1 5 DI...

Page 102: ...tor password and FALSE if password does not match Remarks If this function is called with an invalid password more than 25 times then ValidatePassword will return FALSE for the next 15 minutes regardl...

Page 103: ...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...

Page 104: ...P Parameters IP out retval String containing the current IP address of the device such as 10 0 1 3 Net_GetIPAddressEx NetCard Returns the current IP address of the device Syntax HRESULT Net_GetIPAddre...

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...

Page 106: ...ers SenderId in Sender s email address e g joe mycompany com ToIds in Email addresses to be included in the To line of the email Separate each email address with a semicolon CcIds in Email addresses t...

Page 107: ...Id 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 em...

Page 108: ...d Failed 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 MaxWa...

Page 109: ...eared successfully 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...

Page 110: ...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 MaxLength in Number of bytes to return in RetD...

Page 111: ...s cleared FALSE on failure 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_Clea...

Page 112: ...1 0 HARDWARE 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 Se...

Page 113: ...rial 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 Expr...

Page 114: ...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...

Page 115: ..._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 S...

Page 116: ...is on 0 if is off 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 rel...

Page 117: ...al 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 a...

Page 118: ...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 ret...

Page 119: ...Remarks Commands are typically grouped together by device IR_SendCommandEx Port Group Command Sequence Repeat Sends an IR command out the specified IR port Syntax HRESULT IR_SendCommandEx in long Port...

Page 120: ...r 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...

Page 121: ...01C 09C4 0030 03CC 0030 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 f...

Page 122: ...s in the specified group Remarks If a group contains no commands then the returned string is IR_ListAllCommands Returns an array containing all commands from all groups Syntax HRESULT IR_ListAllComman...

Page 123: ...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 spe...

Page 124: ...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 specifie...

Page 125: ...he 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 F...

Page 126: ...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 V...

Page 127: ...in Type of the Event e g Serial see GetEventType EventId page 139 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...

Page 128: ...d 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...

Page 129: ...x 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...

Page 130: ...val 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 th...

Page 131: ...in ID of the Event Group out retval A returned string filled in with the group for the specified Event GetEventNetCard EventId Returns the group name for the Event with a specified ID Syntax HRESULT G...

Page 132: ...ray of Event IDs Remarks Use GetEventIds to get the complete list of Event IDs stored by the Event Manager This function is more efficient than calling GetEventCount and GetEventByIdx GetEventIdxById...

Page 133: ...ge 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...

Page 134: ...l 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 fo...

Page 135: ...curType 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...

Page 136: ...000020 32 5 Friday 0x00000040 64 6 Saturday Remarks This function is valid only for Clock Events GetEventSchMonth EventId Returns the month value for the Event s schedule Syntax HRESULT GetEventSchMon...

Page 137: ...pecified 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 Eve...

Page 138: ...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 sc...

Page 139: ...where d represents a number Telnet IP address or host name of the Telnet server to connect to GetEventType EventId Returns the type of the Event with a specified ID Syntax HRESULT GetEventType in lon...

Page 140: ...was successfully set FALSE if setting the Event failed Remarks Call this function to set up an Event After making this call a call to SetEventSchedule is required for all Events of type Clock or Time...

Page 141: ...entId in long 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 retv...

Page 142: ...ecute 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 S...

Page 143: ...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 spec...

Page 144: ...e SetEventSchedule SortEvents SortType Direction Sorts the list of Events by the sort type and direction Syntax HRESULT SortEvents in long SortType in long Direction out retval VARIANT_BOOL Success Pa...

Page 145: ...ger 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 escap...

Page 146: ...onds 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 P...

Page 147: ...utions 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...

Page 148: ...tId 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...

Page 149: ...nt can contain up to 16 Actions 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...

Page 150: ...ggered before executing the Action For Actions that execute serially the value is the amount of time to wait after the previous Action completed GetActionDutyCycle ActionId Returns the number of secon...

Page 151: ...n Event This function is more efficient than calling GetActionCount and GetActionByIdx GetActionInfo ActionId Returns an array filled with the data for an Action Syntax HRESULT GetActionInfo in long A...

Page 152: ...n 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 opti...

Page 153: ...oup Command to execute The string 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 val...

Page 154: ...e xyz com bob abc com tom ccaddr com support foo com Log The name of the file to write the logged information to Telnet The IP address or host name of the Telnet server to command All other cases The...

Page 155: ...2 6 Send an Infrared command NX 22 7 HTTP post command NX 22 8 Email message NX 22 9 Log to file NX 22 10 Telnet command NX 22 MoveActionByIdx EventId Idx Where Changes the order of execution for the...

Page 156: ...ng 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...

Page 157: ...sive 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...

Page 158: ...mes 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 settings were updated...

Page 159: ...etActionOption in long 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...

Page 160: ...rt to perform 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 f...

Page 161: ...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 i...

Page 162: ...n The value 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 166 Success out retval TRUE if specified Varia...

Page 163: ...able in the array of Variables 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 inde...

Page 164: ...that represents the Variable 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...

Page 165: ...ied 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 tim...

Page 166: ...s 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 Variab...

Page 167: ...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...

Page 168: ...nverted 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 165 Persistence When a Variable...

Page 169: ...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 so...

Page 170: ...oved 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 availa...

Page 171: ...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...

Page 172: ...mation Methods 100 Event Manager Methods 125 Events 24 47 49 50 54 55 57 58 59 61 63 65 71 76 Expansion Hardware 17 F Factory Default Configurations 18 FCC Part 15 Statement 171 Firmware 23 24 32 48 4...

Page 173: ...34 NX 22 Parts Overview 11 P Power Status Indicators 12 Power Adapter 7 8 11 12 power over Ethernet 14 Power Port 12 Q Quick Start 19 R Relay Diagnostics 45 Relay Methods 115 Relays 14 Remote Procedu...

Page 174: ...Time Zone 33 U Using the WACI 23 V Variables 50 54 55 61 71 72 73 78 84 W Web Server Features 26 17...

Search results

Summary of Contents for WACI NX-22

Reviews:

Related manuals for WACI NX-22

Brands by name

Popular brands

Aurora Multimedia WACI NX-22, Reference Manual & Programming Manual

Search results

Summary of Contents for WACI NX-22

Reviews:

Related manuals for WACI NX-22

Brands by name

Popular brands