pamoja for TypeScript - v0.2.0
    Preparing search index...

    Class CanBus

    One node's place on a CAN bus.

    CanBus.open(interface) opens a kernel CAN interface, such as can0, through SocketCAN on a Linux board and throws anywhere else. CanBus.simulated() makes a bus inside the program, and join() puts another node on the same bus. A node hears every frame the others send and none of its own, and keeps only the frames its filters pass. send and receive return promises; a receive on a simulated bus with nothing waiting resolves at once with null and counts its timeout in waitedMicros.

    Index
    constructor
    interface kind received sent waitedMicros
    clearFilters join receive send setFilters open simulated
    • get interface(): string | null

      The kernel interface the node is on, or null on a simulated bus.

      Returns string | null

    • get waitedMicros(): number

      How long receives on the node have waited without a frame, in microseconds, whether or not the process slept through it.

      Returns number

    • Resolves with the next frame the node keeps, waiting up to timeoutMs for one, or with null when the timeout passed with nothing.

      Parameters

      • timeoutMs: number

      Returns Promise<can.CanFrame | null>

    • Opens a kernel CAN interface through SocketCAN, as one node on its bus. Bring the interface up first, with ip link set can0 up type can bitrate 250000.

      Parameters

      • interface: string

      Returns can.CanBus

    Settings
    Member Visibility

    On This Page
    Constructors
    Accessors
    Methods