spatial-monorepo

---

spatial-monorepo / rtls/src / GenericWebSocketAdapter

Class: GenericWebSocketAdapter

Defined in: packages/rtls/src/adapters/generic-ws.ts:30

Extends

• BaseAdapter

Extended by

• SewioAdapter
• KontaktAdapter
• ZebraMotionWorksAdapter

Constructors

Constructor

new GenericWebSocketAdapter(id, url, mapPayload, opts?): GenericWebSocketAdapter

Defined in: packages/rtls/src/adapters/generic-ws.ts:50

Parameters

id

string

url

string

mapPayload

(raw) => PositionUpdate | null

opts?

coordinateMode?

"meter" | "latlon"

Returns

GenericWebSocketAdapter

Overrides

BaseAdapter.constructor

Properties

_ws

_ws: WebSocket | null = null

Defined in: packages/rtls/src/adapters/generic-ws.ts:39

Exposed as _ws for testing purposes

---

coordinateMode

readonly coordinateMode: "meter" | "latlon"

Defined in: packages/rtls/src/adapters/generic-ws.ts:33

Overrides

BaseAdapter.coordinateMode

---

id

readonly id: string

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

Inherited from

BaseAdapter.id

---

transport

readonly transport: "websocket"

Defined in: packages/rtls/src/adapters/generic-ws.ts:32

Overrides

BaseAdapter.transport

---

vendor

readonly vendor: RTLSVendor = 'websocket'

Defined in: packages/rtls/src/adapters/generic-ws.ts:31

Overrides

BaseAdapter.vendor

Methods

connect()

connect(): Promise`<void>`

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

Returns

Promise`<void>`

Inherited from

BaseAdapter.connect

---

disconnect()

disconnect(): Promise`<void>`

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

Returns

Promise`<void>`

Inherited from

BaseAdapter.disconnect

---

doConnect()

protected doConnect(): Promise`<void>`

Defined in: packages/rtls/src/adapters/generic-ws.ts:62

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

Returns

Promise`<void>`

Overrides

BaseAdapter.doConnect

---

doDisconnect()

protected doDisconnect(): Promise`<void>`

Defined in: packages/rtls/src/adapters/generic-ws.ts:155

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

Returns

Promise`<void>`

Overrides

BaseAdapter.doDisconnect

---

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

Inherited from

BaseAdapter.emit

---

handleConnectionError()

protected handleConnectionError(): void

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

Call when the connection drops unexpectedly — triggers reconnection

Returns

void

Inherited from

BaseAdapter.handleConnectionError

---

health()

health(): AdapterHealth

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

Returns

AdapterHealth

Inherited from

BaseAdapter.health

---

setConnected()

protected setConnected(): void

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

Call after successful connection establishment

Returns

void

Inherited from

BaseAdapter.setConnected

---

subscribe()

subscribe(cb): Unsubscribe

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

Parameters

cb

(u) => void

Returns

Unsubscribe

Inherited from

BaseAdapter.subscribe