Heartbeat table details

name

pntname

This field is the unique name of this heartbeat record. The name can be up to 32 characters in length.

description

description

This field is a description of this heartbeat record. The description can be up to 47 characters in length.

dataset

doas_dset_slot

This field indicates the dataset to which the record is assigned. Datasets are used to associate the record with the privileges assigned for each system mode. Once a record is assigned to a dataset value, the dataset can only be changed to a value for which the system has a privilege record.

enabled

oas_boolean_t

This field is used to enable or disable the heartbeat point.

controlPoint

path

This field is the path to the analog or status point record that will be used to send heartbeat commands to the control point. Only analog and status points are supported.

type

heartBeatType

This field is the heartbeat command type. The following are possible heartbeat command types:

• Ramp

• Toggle

• Strobe

• Time

  Note: Ramp and Time command types are only available when the control point is configured as an analog record. Toggle and Strobe control types are only available when the control point is configured as a status record.

frequency

unsigned short

This field is the frequency (in seconds) at which the heartbeat command is to be sent to the control point.

low

unsigned short

This field is the minimum range value. It is only available when the Ramp heartbeat type is selected.

high

unsigned short

This field is the maximum range value. It is only available when the Ramp heartbeat type is selected.

increment

unsigned short

This field is the amount the analog value will be incremented each cycle. It is only available when the Ramp heartbeat type is selected.

commandDelay

unsigned short

This field is the delay (in milliseconds) that will be used between commands sent to a digital point. The command delay should be set to a value that will allow all the commands in the command sequence to finish before the next cycle begins. This field is only available when the Strobe heartbeat type is selected.

commandSequence

longstring

This field is the command sequence that will be sent to a digital point each cycle. For example, OPEN, CLOSE, OPEN.  The commands listed in the command sequence should match the output message set for the control point. For example, if the output control point is configured to send ON and OFF commands, the command sequence field should be set to ON,OFF,ON. This field is only available when the Strobe heartbeat type is selected.