TimerIDTimerStatus
The
TimerIDStatus
item retrieves dynamic information about a specific Timer step. The TimerID is the internal reference number to a specific Timer on the batch list. This number is unique for all timers on the batch list. (The TimerSteps item can be used to get a list of all the TimerIDs currently on the batch list.)This table shows the input and output formats for this item.
Input Format | Request: TimerIDStatus | ||
Output Format | The TimerIDStatus item returns in these formats: | ||
For timers of Type Count_Down: | |||
<DynamicTimerData> | is | <Elapsed_Time> \t <Remaining_Time> \t <State> | |
where <DynamicTimerData>: | |||
Field Name | Format | Description | |
<State> | ASCII - Integer | Current state of the Timer step. | |
<Mode> | ASCII - String | Mode of the Phase under Recipe Control: O_AUTO P_AUTO | |
<CmdMask> | ASCII - String | Command masks | |
<Unit Name> | ASCII - String | Current Unit Name | |
<UnitID> | ASCII - Integer | Current Unit ID. | |
<FailMsg> | ASCII - Integer | Failure Message | |
<Elapsed_Time> | ASCII - Integer | Amount of time timer has been in the running state | |
<Remaining_Time> | ASCII - Integer | Amount of time remaining (Setpoint - Elapsed_Time) | |
<Hold Behavior> | ASCII - Integer | Current Value of the Hold_Behavior Parameter | |
<Setpoint> | ASCII - Integer | Current Value of the Setpoint Parameter | |
For timers of Type Count_Up: | |||
where <DynamicTimerData>: | |||
Field Name | Format | Description | |
<State> | ASCII - Integer | Current state of the Timer step. | |
<Mode> | ASCII - String | Mode of the Phase under Recipe Control: O_AUTO P_AUTO | |
<CmdMask> | ASCII - String | Command masks | |
<Unit Name> | ASCII - String | Current Unit Name | |
<UnitID> | ASCII - Integer | Current Unit ID. | |
<FailMsg> | ASCII - Integer | Failure Message | |
<Elapsed_Time> | ASCII - Integer | Amount of time timer has been in the running state | |
<Hold Behavior> | ASCII - Integer | Current Value of the Hold_Behavior Parameter | |
This table shows an example of the return on this request.
TIP:
A request on for a COUNT_DOWN timer could return:
object
.
GetItem(4Status)
READY\tP_AUTO\t0\tWP_FREEZER1\t4\t \t250\t50\tCONTINUE\t300\r\n
A request on
object.GetItem(4Status)
could return this for a COUNT_UP timer:RUNNING\tP_AUTO\t0\t \t\t \t40\tCONTINUE\r\n
Provide Feedback