Serial: events

Complete reference. The signature is a listener argument tuple, not a wrapper object.

serial:reconnecting

A retry was scheduled: attempt is its one-based number (number), delay is the capped wait in milliseconds (number).

type Arguments = Parameters<import('serial-core').SerialEvents['reconnecting']>;

jsd.on('serial:reconnecting', payload => console.log(payload));

serial:reconnectFailed

Automatic retries were exhausted: attempts is the number of retries consumed (number), excluding the initial attempt.

type Arguments = Parameters<import('serial-core').SerialEvents['reconnectFailed']>;

jsd.on('serial:reconnectFailed', payload => console.log(payload));

serial:status

Serial service state changed.

type Arguments = [status: SerialStatus];

jsd.on('serial:status', payload => console.log(payload));

serial:connected

Serial service connected; JSD schedules initial machine queries after 100 ms.

type Arguments = [info: { path: string; baudRate: number }];

jsd.on('serial:connected', payload => console.log(payload));

serial:disconnected

Serial service disconnected, with its reason.

type Arguments = [reason: string];

jsd.on('serial:disconnected', payload => console.log(payload));

serial:error

Transport or session failure from serial-core.

type Arguments = [err: Error];

jsd.on('serial:error', payload => console.log(payload));

serial:message

Every nonempty received frame, including invalid frames; includes raw bytes and command alias.

type Arguments = [
    data: {
      raw: Buffer;
      parsed: VisionResponse | string;
      alias: string;
    }
  ];

jsd.on('serial:message', payload => console.log(payload));

serial:jsd-error

Parser validation failure or JSD queue retry exhaustion. The argument is a string, not an Error.

type Arguments = [parsed: string];

jsd.on('serial:jsd-error', payload => console.log(payload));

serial:jsd-ack

Positive protocol acknowledgement, also dequeuing a matching command.

type Arguments = [parsed: VisionResponse];

jsd.on('serial:jsd-ack', payload => console.log(payload));

serial:jsd-nack

Negative acknowledgement. It does not complete a command or cancel retries.

type Arguments = [parsed: VisionResponse];

jsd.on('serial:jsd-nack', payload => console.log(payload));

serial:jsd-data

Valid application data, emitted after routing it to the application.

type Arguments = [parsed: VisionResponse];

jsd.on('serial:jsd-data', payload => console.log(payload));

Aliases used in these signatures are defined in reference types.