Xantech CRM-WIC, Reference Manual

Page: 82 / 99

82
Parameters
Event ID [in] ID of the Event that contains the Action.
Name [in] Name of the desired Action.
Type [in] Type of Action, e.g. Serial, Variable, etc.
Delay [in] Number of seconds to delay before sending
Output
to
Port
. This is a real number, and non-integer values are
allowed.
DutyCycle [in] Number of seconds to delay between each successive execution of the Action. This is a real number, and non-
integer values are allowed.
StopAfter [in] Number of times to repeat the Action
Port [in] Location where the output is sent
Output [in] Data that should be output.
This parameter depends on the value of
Type
.
Action
Type
Returned 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 Event
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
Number String or expression that evaluates to a number
Range String of the form “%d to %d”, where %d represents a number
String Anything that can be converted to a string
The value of
Port
represents where the Action is going to send its output. For variable Actions, the
Port
value is the
name of the Variable. For Actions that execute or cancel an Event, the
Port
value is the 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 are:
Value Action Type Supported on
1 Set a Variable’s value CRM-WIC
2 Send serial data CRM-WIC
5 Trigger another Event CRM-WIC
SetActionOption ( ActionId, OptionType, OptionVal )
Modifies the option for a action, specified by its ID and the option type.