GetNetId (FUN) ¶ FUNCTION GetNetId : USINT Returns the NetID of a given message. InOut: Scope Name Type Comment Return GetNetId USINT NetID of hMessage . Input hMessage CAA.HANDLE handle of received message peError POINTER TO ERROR optional pointer to error enum
GetTimeStamp (FUN) ¶ FUNCTION GetTimeStamp : UDINT Returns the time stamp of a given message (if supported by CAN driver, else 0). InOut: Scope Name Type Comment Return GetTimeStamp UDINT Time Stamp of hMessage . Input hMessage CAA.HANDLE handle of received message peError POINTER TO ERROR optional pointer to error enum
Is29BitIdMessage (FUN) ¶ FUNCTION Is29BitIdMessage : BOOL This function determines if a specified message has an identifier with 11 bits or 29 bits. InOut: Scope Name Type Comment Return Is29BitIdMessage BOOL TRUE if messages is a 29 bit CAN message. Input hMessage CAA.HANDLE handle of message peError POINTER TO ERROR optional pointer to error enum
IsRTRMessage (FUN) ¶ FUNCTION IsRTRMessage : BOOL This function specifies whether a message is an RTR message. InOut: Scope Name Type Comment Return IsRTRMessage BOOL TRUE if messages is a RTR CAN message. Input hMessage CAA.HANDLE handle of message peError POINTER TO ERROR optional pointer to error enum
IsTransmitMessage (FUN) ¶ FUNCTION IsTransmitMessage : BOOL This function specifies whether a message was previously sent with Write . InOut: Scope Name Type Comment Return IsTransmitMessage BOOL TRUE if messages is a Transmit CAN message. Input hMessage CAA.HANDLE handle of message peError POINTER TO ERROR optional pointer to error enum
LostMessages (FUN) ¶ FUNCTION LostMessages : UINT Returns counter, which is incremented with every lost message of hReceiverId InOut: Scope Name Type Comment Return LostMessages UINT Counter, which is incremented with every lost message of hReceiverId Input hReceiverId CAA.HANDLE handle of registered Ids peError POINTER TO ERROR optional pointer to error enum
IndicatorConstants (GVL) ¶ This GVL defines the states of the two device LEDs according to CiA 303-3. These states are returned by GetCiAState and set by SetCiAState . The Error LED gc_usiERR_... (red) is represented by the lower 4 bit of CiA State, the RUN LED gc_usiRUN_... (green) by the higher 4 bit. InOut: Scope Name Type Initial Comment Constant gc_usiERR_OFF USINT 16#0 led off = no error gc_usiERR_ON USINT 16#1 led on = Bus off gc_usiERR_FLK USINT 16#2 flickering = LSS/Auto-bitrate detection gc_usiERR_BLK USINT 16#3 blinking = Invalid Configuration gc_usiERR_SFL USINT 16#4 single flash = Warning LIMIT reached gc_usiERR_DFL USINT 16#5 double flash = Error control event gc_usiERR_TFL USINT 16#6 triple flash = Sync error gc_usiERR_QFL USINT 16#7 quadruple flash = Event timer error gc_usiRUN_OFF USINT 16#0 led off = not running gc_usiRUN_ON USINT 16#10 led on = Operational gc_usiRUN_FLK USINT 16#20 flickering = LSS/Auto-bitrate detection gc_usiRUN_BLK USINT 16#30 blinking = Preoperational gc_usiRUN_SFL USINT 16#40 single flash = Stopped gc_usiRUN_DFL USINT 16#50 double flash = PROGRAM/Firmeware download gc_usiRUN_TFL USINT 16#60 triple flash = reserved gc_usiRUN_QFL USINT 16#70 quadruple flash = reserved
Structures ¶ DIAGNOSIS_INFO (Struct)
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
