File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 04.09.2023, 11:23:31 companyName string 3S-Smart Software Solutions GmbH libraryFile CANbusDevice.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile CANbusDevice.clean.json version version 2.0.0.0 ProjectInformation IsEndUserLibrary bool False OnlineHelp True Released True SIL2 False ShowSmartCodingInfo True LastModificationDateTime date 04.09.2023, 11:23:29 LibraryCategories library-category-list Intern|CANbus Author string 3S - Smart Software Solutions GmbH Company 3S - Smart Software Solutions GmbH CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 Patch 2 DefaultNamespace CANbusDevice Description See: Description DocFormat reStructuredText LanguageModelAttribute qualified-access-only Placeholder CANbusDevice Project CANbusDevice Title CANbusDevice Version version 4.2.0.0
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. Base Interfaces ¶ Library Identification ¶ Name: Base Interfaces Version: newest Company: System Namespace: IBaseLibrary Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Base Interfaces, * (System) CAA Can Low Level Extern ¶ Library Identification ¶ Placeholder: CAA CanL2 Default Resolution: CAA Can Low Level Extern, * (CAA Technical Workgroup) Namespace: CL2 Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CAA CanL2 CAA Device Diagnosis ¶ Library Identification ¶ Placeholder: CAA Device Diagnosis Default Resolution: CAA Device Diagnosis, * (CAA Technical Workgroup) Namespace: DED Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CAA Device Diagnosis 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 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 IoDrvBase ¶ Library Identification ¶ Placeholder: IoDrvBase Default Resolution: IoDrvBase, * (System) Namespace: IoDrvBase Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: IoDrvBase IoDrvUtility ¶ Library Identification ¶ Placeholder: IoDriver Utility Default Resolution: IoDrvUtility, * (3S - Smart Software Solutions GmbH) Namespace: IoDrvUtility Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: IoDriver Utility IoStandard ¶ Library Identification ¶ Placeholder: IoStandard Default Resolution: IoStandard, * (System) Namespace: IoStandard Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: IoStandard Standard ¶ Library Identification ¶ Placeholder: Standard Default Resolution: Standard, * (System) Namespace: Standard Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Standard SysCpuHandling ¶ Library Identification ¶ Placeholder: SysCpuHandling Default Resolution: SysCpuHandling, * (System) Namespace: SysCpuHandling Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysCpuHandling SysMem ¶ Library Identification ¶ Placeholder: SysMem Default Resolution: SysMem, * (System) Namespace: SysMem Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysMem 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)
CANbus_Diag.GetBusInfo (METH) ¶ METHOD GetBusInfo : DED.ERROR Returns information about the associated CANbus. Interpretation of DED.BUS_INFO is as follows: Component Interpretation eType DED.BUS_TYPE.CAN idSystem Network ID idInstance Instance number in I/O configuration (starting by 0) InOut: Scope Name Type Comment Return GetBusInfo DED.ERROR DED.ERROR.NO_ERROR if no error occurred while getting information. Inout buiInfo DED.BUS_INFO Bus information struct
CANbus_Diag.GetBusState (METH) ¶ METHOD GetBusState : DED.BUS_STATE Returns the bus state of the associated CANBus. Following table defines the mapping between CAA Device Diagnosis DED.BUS_STATE and CL2.BUSSTATE . CAA Device Diagnosis CANbus state DED.BUS_STATE.RUNNING CL2.BUSSTATE.ERR_FREE , CL2.BUSSTATE.ACTIVE , CL2.BUSSTATE.WARNING (with xDiagnosisInfoAvailable``=``TRUE ) CL2.BUSSTATE.PASSIVE (with xDiagnosisInfoAvailable``=``TRUE ) DED.BUS_STATE.ERROR Specified CAN interface not found, CL2.BUSSTATE.BUSOFF DED.BUS_STATE.STOPPED CAN driver is not ready (e.g. in case of gateway devices) DED.BUS_STATE.UNKNOWN CL2.BUSSTATE.UNKNOWN InOut: Scope Name Type Comment Return GetBusState DED.BUS_STATE current bus state. Output xDiagnosisInfoAvailable BOOL TRUE , if red exclamation mark in device tree eError DED.ERROR DED.ERROR.NO_ERROR if bus state was retrieved wihout error.
CANbus_Diag.GetQoS (METH) ¶ METHOD GetQoS : DED.ERROR Returns quality of service information for the CANbus. Interpretation of DED.QOS_INFO is as follows: Component Interpretation ctError Total sum of TxErrorCounter, RxErrorCounter and LostCounter. usiBusload Current busload in percent (if supported by CAN driver, else always 0) InOut: Scope Name Type Comment Return GetQoS DED.ERROR DED.ERROR.NO_ERROR if no error occurred while getting information. Inout QualityInfo DED.QOS_INFO
CANbus_Diag.ChildNodeCount (PROP) ¶ PROPERTY ChildNodeCount : CAA.COUNT Returns the number of childs below the current node
CANbus_Diag.Connector (PROP) ¶ PROPERTY Connector : POINTER TO IoStandard.IoConfigConnector
CANbus_Diag.Enable (PROP) ¶ PROPERTY Enable : BOOL Set: This property is used for enabling/disabling a node. Note Changes will take effect after reconfiguring (see DED.Reconfigure ). Get: Returns the current value
CANbus_Diag.FirstChildNode (PROP) ¶ PROPERTY FirstChildNode : DED.INode Returns the first child node below the current one
CANbus_Diag.Index (PROP) ¶ PROPERTY Index : UDINT