DIAGNOSIS_INFO (STRUCT) ¶ TYPE DIAGNOSIS_INFO : STRUCT This structure contains all relevant diagnostic information for a CAN network. It can be retrieved by GetDiagnosis . InOut: Name Type Comment uiBaudrate UINT current Baudrate of CAN driver usiBusLoad USINT current busload calculated by CAN Minidriver. Not all minidrivers implement this feature. xBusAlarm BOOL Shows if CAN Minidriver signals a pending busalarm. eBusState BUSSTATE current bus state signaled by CAN Minidriver ctTxCounter CAA.COUNT transmit counter provided by CAN Minidriver ctTxErrorCounter CAA.COUNT Tx Error Counter provided by CAN Minidriver (Tx Error register); should be always zero (unequal zero means buserror) ctRxCounter CAA.COUNT receive counter provided by CAN Minidriver ctRxErrorCounter CAA.COUNT Rx Error counter provided by CAN Minidriver (Rx Error register); should be always zero (unequal zero means buserror) ctLostCounter CAA.COUNT Rx Lost counter provided by CAN Minidriver; should be always zero (unequal zero means Rx message lost because of overrun or no free message handle) ctFreeRxMessages CAA.COUNT free messages for receiving; should be greater 0 ctMessagesRxQueue CAA.COUNT messages in receive queue waiting for being processed by application or stack ctFreeTxMessages CAA.COUNT free messages for transmitting; should be greater zero otherwise no new tx messages possible (=> CreateMessage returns CAA.gc_hINVALID ) ctMessagesTxQueue CAA.COUNT messages in transmit queue waiting for being processed by CAN Minidriver
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 27.04.2020, 15:47:03 companyName string 3S-Smart Software Solutions GmbH libraryFile CAA_CanL2_Extern.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 contentFile CAA_CanL2_Extern.clean.json version version 2.0.0.0 ProjectInformation Depends on PS bool False Depends on RTS True Released True SIL2 False LastModificationDateTime date 27.04.2020, 15:46:57 LibraryCategories library-category-list Intern|CAA|Fieldbus Author string 3S - Smart Software Solutions GmbH Company CAA Technical Workgroup CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 Patch 2 DefaultNamespace CL2 Description See: Description DocFormat reStructuredText LanguageModelAttribute qualified-access-only Placeholder CAA CanL2 Project CAA_CanL2_Extern Title CAA Can Low Level Extern SpecVersion version 3.0.0.0 Version 3.5.16.0
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. CAA Callback Extern ¶ Library Identification ¶ Placeholder: CAA Callback Default Resolution: CAA Callback Extern, * (CAA Technical Workgroup) Namespace: CB Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CAA Callback CAA Can Low Level Imp Extern ¶ Library Identification ¶ Placeholder: CAA CanL2I Default Resolution: CAA Can Low Level Imp Extern, * (CAA Technical Workgroup) Namespace: CL2I Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CAA CanL2I CAA Memory Block Manager Extern ¶ Library Identification ¶ Placeholder: CAA MemBlockMan Default Resolution: CAA Memory Block Manager Extern, * (CAA Technical Workgroup) Namespace: MBM Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CAA MemBlockMan CAA Ressource Manager Extern ¶ Library Identification ¶ Placeholder: CAA ResMan Default Resolution: CAA Ressource Manager Extern, * (CAA Technical Workgroup) Namespace: RSM Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CAA ResMan 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
_CloneMessage (FUN) ¶ FUNCTION _CloneMessage : CAA.HANDLE Unmanaged implementation of CloneMessage InOut: Scope Name Type Comment Return _CloneMessage CAA.HANDLE cloned message handle Input hMessage CAA.HANDLE handle of message to clone peError POINTER TO ERROR optional pointer to error enum
_CreateArrayReceiver (FUN) ¶ FUNCTION _CreateArrayReceiver : CAA.HANDLE Creates an Array Receiver. InOut: Scope Name Type Comment Return _CreateArrayReceiver CAA.HANDLE new receiver handle or CAA.gc_hINVALID in case of failure Input hDriver CAA.HANDLE handle of CAN interface paSortedCOBIDs POINTER TO CL2I.ARRAY_RECV_ENTRY array filled with COBIDs of interest sorted by COBID ctCOBIDs CAA.COUNT number of COBIDs contained in paSortedCOBIDs eEvent CB.EVENT trigger event when message received xEnableSyncWindow BOOL use SYNC window ==> not implemented peError POINTER TO ERROR optional pointer to error enum
_CreateIdAreaReceiver (FUN) ¶ FUNCTION _CreateIdAreaReceiver : CAA.HANDLE Unmanaged implementation of CreateIdAreaReceiver InOut: Scope Name Type Comment Return _CreateIdAreaReceiver CAA.HANDLE Input hDriver CAA.HANDLE handle of CAN interface xAlwaysNewest BOOL TRUE: returns only the newest message; FALSE: receiver with queue. eEvent CB.EVENT trigger event when message received xEnableSyncWindow BOOL use SYNC window: not implemented ==> do not care peError POINTER TO ERROR optional pointer to error enum
_CreateMaskReceiver (FUN) ¶ FUNCTION _CreateMaskReceiver : CAA.HANDLE Unmanaged implementation of CreateMaskReceiver InOut: Scope Name Type Comment Return _CreateMaskReceiver CAA.HANDLE new receiver handle or CAA.gc_hINVALID in case of failure Input hDriver CAA.HANDLE handle of CAN interface cobIdValue CL2I.COBID CobID value cobIdMask CL2I.COBID CobID mask xRTRValue BOOL RTR value xRTRMask BOOL RTR mask x29BitIdValue BOOL 29 Bit Id value x29BitIdMask BOOL 29 Bit Id mask xTransmitValue BOOL Transmit message value xTransmitMask BOOL Transmit message mask xAlwaysNewest BOOL TRUE: returns only the newest message; FALSE: receiver with queue. eEvent CB.EVENT trigger event when message received xEnableSyncWindow BOOL use SYNC window: not implemented ==> do not care peError POINTER TO ERROR optional pointer to error enum
_CreateMessage (FUN) ¶ FUNCTION _CreateMessage : CAA.HANDLE Unmanaged implementation of CreateMessage InOut: Scope Name Type Comment Return _CreateMessage CAA.HANDLE new message handle Input hDriver CAA.HANDLE handle of CAN interface cobID CL2I.COBID cob ID usiLength USINT length of valid data bytes xRTR BOOL RTR bit x29BitID BOOL 29 Bit ID peError POINTER TO ERROR optional pointer to error enum
_CreateSingleIdReceiver (FUN) ¶ FUNCTION _CreateSingleIdReceiver : CAA.HANDLE Unmanaged implementation of CreateSingleIdReceiver InOut: Scope Name Type Comment Return _CreateSingleIdReceiver CAA.HANDLE new receiver handle or CAA.gc_hINVALID in case of failure Input hDriver CAA.HANDLE handle of CAN interface cobId CL2I.COBID id of message to be received xRTR BOOL RTR bit x29BitId BOOL 29 Bit Id xTransmit BOOL Transmit message xAlwaysNewest BOOL TRUE: returns only the newest message; FALSE: receiver with queue. eEvent CB.EVENT trigger event when message received xEnableSyncWindow BOOL use SYNC window: not implemented ==> do not care peError POINTER TO ERROR optional pointer to error enum
_DeleteReceiver (FUN) ¶ FUNCTION _DeleteReceiver : ERROR Unmanaged implementation of DeleteReceiver InOut: Scope Name Type Comment Return _DeleteReceiver ERROR ERROR.NO_ERROR or appropriate error code Input hReceiverId CAA.HANDLE handle of receiver