Functions
LaxEdge
Raises an alarm that will not be reset by the PLC code. The alarm will be reset when the user acknowledges it.
| Name | Type | Description |
|---|---|---|
| Alarm | Lax_Alarm_typ | Structure containing the alarm details |
LaxEdgeSnippet
Raises an alarm that will not be reset by the PLC code. The alarm will be reset when the user acknowledges it. This function also includes a snippet to use with the alarm.
| Name | Type | Description |
|---|---|---|
| Alarm | Lax_Alarm_typ | Structure containing the alarm details |
| Snippet | STRING[LAX_MAX_TEXT_LEN] | Snippet to be added to the alarm |
LaxLevel
Sets the alarm active or inactive based on a boolean value. This function should be called cyclically to ensure the alarm is set correctly.
| Name | Type | Description |
|---|---|---|
| Alarm | Lax_Alarm_typ | Structure containing the alarm details |
| Level | BOOL | Level to be set (TRUE or FALSE) |
LaxLevelSnippet
Sets the alarm active or inactive based on a boolean value. This function should be called cyclically to ensure the alarm is set correctly. This version includes a snippet to use with the alarm.
| Name | Type | Description |
|---|---|---|
| Alarm | Lax_Alarm_typ | Structure containing the alarm details |
| Level | BOOL | Level to be set (TRUE or FALSE) |
| Snippet | STRING[LAX_MAX_TEXT_LEN] | Snippet to be added to the alarm |
LaxLevelID
Sets the level of the Lax alarm with an additional ID. This function should be called cyclically to ensure the alarm is set correctly. This version includes a user-provided ID, so that 1 alarm can be used for multiple instances.
| Name | Type | Description |
|---|---|---|
| Alarm | Lax_Alarm_typ | Structure containing the alarm details |
| Level | BOOL | Level to be set (TRUE or FALSE) |
| ID | REFERENCE TO UDINT | Reference to store the ID |
LaxLevelSnippetID
Sets the level of the Lax alarm with additional snippet and ID. This function should be called cyclically to ensure the alarm is set correctly. This version includes a user provided ID, so that 1 alarm can be used for multiple instances. This version includes a snippet to use with the alarm.
| Name | Type | Description |
|---|---|---|
| Alarm | Lax_Alarm_typ | Structure containing the alarm details |
| Level | BOOL | Level to be set (TRUE or FALSE) |
| Snippet | STRING[LAX_MAX_TEXT_LEN] | Snippet to be added to the alarm |
| ID | REFERENCE TO UDINT | Reference to store the ID |
LaxAcknowledged
Checks if the Lax alarm has been acknowledged.
| Name | Type | Description |
|---|---|---|
| Alarm | Lax_Alarm_typ | Structure containing the alarm details |
LaxAcknowledgedID
Checks if the Lax alarm has been acknowledged. This version includes a user-provided ID, so that 1 alarm can be used for multiple instances.
| Name | Type | Description |
|---|---|---|
| Alarm | Lax_Alarm_typ | Structure containing the alarm details |
| ID | UDINT | ID of the alarm to be checked |
LaxCreateAlarms
Creates alarms that have been added to the Lax configuration.
| Name | Type | Description |
|---|---|---|
| Config | Lax_Config_typ | Lax data structure storing transient info |
LaxCreateTmx
Creates Lax Tmx (text system) file for the alarms with the messages and snippets that have been added to the Lax configuration.
| Name | Type | Description |
|---|---|---|
| Config | Lax_Config_typ | Lax data structure storing transient info |
LaxSetDefaultBehavior
Sets the default behavior for a specific Lax alarm type.
| Name | Type | Description |
|---|---|---|
| AlarmBehavior | MpAlarmXBehaviorType | Default behavior for the alarm type |
| AlarmType | LAX_ALARM_TYPE_enum | Type of the alarm |
LaxSetCustomBehavior
Sets custom behavior for a specific Lax alarm type.
| Name | Type | Description |
|---|---|---|
| AlarmBehavior | MpAlarmXBehaviorType | Custom behavior for the alarm type |
| AutoReset | BOOL | Auto-reset flag |
| Acknowledge | MpAlarmXAcknowledgeConfigEnum | Acknowledge configuration |
| MultipleInstances | BOOL | Multiple instances flag |
| ReactionUntilAcknowledged | BOOL | Reaction until acknowledged flag |
| Retain | BOOL | Retain flag |
| Async | BOOL | Asynchronous flag |
LaxAddAlarm
Adds an alarm to the Lax system.
| Name | Type | Description |
|---|---|---|
| Config | Lax_Config_typ | Lax data structure storing transient info |
| AlarmType | LAX_ALARM_TYPE_enum | Type of the alarm |
| Alarm | Lax_Alarm_typ | Structure containing the alarm details |
| Code | UDINT | Alarm code |
| Severity | UDINT | Severity level of the alarm |
| Message | STRING[LAX_MAX_TEXT_LEN] | Default Alarm message added to the TMX file |
| AdditionalInfo1 | STRING[LAX_MAX_TEXT_LEN] | Additional information |
| Behavior | MpAlarmXBehaviorType | Behavior type of the alarm |
LaxAddSnippet
Adds a snippet to the Lax configuration.
| Name | Type | Description |
|---|---|---|
| Config | Lax_Config_typ | Lax data structure storing transient info |
| Key | STRING[LAX_MAX_SNIPPET_KEY_LEN] | Snippet key |
| Value | STRING[LAX_MAX_PV_NAME_LEN] | PV Name |
LaxSetDefaultAlarmCore
Sets the default alarm core for alarms where one is not provided.
| Name | Type | Description |
|---|---|---|
| mpLink | MpComIdentType | Communication identifier for the MpLink |
LaxQueueAlarm
Queues an alarm in Lax. This is an internal function for storing alarms that are raised before creating and should not be used by the user.
| Name | Type | Description |
|---|---|---|
| Alarm | Lax_Alarm_typ | Structure containing the alarm details |
| Snippet | STRING[LAX_MAX_TEXT_LEN] | Snippet to be added to the alarm |
| ID | REFERENCE TO UDINT | Reference to store the ID |
LaxDequeueAlarm
Dequeues an alarm from Lax. This function should be called after the alarms are created and the alarms should be added using LaxEdge.
| Name | Type | Description |
|---|---|---|
| Alarm | REFERENCE TO Lax_Alarm_typ | Reference to store the dequeued alarm |
The Following functions may work, but have not been fully fleshed out and tested.
LaxAddCategory
Adds a category to the Lax configuration.
| Name | Type | Description |
|---|---|---|
| Config | Lax_Config_typ | Lax data structure storing transient info |
| Name | STRING[LAX_MAX_NAME_LEN] | Category name |
| DefinedBy | LAX_CATEGORY_TYPE_enum | Type defining the category |
| ValueRange | STRING[LAX_MAX_VALUE_LEN] | Value range for the category |
LaxAddMappingByName
Adds a mapping by name to the Lax configuration. (Note: This functions has not been well tested. Mappings can be added using the static configuration file)
| Name | Type | Description |
|---|---|---|
| Config | Lax_Config_typ | Lax data structure storing transient info |
| Name | STRING[LAX_MAX_NAME_LEN] | Name for the mapping |
| ActionType | MpAlarmXActionEnum | Action type for the mapping |
| ActionUseName | STRING[LAX_MAX_NAME_LEN] | Action use name for the mapping |
LaxAddMappingBySeverity
Adds a mapping by severity to the Lax configuration. (Note: This functions has not been well tested. Mappings can be added using the static configuration file)
| Name | Type | Description |
|---|---|---|
| Config | Lax_Config_typ | Lax data structure storing transient info |
| Severity | UDINT | Severity for the mapping |
| ActionType | MpAlarmXActionEnum | Action type for the mapping |
| ActionUseName | STRING[LAX_MAX_NAME_LEN] | Action use name for the mapping |
LaxAddDefaultMapping
Adds a default mapping to the Lax configuration. (Note: This functions has not been well tested. Mappings can be added using the static configuration file)
| Name | Type | Description |
|---|---|---|
| Config | Lax_Config_typ | Lax data structure storing transient info |
| ActionType | MpAlarmXActionEnum | Action type for the mapping |
| ActionUseName | STRING[LAX_MAX_NAME_LEN] | Action use name for the mapping |