CAPLfunctionsCANOverview

CAN CAPL Functions

Valid for: CANoe DE • CANoe:lite DE • CANoe4SW DE • CANoe4SW:lite DE

ON THIS PAGE:

• Bus Statistics
• CANdb API
• Event Procedures
• General Functions
• Hardware API
• Selectors
• Statistics API

Bus Statistics

• canEnableStatistics: Enables or disables CAN statistics on a specific (Form 1) or all (Form 2) CAN channels.
• canGetBurstsCount: Gets the total count of bursts of a CAN channel.
• canGetBurstTime: Gets the burst time of a CAN channel in microseconds.
• canGetBusLoad: Gets the busload of a CAN channel in percent.
• canGetChipState: Gets the current chip state of a CAN channel.
• canGetErrorFrameCount: Gets the total count of error frames of a CAN channel.
• canGetErrorFrameRate: Gets the error frame rate of a CAN channel in frames per second [fr/s].
• canGetExtDataCount: Gets the total count of extended data frames of a CAN channel.
• canGetExtDataRate: Gets the rate of extended data frames of a CAN channel in frames per second [fr/s].
• canGetExtRemoteCount: Gets the total count of extended remote frames of a CAN channel.
• canGetExtRemoteRate: Gets the rate of extended remote frames of a CAN channel in frames per second [fr/s].
• canGetFramesPerBurstCount: Gets the count of frames per burst of a CAN channel.
• canGetMinSendDistance: Gets the minimum distance between two consecutive frames of a CAN channel in milliseconds.
• canGetOverloadFrameCount: Gets the total count of overload frames of a CAN channel.
• canGetOverloadFrameRate: Gets the rate of overload frames of a CAN channel in frames per second [fr/s].
• canGetRxErrorCount: Gets the total count of receive errors of a CAN channel.
• canGetStdDataCount: Gets the total count of standard data frames of a CAN channel.
• canGetStdDataRate: Gets the rate of standard data frames of a CAN channel in frames per second [fr/s].
• canGetStdRemoteCount: Gets the total count of standard remote frames of a CAN channel.
• canGetStdRemoteRate: Gets the rate of standard remote frames of a CAN channel in frames per second [fr/s].
• canGetTransceiverErrorCount: Gets the total count of transceiver errors of a CAN channel.
• canGetTxErrorCount: Gets the total count of transmit errors of a CAN channel.

CANdb API

• getFirstCANdbFilename: Finds out the filename of the first assigned database.
• getFirstCANdbName: Finds out the name of the first assigned database.
• getSignalName: Returns the signal name at indexed positions (start bit) in the payload of a CAN message for CAN networks. (Form 1) Returns the signal name at indexed positions (start bit) of a PDU for CAN networks. (Form 2)
• getMessageAttrInt: Gets the value of a message attribute from the database.
• GetMessageID: Finds out the message ID.
• GetMessageName: Finds out the message name.
• getNextCANdbFilename: Finds out the filenames of the other assigned databases.
• getNextCANdbName: Finds out the names of the other assigned databases.
• setSignalStartValues: Sets the values of the signals in the parameter to the start values defined in the database.

Event Procedures

• on busIntegration: Is called when a CAN channel is Bus Integrated (e.g. after the start of measurement, rest or bit timing changed).
• on errorFrame: Occurrence of an Error Frame.
• on message: Receipt of a CAN message.
• on signal: Is called with every signal change.
• on signal_change: Is called with every signal change.
• on signal_update: Is called with every signal reception.

Events of CAN controller

• on busOff: CAN controller goes to Bus Off.
• on errorActive: CAN controller goes to ErrorActive.
• on errorPassive: CAN controller goes to ErrorPassive.
• on warningLimit: CAN controller reaches the Warning Limit.

General Functions

• canConfigureBusOff: Sets the bus state to BussOff.
• canGetDataLength: Returns the valid payload length of the can message.
• canOutputErrorFrame: Outputs an Error Frame to the CAN bus.
• getPayloadData: Returns the valid payload of a frame that was interrupted during transmission.
• isStdId: Checks parameter for standard identifier.
• isExtId: Checks parameter for extended identifier.
• mkExtId: Returns an extended ID.
• output: Outputs a message or an Error Frame from the program block.
• valOfId: Returns the value of a message identifier independent of its type.

Hardware API

• canActivateTxSelfAck: Activates/deactivates the transmit self ack feature for the defined channel.
• canFdGetConfiguration: Gets the CAN controller parameters for arbitration and data phase.
• canFdSetConfiguration: Sets the CAN controller parameters for arbitration and data phase.
• canFlushTxQueue: Flushes the Tx queue for the defined channel.
• canGetConfiguration: Reads the CAN controller parameters.
• canSetChannelAcc: Sends received messages through to your CANoe DE product via an acceptance filter.
• canSetChannelMode: Activates/deactivates the TXRQ of the CAN controller.
• canSetChannelOutput: Defines the response of the CAN controller to the bus traffic and sets the ACK bit.
• canSetConfiguration: Sets the CAN controller parameters.
• GetCanBittimingConfiguration: Returns the configured bit timings.
• getCardTypeEx: Determines the card type of CAN channel.
• getChipType: Determines the type of CAN controller used.
• resetCan: Resets the CAN controller.
• ResetCanEx: Resets the CAN controller for one specific CAN channel.
• ScanBaudrateActive: Determines the baudrate for the given channel.
• ScanBaudratePassive: Starts the scan and detects the baudrate on the given channel.
• setBtr: Sets another baudrate.
• SetCanBittimingConfiguration: Configures the bit timings.
• setOcr: Sets the Output Control Register.

Selectors

• Message: Detailed description of the CAN message selectors.
• ErrorFrame: Detailed description of the CAN Error Frame selectors.

Statistics API

• canResetStatistics: Resets CAN statistics.
• BusLoad: Returns the current busload of a channel.
• ChipState: Returns the current chip state of the CAN controller.
• ExtendedFrameRate: Returns the current rate of extended CAN messages on a channel.
• ExtendedRemoteFrameRate: Returns the number of extended remote CAN messages on a channel since start of measurement.
• RxChipErrorCount: Returns the current Rx error count in the receiver of a channel.
• StandardFrameRate: Returns the current rate of standard CAN messages on a channel.
• StandardRemoteFrameRate: Returns the current rate of standard CAN messages on a channel.
• TxChipErrorCount: Returns the current number of Tx errors in the CAN receiver of a channel.