MQTTSubscribe.SubscribeActive (PROP) ¶ PROPERTY SubscribeActive : BOOL
Properties ¶ MQTTAuthProperties (Struct) MQTTConnackProperties (Struct) MQTTConnectProperties (Struct) MQTTPublishProperties (Struct) MQTTStringPair (Struct) MQTTSubscribeProperties (Struct) MQTTWillProperties (Struct)
MQTTAuthProperties (STRUCT) ¶ TYPE MQTTAuthProperties : STRUCT Auth properties (MQTT V5) MQTTAuthProperties can be send to the server via the method MQTTClient.SendAuth(). The content of pbAuthenticationData depends on the authentication method. InOut: Name Type Comment wsAuthenticationMethod WSTRING Name of the authentication method pbAuthenticationData POINTER TO BYTE Binary Data containing authentication data udiAuthenticationDataSize UDINT Size of pbAuthenticationData userProperties ARRAY [0..(MQTTParam.g_udiMaxUserProperties - 1)] OF MQTTStringPair User defined properties
MQTTConnackProperties (STRUCT) ¶ TYPE MQTTConnackProperties : STRUCT Properties of CONNACK, AUTH and DISCONNECT packets (MQTT V5). InOut: Name Type Comment udiSessionExpiryInterval UDINT Session Expiry Interval in seconds. wsAssignedClientIdentifier WSTRING Assigned Client Identifier: If the Client connects using a zero length Client Identifier, the Server MUST respond with a CONNACK containing an Assigned Client Identifier. uiServerKeepAlive UINT The Keep Alive is a time interval measured in seconds. It is the maximum time interval that is permitted to elapse between the point at which the Client finishes transmitting one MQTT Control Packet and the point it starts sending the next. The server Keep Alive interval overwrites the value of the input tPingInterval. xAuthPacketReceived BOOL TRUE, if a AUTH Packet has been received. The data is stored in wsAuthenticationMethod, bAuthenticationData and udiAuthenticationDataSize. The ReasonCode is stored in MQTTClient.eReaonCode. The response to the server can be send via the method MQTTClient.SendAuth(). wsAuthenticationMethod WSTRING Name of the authentication method bAuthenticationData ARRAY [0..MQTTParam.g_udiMaxAuthDataSize] OF BYTE Binary Data containing authentication data udiAuthenticationDataSize UDINT Size of pbAuthenticationData wsResponseInformation WSTRING Basis for Response Topics. wsServerReference WSTRING String which can be used to identify another Server to use. The Server uses a Server Reference in either a CONNACK or DISCONNECT packet with Reason code of 0x9C (Use another server) or Reason Code 0x9D (Server moved). wsReasonString WSTRING String representing the reason for the disconnect. uiReceiveMaximum UINT The Server uses this value to limit the number of QoS 1 and QoS 2 publications that it is willing to process concurrently for the Client. uiTopicAliasMaximum UINT The maximum value of topic aliases. bMaximumQoS BYTE Maximum allowed QoS of the server. A value of 255 means that the value has not been set. bRetainAvailable BYTE Retain Available: A value of 0 means that retained messages are not supported. A value of 1 means retained messages are supported. A value of 255 means that the value has not been set. udiMaximumPacketSize UDINT Maximum packet size of the server A value of 0 means that the value has not been set. bWildcardSubscriptionAvailable BYTE Wildcard Subscription Available: A value is 0 means that Wildcard Subscriptions are not supported. A value of 1 means Wildcard Subscriptions are supported. A value of 255 means that the value has not been set. bSubscriptionIdentifierAvailable BYTE Subscription Identifiers Available: A value is 0 means that Subscription Identifiers are not supported. A value of 1 means Subscription Identifiers are supported. A value of 255 means that the value has not been set. bSharedSubscriptionAvailable BYTE Shared Subscription Available: A value of 1 means Shared 1356 Subscriptions are supported. If not present, then Shared Subscriptions are supported. A value of 255 means that the value has not been set. userProperties ARRAY [0..(MQTTParam.g_udiMaxUserProperties - 1)] OF MQTTStringPair Received user prperties
MQTTConnectProperties (STRUCT) ¶ TYPE MQTTConnectProperties : STRUCT Connect properties (MQTT V5) InOut: Name Type Comment udiSessionExpiryInterval UDINT Session Expiry Interval: Time in seconds a session retains after a disconnect. wsAuthenticationMethod WSTRING Name of the authentication method pbAuthenticationData POINTER TO BYTE Binary Data containing authentication data udiAuthenticationDataSize UDINT Size of pbAuthenticationData bRequestProblemInformation BYTE The Client uses this value to indicate whether the Reason String or User Properties are sent in the case of failures. bRequestResponseInformation BYTE This value can be used to request the Server to return Response Information. uiReceiveMaximum UINT The Client uses this value to limit the number of QoS 1 and QoS 2 publications that it is willing to process concurrently. There is no mechanism to limit the QoS 0 publications that the Server might try to send. uiTopicAliasMaximum UINT This value indicates the highest value that the Server will accept as a Topic Alias sent by the Client. udiMaximumPacketSize UDINT The Client uses the Maximum Packet Size to inform the Server that it will not process packets exceeding this limit. userProperties ARRAY [0..(MQTTParam.g_udiMaxUserProperties - 1)] OF MQTTStringPair User defined properties
createJWT (FB) ¶ FUNCTION_BLOCK createJWT EXTENDS CBML.ETrigTo Function Block to create a JSON Web Tocken (JWT) InOut: Scope Name Type Initial Comment Inherited from Input xExecute BOOL Rising edge: Starts defined operation FALSE : Resets the defined operation after ready condition was reached ETrigTo udiTimeOut UDINT Max. operating time for executing [µs], 0: No operating time limit ETrigTo Output xDone BOOL Ready condition reached ETrigTo xBusy BOOL Operation is running ETrigTo xError BOOL Error condition reached ETrigTo Input header JSON.JSONData JSON representation of the JWT Header payload JSON.JSONData JSON representation of the JWT Payload sSecret STRING(511) ‘’ Secret for Symetric signing sUseCaseName STRING ‘’ A name to identify this context in the security manager sCommonName STRING ‘’ Certificate Common Name pbJWT POINTER TO BYTE Pointer to JWT output udiMaxJWTSize UDINT Maximum size of JWT output eAlgorithm JWTAlgorithm JWT Algorithm Output udiJWTSize UDINT Size of JWT output eError Error Output Error
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