package socketcan

You can search for identifiers within the package.

in-package search v0.2.0

package socketcan

socketcan
- Socketcan
  - BCM
  - Error
  - Filter
  - Frame
  - Id
  - Mask
  - Socket

Legend:
Library
Module
Module type
Parameter
Class
Class type

Errors of the CAN interface

type t =

| CAN_ERR_TX_TIMEOUT
| CAN_ERR_LOSTARB
| CAN_ERR_CRTL
| CAN_ERR_PROT
| CAN_ERR_TRX
| CAN_ERR_ACK
| CAN_ERR_BUSOFF
| CAN_ERR_BUSERROR
| CAN_ERR_RESTARTED

error class which gets encoded in the can-id of error-frames

type status =

| CAN_ERR_CRTL_RX_OVERFLOW
| CAN_ERR_CRTL_TX_OVERFLOW
| CAN_ERR_CRTL_RX_WARNING
| CAN_ERR_CRTL_TX_WARNING
| CAN_ERR_CRTL_RX_PASSIVE
| CAN_ERR_CRTL_TX_PASSIVE
| CAN_ERR_PROT_BIT
| CAN_ERR_PROT_FORM
| CAN_ERR_PROT_STUFF
| CAN_ERR_PROT_BIT0
| CAN_ERR_PROT_BIT1
| CAN_ERR_PROT_OVERLOAD
| CAN_ERR_PROT_ACTIVE
| CAN_ERR_PROT_TX
| CAN_ERR_PROT_LOC_SOF
| CAN_ERR_PROT_LOC_ID28_21
| CAN_ERR_PROT_LOC_ID20_18
| CAN_ERR_PROT_LOC_SRTR
| CAN_ERR_PROT_LOC_IDE
| CAN_ERR_PROT_LOC_ID17_13
| CAN_ERR_PROT_LOC_ID12_05
| CAN_ERR_PROT_LOC_ID04_00
| CAN_ERR_PROT_LOC_RTR
| CAN_ERR_PROT_LOC_RES1
| CAN_ERR_PROT_LOC_RES0
| CAN_ERR_PROT_LOC_DLC
| CAN_ERR_PROT_LOC_DATA
| CAN_ERR_PROT_LOC_CRC_SEQ
| CAN_ERR_PROT_LOC_CRC_DEL
| CAN_ERR_PROT_LOC_ACK
| CAN_ERR_PROT_LOC_ACK_DEL
| CAN_ERR_PROT_LOC_EOF
| CAN_ERR_PROT_LOC_INTERM
| CAN_ERR_TRX_CANH_NO_WIRE
| CAN_ERR_TRX_CANH_SHORT_TO_BAT
| CAN_ERR_TRX_CANH_SHORT_TO_VCC
| CAN_ERR_TRX_CANH_SHORT_TO_GND
| CAN_ERR_TRX_CANL_NO_WIRE
| CAN_ERR_TRX_CANL_SHORT_TO_BAT
| CAN_ERR_TRX_CANL_SHORT_TO_VCC
| CAN_ERR_TRX_CANL_SHORT_TO_GND
| CAN_ERR_TRX_CANL_SHORT_TO_CANH

error status that is encoded in the payload of error-frames

val of_frame : Frame.t -> t list * status list

of_frame f parses the given frame f for it's error class and error status. If f is not an error frame, empty lists are returned.

val string_of : t -> string

val string_of_status : status -> string