JSON Web Token SL Library Documentation ¶ Company : CODESYS Title : JSON Web Token SL Version : 1.9.0.0 Categories : Application|Utils Namespace : JWT Author : CODESYS Development GmbH Placeholder : JSON_Web_Token_SL Description [ 1 ] ¶ Library to create JSON Web Token Contents: ¶ JSON Web Token Enums Function Block Gloabal Constant Indices and tables ¶ [ 1 ] Based on JSON Web Token SL.library, last modified 11.09.2023, 10:39:00. LibDoc 4.4.0.0-b.37 The content file JSON Web Token SL.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 11.09.2023, 10:39:02.
JSON Web Token ¶ Enums ERROR (Enum) JWTAlgorithm (Enum) Function Block createJWT (FunctionBlock) Gloabal Constant Gloabal_Constant (GVL)
Enums ¶ ERROR (Enum) JWTAlgorithm (Enum)
ERROR (ENUM) ¶ TYPE ERROR : Attributes: qualified_only InOut: Name Comment NO_ERROR No Error Conversion_Failed Could not convert JSON Data Invalid_Key Could not find valid private key, or certificate Signature_Failed Signig of JWT Failed Algorithm_Not_Supported JWT Algorithm not Supported Secret_Not_Initialised Secret is not initialised but is needed CommonName_Not_Initialized Common Name is not initialised but is needed Invalid_JWT_Pointer Pointer to JWT output is invalid INVALID_LICENSE No valid License found
JWTAlgorithm (ENUM) ¶ TYPE JWTAlgorithm : Attributes: qualified_only InOut: Name Comment HS256 HS256 algorithm HS384 HS384 algorithm HS512 HS512 algorithm RS256 RS256 algorithm
Function Block ¶ createJWT (FunctionBlock)
ConnectionDiagnostics (FB) ¶ FUNCTION_BLOCK PUBLIC FINAL ConnectionDiagnostics EXTENDS Diagnostics IMPLEMENTS IConnectionDiagnostics Data structure for reporting diagnostic information See IConnectionDiagnostics for more details InOut: Scope Name Type Comment Inherited from Input Const eDiagnosticsLevel DiagnosticsLevel Diagnostics Output itfTotalInformation IDiagnosticsCounter Provides the sum of all counters in this Objectdiagnostics with DiagnosticsClassification.Information Diagnostics itfTotalError IDiagnosticsCounter Provides the sum of all counters in this Objectdiagnostics with DiagnosticsClassification.Error Diagnostics xSubError BOOL Indicates if any statistics Object of the next PubSublayer Objects shows a value > 0 in itfTotalError Diagnostics itfStateError IDiagnosticsCounter PubSub state machine changed to STATE.ERROR Diagnostics itfStateOperationalByMethod IDiagnosticsCounter State changed to STATE.OPERATIONAL triggered by Enable Method call. Diagnostics itfStateOperationalByParent IDiagnosticsCounter State changed to STATE.OPERATIONAL triggered by an operational parent. Diagnostics itfStateOperationalFromError IDiagnosticsCounter State changed from STATE.ERROR to STATE.OPERATIONAL Diagnostics itfStatePausedByParent IDiagnosticsCounter State changed to STATE.PAUSED triggered by a paused or disabled parent. Diagnostics itfStateDisabledByMethod IDiagnosticsCounter State changed to STATE.DISABLED triggered by Disable Method call. Diagnostics ipResolvedAddress IPADDRESS
ReaderDiagnostics (FB) ¶ FUNCTION_BLOCK PUBLIC FINAL ReaderDiagnostics EXTENDS Diagnostics IMPLEMENTS IReaderDiagnostics Data structure for reporting diagnostic information See IReaderDiagnostics for more details InOut: Scope Name Type Comment Inherited from Input Const eDiagnosticsLevel DiagnosticsLevel Diagnostics Output itfTotalInformation IDiagnosticsCounter Provides the sum of all counters in this Objectdiagnostics with DiagnosticsClassification.Information Diagnostics itfTotalError IDiagnosticsCounter Provides the sum of all counters in this Objectdiagnostics with DiagnosticsClassification.Error Diagnostics xSubError BOOL Indicates if any statistics Object of the next PubSublayer Objects shows a value > 0 in itfTotalError Diagnostics itfStateError IDiagnosticsCounter PubSub state machine changed to STATE.ERROR Diagnostics itfStateOperationalByMethod IDiagnosticsCounter State changed to STATE.OPERATIONAL triggered by Enable Method call. Diagnostics itfStateOperationalByParent IDiagnosticsCounter State changed to STATE.OPERATIONAL triggered by an operational parent. Diagnostics itfStateOperationalFromError IDiagnosticsCounter State changed from STATE.ERROR to STATE.OPERATIONAL Diagnostics itfStatePausedByParent IDiagnosticsCounter State changed to STATE.PAUSED triggered by a paused or disabled parent. Diagnostics itfStateDisabledByMethod IDiagnosticsCounter State changed to STATE.DISABLED triggered by Disable Method call. Diagnostics itfFailedDataSetMessages IDiagnosticsCounter e.g. because of unknown MajorVersion uiMessageSequenceNumber UINT SequenceNumber of last DataSetMessage eStatusCode ERROR Status of last DataSetMessage udiMajorVersion UDINT MajorVersion of available DataSet Meta Data udiMinorVersion UDINT MinorVersion of available Data Set Meta Data
ReaderGroupDiagnostics (FB) ¶ FUNCTION_BLOCK PUBLIC FINAL ReaderGroupDiagnostics EXTENDS Diagnostics IMPLEMENTS IReaderGroupDiagnostics Data structure for reporting diagnostic information See IReaderGroupDiagnostics for more details InOut: Scope Name Type Comment Inherited from Input Const eDiagnosticsLevel DiagnosticsLevel Diagnostics Output itfTotalInformation IDiagnosticsCounter Provides the sum of all counters in this Objectdiagnostics with DiagnosticsClassification.Information Diagnostics itfTotalError IDiagnosticsCounter Provides the sum of all counters in this Objectdiagnostics with DiagnosticsClassification.Error Diagnostics xSubError BOOL Indicates if any statistics Object of the next PubSublayer Objects shows a value > 0 in itfTotalError Diagnostics itfStateError IDiagnosticsCounter PubSub state machine changed to STATE.ERROR Diagnostics itfStateOperationalByMethod IDiagnosticsCounter State changed to STATE.OPERATIONAL triggered by Enable Method call. Diagnostics itfStateOperationalByParent IDiagnosticsCounter State changed to STATE.OPERATIONAL triggered by an operational parent. Diagnostics itfStateOperationalFromError IDiagnosticsCounter State changed from STATE.ERROR to STATE.OPERATIONAL Diagnostics itfStatePausedByParent IDiagnosticsCounter State changed to STATE.PAUSED triggered by a paused or disabled parent. Diagnostics itfStateDisabledByMethod IDiagnosticsCounter State changed to STATE.DISABLED triggered by Disable Method call. Diagnostics itfReceivedNetworkMessages IDiagnosticsCounter Received and processed NetworkMessages itfReceivedInvalidNetworkMessages IDiagnosticsCounter Invalid format of NetworkMessageHeader uiConfiguredDataSetReaders UINT Number of configured Reader FB’s in this group uiOperationalDataSetReaders UINT Number of Reader FB’s with state Operational
RootDiagnostics (FB) ¶ FUNCTION_BLOCK PUBLIC FINAL RootDiagnostics EXTENDS Diagnostics IMPLEMENTS IRootDiagnostics Data structure for reporting diagnostic information See IRootDiagnostics for more details InOut: Scope Name Type Comment Inherited from Input Const eDiagnosticsLevel DiagnosticsLevel Diagnostics Output itfTotalInformation IDiagnosticsCounter Provides the sum of all counters in this Objectdiagnostics with DiagnosticsClassification.Information Diagnostics itfTotalError IDiagnosticsCounter Provides the sum of all counters in this Objectdiagnostics with DiagnosticsClassification.Error Diagnostics xSubError BOOL Indicates if any statistics Object of the next PubSublayer Objects shows a value > 0 in itfTotalError Diagnostics itfStateError IDiagnosticsCounter PubSub state machine changed to STATE.ERROR Diagnostics itfStateOperationalByMethod IDiagnosticsCounter State changed to STATE.OPERATIONAL triggered by Enable Method call. Diagnostics itfStateOperationalByParent IDiagnosticsCounter State changed to STATE.OPERATIONAL triggered by an operational parent. Diagnostics itfStateOperationalFromError IDiagnosticsCounter State changed from STATE.ERROR to STATE.OPERATIONAL Diagnostics itfStatePausedByParent IDiagnosticsCounter State changed to STATE.PAUSED triggered by a paused or disabled parent. Diagnostics itfStateDisabledByMethod IDiagnosticsCounter State changed to STATE.DISABLED triggered by Disable Method call. Diagnostics uiConfiguredDataSetWriters UINT Number of configured Writer FB’s uiConfiguredDataSetReaders UINT Number of configured Reader FB’s uiOperationalDataSetWriters UINT Number of Writer FB’s with state Operational uiOperationalDataSetReaders UINT Number of Reader FB’s with state Operational