Y_PK_Return_Motion_Alarm
Returns the alarm text (in Message) associated with the supplied Inp_ErrorID.
If the value is not found "Unknown Alarm" will be returned.
Parameters
| * | Parameter | Data Type | Description | Default |
|---|---|---|---|---|
| VAR_INPUT | ||||
| B | Enable | BOOL | Upon the rising edge, all other function block inputs are read and the function is initiated. To modify an input, change the value and re-trigger the execute input. | FALSE |
| V | Inp_ErrorID | UINT | The ErrorID/alarm for which the alarm text is returned. | 0 |
| VAR_OUTPUT | ||||
| B | Done | BOOL | Set high when the commanded action has completed successfully. If another block takes control before the action is completed, the Done output will not be set. This output is reset when Execute goes low. | |
| B | Busy | BOOL | Set high upon the rising edge of the Execute input, and reset when Done, CommandAborted, or Error is true. In the case of a function block with an Enable input, a Busy output indicates the function is operating, but not ready to provide Valid information. (No Error) | |
| B | Message | STRING | Text associated with the supplied Inp_ErrorID. If the value is not found "Unknown Alarm" will be returned. | |