cycle

cycle — changes the cycle time of a point.

Synopsis

       
(cycle point_name cycle_millisecs)
	

Parameters

point_name

The name of an existing point.

cycle_millisecs

The new point cycle (or heartbeat) time in milliseconds. A cycle time of 0 is not allowed.

Returns

OK or (error).

Description

This command changes the cycle time attribute of the specified point. If the point was created with a non-zero cycle time (see analog, digital, group or heartbeat commands), and was therefore already being processed cyclically, then the point will begin to process at the specified cycle period after the current cycle period is completed. See the cycleModify command as a preferred alternative. This command is infrequently used.

Example

(cycle digital_input_group 50)