Class NmeaClient<TData, TPackets>

Simple client for managing NMEA connections. Abstracts away XState details while still exposing the machine for advanced use.

Type Parameters

TData
TPackets extends Record<string, PacketStub | undefined>

Hierarchy (View Summary)

NmeaClient
- NavigationNmeaClient

Index

Accessors

data isConnected isConnecting error machine

Constructors

Methods

connect disconnect setLogging setBaudRate dispose

Accessors

data

get data(): TData
Gets the current data.

Returns TData
- Defined in packages/nmea-web-serial/src/core/client.ts:84

isConnected

get isConnected(): boolean
Gets whether the connection is currently active.

Returns boolean
- Defined in packages/nmea-web-serial/src/core/client.ts:92

isConnecting

get isConnecting(): boolean
Gets whether the connection is in progress.

Returns boolean
- Defined in packages/nmea-web-serial/src/core/client.ts:100

error

get error(): string | null
Gets the current error message, if any.

Returns string | null
- Defined in packages/nmea-web-serial/src/core/client.ts:108

machine

get machine(): NmeaMachineActor<TData, TPackets>
Gets the underlying XState actor (for advanced users). Allows access to full XState functionality.

Returns NmeaMachineActor<TData, TPackets>
- Defined in packages/nmea-web-serial/src/core/client.ts:145

Constructors

constructor

new NmeaClient<
    TData,
    TPackets extends Record<string, PacketStub<string> | undefined>,
>(
    machine: StateMachine<NmeaContext<TData, TPackets>>,
    options?: NmeaClientOptions<TData>,
): NmeaClient<TData, TPackets>
Creates a new NMEA client.
Type Parameters
- TData
- TPackets extends Record<string, PacketStub<string> | undefined>
Parameters
- machine: StateMachine<NmeaContext<TData, TPackets>>
  The NMEA machine instance (created with createNmeaMachine).
- Optionaloptions: NmeaClientOptions<TData>
  Optional configuration and callbacks.
Returns NmeaClient<TData, TPackets>
- Defined in packages/nmea-web-serial/src/core/client.ts:42

Methods

connect

connect(): void
Connects to the serial port.

Returns void
- Defined in packages/nmea-web-serial/src/core/client.ts:116

disconnect

disconnect(): void
Disconnects from the serial port.

Returns void
- Defined in packages/nmea-web-serial/src/core/client.ts:123

setLogging

setLogging(enabled: boolean): void
Sets logging enabled/disabled.
Parameters
- enabled: boolean
Returns void
- Defined in packages/nmea-web-serial/src/core/client.ts:130

setBaudRate

setBaudRate(baudRate: number): void
Sets the baud rate (requires reconnection to take effect).
Parameters
- baudRate: number
Returns void
- Defined in packages/nmea-web-serial/src/core/client.ts:137

dispose

dispose(): void
Disposes of the client and cleans up resources.

Returns void
- Defined in packages/nmea-web-serial/src/core/client.ts:152