Skip to content

spatial-monorepo


spatial-monorepo / rtls/src / PozyxAdapter

Class: PozyxAdapter

Defined in: packages/rtls/src/adapters/pozyx.ts:42

Extends

Constructors

Constructor

new PozyxAdapter(id, tenant, apiKey, opts?): PozyxAdapter

Defined in: packages/rtls/src/adapters/pozyx.ts:45

Parameters

id

string

tenant

string

apiKey

string

opts?
coordinateMode?

"meter" | "latlon"

Returns

PozyxAdapter

Overrides

GenericMQTTAdapter.constructor

Properties

coordinateMode

readonly coordinateMode: "meter" | "latlon"

Defined in: packages/rtls/src/adapters/generic-mqtt.ts:16

Inherited from

GenericMQTTAdapter.coordinateMode


id

readonly id: string

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

Inherited from

GenericMQTTAdapter.id


transport

readonly transport: "mqtt"

Defined in: packages/rtls/src/adapters/generic-mqtt.ts:15

Inherited from

GenericMQTTAdapter.transport


vendor

readonly vendor: "pozyx"

Defined in: packages/rtls/src/adapters/pozyx.ts:43

Overrides

GenericMQTTAdapter.vendor

Methods

connect()

connect(): Promise`<void>`

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

Returns

Promise`<void>`

Inherited from

GenericMQTTAdapter.connect


disconnect()

disconnect(): Promise`<void>`

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

Returns

Promise`<void>`

Inherited from

GenericMQTTAdapter.disconnect


doConnect()

protected doConnect(): Promise`<void>`

Defined in: packages/rtls/src/adapters/generic-mqtt.ts:43

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

Returns

Promise`<void>`

Inherited from

GenericMQTTAdapter.doConnect


doDisconnect()

protected doDisconnect(): Promise`<void>`

Defined in: packages/rtls/src/adapters/generic-mqtt.ts:104

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

Returns

Promise`<void>`

Inherited from

GenericMQTTAdapter.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

GenericMQTTAdapter.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

GenericMQTTAdapter.handleConnectionError


health()

health(): AdapterHealth

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

Returns

AdapterHealth

Inherited from

GenericMQTTAdapter.health


setConnected()

protected setConnected(): void

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

Call after successful connection establishment

Returns

void

Inherited from

GenericMQTTAdapter.setConnected


subscribe()

subscribe(cb): Unsubscribe

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

Parameters

cb

(u) => void

Returns

Unsubscribe

Inherited from

GenericMQTTAdapter.subscribe


mapPayload()

static mapPayload(raw): PositionUpdate | null

Defined in: packages/rtls/src/adapters/pozyx.ts:62

Parameters

raw

unknown

Returns

PositionUpdate | null

Released under commercial licensing.