package socketcan

You can search for identifiers within the package.

in-package search v0.2.0

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

Legend:
Library
Module
Module type
Parameter
Class
Class type

The SocketCAN BroadCast Manager (BCM) allows to send CAN message frames from kernel space; the kernel e.g. can then send periodic messages without having to be triggered by user space.

type t

CAN broadcast manager

type opcode =

| TX_SETUP
| TX_DELETE
| TX_READ
| TX_SEND
| TX_STATUS
| TX_EXPIRED
| RX_SETUP
| RX_DELETE
| RX_READ
| RX_STATUS
| RX_TIMEOUT
| RX_CHANGED

type flag =

| SETTIMER
| STARTTIMER
| TX_COUNTEVT
| TX_ANNOUNCE
| TX_CP_CAN_ID
| RX_FILTER_ID
| RX_CHECK_DLC
| RX_NO_AUTOTIMER
| RX_ANNOUNCE_RESUME
| TX_RESET_MULTI_IDX
| RX_RTR_FRAME

val create : string -> (t, [> `EUnix of Unix.error ]) Result.result

create s opens the can-interface named s (e.g. "can0")

val close : t -> unit

close s closes the socket s.

type timer = Posix_time.Timeval.t

time value with seconds tv_sec and microseconds tv_usec

val write : 
  t ->
  opcode list ->
  flag list ->
  (int * timer * timer * Id.t) ->
  Frame.t list ->
  (unit, [> `EUnix of Unix.error ]) Result.result

write socket ops flags (x, t1, t2, id) frames writes the configuration to the broadcast socket

val fd : t -> Unix.file_descr

fs s will return a Unix-file-descriptor of the socket s; this file-descriptor can then be used with e.g. Unix.select.