Function Blocks ¶ BasicAuthWebClient (FunctionBlock) DigestAuthWebClient (FunctionBlock) mGetKeyValues (Method) OAuth1WebClient (FunctionBlock) OAuth2WebClient (FunctionBlock) ResetToken (Method) WebClient (FunctionBlock)
BasicAuthWebClient (FB) ¶ FUNCTION_BLOCK BasicAuthWebClient Webclient with basic authentification InOut: Scope Name Type Initial Comment Input wsLogin WSTRING(255) Login name wsPassword WSTRING(255) Password xExecute BOOL Rising edge: Send request udiTimeOut UDINT Timeout in micro seconds sURL STRING(1024) URL of the web server eRequestType REQUEST_TYPE REQUEST_TYPE.GET Type of the request: POST or GET eContentType CONTENT_TYPE CONTENT_TYPE.APPLICATION_FORM HTTP Content-Type of the request pwsAdditionalHeader POINTER TO WSTRING Additional HTTP header pwsPostValue POINTER TO WSTRING Post parameter xCloseConnection BOOL FALSE Close the connection after each request. itfTLSContext NBS.ITLSContext 0 Encapsulates all the data neccecray to handle encrypted tcp connections Static initialization, as shown in the following code snippet. VAR commonName : STRING := 'MyRrasPi' ; ciCertInfo : NBS.CERT_INFO := ( psInfo := ADR ( commonName ), udiSize := LEN ( commonName )); myTLSContext : NBS.TLSContext := ( ePurpose := NBS.PURPOSE.CLIENT_SIDE , sUseCaseName := 'NBSTest' , sTLSVersion := '1.3' , ciCertInfo := ciCertInfo , udiVerificationMode := 2 ); END_VAR itfAsyncProperty NBS.IAsyncProperty 0 Runs the connect process in a own background task, usage see library Net Base Services Output xDone BOOL xBusy BOOL xError BOOL eError ERROR Current error state httpResult HttpResult The result of the request
DigestAuthWebClient (FB) ¶ FUNCTION_BLOCK DigestAuthWebClient EXTENDS CBM.ETrigTo Webclient for digest authentification, MD5 and SHA-256 available InOut: Scope Name Type Initial 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 wsLogin WSTRING(255) Login name wsPassword WSTRING(255) Password sURL STRING(1024) URL of the web server eRequestType REQUEST_TYPE REQUEST_TYPE.GET Type of the request: eContentType CONTENT_TYPE CONTENT_TYPE.APPLICATION_FORM HTTP Content-Type of the request pwsAdditionalHeader POINTER TO WSTRING Additional HTTP header pwsPostValue POINTER TO WSTRING Post parameter xCloseConnection BOOL FALSE Close the connection after each request. itfTLSContext NBS.ITLSContext 0 Encapsulates all the data neccecray to handle encrypted tcp connections Static initialization, as shown in the following code snippet. VAR commonName : STRING := 'MyRrasPi' ; ciCertInfo : NBS.CERT_INFO := ( psInfo := ADR ( commonName ), udiSize := LEN ( commonName )); myTLSContext : NBS.TLSContext := ( ePurpose := NBS.PURPOSE.CLIENT_SIDE , sUseCaseName := 'NBSTest' , sTLSVersion := '1.3' , ciCertInfo := ciCertInfo , udiVerificationMode := 2 ); END_VAR itfAsyncProperty NBS.IAsyncProperty 0 Runs the connect process in a own background task, usage see library Net Base Services Output eError ERROR Current error state httpResult HttpResult The result of the request Methods: mGetKeyValues Structure: mGetKeyValues (Method)
Param (PARAMS) ¶ InOut: Scope Name Type Initial Comment Constant gc_udiBufferSize UDINT 4096 Buffersize: Maximum size of a single xml element inclusive attributes and value gc_udiMaxValueSize UDINT 255 Maximum size of names, values, attributes and attribute names gc_MaxStructureDepth UINT 100 Maximum structure depth of the XML file
Structs ¶ XMLElement (Struct)
XMLElement (STRUCT) ¶ TYPE XMLElement : STRUCT Structure of a XML element InOut: Name Type Comment diParentIndex DINT The index of the parent XMLElement wsName WSTRING(gc_udiMaxValueSize) The name of the XML element wsValue WSTRING(gc_udiMaxValueSize) The value of the XML element udiPosition UDINT Position of the start tag in xml file elementType ElementType Type of the elemnet (Element, Attribute, Comment..)
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 14.08.2024, 09:24:09 companyName string 3S-Smart Software Solutions GmbH libraryFile XML Utility SL.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile XML Utility SL.clean.json version version 2.0.0.0 ProjectInformation ActivateDongleLicensing bool False IsEndUserLibrary False OnlineHelp True Released True LastModificationDateTime date 14.08.2024, 09:24:07 FirmCode int 101597 ProductCode 8716 LibraryCategories library-category-list Application|Utils ActivationMail string support@codesys.com ActivationUrl http://license.codesys.com AlternativeFirmCodes 5000304 Author CODESYS Development GmbH Company CODESYS CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 Patch 2 DefaultNamespace XML Description See: Description DocFormat reStructuredText DocLanguages en,de LanguageModelAttribute qualified-access-only Placeholder XML_Utility_SL Project XML Utility SL Title XML Utility SL Version version 1.11.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 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 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 CmpAsyncMgr ¶ Library Identification ¶ Placeholder: CmpAsyncMgr Default Resolution: CmpAsyncMgr, * (System) Namespace: CmpAsyncMgr Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpAsyncMgr 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 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 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 SysFile ¶ Library Identification ¶ Placeholder: SysFile Default Resolution: SysFile, * (System) Namespace: SysFile Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysFile SysMem ¶ Library Identification ¶ Placeholder: SysMem Default Resolution: SysMem, * (System) Namespace: SysMem Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysMem SysTask ¶ Library Identification ¶ Placeholder: SysTask Default Resolution: SysTask, * (System) Namespace: SysTask Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTask 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)
J1939 Safety Standard Library Documentation ¶ Company : CODESYS Title : J1939 Safety Standard Version : 4.2.0.0 Categories : Application|Safety SIL2 Namespace : J1939SafetyStd Author : CODESYS Development GmbH Placeholder : J1939 Safety Standard Description [ 1 ] ¶ CODESYS J1939 Safety - a set of libraries to send/receive “Safety Data Groups” according to SAE J1939-76. The CODESYS J1939 Safety provides functionality to send / receive “Safety Data Groups” (SDG) according to SAE J1939-76. There is a safe (certified) and an standard (uncertified) part of functionality - split in separate libraries: J1939Safety_Itfs.library - data types (DUT’s) and interfaces shared between safe and standard code J1939 Safety.library - containing the safe code J1939 Safety Standard.library - containing the standard (not certified) code For introduction and overview please see the documentation of the J1939 Safety.library. Contents: ¶ J1939 Safety Standard Function Blocks Types Library Information GetLibVersion (Function) GetLibVersionNumber (Function) IsLibReleased (Function) Indices and tables ¶ [ 1 ] Based on J1939 Safety Standard.library, last modified 25.07.2024, 08:55:07. LibDoc 4.5.0.0 The content file J1939 Safety Standard.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 25.07.2024, 08:55:09.
J1939 Safety Standard ¶ Function Blocks CAN low level CL2Driver (FunctionBlock) DRIVER_CONFIG (Struct) Unsafe_SDG_Receiver (FunctionBlock) Basics and data flow Sequence of operation on update of SHM Sequence of operation on update of SDM Unsafe_SDG_Sender (FunctionBlock) Basics and data flow Types ERROR (Enum)
