Gloabal Constant ¶ Gloabal_Constant (GVL)

Gloabal_Constant (GVL) ¶ Attributes: qualified_only InOut: Scope Name Type Initial Comment Constant gc_MaxJWTSize UINT 2047 Max imum size of JWT. Default 2047 => 2048 Bit long JWT

File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 11.09.2023, 10:39:02 companyName string 3S-Smart Software Solutions GmbH libraryFile JSON Web Token SL.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile JSON Web Token SL.clean.json version version 2.0.0.0 ProjectInformation OnlineHelp bool True Released True LastModificationDateTime date 11.09.2023, 10:39:00 LibraryCategories library-category-list Application|Utils Author string CODESYS Development GmbH Company CODESYS CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 Patch 2 DefaultNamespace JWT Description See: Description DocFormat reStructuredText DocLanguages en,de LanguageModelAttribute qualified-access-only Placeholder JSON_Web_Token_SL Project JSON Web Token SL Title JSON Web Token SL Version version 1.9.0.0

Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. 3SLicense ¶ Library Identification ¶ Placeholder: 3SLicense Default Resolution: 3SLicense, * (3S - Smart Software Solutions GmbH) Namespace: _3S_LICENSE Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: 3SLicense CmpCrypto ¶ Library Identification ¶ Placeholder: CmpCrypto Default Resolution: CmpCrypto, * (System) Namespace: CmpCrypto Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpCrypto CmpErrors2 Interfaces ¶ Library Identification ¶ Name: CmpErrors2 Interfaces Version: newest Company: System Namespace: CmpErrors Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpErrors2 Interfaces, * (System) CmpLog ¶ Library Identification ¶ Placeholder: CmpLog Default Resolution: CmpLog, * (System) Namespace: CmpLog Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpLog CmpX509Cert ¶ Library Identification ¶ Placeholder: CmpX509Cert Default Resolution: CmpX509Cert, * (System) Namespace: CmpX509Cert Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpX509Cert 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 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 JSON Utilities SL ¶ Library Identification ¶ Placeholder: JSON_Utilities_SL Default Resolution: JSON Utilities SL, * (CODESYS) Namespace: JSON Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: JSON_Utilities_SL Library Parameter ¶ Parameter: G_DIMAXDEPTH = 50 Parameter: G_DIMAXELEMENTS = 4096 Parameter: G_DIMAXFILESIZE = 32000 Parameter: G_DIMAXSTRINGSIZE = 255 Standard ¶ Library Identification ¶ Placeholder: Standard Default Resolution: Standard, * (System) Namespace: Standard Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Standard String Util Intern ¶ Library Identification ¶ Placeholder: String_Util_Intern Default Resolution: String Util Intern, * (CODESYS) Namespace: MSU Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: String_Util_Intern 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) 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

MQTTPublishProperties (STRUCT) ¶ TYPE MQTTPublishProperties : STRUCT Publish properties (MQTT V5) The structure is used for sending and receiving properties. Notice: Some fields are only relevant for the publisher or the subscriber. InOut: Name Type Comment bPayloadFormatIndicator BYTE Payload Format: 0: Binary Data, 1: UTF-8 (relevant for publisher and subscriber) udiMessageExpiryInterval UDINT Expiry interval of the message in seconds (relevant for publisher and subscriber) wsContentType WSTRING MIME style content type of the payload (relevant for publisher and subscriber) wsResponseTopic WSTRING(1024) Some applications or standards might wish to run a Request/Response interaction over MQTT. The Resopnse Topic can be used for this purpose. (relevant for publisher and subscriber) udiCorrelationDataSize UDINT Size of the correlation data buffer |paCorrelationData| (relevant for publisher and subscriber) paCorrelationData POINTER TO BYTE Pointer to correlation data buffer. The Correlation Data is used by the sender of the Request Message to identify which request the Response Message is for when it is received. (relevant for publisher and subscriber) udiSubscriptionIdentifier UDINT The subscription identifier of the last received message (see output of the subscriber function block). The subscription identifier can be set via MQTTSubscribeProperties.udiSubscriptionIdentifier. The identifier has no effect for the publisher function block. (relevant for the subscriber) uiTopicAlias UINT A Topic Alias is an integer value that is used to identify the Topic instead of using the Topic Name. If a Topic Alias mapping has been set at the receiver (the broker), a sender can send a PUBLISH packet that contains that Topic Alias and a zero length Topic Name. The receiver (the broker) then treats the incoming PUBLISH as if it had contained the Topic Name of the Topic Alias. The Topic Alias has no effect for the subscriber function block and is not transferd from the broker to the subscriber. (relevant for the publisher) userProperties ARRAY [0..(MQTTParam.g_udiMaxUserProperties - 1)] OF MQTTStringPair User defined properties (relevant for publisher and subscriber)

MQTTStringPair (STRUCT) ¶ TYPE MQTTStringPair : STRUCT Key-value pair for user properties (MQTT V5) InOut: Name Type Comment wsKey WSTRING(MQTTParam.g_udiMaxUserPropertyValueLength) The key wsValue WSTRING(MQTTParam.g_udiMaxUserPropertyValueLength) The value

