_GetLostCounter (FUN) ¶ FUNCTION _GetLostCounter : CAA.COUNT Unmanaged implementation of GetLostCounter InOut: Scope Name Type Comment Return _GetLostCounter CAA.COUNT number of lost messages Input hDriver CAA.HANDLE handle of CAN interface peError POINTER TO ERROR optional pointer to error enum
_GetReceiveCounter (FUN) ¶ FUNCTION _GetReceiveCounter : CAA.COUNT Unmanaged implementation of GetReceiveCounter InOut: Scope Name Type Comment Return _GetReceiveCounter CAA.COUNT number of received messages Input hDriver CAA.HANDLE handle of CAN interface peError POINTER TO ERROR optional pointer to error enum
_GetReceiveErrorCounter (FUN) ¶ FUNCTION _GetReceiveErrorCounter : CAA.COUNT Unmanaged implementation of GetReceiveErrorCounter InOut: Scope Name Type Comment Return _GetReceiveErrorCounter CAA.COUNT number of receive errors Input hDriver CAA.HANDLE handle of CAN interface peError POINTER TO ERROR optional pointer to error enum
_GetReceivePoolSize (FUN) ¶ FUNCTION _GetReceivePoolSize : CAA.COUNT Unmanaged implementation of GetReceivePoolSize InOut: Scope Name Type Comment Return _GetReceivePoolSize CAA.COUNT number of free receive messages in global receive pool Input hDriver CAA.HANDLE handle of CAN interface peError POINTER TO ERROR optional pointer to error enum
CAA Device Diagnosis Library Documentation ¶ Company CAA Technical Workgroup Title CAA Device Diagnosis Version 3.5.15.0 Categories Intern|CAA|Fieldbus Namespace DED Author 3S - Smart Software Solutions GmbH Placeholder CAA Device Diagnosis Description 1 ¶ Generic device diagnosis interface for all fieldbus types Contents: ¶ CAA Device Diagnosis Enums Function Blocks Functions Global Constants Interfaces Internal Structs VersionConstants (GVL) Indices and tables ¶ 1 Based on CAA_DeviceDiagnosis.library, last modified 24.07.2019, 08:33:34. LibDoc 4.4.0.0-b.27 The content file CAA_DeviceDiagnosis.clean.json was generated with CODESYS V3.5 SP15 on 24.07.2019, 08:33:40.
CAA Device Diagnosis ¶ Enums BUS_STATE (Enum) BUS_TYPE (Enum) DEVICE_STATE (Enum) DEVICE_TRANSITION_STATE (Enum) DEVICE_TYPE (Enum) ERROR (Enum) LOGGER_MODE (Enum) PROC_CMD (Enum) PROC_STATE (Enum) Function Blocks Bus GetBusError (FunctionBlock) Device GetDeviceError (FunctionBlock) GetSpecificDeviceError (FunctionBlock) Reconfigure Reconfigure (FunctionBlock) Stack GetBusScan (FunctionBlock) Utility GetIDeviceInstByIoAddr (FunctionBlock) Functions CanReconfigure (Function) GetNextNode (Function) GetNodeDepth (Function) GetRoot (Function) INode_TO_IBus (Function) INode_TO_IDevice (Function) INode_TO_IDevice2 (Function) INode_TO_IStack (Function) Global Constants ERROR_CODES (GVL) Interfaces IBus (Interface) Fieldbus-dependent-methods GetSpecificBusState (Method) GetBusDiagnosisInfo (Method) GetBusErrorAsync (Method) GetBusInfo (Method) GetBusState (Method) GetQoS (Method) IDevice (Interface) Fieldbus-dependent-methods GetSpecificDeviceErrorAsync (Method) GetSpecificDeviceState (Method) GetDeviceDiagnosisInfo (Method) GetDeviceErrorAsync (Method) GetDeviceInfo (Method) GetDeviceState (Method) SetCommunicationState (Method) IDevice2 (Interface) CheckCurrentSupportedCommunicationState (Method) CheckSupportedCommunicationState (Method) ILogger (Interface) DisableLogger (Method) EnableLogger (Method) GetLogEntry (Method) INode (Folder) ChildNodeCount (Property) Enable (Property) FirstChildNode (Property) IsRootNode (Property) NextSiblingNode (Property) ParentNode (Property) SiblingNodeCount (Property) IReconfigureProvider (Folder) ReconfigureActive (Property) ReconfigureAsync (Method) RegisterIRPChild (Method) SiblingIRP (Property) IStack (Interface) GetBusScanAsync (Method) GetLogger (Method) Internal Diag Base CAADiagDeviceDefault (FunctionBlock) GetDeviceInfo (Method) GetDeviceState (Method) CAADiagTreeBase (FunctionBlock) INode ChildNodeCount (Property) Enable (Property) FirstChildNode (Property) IsRootNode (Property) NextSiblingNode (Property) ParentNode (Property) SiblingNodeCount (Property) CAAReconfigureBase (FunctionBlock) BeginReconfigure (Method) EndReconfigure (Method) IReconfigureProvider ReconfigureActive (Property) ReconfigureAsync (Method) RegisterIRPChild (Method) SiblingIRP (Property) Initialize_Diag (Method) Reconfigure-Implementations ReconfigureChildrenAsync (Method) ReconfigureIoDriverAsync (Method) Structs BUS_INFO (Struct) DEVICE_INFO (Struct) ERROR_INFO (Struct) LOG_ENTRY (Struct) QOS_INFO (Struct)
Enums ¶ BUS_STATE (Enum) BUS_TYPE (Enum) DEVICE_STATE (Enum) DEVICE_TRANSITION_STATE (Enum) DEVICE_TYPE (Enum) ERROR (Enum) LOGGER_MODE (Enum) PROC_CMD (Enum) PROC_STATE (Enum)
BUS_STATE (ENUM) ¶ TYPE BUS_STATE : This enumeration lists all possible states of a fieldbus. The mapping to the according fieldbus specific states is defined by the associated fieldbus stack. Attributes: qualified_only InOut: Name Comment UNKNOWN The bus state is unknown. STOPPED The fieldbus is stopped. No I/O transfer can be processed. RUNNING The fieldbus is running. ERROR The fieldbus is in error state. GetBusError supplies the specific error code. DISABLED Bus is disabled in device tree.
BUS_TYPE (ENUM) ¶ TYPE BUS_TYPE : This enumeration lists all available fieldbus types. Attributes: qualified_only InOut: Name Initial Comment UNKNOWN 16#0 unknown fieldbus PROFIBUS_DP 16#1 Profibus DP CAN 16#2 CAN bus CANOPEN 16#3 CANopen DEVICENET 16#4 DeviceNet ETHERCAT 16#5 EtherCAT PROFINET_IO 16#6 ProfiNet I/O ETHERNET_IP 16#7 EtherNet/IP SERCOSII 16#8 Sercos II SERCOSIII 16#9 Sercos III MODBUS_TCP 16#A Modbus TCP MODBUS_RTU 16#B Modbus RTU AS_INTERFACE 16#C AS Interface INTERBUS 16#D Interbus J1939 16#E J1939 LON 16#F LON CC_LINK 16#10 CC Link POWERLINK 16#11 Powerlink ETHERNET 16#12 Ethernet SERIAL_LINE 16#13 serial line VEN_SPEC 16#14 vendor-specific fieldbus FIRST_MF 16#8000 first manufacturer fieldbus LAST 16#FFFF last manufacturer fieldbus
DEVICE_STATE (ENUM) ¶ TYPE DEVICE_STATE : This enumeration lists all possible states of a device. The mapping to the according fieldbus specific states is defined by the associated fieldbus stack. Attributes: qualified_only InOut: Name Comment UNKNOWN The device state is unknown. Example: No supervision mechanism active. STOPPED The device is stopped. RUNNING The device is running. ERROR The device is in error state. GetDeviceError may supply a specific error code. DISABLED The device is disabled in device tree. NOT_CONFIGURED The device has not yet been configured by the stack. Example: Configuration phase not started yet. CONFIGURED The device has been configured by the stack. Example: Configuration phase finished but device is not in running state. NOT_FOUND The device was not found on bus.