Functions ¶ Helper function to handle module calls. RaiseModuleEvent (Function) ReplaceAlarmPlaceholderString (Function)

RaiseModuleEvent (FUN) ¶ FUNCTION RaiseModuleEvent : BOOL This function raises an event that has been configured as Event-Alarm of an Module-Instance InOut: Scope Name Type Comment Return RaiseModuleEvent BOOL Input itfAlarmHandler AlarmManager.IAlarmHandler The alarm handler that shall raise an alarm. If this parameter is 0 g_AlarmHandler from AlarmManager library is used inst AC.IModule The module instance that defines the Event-Alarm pEventID POINTER TO STRING The Target of the Event-Alarm in the module description

ReplaceAlarmPlaceholderString (FUN) ¶ FUNCTION ReplaceAlarmPlaceholderString : STRING This function can be used to replace placeholders in a message (i.e. latch variables as “LATCHVAR1” or “LATCHVAR2”) by some strings. This function can be used to get the resulting alarm message for display when getting a module call after an alarm was issued. InOut: Scope Name Type Comment Return ReplaceAlarmPlaceholderString STRING The replaced string. Input strMessage STRING Message which has a placeholder to be replaced strPlaceholder STRING The placeholder strReplacement STRING The string the placeholder shall be replaced with

GlobalTextList (Text List) ¶ ID Default en de 1 ACK all visible ACK all visible Alle sichtbaren Alarme bestätigen 0 ACK selected ACK selected Selektierte Alarme bestätigen 3 Freeze Scrl Pos Freeze Scrl Pos Scrl Position einfrieren 2 History History Historie

ModuleInterface ¶ Interfaces used by the alarm generator in order to define and get module calls. IModuleAlarming (Interface) ConsumeModuleAlarm (Method)

IModuleAlarming (ITF) ¶ INTERFACE IModuleAlarming EXTENDS __System.IQueryInterface Interface used to make a module function block to be callable after an alarm was issued. Implement this interface in your module function block in order to get a callable module function block, which can get module calls after an alarm was issued. Methods: ConsumeModuleAlarm Structure: ConsumeModuleAlarm (Method)

IModuleAlarming.ConsumeModuleAlarm (METH) ¶ METHOD ConsumeModuleAlarm : BOOL This method is called is an alarm was issued for a module which defined a module call. If true is returned the alarm was consumed by this function and will be no further treated. This means returning true will stop the transmission of this alarm to other modules. If false is returned other modules will still be alarmed InOut: Scope Name Type Comment Return ConsumeModuleAlarm BOOL True is returned if the alarm does not need to be issued further (i.e. by the module parents), or false if it needs to be issued further. Input inst AC.IModule The module instance for which the alarm was issued alarm AlarmManager.IAlarm The alarm for which a transition occured (see the AlarmManager library for details) transition AlarmManager.AlarmStateTransition The transition type, which occured for the alarm (see the AlarmManager library for details)

File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 24.05.2022, 17:08:39 companyName string 3S-Smart Software Solutions GmbH libraryFile AC_Alarming.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile AC_Alarming.clean.json version version 2.0.0.0 ProjectInformation Released bool True LastModificationDateTime date 24.05.2022, 17:08:38 LibraryCategories library-category-list Application|Composer Author string 3S - Smart Software Solutions GmbH Company 3S - Smart Software Solutions GmbH CompiledLibraryCompatibilityVersion CODESYS V3.5 SP16 DefaultNamespace AC_Alarming Description See: Description DocFormat reStructuredText LanguageModelAttribute qualified-access-only Placeholder AC_Alarming Project AC_Alarming Title AC_Alarming Version version 4.1.0.0

Visualization ¶ Visualization template(s) used by the alarm generator to generate a visualization.

Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. AC_ModuleBase ¶ Library Identification ¶ Placeholder: AC_ModuleBase Default Resolution: AC_ModuleBase, * (3S - Smart Software Solutions GmbH) Namespace: AC Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: AC_ModuleBase 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)) StringUtils ¶ Library Identification ¶ Placeholder: StringUtils Default Resolution: StringUtils, * (System) Namespace: Stu Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: StringUtils VisuElem3DPath ¶ Library Identification ¶ Placeholder: System_VisuElem3DPath Default Resolution: VisuElem3DPath, 3.5.14.0 (System) Namespace: VisuElem3DPath Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuElem3DPath Library Parameter ¶ Parameter: GC_POINTS_PER_POLYGON = 100 VisuElemCamDisplayer ¶ Library Identification ¶ Placeholder: System_VisuElemCamDisplayer Default Resolution: VisuElemCamDisplayer, 3.5.14.0 (System) Namespace: VisuElemCamDisplayer Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuElemCamDisplayer Library Parameter ¶ Parameter: GC_POINTS_PER_CAM = 100 VisuElemMeter ¶ Library Identification ¶ Placeholder: System_VisuElemMeter Default Resolution: VisuElemMeter, 3.5.14.0 (System) Namespace: VisuElemMeter Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuElemMeter VisuElemTextEditor ¶ Library Identification ¶ Placeholder: System_VisuElemTextEditor Default Resolution: VisuElemTextEditor, 3.5.14.0 (System) Namespace: VisuElemTextEditor Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuElemTextEditor VisuElemTrace ¶ Library Identification ¶ Placeholder: System_VisuElemTrace Default Resolution: VisuElemTrace, 3.5.14.0 (System) Namespace: VisuElemTrace Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuElemTrace VisuElemXYChart ¶ Library Identification ¶ Placeholder: System_VisuElemXYChart Default Resolution: VisuElemXYChart, 3.5.14.0 (System) Namespace: VisuElemXYChart Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuElemXYChart VisuElems ¶ Library Identification ¶ Placeholder: System_VisuElems Default Resolution: VisuElems, 3.5.14.0 (System) Namespace: VisuElems Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuElems VisuElemsAlarm ¶ Library Identification ¶ Placeholder: System_VisuElemsAlarm Default Resolution: VisuElemsAlarm, 3.5.14.0 (System) Namespace: VisuElemsAlarm Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuElemsAlarm VisuElemsDateTime ¶ Library Identification ¶ Placeholder: System_VisuElemsDateTime Default Resolution: VisuElemsDateTime, 3.5.14.0 (System) Namespace: VisuElemsDateTime Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuElemsDateTime VisuElemsSpecialControls ¶ Library Identification ¶ Placeholder: System_VisuElemsSpecialControls Default Resolution: VisuElemsSpecialControls, 3.5.14.0 (System) Namespace: VisuElemsSpecialControls Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuElemsSpecialControls VisuElemsWinControls ¶ Library Identification ¶ Placeholder: System_VisuElemsWinControls Default Resolution: VisuElemsWinControls, 3.5.14.0 (System) Namespace: VisuElemsWinControls Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuElemsWinControls VisuInputs ¶ Library Identification ¶ Placeholder: system_visuinputs Default Resolution: VisuInputs, 3.5.16.0 (System) Namespace: visuinputs Library Properties ¶ LinkAllContent: False Optional: False PublishSymbolsInContainer: True QualifiedOnly: False SystemLibrary: True Key: system_visuinputs VisuNativeControl ¶ Library Identification ¶ Placeholder: System_VisuNativeControl Default Resolution: VisuNativeControl, 3.5.14.0 (System) Namespace: VisuNativeControl Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuNativeControl