Xantech CRM-WIC Reference Manual Download Page 86

Page: 86 / 99

Value Action Type

Supported on

Set a Variable’s value CRM-WIC

Send serial data

CRM-WIC

Trigger another Event CRM-WIC

DeleteActionById ( ActionId )

Delete an Action with the given ID.

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.

Summary of Contents for CRM-WIC

Page 1: ...Reference Manual Programming Guide Room Monitor Web Intelligent Controller Model CRM WIC...

Page 2: ...THROUGH THE BOOT MENU 14 USING THE CRM WIC 15 TESTING HARDWARE 15 UPLOADING FIRMWARE UPGRADES 15 VIEWING SERVER LOGS 15 UPLOADING CUSTOM WEB PAGES 15 MANAGING CUSTOM EVENTS 15 USING REMOTE PROCEDURE...

Page 3: ...ecial Characters 45 REMOTE PROCEDURE CALLS 46 RPC SERVER LOGS 46 SYNTAX FOR HTTP POST 46 Call Tokens 46 Response Tokens 47 EXAMPLE 1 Serial_GetSettings 47 EXAMPLE 2 Net_GetSubnetMask 47 FAULT CODES 48...

Page 4: ...GetEventCount 72 ACTION METHODS 73 GetActionByIdx EventId Idx 73 GetActionByName EventId Name 73 MoveActionByIdx EventId Idx Where 74 GetActionName ActionId 74 GetActionType ActionId 74 GetActionOptio...

Page 5: ...ault Value Persist 91 SetVariableByName Name Type Default Value Persist 93 AddVariable Name Type Default Value Persist 94 DeleteVariableById VarId 95 DeleteVariableByName Name 96 SortVariables SortTyp...

Page 6: ...system the Web Intelligent Controller can automatically every night at 12AM turn the projector OFF if left on check Bulb Life and if low email the IT or AV specialist responsible When interfaced with...

Page 7: ...7 Box Contents Box Contents for the CRM WIC Web Intelligent Controller Model CRMWIC Power Adapter...

Page 8: ...8 Hardware User Interface Hardware User Interface for the CRM WIC...

Page 9: ...Settings page 11 Setting options and factory default settings Serial Settings Dipswitch Override page 26 Settings override from Admin Web Pages page 32 Tools on Admin Web Pages Jump To Events Jump to...

Page 10: ...S 232 422 485 Male DB9 2 Monitoring 32 Bit Internal Clock Calendar Network Access Web FTP CRM WIC Input Voltage Min 8V Typ 12V Max 18V Network Adapter 10 100Mbits RS 232 RS 422 485 15KB Protection 115...

Page 11: ...tions 1 4 Baud Rate bps 1 2 3 4 300 Off Off Off Off 600 Off Off Off ON 1200 Off Off ON Off 2400 Off Off ON ON 4800 Off ON Off Off 9600 Off ON Off ON 19200 Off ON ON Off 38000 Off ON ON ON 57600 ON Off...

Page 12: ...ed at this point After another 10 seconds or so the blue Status LED should start blinking slowly A slow steady blink on the blue Status LED indicates that the CRM WIC is ready to connect to an IP base...

Page 13: ...have a DHCP server on your network you may enable or disable the DHCP setting on the CRM WIC by pressing and holding the reset button for about 30 seconds Look for ONE 1 or TWO 2 flashes on the blue S...

Page 14: ...etc http IP Address or Host Name setup Configuring through the Admin Web Pages Once the CRM WIC is connected to the network you may configure the device through the admin web pages at http IP Address...

Page 15: ...min Web Pages The CRM WIC cannot be used for any other purpose while in this mode Firmware upgrade files will have extension AFW operating system upgrades or ABT bootstrap loader upgrades Viewing Serv...

Page 16: ...16 For full details see the RPC section at the end of this manual...

Page 17: ...top bits 1 and Flow control None When connected the CTS 1 and DSR 1 LEDs will light Press hold the reset button for 5 seconds The CRM WIC Boot Menu will appear on the terminal screen CRM WIC Boot Menu...

Page 18: ...the CRM WIC s network settings to the factory defaults see Factory Default Configurations on page 11 2 Configure IP Settings You may enable DHCP or manually set an IP address subnet mask and gateway...

Page 19: ...c temp CRM WICplus20 afw You may only upgrade one file at a time and you may not do anything else with the CRM WIC in this mode During the file transfer the serial LEDs will blink one at a time and y...

