Interface ITransport

Transport abstraction interface

interface ITransport {
    connect(): Promise<void>;
    disconnect(): Promise<void>;
    isConnected(): boolean;
    onFrame(handler: (frame: CANFrame) => void): void;
    send(frame: CANFrame): Promise<void>;
}

Implemented by

VirtualTransport

Index

Methods

connect disconnect isConnected onFrame send

Methods

connect

connect(): Promise<void>
Connect to the CAN bus

Returns Promise<void>
- Defined in src/types.ts:34

disconnect

disconnect(): Promise<void>
Disconnect from the CAN bus

Returns Promise<void>
- Defined in src/types.ts:37

isConnected

isConnected(): boolean
Check if connected

Returns boolean
- Defined in src/types.ts:46

onFrame

onFrame(handler: (frame: CANFrame) => void): void
Register frame receive handler
Parameters
- handler: (frame: CANFrame) => void
Returns void
- Defined in src/types.ts:43

send

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