CmpOPCUAProviderAlarmConfiguration Library Documentation ¶ Company : System Title : CmpOPCUAProviderAlarmConfiguration Version : 3.5.19.50 Categories : System|SysLibs Author : 3S - Smart Software Solutions GmbH Placeholder : CmpOPCUAProviderAlarmConfiguration Description [ 1 ] ¶ This library connects the CODESYS Alarm Configuration with the CODESYS OPC UA Server. If this library is inserted it will automatically connect to alarm configuration as a client and send the events to the OPC UA Server. The OPC UA server then sends the events to the clients which are monitoring events. Note Nothing expect adding this library has to be done by the user. This library doesn’t contain any functions or interfaces wich are intended to be called from the user application code. Note The current implementation requires that the application contains a symbolconfiguration. If this object is not available the mapping will not work and the events will not be sent to the OPC UA client. If no symbols of the application are required just add the editor and clear the selection inside the editor. Note The Alarmconfiguration requires that a visualization is added. If no visualization is added the no message texts will be available. How alarms and events are added to the OPC UA server is described here: ¶ If the application contains an alarm configuration and this library is added this application will be registred as an event source at the OPC UA server. The application will have the SubscribeToEvent flag set if this library is added. The application will be put into the OPC UA servers eventing infrastructure to allow proper handling of the event. If an event or alarm is triggered by the alarm configuration this alarm will be sent to the OPC UA server. The corresponding application node will be used as the event source inside the OPC UA server. #. The event will be transported to the OPC UA server node (id:2253) via the PLC node (e.g. CODESYS Control Win V3). So the event will be sent to clients subscribed to the application node, the PLC Node or the servernode. This library connects the CODESYS Alarm Configuration with the CODESYS OPC UA Server. If this library is inserted it will automatically connect to alarm configuration as a client and send the events to the OPC UA Server. The OPC UA server then sends the events to the clients which are monitoring events. Note Nothing expect adding this library has to be done by the user. This library doesn’t contain any functions or interfaces wich are intended to be called from the user application code. Note The current implementation requires that the application contains a symbolconfiguration. If this object is not available the mapping will not work and the events will not be sent to the OPC UA client. If no symbols of the application are required just add the editor and clear the selection inside the editor. How alarms and events are added to the OPC UA server is described here: ¶ If the application contains an alarm configuration and this library is added this application will be registred as an event source at the OPC UA server. The application will have the SubscribeToEvent flag set if this library is added. The application will be put into the OPC UA servers eventing infrastructure to allow proper handling of the event. If an event or alarm is triggered by the alarm configuration this alarm will be sent to the OPC UA server. The corresponding application node will be used as the event source inside the OPC UA server. The event will be transported to the OPC UA server node (id:2253) via the PLC node (e.g. CODESYS Control Win V3). So the event will be sent to clients subscribed to the application node, the PLC Node or the servernode. Mapping of events: ¶ The events of the alarm configuration are mapped to the BaseEventType of OPC UA. EventID: Combined by the Providers component ID, the application ID and the events internal ID. EventType: BaseEventType SourceNode: NodeId of the application which fired the event. SourceName: Name of the application which fired the event. Time: Timestamp when the event occured. Message: Message hold by the event. Severity: The conversion is done using the following rule: (1000 - (priority * (999.0/255))). This converts the Alarmmanager range (255 (low) to 0 (high) into the OPC UA range 1(low) to 1000(high)). If this mapping is not appropriate for your needs, use the SetCustomMapping function to set your own mapping. ReceiveTime: Will be filled up by the server automatically. Mapping of alarms: ¶ Alarms are mapped accordung to OPC UA Alarms and Conditions (Part 9). Mapping of EventTypes Acknowledgement method OPC UA EventType REP ConditionType ACK AcknowledgeableConditionType REP_ACK AlarmConditionType ACK_REP AlarmConditionType ACK_REP_ACK AlarmConditionType Acknowledge and Confirm is possible by an OPC UA Client ConditionRefresh is supported to allow clients to synchronize to the current state of the alarms. Contents: ¶ Curstom Mapping ICustomAlarmToOpcUaMapping (Interface) SetCustomMapping (Function) Indices and tables ¶ [ 1 ] Based on CmpOPCUAProviderAlarmConfiguration.library, last modified 27.11.2023, 18:00:35. LibDoc 4.4.0.0-b.37 The content file CmpOPCUAProviderAlarmConfiguration.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 27.11.2023, 18:00:39.
Curstom Mapping ¶ ICustomAlarmToOpcUaMapping (Interface) MapPriority (Method) SetCustomMapping (Function)
ICustomAlarmToOpcUaMapping (ITF) ¶ INTERFACE ICustomAlarmToOpcUaMapping This interface is used to register a custom set of methods used to convert events into the OPC UA value range. Methods: MapPriority Structure: MapPriority (Method)
ICustomAlarmToOpcUaMapping.MapPriority (METH) ¶ METHOD MapPriority : UDINT This function is called to convert he priority of the AlarmConfiguration (0 (highest) .. 255(lowest)) into the OPC UA severity range (1(lowest) .. 1000(highest)). InOut: Scope Name Type Return MapPriority UDINT Input SeverityAlarm USINT
SetCustomMapping (FUN) ¶ FUNCTION SetCustomMapping This functions is used to setup the custom mapping interface. InOut: Scope Name Type Input iMapping ICustomAlarmToOpcUaMapping
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 27.11.2023, 18:00:39 companyName string 3S-Smart Software Solutions GmbH libraryFile CmpOPCUAProviderAlarmConfiguration.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile CmpOPCUAProviderAlarmConfiguration.clean.json version version 2.0.0.0 ProjectInformation Released bool True LastModificationDateTime date 27.11.2023, 18:00:35 LibraryCategories library-category-list System|SysLibs Author string 3S - Smart Software Solutions GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP16 DefaultNamespace Description See: Description DocFormat reStructuredText LanguageModelAttribute qualified-access-only Placeholder CmpOPCUAProviderAlarmConfiguration Project CmpOPCUAProviderAlarmConfiguration Title CmpOPCUAProviderAlarmConfiguration Version version 3.5.19.50
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. AlarmManager ¶ Library Identification ¶ Placeholder: AlarmManager Default Resolution: AlarmManager, * (Intern) Namespace: AlarmManager Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: AlarmManager Library Parameter ¶ Parameter: COUNT_ROWS_TO_CHECK_FOR_OLDEST_ALARMS = 50 Parameter: PLACEHOLDER_VALUE_LENGTH = (ANY_TO_INT(60) * ANY_TO_INT(2)) CmpApp ¶ Library Identification ¶ Placeholder: CmpApp Default Resolution: CmpApp, * (System) Namespace: CmpApp Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpApp CmpEventMgr ¶ Library Identification ¶ Placeholder: CmpEventMgr Default Resolution: CmpEventMgr, * (System) Namespace: CmpEventMgr Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpEventMgr CmpOPCUAStack ¶ Library Identification ¶ Name: CmpOPCUAStack Version: 3.5.17.0 Company: System Namespace: CmpOPCUAStack Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpOPCUAStack, 3.5.17.0 (System) Component Manager ¶ Library Identification ¶ Placeholder: Component Manager Default Resolution: Component Manager, * (System) Namespace: Component_Manager Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Component Manager Standard ¶ Library Identification ¶ Placeholder: Standard Default Resolution: Standard, * (System) Namespace: Standard Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Standard StringUtils ¶ Library Identification ¶ Placeholder: StringUtils Default Resolution: StringUtils, * (System) Namespace: Stu Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: StringUtils SysMem ¶ Library Identification ¶ Placeholder: SysMem Default Resolution: SysMem, * (System) Namespace: SysMem Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysMem SysTask ¶ Library Identification ¶ Placeholder: SysTask Default Resolution: SysTask, * (System) Namespace: SysTask Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTask SysTypes2 Interfaces ¶ Library Identification ¶ Name: SysTypes2 Interfaces Version: newest Company: System Namespace: SysTypes Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTypes2 Interfaces, * (System)
OpcUaObjectDescription (STRUCT) ¶ TYPE OpcUaObjectDescription : STRUCT InOut: Name Type Comment eventNotifier OpcUa_Byte [m]: Field which kind of events are available.
OpcUaObjectTypeDescription (STRUCT) ¶ TYPE OpcUaObjectTypeDescription : STRUCT InOut: Name Type Comment isAbstract OpcUa_Boolean [m]: Flag if is an abstract ObjectType.
OpcUaReferenceTypeDescription (STRUCT) ¶ TYPE OpcUaReferenceTypeDescription : STRUCT InOut: Name Type Comment isAbstract OpcUa_Boolean [m]: Flag if is an abstract RefereceType. symmetric OpcUa_Boolean [m]: Flag if this is a symmetric reference. bInverseNameSet OpcUa_Boolean [m]: Flag if the inverse name is set. inverseName OpcUa_LocalizedText [o]: Inverse name of the reference.