MQTTSubscribeProperties (STRUCT) ¶ TYPE MQTTSubscribeProperties : STRUCT Subscribe properties (MQTT V5) InOut: Name Type Comment udiSubscriptionIdentifier UDINT The subscription identifier will be returned on the message when it is delivered. This allows the Client to determine which subscription or subscriptions caused the message to be delivered. Setting the identifier accelerates the filtering of the telegrams in the subscriber function block. udiCorrelationDataSize UDINT Size of the correlation data receive buffer |paCorrelationData| paCorrelationData POINTER TO BYTE Pointer to correlation data reveive buffer. The Correlation Data is used by the sender of the Request Message to identify which request the Response Message is for when it is received. userProperties ARRAY [0..(MQTTParam.g_udiMaxUserProperties - 1)] OF MQTTStringPair User defined properties xNoLocalOption BOOL No Local option If the value is TRUE, Application Messages MUST NOT be forwarded to a connection with a ClientID equal to the ClientID of the publishing connection xRetainAsPublished BOOL Retain As Published option If TRUE, Application Messages forwarded using this subscription keep the RETAIN flag they were published with. eRetainHandling MQTT_RETAIN_HANDLING This option specifies 2135 whether retained messages are sent when the subscription is established.

MQTTWillProperties (STRUCT) ¶ TYPE MQTTWillProperties : STRUCT Will properties (MQTT V5) InOut: Name Type Comment bPayloadFormatIndicator BYTE Payload Format: 0: Binary Data, 1: UTF-8 udiMessageExpiryInterval UDINT Expiry interval of the message in seconds wsContentType WSTRING MIME style content type of the payload wsResponseTopic WSTRING Some applications or standards might wish to run a Request/Response interaction over MQTT. The Resopnse Topic can be used for this purpose. udiCorrelationDataSize UDINT Size of the correlation data buffer |paCorrelationData| paCorrelationData POINTER TO BYTE Pointer to correlation data buffer. The Correlation Data is used by the sender of the Request Message to identify which request the Response Message is for when it is received. udiWillDelayInterval UDINT The Server delays publishing the Client’s Will Message until the Will Delay Interval (in seconds) has passed or the Session ends, whichever happens first. userProperties ARRAY [0..(MQTTParam.g_udiMaxUserProperties - 1)] OF MQTTStringPair User defined properties

OPC UA PubSub SL ¶ Aliases Function Blocks AsyncProperty (Alias) IPAddressSet (Alias) IPv4Address (Alias) ResolveHostname (Alias) IPADDRESS (Alias) Interfaces IAsyncProperty (Alias) IIPAddress (Alias) IIPAddressSet (Alias) ITSNContext (Alias) Constants IEC_TYPES (GVL) UDP (GVL) Enums BIT_OFFSET (Alias) BIT_SIZE (Enum) DiagnosticsClassification (Enum) DiagnosticsLevel (Enum) ERROR (Enum) STATE (Enum) Function Blocks Configuration (FunctionBlock) SetInitialValue (Method) Connection (FunctionBlock) SetInitialValue (Method) DataSet (FunctionBlock) PrepareValues (Method) SetInitialValue (Method) Diagnostics Base Diagnostics (Folder) DiagnosticsCounter (FunctionBlock) ConnectionDiagnostics (FunctionBlock) ReaderDiagnostics (FunctionBlock) ReaderGroupDiagnostics (FunctionBlock) RootDiagnostics (FunctionBlock) WriterDiagnostics (FunctionBlock) WriterGroupDiagnostics (FunctionBlock) Reader (FunctionBlock) SetInitialValue (Method) ReaderGroup (FunctionBlock) SetInitialValue (Method) Writer (FunctionBlock) SetInitialValue (Method) WriterGroup (FunctionBlock) SetInitialValue (Method) Functions DT_TO_UAVersionTime (Function) GetAsChar (Function) GetAsWChar (Function) STRING_SIZE_TO_UALEN (Function) WSTRING_SIZE_TO_UALEN (Function) Interfaces Diagnostics IConnectionDiagnostics (Interface) GetInstancePointer (Method) IDiagnostics (Interface) Reset (Method) IDiagnosticsCounter (Interface) GetInstancePointer (Method) IReaderDiagnostics (Interface) GetInstancePointer (Method) IReaderGroupDiagnostics (Interface) GetInstancePointer (Method) IRootDiagnostics (Interface) GetInstancePointer (Method) IWriterDiagnostics (Interface) GetInstancePointer (Method) IWriterGroupDiagnostics (Interface) GetInstancePointer (Method) IConfiguration (Interface) IConnection (Interface) IDataSet (Interface) GetSize (Method) GetVersion (Method) IReader (Interface) IReaderGroup (Interface) IStatus (Interface) Disable (Method) Enable (Method) GetState (Method) IWriter (Interface) IWriterGroup (Interface) Structs ArrayType (Struct) Index (Struct) UIndex (Struct) UMeta (Struct) VersionTime (Struct) Types IEC_TYPE (Alias) UNICODE (Alias)

Aliases ¶ Function Blocks AsyncProperty (Alias) IPAddressSet (Alias) IPv4Address (Alias) ResolveHostname (Alias) IPADDRESS (Alias) Interfaces IAsyncProperty (Alias) IIPAddress (Alias) IIPAddressSet (Alias) ITSNContext (Alias)