Interface ICANPort

CAN Port - Raw CAN frame interface

This port handles:

Sending raw CAN frames
Receiving raw CAN frames via callback
Setting hardware/software filters

interface ICANPort {
    close(): void;
    getInterface(): string;
    isConnected(): boolean;
    onFrame(callback: (frame: CANFrame) => void): void;
    send(frame: CANFrame): Promise<void>;
    setFilters(filters: CANFilter[]): void;
}

Implemented by

VirtualCANPort

Index

Methods

close getInterface isConnected onFrame send setFilters

Methods

close

close(): void
Close the port

Returns void
- Defined in src/interfaces/CANPort.ts:59

getInterface

getInterface(): string
Get interface name (e.g., "vcan0", "can0")

Returns string
- Defined in src/interfaces/CANPort.ts:49

isConnected

isConnected(): boolean
Check if port is connected

Returns boolean
- Defined in src/interfaces/CANPort.ts:54

onFrame

onFrame(callback: (frame: CANFrame) => void): void
Register callback for incoming frames
Parameters
- callback: (frame: CANFrame) => void
Returns void
- Defined in src/interfaces/CANPort.ts:38

send

send(frame: CANFrame): Promise<void>
Send a raw CAN frame
Parameters
- frame: CANFrame
Returns Promise<void>
- Defined in src/interfaces/CANPort.ts:33

setFilters

setFilters(filters: CANFilter[]): void
Set CAN filters (hardware or software) Empty array = accept all frames
Parameters
- filters: CANFilter[]
Returns void
- Defined in src/interfaces/CANPort.ts:44