Diagnostic Information ¶ Functions for getting diagnostic information about a given CAN Network. 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)
GetBaudrate (FUN) ¶ FUNCTION GetBaudrate : UINT This function returns the current baudrate of the bus. Information can be also read by GetDiagnosis . 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 This function returns if the CAN chip is in Bus Alarm state. In this state sending and receiving messages is not possible. A Bus Alarm can be reset by ResetBusAlarm which leads to a re-initialization of the CAN chip. Diagnostic Information can be also read by GetDiagnosis . 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 This function return the current state of the bus. Diagnostic Information can be also read by GetDiagnosis . 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
GetBusload (FUN) ¶ FUNCTION GetBusload : USINT This function is not implemented by all drivers. It returns the current busload in percent. Diagnostic Information can be also read by GetDiagnosis . InOut: Scope Name Type Comment Return GetBusload USINT bus load (0..100) in percent Input hDriver CAA.HANDLE handle of CAN interface peError POINTER TO ERROR optional pointer to error enum
GetDiagnosis (FUN) ¶ FUNCTION GetDiagnosis : ERROR Function returns all relevant diagnostic information for a specific driver. InOut: Scope Name Type Comment Return GetDiagnosis ERROR ERROR.NO_ERROR or appropriate error code Input hDriver CAA.HANDLE handle of CAN interface pDiagnosisInfo POINTER TO DIAGNOSIS_INFO Pointer to diagnostic information
GetLostCounter (FUN) ¶ FUNCTION GetLostCounter : CAA.COUNT Returns a counter which is incremented with each lost message. Diagnostic Information can be also read by GetDiagnosis . InOut: Scope Name Type Comment Return GetLostCounter CAA.COUNT number of lost messages Input hDriver CAA.HANDLE handle of CAN interface peError POINTER TO ERROR optional pointer to error enum
GetReceiveCounter (FUN) ¶ FUNCTION GetReceiveCounter : CAA.COUNT Returns a counter which is incremented with each received message. Diagnostic Information can be also read by GetDiagnosis . InOut: Scope Name Type Comment Return GetReceiveCounter CAA.COUNT number of received messages Input hDriver CAA.HANDLE handle of CAN interface peError POINTER TO ERROR optional pointer to error enum
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 03.07.2017, 15:38:08 companyName string 3S-Smart Software Solutions GmbH libraryFile CAA_CanL2I_Extern.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP11 contentFile CAA_CanL2I_Extern.clean.json version version 2.0.0.0 ProjectInformation Depends on RTS bool False Depends onPS False Released True SIL2 False LastModificationDateTime date 03.07.2017, 15:38:06 LibraryCategories library-category-list Intern|CAA|Fieldbus Author string 3S - Smart Software Solutions GmbH Company CAA Technical Workgroup DefaultNamespace CL2I Description See: Description DocFormat reStructuredText LanguageModelAttribute qualified-access-only Placeholder CAA CanL2I Project CAA_CanL2I_Extern Title CAA Can Low Level Imp Extern SpecVersion version 3.0.0.0 Version 3.5.11.0
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. 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