TimerIDTimerData
The
TimerIDTimerData
item retrieves information about the selected static timer step on the batch list.This table shows the input and output formats for this item.
Format | Description | ||
|---|---|---|---|
Input Format | Request: TimerIDTimerData | ||
Output Format | The TimerIDTimerData item returns in this format: | ||
<StaticTimerData> | is | <CreateID> \t <Step Name> \t <State> \t <Mode> \t <CmdMask> \t <FailMsg> \t <UnitID> \t <Unit Name> \t <Recipe Path> \t <ParamList> \t <ParamList> \t <ParamLimitList> \t <RptList> \t <RptLimitList> | |
where <StaticTimerData> is: | |||
Field Name | Format | Description | |
<CreateID> | ASCII - String | CreateID of associated recipe timer step. | |
<Step Name> | ASCII - String | Name of the Timer Step (includes CreateID and path in recipe. | |
<Recipe Path> | ASCII - String | For timer steps this field holds the phase class name from the area model. | |
<ParamList> | Variable List | Parameters associated with the phase | |
<ParamLimitList> | Variable List | Parameter deviation limits associated with the phase | |
<RptList> | Variable List | Report parameters associated with the phase | |
<RptLimitList> | Variable List | Report parameter deviation limits associated with the phase. | |
where <ParamList> is: | |||
<ParamList> | is | $PARM \t <Parameters> \t $END | |
<Parameters> | is | <NullParamList> | <PList> | |
<NullParamList> | is | <sp> | |
<PList> | is | <Parameter> | <Parameter> \t <PList> | |
<Parameter> | is | <ParmName> \t <ParmType> \t <ParmKind> \t <EUs> \t <MaxValue> \t <MinValue> \t <Value> | |
where <Parameter> is: | |||
Field Name | Format | Description | |
<ParmName> | ASCII - String | Parameter Name | |
<ParmType> | ASCII - Integer | Data Type 1: Real 3: String
2: Long 5: Enumeration | |
<ParmKind> | ASCII - Integer | Type of parameter 1: Value 4: Static
2: UnAcked Prompt 5: Material Data
3: Deferred 6: Expression | |
<EUs> | ASCII - String | Eng Unit If <ParmType> =5, then this is the enumeration set
If <ParmType> =3, then it is a single space | |
<MaxValue> | ASCII - String | Maximum value (Use a single space for strings and enumerations) | |
<MinValue> | ASCII - String | Minimum value (Use a single space for strings and enumerations) | |
<Value> | <ParmType> | Value assigned to parameter. | |
where <ParamLimitList> is: | |||
<ParamLimitList> | is | $PARAMLIMITS \t <ParamLimits> \t $END | |
<ParamLimits> | is | <NullParamLimitList> | <PLList> | |
<NullParamLimitList> | is | <sp> | |
<PLList> | is | <ParameterLimit> | <ParameterLimit> \t <PList> | |
<ParameterLimit> | is | <ParmName> \t <Verification Method> \t <HighHighHigh Limit> \t <HighHigh Limit> \t <High Limit> \t <Low Limit> \t <LowLow Limit> \t <LowLowLow Limit> | |
where <ParameterLimit> is: | |||
Field Name | Format | Description | |
<ParmName> | ASCII - String | Parameter Name | |
<Verification Method> | ASCII - Integer | Parameter Verification Method: 0 = No Limits
1 = High/Low
2 = High-High/Low-Low
3 = High-High-High/Low-Low-Low | |
<HighHighHigh Limit> | ASCII - Integer | High-High-High Limit | |
<HighHigh Limit> | ASCII - Integer | High-High Limit | |
<High Limit> | ASCII - Integer | High Limit | |
<Low Limit> | ASCII - Integer | Low Limit | |
<LowLow Limit> | ASCII - Integer | Low-Low Limit | |
<LowLowLow Limit> | ASCII - Integer | Low-Low-Low Limit | |
where <RptList> is: | |||
<RptList> | is | $REPORT \t <RptParameters> \t $END | |
<RptParameters> | is | <NullRptList> | <RPList> | |
<RPList> | is | <ReportParam> | <ReportParam> \t <RPList> | |
<ReportParam> | is | <RptName> \t <RptType> \t <EUs> \t <Value> | |
where <ReportParam> is: | |||
Field Name | Format | Description | |
<RptName> | ASCII - String | Report parameter Name | |
<RptType> | ASCII - Integer | Data Type 1: Real 3: String
2: Long 5: Enumeration | |
<EUs> | ASCII - String | Eng Unit If <RptType> =5, then this is the enumeration set
If <RptType> =3, then it is a single space | |
where <RptLimitList> is: | |||
<RptLimitsList> | is | $REPORTLIMITS \t <RptLimits> \t $END | |
<RptLimits> | is | <NullRptLimitList> | <RLList> | |
<NullRptLimitList> | is | <sp> | |
<RLList> | is | <ReportParmLimit> | <ReportParmLimit> \t <RList> | |
<ReportParmLimit> | is | <ReportParmName> \t <Verification Method> \t <HighHighHigh Limit> \t <HighHigh Limit> \t <High Limit> \t <Low Limit> \t <LowLow Limit> \t <LowLowLow Limit> | |
where <ReportParmLimit> is: | |||
Field Name | Format | Description | |
<ReportParm Name> | ASCII - String | Parameter Name | |
<Verification Method> | ASCII - Integer | Parameter Verification Method: 0 = No Limits
1 = High/Low
2 = High-High/Low-Low
3 = High-High-High/Low-Low-Low | |
<HighHighHigh Limit> | ASCII - Integer | High-High-High Limit | |
<HighHigh Limit> | ASCII - Integer | High-High Limit | |
<High Limit> | ASCII - Integer | High Limit | |
<Low Limit> | ASCII - Integer | Low Limit | |
<LowLow Limit> | ASCII - Integer | Low-Low Limit | |
<LowLowLow Limit> | ASCII - Integer | Low-Low-Low Limit | |
This is an example of the return on this request.
A request on
object
.
GetItem(4TimerData)
could return:9\t9:CLS_FRENCHVANILLA\CLS_FRENCHVANILLA_UP:1\TIMER_DN:1\t$TIMER_DN_SECOND\r\n
$PARM\tTIMER_TYPE\t5\t1\t$TIMER_TYPE\t \t
\tCOUNT_DOWN\tHOLD_BEHAVIOR\t5\t1\t$HOLD_BEHAVIOR\t \t
\tCONTINUE\tSETPOINT\t1\t1\tSECONDS\t4147200\t10\t300\t$END\r\n
$PARMLIMITS\tTIMER_TYPE\t0\t \t \t \t \t \t \tHOLD_BEHAVIOR\t0\t \t \t \t \t \t
\tSETPOINT\t0\t \t \t \t \t \t \t$END\r\n
$REPORT\tELAPSED_TIME\t1\tSECONDS\tREMAINING_TIME\t1\tSECONDS\t$END\r\n
$REPORTLIMITS\tELAPSED_TIME\t0\t \t \t \t \t \t \tREMAINING_TIME\t0\t \t \t \t \t \t
\t$END\r\n
Provide Feedback