|
Field Name |
Description |
Notes |
|
action:equipmentname |
Name of the equipment item as seen in the equipment manager. |
Unique |
|
action:devicename |
Name of the device interface |
ControlByWeb |
|
action:name |
Name of the particular action |
StartStop |
|
action:order |
If multiple actions are present in the equipment item, this defines the order. |
0 |
|
action:functionid |
Custom event function that will activate this action. |
This is normally blank. |
|
action:triggername |
Name of the trigger that executes the action |
EventStartStop, EventSetupTeardown |
|
action:objectname |
Unique point object name |
|
|
Parm:modelname |
Name of the relay model |
“X301”, “X410”, etc |
|
parm:ipaddress |
IP address of relay |
|
|
parm:port |
Port of relay |
80 default |
|
Parm:usessl |
Flag to use SSL (https) |
TRUE|FALSE |
|
parm:devicename |
Name of the relay |
e.g. “Basement NT:Pump1” |
|
parm:occvalue |
Value to send to relay on event start |
0 = OFF (de-energized) 1 = ON (energized) |
|
parm:unoccvalue |
Value to send to relay on event stop |
0 = OFF (de-energized) 1 = ON (energized) |
|
parm:actionstate |
Not applicable |
blank |
|
parm:relaynumber |
Number of the relay to command |
1-4 (depends on relay) |
|
parm:useglobalpassword |
flag to use global password instead of one assigned to this device |
true/false |
|
Parm:username |
Username of the control credentials |
Blank or “admin”, “manager”, “user” |
|
parm:encpassword |
Encrypted password of the device |
string |