Page 20: ...on date time setting network settings and network security settings DIAGNOSTIC serial port configuration settings firmware upgrade instructions logs options and other diagnostic tools for using and or...

Page 21: ...ative options Many of these options are also available from the Boot Menu Firmware Version The firmware version installed on the CRM WIC is displayed Date Time The current date and time is displayed Y...

Page 22: ...ess Subnet Mask and Default Gateway will be black and editable Host Name By setting the host name your CRM WIC s web server may be accessed at http Host Name Similarly the FTP server may be reached at...

Page 23: ...23 Diagnostics Four of the Diagnostics described in this section Serial Memory Log and F W are available for the CRM WIC...

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

Page 25: ...0 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 Therefore you m...

Page 26: ...e standard settings for serial applications Baud Parity Data Bits Stop Bits and Handshaking You may also choose whether to use RS 232 or RS 422 285 signal levels MEMORY System Memory Information Syste...

Page 27: ...Info Displays the build date and version number of the RPC server Also displays all tokens and methods available from the server RPC Server Commands Logs all HTTP Post calls to the server Active X ca...

Page 28: ...load the file click the Ready to Download Firmware button The blue Status LED will turn OFF and all the Serial LEDs for both ports will be on You will now need to upload the OS or boot file using a tf...

Page 29: ...Event Manager are described in the section The Event Manager Files This link will simply take you to the CRM WIC s ftp server ftp IP Address or Host Name Any custom web pages uploaded to the wwwpub d...

Page 30: ...s Overview of Events Actions Variables In the simplest terms when certain conditions in hardware or variables are met the CRM WIC may be programmed to automatically perform specified tasks To put this...

Page 31: ...zed 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 Events actions and variabl...

Page 32: ...ents As mentioned earlier events are triggered when a condition is met in the hardware or for a variable The options for triggering an event depend on its type The system recognizes the following type...

Page 33: ...cuted concurrently at the time the event is triggered 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 t...

Page 34: ...nt and action are both highlighted the Edit button above the list of Actions may be selected From the edit action page you will have several options based on the type of Action Types of Actions Variab...

Page 35: ...ated with the event then untrigger the event NOTE When an event is triggered it remains triggered until all actions have been completed Once the actions are complete the trigger flag is reset Action T...

Page 36: ...flag is set the Current Value of the variable will be stored to permanent storage whenever it is changed This value will persist through a system reset or power failure so the Default Value is not use...

Page 37: ...231 1 Schedule A Schedule Variable can have a time value specified by hour minute second AM PM fields String A String Variable can be a Unicode string up to 128 characters in length Range A Range Vari...

Page 38: ...ithout quotes is an identifier for a variable Special characters inside string values inside quotes must be escaped Evaluation of Expressions Expressions are evaluated strictly left to right and order...

Page 39: ...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 For example This expression resolves to this value 3 4 7 Hello There Hel...

Page 40: ...les Use this operator to divide one numerical value by another The resultant type is an integer value what is error For example This expression resolves to this value 10 3 3 10 2 5 Equal Comparison Op...

Page 41: ...nd 0 if the second value is larger or equal For example assuming MyNumber has an integer value of 4 This expression resolves to this value MyNumber 5 0 MyNumber 4 0 MyNumber 3 1 Less Than Comparison O...

Page 42: ...tor determines the true or false state of the complex expression Expression1 Expression2 using the rules applying to a traditional logical OR statement If Expression1 is and Expression2 is Expression1...

Page 43: ...43 This expression resolves to this value 0 1 4 3 1 Hello Hello 0...

Page 44: ...erforms 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 12I10 i...

Page 45: ...m Quotes are not needed if the expression check box is UNCHECKED for the event or action Valid escape codes are Code Name Description a bell alert Character code 0x07 b backspace Character code 0x08...

Page 46: ...of available methods The Log Files web page also allows you to enable logging for the RPC commands Syntax for HTTP Post Call Tokens Methods may be called using HTTP Post using the following call toke...

Page 47: ...Code response1 Value for Response 1 response2 Value for Response 2 response3 Value for Response 3 etc EXAMPLE 1 Serial_GetSettings Let us look at the method Serial_GetSettings defined on page 55 From...

Page 48: ...gnal too weak 11 Other IR capture error 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...

Page 49: ...be access from your Flash action scripts in the variable callerID 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...

Page 50: ...ort1 strPort2 set CRM WICUser CreateObject CRM WIC UserAPI 1 strIP CRM WICUser Net_GetIPAddress if strIP then strErr CRM WICUser GetLastErrorString end if strPort1 CRM WICUser Serial_GetSettings 1 str...

