spatial-monorepo / rtls/src / QuuppaAdapter
Class: QuuppaAdapter
Defined in: packages/rtls/src/adapters/quuppa.ts:39
Extends
Constructors
Constructor
new QuuppaAdapter(
id,url,projectKey,opts?):QuuppaAdapter
Defined in: packages/rtls/src/adapters/quuppa.ts:42
Parameters
id
string
url
string
projectKey
string
opts?
coordinateMode?
"meter" | "latlon"
intervalMs?
number
Returns
QuuppaAdapter
Overrides
GenericRESTPollAdapter.constructor
Properties
coordinateMode
readonlycoordinateMode:"meter"|"latlon"
Defined in: packages/rtls/src/adapters/generic-poll.ts:25
Inherited from
GenericRESTPollAdapter.coordinateMode
id
readonlyid:string
Defined in: packages/rtls/src/base-adapter.ts:26
Inherited from
transport
readonlytransport:"http-poll"
Defined in: packages/rtls/src/adapters/generic-poll.ts:24
Inherited from
GenericRESTPollAdapter.transport
vendor
readonlyvendor:"quuppa"
Defined in: packages/rtls/src/adapters/quuppa.ts:40
Overrides
Methods
connect()
connect():
Promise`<void>`
Defined in: packages/rtls/src/base-adapter.ts:57
Returns
Promise`<void>`
Inherited from
GenericRESTPollAdapter.connect
disconnect()
disconnect():
Promise`<void>`
Defined in: packages/rtls/src/base-adapter.ts:65
Returns
Promise`<void>`
Inherited from
GenericRESTPollAdapter.disconnect
doConnect()
protecteddoConnect():Promise`<void>`
Defined in: packages/rtls/src/adapters/generic-poll.ts:52
Subclass performs actual connection (e.g., open WebSocket). Must call this.setConnected() on success or this.handleConnectionError() on failure.
Returns
Promise`<void>`
Inherited from
GenericRESTPollAdapter.doConnect
doDisconnect()
protecteddoDisconnect():Promise`<void>`
Defined in: packages/rtls/src/adapters/generic-poll.ts:60
Subclass tears down the actual connection (e.g., close WebSocket).
Returns
Promise`<void>`
Inherited from
GenericRESTPollAdapter.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
GenericRESTPollAdapter.handleConnectionError
health()
health():
AdapterHealth
Defined in: packages/rtls/src/base-adapter.ts:84
Returns
Inherited from
setConnected()
protectedsetConnected():void
Defined in: packages/rtls/src/base-adapter.ts:91
Call after successful connection establishment
Returns
void
Inherited from
GenericRESTPollAdapter.setConnected
subscribe()
subscribe(
cb):Unsubscribe
Defined in: packages/rtls/src/base-adapter.ts:77
Parameters
cb
(u) => void
Returns
Inherited from
GenericRESTPollAdapter.subscribe
mapPayload()
staticmapPayload(raw):PositionUpdate|null
Defined in: packages/rtls/src/adapters/quuppa.ts:57
Parameters
raw
unknown
Returns
PositionUpdate | null
