Action Keywords

An action is defined as a keyword that identifies the action type, always followed by one or more parameters and sometimes the equal (assignment) operator.

Every keyword uses a specific syntax that interprets parameters according to its own rules.

Cameras

CAMERA

The CAMERA action is used to temporarily disable cameras’ live view and recording features.

Action	Description
CAMERA name = ON	live view enabled
CAMERA name = OFF	live view and recording disabled
CAMERA name = RECON	recording enabled
CAMERA name = RECOFF	recording disabled

Parameters:

• name - the camera’s id. You can specify a list of space separated ids.

Examples:

• CAMERA entrance = ON

CAMERAREC

Records video from a camera.

Action	Description
CAMERAREC name = sec	records for the number of seconds defined with the set attribute

Parameters:

• name - the camera’s id. You can specify a list of space separated ids.

Examples:

CAMERAREC openspace = 30

CAMERARECFULL

Records video from a camera, like CAMERAREC, but ignores the DroppedFrames parameter in hsyco.ini, so that all frames captured from the camera during the recording period are recorded with no skips.

Action	Description
CAMERARECFULL name = sec	records for the number of seconds defined with the set attribute

Parameters:

• name - the camera’s id. You can specify a list of space separated ids.

Examples:

CAMERARECFULL openspace = 30

DMX

DMX

Controls the value of DMX-512 channels.

Action	Description
DMX address = ON	sets the DMX address to the value preceding the last OFF command
DMX address = OFF	sets the DMX address to value = 0
DMX address = FLIP	flips the status of a DMX channel (if the status is ON it executes the OFF command and vice versa). When more channels are specified, if the previous status of at least one of the channels is different from OFF, the OFF command will be sent to all the channels, otherwise the ON command will be sent
DMX address = value	assigns a value to the DMX channel. Valid values are numbers between 0 and 255
DMX addressX = DMX addressY	the DMX channel addressX assumes the current status of the DMX channel addressY
DMX address = MERGE	the channel or channels on the DMX OUT bus of the gateway follow the same channels of the DMX IN bus
DMX address = UNMERGE	disables merge mode

Parameters:

• address - when using one DMX gateway, address will be a standard DMX-512 address between 1 and 512. If there is more than one gateway, 1000 must be added to the DMX address for the second gateway, 2000 for the third one and so on. For example, 2100 stands for the address 100 on the DMX bus controlled by the third gateway. You can also use a from-to range format to specify a contiguous block of channels.

Examples:

DMX 100 101 102 = ON
DMX 100-120  200-220 = DMX 40
DMX 33 = MERGE

I/O Servers

IO

Writes to I/O servers data points.

Action	Description
IO name = value	sets the data point to a value. Values are specific to the type of I/O server
IO name = FLIP	inverts the output of the I/O data point. If the status of the output is 0 the new status will be 1, if different from 0 the new status will be 0
IO name1 = IO name2	sets the I/O interface output name1 to the current value of the I/O interface name2

Parameters:

• name - the server id, followed by a single dot and the data point suffix. The EVENTS interpreter converts data points names to lower case
• value - you can use multiple unquoted words, quoted strings and variables, that will be appended to the value string.

Examples:

IO contacts.c1 contacts.c3= 1
IO sensors.c1 = FLIP
IO contacts.o1 contacts.o2 = IO sensors.flood

Serial Communication Ports

COMM

Sends a sequence of bytes to the specified communication port.

Action	Description
COMM name = hexbytes	sends bytes to a serial port

 If both verboseLog and userLog are set to true, the full trace of sent bytes is written to the log file.

Parameters:

• name - the name of the communications port, as defined in the CommPorts parameter in hsyco.ini
• hexbytes - string with the hexadecimal representation of the sequence of bytes to be sent. You can use multiple unquoted words, quoted strings and variables, that will be appended to generate the byte stream sent to the communication port.

Examples:

COMM serialport =  FE03C9104B27
COMM serialport =  FE $body 27