Y_PostUserAlarm
The Y_PostUserAlarm writes application specific alarms to the system, e.g. the WebUI.
Parameters
| * | Parameter | Data Type | Description | Default |
|---|---|---|---|---|
| VAR_INPUT | ||||
| B | Execute | 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 | AlarmErrorID | UINT | Lower 16-bits of alarm code to be posted (upper 16-bits are defined by the system) | |
| V | AlarmSource | STRING | Description of the alarm source. Only the first 15 characters are displayed in the alarm history. | |
| 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 | Error | BOOL | Set high if an error has occurred during the execution of the function block. This output is cleared when 'Execute' or 'Enable' goes low. | |
| E | ErrorID | UINT | If Error is true, this output provides the Error ID. This output is reset when 'Execute' or 'Enable' goes low. | |
Notes
The following alarm information is provided automatically by the firmware:
- Time Stamp
- Error Class(indicating custom user alarm.)
Operation:
- When the function block is executed, an alarm is posted to the system, viewable in the active alarm list (until cleared) and in the alarm history. Executing the function block multiple times will result in multiple alarm instances.
- Because this feature does not generate motion specific alarms, motion is not stopped or affected in any way.
Example
Executing the following function block results in the user alarm being posted to the WebUI as shown. The AlarmErrorID is input in decimal form (UINT#48879).
The controller's web UI will display the alarm as shown below:
The AlarmErrorID will show up on the web UI in hexadecimal form.
Error Description
See the
Function Block ErrorID List