Page 51: ...ned as a null string an integer retval returns 1 and Booleans will return FALSE Error Information Methods GetLastErrorCode Returns the fault code from the last failed method call Syntax HRESULT GetLas...

Page 52: ...ameters ExtErrorString out retval String giving more information about an error Remarks Corresponds to response2 of an HTTP Post response when status is 0 failure General Information Methods AllState_...

Page 53: ...leep Milliseconds Generates a wait period using the specified number of milliseconds Syntax HRESULT Time_Sleep in long Milliseconds out retval VARIANT_BOOL Success Parameters Milliseconds in The numbe...

Page 54: ...k Returns the current subnet mask of the device Syntax HRESULT Net_GetSubnetMask out retval BSTR SubnetMask Parameters SubnetMask out retval String containing the current subnet mask of the device suc...

Page 55: ...0 1200 2400 4800 9600 19200 38400 57600 and 115200 Parity ODD EVEN NONE Stop Bits 1 2 Flow Control HARDWARE SOFTWARE NONE Serial_Send Port Msg MaxWaitMS Sends a string to the specified port Syntax HRE...

Page 56: ...SULT 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 F...

Page 57: ...number of Events Use GetEventByIdx to get the ID of the next Event in the list Then use the ID and the remaining Event functions to retrieve the information you are interested in e g Name Type Actions...

Page 58: ...value returned by GetEventCount 1 is returned if the Event with the specified ID is not found GetEventName EventId Returns the name of the Event with a specified ID Syntax HRESULT GetEventName in long...

Page 59: ...t retval long OptionVal Parameters EventId in ID for the specified event OptionType in Type of option for the event OptionVal out retval Value of the specified option for the event Remarks Pass one of...

Page 60: ...he Actions execution When Actions execute concurrently the Event Manager determines the next Action to run by calculating its next run time The Event Manager uses the Action s Delay and Repeat Every v...

Page 61: ...t variable etc When the expression evaluates to non zero the Event is scheduled to run When Match is not an expression then the incoming data is compared against the Match value If the Match matches t...

Page 62: ...apply Valid values for RecurType are Value Description 0 Once 1 Daily 2 Weekly 3 Monthly 4 Yearly Remarks This function is valid for Clock Events only GetEventSchMaskOrDay EventId When the Event is s...

Page 63: ...s This function is valid only for Clock Events GetEventSchMonth EventId Returns the month value for the Event s schedule Syntax HRESULT GetEventSchMonth in long EventId out retval long Month Parameter...

Page 64: ...of the Event s schedule Syntax HRESULT GetEventSchRecurEveryN in long EventId out retval long EveryN Parameters EventId in ID for the specified event EveryN out retval Repeat every N periods The perio...

Page 65: ...Parameters EventId in ID for the specified event Minute out retval Integer representing the scheduled minute Values range from 0 to 59 Remarks This function is valid only for Clock and Timer Events G...

Page 66: ...igger The value of Source depends on the type of Event Event Type Format String Clock and Timer RTC Variable Name of the Variable Serial Port d where d represents a number Match in Value to match to t...

Page 67: ...Timer RTC Variable Name of the Variable Serial Port d where d represents a number Match in Value to match to trigger the Event If the Match value is an expression then the expression will need to eval...

Page 68: ...tion failed Remarks Pass one of the following values into OptionType Value Option Set OptionVal to 1 Concurrent 0 Event s actions will execute serially 1 Event s actions will execute concurrently 2 Ex...

Page 69: ...MaskOrDay in Mask of days or specific day of the month MaskDay values for weekly Events Bit Day 0 Sunday 1 Monday 2 Tuesday 3 Wednesday 4 Thursday 5 Friday 6 Saturday Month in Month setting for the sc...

Page 70: ...me of the new duplicate Event CloneID out retval ID of the new duplicate Event Remarks The name of the newly cloned Event will be set to s Copy where the s is replaced by the name of the Event being c...

Page 71: ...t or clear the expression flag for the Event s match value DeleteEventById EventId Delete an Event specified by its ID Syntax HRESULT DeleteEventById in long EventId out retval VARIANT_BOOL Success Pa...

Page 72: ...ort ascending 1 or descending 0 Success out retval TRUE if the events are successfully sorted FALSE if sorting the events failed Remarks This function is not supported in the version 2 0 firmware GetE...

Page 73: ...ed Action Remarks Use this function to get the list of Actions associated with a particular Event Each Event can contain up to 16 Actions GetActionByName EventId Name Returns the Action ID for a speci...

