spatial-monorepo / rtls/src / KontaktAdapter
Class: KontaktAdapter
Defined in: packages/rtls/src/adapters/kontakt.ts:45
Extends
Constructors
Constructor
new KontaktAdapter(
id,url,apiKey,opts?):KontaktAdapter
Defined in: packages/rtls/src/adapters/kontakt.ts:46
Parameters
id
string
url
string
apiKey
string
opts?
coordinateMode?
"meter" | "latlon"
Returns
KontaktAdapter
Overrides
GenericWebSocketAdapter.constructor
Properties
_ws
_ws:
WebSocket|null=null
Defined in: packages/rtls/src/adapters/generic-ws.ts:39
Exposed as _ws for testing purposes
Inherited from
coordinateMode
readonlycoordinateMode:"meter"|"latlon"
Defined in: packages/rtls/src/adapters/generic-ws.ts:33
Inherited from
GenericWebSocketAdapter.coordinateMode
id
readonlyid:string
Defined in: packages/rtls/src/base-adapter.ts:26
Inherited from
transport
readonlytransport:"websocket"
Defined in: packages/rtls/src/adapters/generic-ws.ts:32
Inherited from
GenericWebSocketAdapter.transport
vendor
readonlyvendor:RTLSVendor='websocket'
Defined in: packages/rtls/src/adapters/generic-ws.ts:31
Inherited from
GenericWebSocketAdapter.vendor
Methods
connect()
connect():
Promise`<void>`
Defined in: packages/rtls/src/base-adapter.ts:57
Returns
Promise`<void>`
Inherited from
GenericWebSocketAdapter.connect
disconnect()
disconnect():
Promise`<void>`
Defined in: packages/rtls/src/base-adapter.ts:65
Returns
Promise`<void>`
Inherited from
GenericWebSocketAdapter.disconnect
doConnect()
protecteddoConnect():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>`
Inherited from
GenericWebSocketAdapter.doConnect
doDisconnect()
protecteddoDisconnect():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>`
Inherited from
GenericWebSocketAdapter.doDisconnect
emit()
protectedemit(update):void
Defined in: packages/rtls/src/base-adapter.ts:101
Broadcast a position update to all subscribers
Parameters
update
Returns
void
Inherited from
handleConnectionError()
protectedhandleConnectionError():void
Defined in: packages/rtls/src/base-adapter.ts:109
Call when the connection drops unexpectedly — triggers reconnection
Returns
void
Inherited from
GenericWebSocketAdapter.handleConnectionError
health()
health():
AdapterHealth
Defined in: packages/rtls/src/base-adapter.ts:84
Returns
Inherited from
GenericWebSocketAdapter.health
setConnected()
protectedsetConnected():void
Defined in: packages/rtls/src/base-adapter.ts:91
Call after successful connection establishment
Returns
void
Inherited from
GenericWebSocketAdapter.setConnected
subscribe()
subscribe(
cb):Unsubscribe
Defined in: packages/rtls/src/base-adapter.ts:77
Parameters
cb
(u) => void
Returns
Inherited from
GenericWebSocketAdapter.subscribe
mapPayload()
staticmapPayload(raw):PositionUpdate|null
Defined in: packages/rtls/src/adapters/kontakt.ts:73
Parameters
raw
unknown
Returns
PositionUpdate | null
