GetCiAState (FUN) ¶ FUNCTION GetCiAState : USINT Returns the current CiA LED state according to CiA 303-3. Interpretation of returned USINT see IndicatorConstants . InOut: Scope Name Type Comment Return GetCiAState USINT current CiA state (see IndicatorConstants ) Input hDriver CAA.HANDLE handle of CAN interface peError POINTER TO ERROR optional pointer to error enum
SetCiAState (FUN) ¶ FUNCTION SetCiAState : ERROR Sets the current CiA LED state according to CiA 303-3. Interpretation of usiState see IndicatorConstants . InOut: Scope Name Type Comment Return SetCiAState ERROR ERROR.NO_ERROR or appropriate error code Input hDriver CAA.HANDLE handle of CAN interface usiState USINT new CiA State (see IndicatorConstants )
Internal ¶ All functions in this folder are unmanaged functions. No resource manager is managing the resources. This means that the caller is responsible for freeing all resources (Prefix “_”). Functions without resource manager have better performance. Handles returned by unmanaged functions should not be used with managed functions and vice versa. Basic Functions _CloneMessage (Function) _CreateArrayReceiver (Function) _CreateIdAreaReceiver (Function) _CreateMaskReceiver (Function) _CreateMessage (Function) _CreateSingleIdReceiver (Function) _DeleteReceiver (Function) _DriverClose (Function) _DriverGetSize (Function) _DriverOpenH (Function) _DriverOpenP (Function) _FreeMessage (Function) _Read (Function) _ReadArrayReceiver (Function) _RegisterIdArea (Function) _UnregisterIdArea (Function) _Write (Function) Diagnostic Information _GetBaudrate (Function) _GetBusAlarm (Function) _GetBusState (Function) _GetBusload (Function) _GetDiagnosis (Function) _GetLostCounter (Function) _GetReceiveCounter (Function) _GetReceiveErrorCounter (Function) _GetReceivePoolSize (Function) _GetReceiveQueueLength (Function) _GetTransmitCounter (Function) _GetTransmitErrorCounter (Function) _GetTransmitPoolSize (Function) _GetTransmitQueueLength (Function) _IsSendingActive (Function) _ResetBusAlarm (Function) Extended Functionality _DisableSyncService (Function) _EnableSyncService (Function) Indicator Services _GetCiAState (Function) _SetCiAState (Function) Message Information _GetMessageDataPointer (Function) _GetMessageId (Function) _GetMessageLength (Function) _GetMsgCount (Function) _GetNetId (Function) _GetTimeStamp (Function) _Is29BitIdMessage (Function) _IsRTRMessage (Function) _IsTransmitMessage (Function) _LostMessages (Function)
Basic Functions ¶ _CloneMessage (Function) _CreateArrayReceiver (Function) _CreateIdAreaReceiver (Function) _CreateMaskReceiver (Function) _CreateMessage (Function) _CreateSingleIdReceiver (Function) _DeleteReceiver (Function) _DriverClose (Function) _DriverGetSize (Function) _DriverOpenH (Function) _DriverOpenP (Function) _FreeMessage (Function) _Read (Function) _ReadArrayReceiver (Function) _RegisterIdArea (Function) _UnregisterIdArea (Function) _Write (Function)
Diagnostic Information ¶ _GetBaudrate (Function) _GetBusAlarm (Function) _GetBusState (Function) _GetBusload (Function) _GetDiagnosis (Function) _GetLostCounter (Function) _GetReceiveCounter (Function) _GetReceiveErrorCounter (Function) _GetReceivePoolSize (Function) _GetReceiveQueueLength (Function) _GetTransmitCounter (Function) _GetTransmitErrorCounter (Function) _GetTransmitPoolSize (Function) _GetTransmitQueueLength (Function) _IsSendingActive (Function) _ResetBusAlarm (Function)
Extended Functionality ¶ _DisableSyncService (Function) _EnableSyncService (Function)
Indicator Services ¶ _GetCiAState (Function) _SetCiAState (Function)
Message Information ¶ _GetMessageDataPointer (Function) _GetMessageId (Function) _GetMessageLength (Function) _GetMsgCount (Function) _GetNetId (Function) _GetTimeStamp (Function) _Is29BitIdMessage (Function) _IsRTRMessage (Function) _IsTransmitMessage (Function) _LostMessages (Function)
Message Information ¶ Functions for getting message information (CAN ID, Data, message length, …) about a given message handle. GetMessageDataPointer (Function) GetMessageId (Function) GetMessageLength (Function) GetMsgCount (Function) GetNetId (Function) GetTimeStamp (Function) Is29BitIdMessage (Function) IsRTRMessage (Function) IsTransmitMessage (Function) LostMessages (Function)
GetMessageDataPointer (FUN) ¶ FUNCTION GetMessageDataPointer : POINTER TO CL2I.DATA Returns pointer to the eight data bytes of a message. Number of valid bytes can be retrieved by GetMessageLength . Note The data is organised in the “Network Byte Order“ of the CANbus. The alignment of data types in the RTS memory may differ from the alignment in the data messages. Example VAR hMsg : CAA.HANDLE ; pData : POINTER TO CL2I.DATA ; usiMsgLen : USINT ; byFirstByte : BYTE ; bySecondByte : BYTE ; eError : CL2.ERROR ; END_VAR IF hMsg <> CAA.gc_hINVALID THEN //Get message data pointer pData := CL2.GetMessageDataPointer ( hMessage := hMsg , peError := ADR ( eError )); usiMsgLen := CL2.GetMessageLength ( hMessage := hMsg , peError := ADR ( eError )); //get number of valid bytes IF pData <> CAA.gc_pNULL THEN byFirstByte := pData ^ [0] ; bySecondByte := pData ^ [1] ; END_IF END_IF InOut: Scope Name Type Comment Return GetMessageDataPointer POINTER TO CL2I.DATA Pointer to message data Input hMessage CAA.HANDLE handle of message peError POINTER TO ERROR optional pointer to error enum