Page 74: ...if sorting the events failed 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...

Page 75: ...n for an Action specified by its ID and the option type Syntax HRESULT GetActionOption in long ActionId in long OptionType out retval long OptionVal Parameters ActionId in ID for specified action Opti...

Page 76: ...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 seconds to wait between successive exec...

Page 77: ...d 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 For variable Actions the Port value is the name of...

Page 78: ...x expression Event 0 Cancel the Event 1 Execute the Event 2 Disable the Event 3 Enable the Event SetActionById ActionId Name Type Delay DutyCycle StopAfter Port Output Modifies an action specified by...

Page 79: ...vent 1 Execute the Event 2 Disable the Event 3 Enable the Event Success out retval TRUE if specified action settings were updated FALSE if updating the action failed Remarks Valid values for Output fo...

Page 80: ...er of seconds to delay before sending Output to Port This is a real number and non integer values are allowed DutyCycle in Number of seconds to delay between each successive execution of the Action Th...

Page 81: ...he name of the Event In all other cases Port is the name of the port of the associated device e g Port1 Action types that the CRM WIC supports depends on the device s hardware capabilities Type values...

Page 82: ...vent Success out retval TRUE if specified action settings were updated FALSE if updating the action failed Remarks Valid values for Output for Variable Actions Variable Type Valid values to assign Num...

Page 83: ...the option failed Remarks Two options are supported for Actions OptionType Description OptionVal 1 Expression 0 output is a simple string 1 output is an expression 2 Disable 0 Action is enabled 1 Act...

Page 84: ...tval TRUE if a new Action was created with the specified settings FALSE if creating the Action failed Remarks Valid values for Output for Variable Actions Variable Type Valid values to assign Number S...

Page 85: ...values for Output Variable Depends on the type of Variable being assigned Serial A simple string or complex expression Event 0 Cancel the Event 1 Execute the Event 2 Disable the Event 3 Enable the Ev...

Page 86: ...e given ID 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 succes...

Page 87: ...LSE if deleting the Action failed DeleteActionByName EventId Name Delete an Action specified by its Event ID and Action name Syntax HRESULT DeleteActionByName in long EventId in BSTR Name out retval V...

Page 88: ...ntId out retval long NumActions Parameters EventId in ID of the Event NumActions out retval Total number of Actions owned by specified Event Variable Methods GetVariableByIdx Idx Returns the ID of the...

Page 89: ...t of letters numbers and the underscore All other characters are not permitted GetVariablePersist VarId Returns the persistence status of a Variable Syntax HRESULT GetVariablePersist in long VarId out...

Page 90: ...etval BSTR Default Parameters VarId in ID of specified variable Default out retval String containing default value of the specified variable Remarks The returned value is a string that represents the...

Page 91: ...aller into the actual type e g a variable of type long The format for the returned string depends on the Variable s type In the examples below d represents an integer s represents a string Type Format...

Page 92: ...The returned value is a string that represents the stored value of the Variable The string value will need to be converted by the caller into the actual type e g a variable of type long The format fo...

Page 93: ...s Parameters Name in Name of the Variable to change Type in Variable type Valid types are Type Value Description 1 Number 2 Schedule 3 String 4 Range Default in Default value for the specified Variabl...

Page 94: ...er d 25 String s This is a string Range d to d 1 to 35 Schedule d d d 17 35 02 Persistence When a Variable is persistent the value of the variable is stored to permanent storage each time it is change...

Page 95: ...ble of type long The format for the returned string depends on the Variable s type In the examples below d represents an integer s represents a string Type Format Example Number d 25 String s This is...

Page 96: ...e in Name of the Variable to delete Success out retval TRUE if the specified Variable was successfully deleted FALSE if deleting the Variable failed SortVariables SortType Direction Sorts all Variable...

Page 97: ...iables Syntax HRESULT GetVariableCount out retval long NumVariables Parameters NumVariables out retval Total number of variables in the system Remarks Use this function in conjunction with GetVariable...

Page 98: ...98 Index...

Page 99: ...repair or replacement during the specified warranty period product should be shipped back to the Manufacturer at Purchaser s expense after a proper RA Return Authorization has been set up If requeste...

Search results

Summary of Contents for CRM-WIC

Reviews:

Related manuals for CRM-WIC

Brands by name

Popular brands

Xantech CRM-WIC, Reference Manual

Search results

Summary of Contents for CRM-WIC

Reviews:

Related manuals for CRM-WIC

Brands by name

Popular brands