API Docs for:
Show:

RawChannel Class

Defined in: src/raw.h:51
Module: CAN

A Raw channel to access a certain CAN channel (e.g. vcan0) via CAN messages.

Item Index

Methods

addListener

(
  • event
  • callback
  • instance
)

Defined in src/raw.h:72

Add listener to receive certain notifications

Parameters:

  • event String

    onMessage to register for incoming messages

  • callback Any

    JS callback object

  • instance Any

    Optional instance pointer to call callback

send

(
  • message
)

Defined in src/raw.h:93

Send a CAN message immediately

Parameters:

  • message Object

    JSON object describing the CAN message, keys are id, length, data {Buffer}, ext or rtr

setRxFilters

(
  • filters
)

Defined in src/raw.h:100

Set a list of active filters to be applied for incoming messages

Parameters:

  • filters Object

    single filter or array of filter e.g. { id: 0x1ff, mask: 0x1ff, invert: false}, result of (id & mask)

start

()

Defined in src/raw.h:81

Start operation on this CAN channel

stop

()

Defined in src/raw.h:87

Stop any operations on this CAN channel