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.
_FreeMessage (FUN) ¶ FUNCTION _FreeMessage : ERROR Unmanaged implementation of FreeMessage InOut: Scope Name Type Comment Return _FreeMessage ERROR ERROR.NO_ERROR or appropriate error code Input hMessage CAA.HANDLE handle of message to be freed
_Read (FUN) ¶ FUNCTION _Read : CAA.HANDLE Unmanaged implementation of Read InOut: Scope Name Type Comment Return _Read CAA.HANDLE handle of received CAN message or CAA.gc_hINVALID if receiver is empty. Input hReceiverId CAA.HANDLE receiver handle pctMsgLeft POINTER TO CAA.COUNT Optional pointer to ctMsgLeft . After calling CL2.Read ctMsgLeft contains the number of remaining messages in receive queue. peError POINTER TO ERROR optional pointer to error enum
_ReadArrayReceiver (FUN) ¶ FUNCTION _ReadArrayReceiver : CAA.HANDLE Reads messages from an Array Receiver created by _CreateArrayReceiver InOut: Scope Name Type Comment Return _ReadArrayReceiver CAA.HANDLE handle of received CAN message or CAA.gc_hINVALID if receiver is empty. Input hArrayReceiver CAA.HANDLE handle of array receiver ctIndex CAA.COUNT specifies the array entry which should be read pctMsgLeft POINTER TO CAA.COUNT returns number of messages currently in the receiver peError POINTER TO ERROR optional pointer to error enum
_UnregisterIdArea (FUN) ¶ FUNCTION _UnregisterIdArea : ERROR Unmanaged implementation of UnregisterIdArea InOut: Scope Name Type Comment Return _UnregisterIdArea ERROR ERROR.NO_ERROR or appropriate error code Input hReceiverId CAA.HANDLE Handle returned by CreateIdAreaReceiver cobIdStart CL2I.COBID start id of message to be received cobIdEnd CL2I.COBID end id of message to be received xRTRValue BOOL Value RTR bit xRTRMask BOOL Mask RTR bit x29BitIdValue BOOL Value 29 Bit Id x29BitIdMask BOOL Mask 29 Bit Id xTransmitValue BOOL Value Transmit Message xTransmitMask BOOL Mask Transmit Message
_RegisterIdArea (FUN) ¶ FUNCTION _RegisterIdArea : ERROR Unmanaged implementation of RegisterIdArea InOut: Scope Name Type Comment Return _RegisterIdArea ERROR ERROR.NO_ERROR or appropriate error code Input hReceiverId CAA.HANDLE Handle from CreateIdAreaReceiver cobIdStart CL2I.COBID start id of message to be received cobIdEnd CL2I.COBID end id of message to be received xRTRValue BOOL Value RTR bit xRTRMask BOOL Mask RTR bit x29BitIdValue BOOL Value 29 Bit Id x29BitIdMask BOOL Mask 29 Bit Id xTransmitValue BOOL Value Transmit message xTransmitMask BOOL Mask Transmit message
_Write (FUN) ¶ FUNCTION _Write : ERROR Unmanaged implementation of Write InOut: Scope Name Type Comment Return _Write ERROR ERROR.NO_ERROR or appropriate error code Input hDriver CAA.HANDLE handle of CAN interface hMessage CAA.HANDLE handle of message to be written usiPriority USINT priority of message: 0: send immediately; 1-n: priority (1: high, n: low), default is n = 8 xEnableSyncWindow BOOL use SYNC window => not implemented; do not care
_GetBaudrate (FUN) ¶ FUNCTION _GetBaudrate : UINT Unmanaged implementation of GetBaudrate InOut: Scope Name Type Comment Return _GetBaudrate UINT baudrate in kBit/s Input hDriver CAA.HANDLE handle of CAN interface peError POINTER TO ERROR optional pointer to error enum
_GetBusAlarm (FUN) ¶ FUNCTION _GetBusAlarm : BOOL Unmanaged implementation of GetBusAlarm InOut: Scope Name Type Comment Return _GetBusAlarm BOOL TRUE if a bus alarm is pending. Input hDriver CAA.HANDLE handle of CAN interface peError POINTER TO ERROR optional pointer to error enum
_GetBusState (FUN) ¶ FUNCTION _GetBusState : BUSSTATE Unmanaged implementation of GetBusState InOut: Scope Name Type Comment Return _GetBusState BUSSTATE current bus state Input hDriver CAA.HANDLE handle of CAN interface peError POINTER TO ERROR optional pointer to error enum
