Skip to content

spatial-monorepo


spatial-monorepo / rtls/src / BaseAdapter

Abstract Class: BaseAdapter

Defined in: packages/rtls/src/base-adapter.ts:25

Extended by

Implements

Constructors

Constructor

new BaseAdapter(id): BaseAdapter

Defined in: packages/rtls/src/base-adapter.ts:42

Parameters

id

string

Returns

BaseAdapter

Properties

coordinateMode

abstract readonly coordinateMode: "meter" | "latlon"

Defined in: packages/rtls/src/base-adapter.ts:29

Implementation of

RTLSAdapter.coordinateMode


id

readonly id: string

Defined in: packages/rtls/src/base-adapter.ts:26

Implementation of

RTLSAdapter.id


transport

abstract readonly transport: "mqtt" | "websocket" | "sse" | "http-poll" | "grpc-web" | "sdk"

Defined in: packages/rtls/src/base-adapter.ts:28

Implementation of

RTLSAdapter.transport


vendor

abstract readonly vendor: RTLSVendor

Defined in: packages/rtls/src/base-adapter.ts:27

Implementation of

RTLSAdapter.vendor

Methods

connect()

connect(): Promise`<void>`

Defined in: packages/rtls/src/base-adapter.ts:57

Returns

Promise`<void>`

Implementation of

RTLSAdapter.connect


disconnect()

disconnect(): Promise`<void>`

Defined in: packages/rtls/src/base-adapter.ts:65

Returns

Promise`<void>`

Implementation of

RTLSAdapter.disconnect


doConnect()

abstract protected doConnect(): Promise`<void>`

Defined in: packages/rtls/src/base-adapter.ts:50

Subclass performs actual connection (e.g., open WebSocket). Must call this.setConnected() on success or this.handleConnectionError() on failure.

Returns

Promise`<void>`


doDisconnect()

abstract protected doDisconnect(): Promise`<void>`

Defined in: packages/rtls/src/base-adapter.ts:53

Subclass tears down the actual connection (e.g., close WebSocket).

Returns

Promise`<void>`


emit()

protected emit(update): void

Defined in: packages/rtls/src/base-adapter.ts:101

Broadcast a position update to all subscribers

Parameters

update

PositionUpdate

Returns

void


handleConnectionError()

protected handleConnectionError(): void

Defined in: packages/rtls/src/base-adapter.ts:109

Call when the connection drops unexpectedly — triggers reconnection

Returns

void


health()

health(): AdapterHealth

Defined in: packages/rtls/src/base-adapter.ts:84

Returns

AdapterHealth

Implementation of

RTLSAdapter.health


setConnected()

protected setConnected(): void

Defined in: packages/rtls/src/base-adapter.ts:91

Call after successful connection establishment

Returns

void


subscribe()

subscribe(cb): Unsubscribe

Defined in: packages/rtls/src/base-adapter.ts:77

Parameters

cb

(u) => void

Returns

Unsubscribe

Implementation of

RTLSAdapter.subscribe

Released under commercial licensing.