SF_EmergencyStop (FB) ¶ FUNCTION_BLOCK SF_EmergencyStop This function block is a safety-related function block for monitoring an emergency stop button. This Function block can be used for emergency switch off functionality (stop category 0), or - with additional peripheral support - as emergency stop (stop category 1 or 2). Function block according to PLCopen, Technical Committee 5: Safety Software (Technical Specification), Part 1: Concepts and Function Blocks, Version 2.01 (2020-2) InOut: Scope Name Type Initial Comment Input Activate BOOL FALSE Activation of the FB. S_EStopIn BOOL FALSE Safety demand input. S_StartReset BOOL FALSE Start behaviour of safety FB S_AutoReset BOOL FALSE Behaviour on error of safety FB Reset BOOL FALSE Manual reset of FB Output Ready BOOL FALSE Activation of the FB. TRUE indicates that the FB is activated and the outputs results are valid, FALSE the FB is not active and the program is not executed. S_EStopOut BOOL FALSE Output for the safety-related response. SafetyDemand BOOL FALSE Output indicating that the FB is active and the primary safety function is demanded (e.g. related to the safety functionality). ResetRequest BOOL FALSE Output which can be used to signal the operator to press the reset functionality to continue. Error BOOL FALSE Error flag DiagCode WORD 0 Diagnostic register
SF_Equivalent (FB) ¶ FUNCTION_BLOCK SF_Equivalent This function block converts two equivalent SAFEBOOL inputs (both NO or NC) to one SAFEBOOL output, includ-ing discrepancy time monitoring. This function block should not be used stand-alone since it has no restart interlock. It is required to connect the output to other safety related functionalities. Function block according to PLCopen, Technical Committee 5: Safety Software (Technical Specification), Part 1: Concepts and Function Blocks, Version 2.01 (2020-2) InOut: Scope Name Type Initial Comment Input Activate BOOL FALSE Activation of the FB. S_ChannelA BOOL FALSE Input A for logical connection. S_ChannelB BOOL FALSE Input B for logical connection. DiscrepancyTime TIME TIME#0ms Maximum monitoring time for discrepancy status of both inputs. Output Ready BOOL FALSE Activation of the FB. TRUE indicates that the FB is activated and the outputs results are valid, FALSE the FB is not active and the program is not executed. S_EquivalentOut BOOL FALSE Safety related output SafetyDemand BOOL FALSE Output indicating that the FB is active and the primary safety function is demanded (e.g. related to the safety functionality). Error BOOL FALSE Error flag DiagCode WORD 0 Diagnostic register
SF_ResetButton (FB) ¶ FUNCTION_BLOCK SF_ResetButton This function block adds the trailing edge functionality to all the function blocks with reset input with rising edge detection. This can be used to comply to EN ISO 13849-1:2015. Function block according to PLCopen, Technical Committee 5: Safety Software (Technical Specification), Part 1: Concepts and Function Blocks, Version 2.01 (2020-2) InOut: Scope Name Type Initial Comment Input ResetRequested BOOL TRUE Input which should be connected to the ResetRequest output of the paired FB. TRUE: ResetRequested, FALSE: No reset requested / no monitoring of ResetIn. ResetIn BOOL FALSE Input of reset button. FALSE: reset button released, TRUE: reset button actuated by operator. TrailingMinimum TIME TIME#350ms Minimum time that the reset switch has to be actuated. If the reset button is pushed shorter than this time, the reset is ignored. Absolut minimum value is 100msec. Minimum value 2 PLC cycles. Default value T#350MS TrailingMaximum TIME TIME#2s0ms Maximum time that the reset switch is actuated. Typical value can be around 2 sec. If the reset button is pushed longer than this time, the reset is ignored. Output Ready BOOL FALSE Activation of the FB. TRUE indicates that the FB is activated and the outputs results are valid, FALSE the FB is not active and the program is not executed. ResetOut BOOL FALSE Pulse for the initiation of the reset procedure. This pulse is generated after the falling edge. Pulse output with rising edge first. At least 1 cycle. Error BOOL FALSE Error flag DiagCode WORD ANY_TO_WORD(FBS_RESBUT.IDLE) Diagnostic register
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 12.04.2022, 15:21:24 companyName string 3S-Smart Software Solutions GmbH libraryFile PLCopenSafetyFBs.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 1 contentFile PLCopenSafetyFBs.clean.json version version 2.0.0.0 ProjectInformation AutoResolveUnbound bool True IsEndUserLibrary True Released True SIL2 True LastModificationDateTime date 12.04.2022, 15:21:24 LibraryCategories library-category-list Application|Safety SIL2 Author string 3S - Smart Software Solutions GmbH Company 3S - Smart Software Solutions GmbH CompiledLibraryCompatibilityVersion CODESYS V3.5 SP16 Patch 1 DefaultNamespace SFB Description See: Description DocFormat reStructuredText LanguageModelAttribute qualified-access-only Placeholder SafetyPLCopenSIL2 Project PLCopenSafetyFBs Title PLCopen Safety FBs Version version 3.5.18.0
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. Standard ¶ Library Identification ¶ Placeholder: Standard Default Resolution: Standard, * (System) Namespace: Standard Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Standard SysTimeCore ¶ Library Identification ¶ Placeholder: SysTimeCore Default Resolution: SysTimeCore, * (System) Namespace: SysTimeCore Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTimeCore
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 11.09.2023, 10:36:30 companyName string 3S-Smart Software Solutions GmbH libraryFile Azure IoT Hub Client SL.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile Azure IoT Hub Client SL.clean.json version version 2.0.0.0 ProjectInformation ActivateDongleLicensing bool False IsEndUserLibrary True OnlineHelp True Released True LastModificationDateTime date 11.09.2023, 10:36:27 FirmCode int 101597 ProductCode 8790 LibraryCategories library-category-list Application|Utils ActivationMail string support@codesys.com ActivationUrl http://license.codesys.com AlternativeFirmCodes 5000304 Author CODESYS Development GmbH AutoResolveUnbound True Company CODESYS CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 Patch 2 DefaultNamespace AZURE Description See: Description DocFormat reStructuredText DocLanguages en,de LanguageModelAttribute qualified-access-only Placeholder Azure_IoT_Hub_Client_SL Project Azure IoT Hub Client SL Title Azure IoT Hub Client SL Version version 1.9.0.0
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. CAA Behaviour Model ¶ Library Identification ¶ Placeholder: CAA Behaviour Model Default Resolution: CAA Behaviour Model, * (CAA Technical Workgroup) Namespace: CBM Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CAA Behaviour Model CAA FB Factory ¶ Library Identification ¶ Placeholder: CAA FB Factory Default Resolution: CAA FB Factory, * (CAA Technical Workgroup) Namespace: FBF Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CAA FB Factory CAA Types Extern ¶ Library Identification ¶ Placeholder: CAA Types Default Resolution: CAA Types Extern, * (CAA Technical Workgroup) Namespace: CAA Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CAA Types CmpCrypto ¶ Library Identification ¶ Placeholder: CmpCrypto Default Resolution: CmpCrypto, * (System) Namespace: CmpCrypto Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpCrypto Common Behaviour Model ¶ Library Identification ¶ Placeholder: CBML Default Resolution: Common Behaviour Model, * (3S - Smart Software Solutions GmbH) Namespace: CBML Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CBML Element Collections ¶ Library Identification ¶ Placeholder: ElementCollections Default Resolution: Element Collections, * (3S - Smart Software Solutions GmbH) Namespace: COL Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: ElementCollections MQTT Client SL ¶ Library Identification ¶ Placeholder: MQTT_Client_SL Default Resolution: MQTT Client SL, * (CODESYS) Namespace: MQTT Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: MQTT_Client_SL Library Parameter ¶ Parameter: G_UDIMAXAUTHDATASIZE = 256 Parameter: G_UDIMAXCORRELATIONDATASIZE = 256 Parameter: G_UDIMAXPACKETSIZE = 6000 Parameter: G_UDIMAXPAYLOADSIZE = 4096 Parameter: G_UDIMAXPUBLISHERSANDSUBSCRIBERS = 20 Parameter: G_UDIMAXQUEUEDPACKETS = 1000 Parameter: G_UDIMAXRECEIVEBUFFERSIZE = g_udiMaxPacketSize Parameter: G_UDIMAXUSERPROPERTIES = 10 Parameter: G_UDIMAXUSERPROPERTYVALUELENGTH = 80 Parameter: G_UIMAXTOPICLEVEL = 10 Net Base Services ¶ Library Identification ¶ Placeholder: NetBaseSrv Default Resolution: Net Base Services, * (3S - Smart Software Solutions GmbH) Namespace: NBS Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: NetBaseSrv 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 SysTime ¶ Library Identification ¶ Name: SysTime Version: 3.5.9.0 Company: System Namespace: SysTime Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTime, 3.5.9.0 (System) 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) Util ¶ Library Identification ¶ Placeholder: Util Default Resolution: Util, * (System) Namespace: Util Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Util Library Parameter ¶ Parameter: IBLOCKSIZE = 22800 Web Client SL ¶ Library Identification ¶ Placeholder: Web_Client_SL Default Resolution: Web Client SL, * (CODESYS) Namespace: WEB_CLIENT Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: Web_Client_SL Library Parameter ¶ Parameter: G_UDIMAXHEADERSIZE = 4000 Parameter: G_UDIMAXOAUTH2TOKENSIZE = 2048 Parameter: G_UDIMAXREQUESTSIZE = 16000 Parameter: G_UDIMAXRESPONSESIZE = 16000
MaxOnTime (FB) ¶ FUNCTION_BLOCK MaxOnTime “warp clock”-enabled maximum on-time. If xInput is TRUE MaxOnTime set xOutput to TRUE not longer then tMaxOn. After tMaxOn is expired xOutput is set to FALSE and a new rising edge of xInput is needed to restart the maximum on-time again. “Warp clock”-enabled ¶ Certain application domains base their functionality / algorithms on real world wall clock date/time. To develop such functionality it is helpful to have control over the application timeline to speedup testing or doesnt loose control on the timeline sitting on breakpoints. WarpClock and “warp clock”-enabled function blocks provides such a control if needed. For more details about “warp” time see WarpClock . To use “warp” time connect an accordingly configured WarpClock to itfDateTimeProvider. InOut: Scope Name Type Initial Comment Input xInput BOOL FALSE Input tMaxOn TIME TIME#0ms Maximum on-time xReset BOOL FALSE Reset itfDateTimeProvider Util.IDateTimeProvider Globals.g_dtpDateTimeProvider Source for the current date and time information in milliseconds since 1.1.1970 00:00:00.000 Output xOutput BOOL Output xError BOOL Error indication eErrorID Error Error ID
GetDeviceTwin (FB) ¶ FUNCTION_BLOCK GetDeviceTwin EXTENDS CBM.ETrigTo Reads the device twin from the Microsoft AZURE IoT Hub via HTTPS. InOut: Scope Name Type Comment Inherited from Input xExecute BOOL Rising edge: Action starts Falling edge: Resets outputs If a falling edge occurs before the function block has completed its action, the outputs operate in the usual manner and are only reset if either the action is completed or in the event of an error. In this case, the corresponding output values ( xDone , xError ) are present at the outputs for exactly one cycle. ETrigTo udiTimeOut UDINT Defines the time (µs) after which an FB (e.g. requiring an external acknowledgement) aborts operation due to a timeout with error message. ETrigTo Output xDone BOOL TRUE : Action successfully completed ETrigTo xBusy BOOL TRUE : Function block active ETrigTo xError BOOL TRUE : Error occurred, function block aborts action FALSE : No error ETrigTo Input sHubDomainName STRING(255) Domain name of the IoT Hub sDeviceId STRING(255) Device ID wsSaS WSTRING(255) Shared Access Signature (SAS Token) Output eError IOT_HUB_CLIENT_ERROR Error code iHttpStatus INT HTTP status wsData WSTRING(WEB_CLIENT.g_udiMaxResponseSize) The device twin (JSON data)
UpdateDeviceTwin (FB) ¶ FUNCTION_BLOCK UpdateDeviceTwin EXTENDS CBM.ETrigTo Update the device twin (desired properties only!) via HTTPS. InOut: Scope Name Type Comment Inherited from Input xExecute BOOL Rising edge: Action starts Falling edge: Resets outputs If a falling edge occurs before the function block has completed its action, the outputs operate in the usual manner and are only reset if either the action is completed or in the event of an error. In this case, the corresponding output values ( xDone , xError ) are present at the outputs for exactly one cycle. ETrigTo udiTimeOut UDINT Defines the time (µs) after which an FB (e.g. requiring an external acknowledgement) aborts operation due to a timeout with error message. ETrigTo Output xDone BOOL TRUE : Action successfully completed ETrigTo xBusy BOOL TRUE : Function block active ETrigTo xError BOOL TRUE : Error occurred, function block aborts action FALSE : No error ETrigTo Input sHubDomainName STRING(255) Domain name of the IoT Hub sDeviceId STRING(255) Device ID wsSaS WSTRING(255) Shared Access Signature (SAS Token) pwsData POINTER TO WSTRING The device twin properties to update (Input, JSON format) Output eError IOT_HUB_CLIENT_ERROR Error code iHttpStatus INT HTTP status wsDeviceTwinInfo WSTRING(WEB_CLIENT.g_udiMaxResponseSize) Last device twin info (Output, JSON format)