GetMessageLength (FUN) ¶ FUNCTION GetMessageLength : USINT Returns number of valid bytes in message. Example See GetMessageDataPointer . InOut: Scope Name Type Comment Return GetMessageLength USINT number of valid data bytes in message Input hMessage CAA.HANDLE handle of message peError POINTER TO ERROR optional pointer to error enum
GetMsgCount (FUN) ¶ FUNCTION GetMsgCount : CAA.COUNT Returns the number of messages in the receive queue of a given receiver. InOut: Scope Name Type Comment Return GetMsgCount CAA.COUNT number of messages in receive queue of hReceiverId . Input hReceiverId CAA.HANDLE receiver handle peError POINTER TO ERROR optional pointer to error enum
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)