Class BLEObject

Hierarchy (view full)

Constructors

constructor

Properties

address appearance? createdTimestamp displayName frequency knownAddresses manufacturerData? mtu? parentUID rawAdvertisement? txPower uid

Accessors

angularVelocity calibratedRSSI environmentFactor linearVelocity orientation position relativePositions services velocity

Methods

addRelativePosition addService bind clone getCalibratedRSSI getPosition getRelativePosition getRelativePositions getServiceByUUID hasRelativePosition parseAdvertisement parseManufacturerData parseScanData parseServiceData removeRelativePositions setCalibratedRSSI setParent setPosition setUID fromAdvertisementData

Constructors

constructor

Properties

address

address: MACAddress

Current mac address

Optional appearance

appearance?: number

createdTimestamp

createdTimestamp: number

Created timestamp

displayName

displayName: string

Object display name

frequency

frequency: number

RF transmission frequency

knownAddresses

knownAddresses: MACAddress[] = []

A list of known mac address

Optional manufacturerData

manufacturerData?: Map<number, Uint8Array<ArrayBufferLike>> = ...

Optional mtu

mtu?: number

parentUID

parentUID: string

Optional rawAdvertisement

rawAdvertisement?: Uint8Array<ArrayBufferLike>

txPower

txPower: number

RF transmission power

uid

uid: string

Object identifier

Returns

Unique object identifier

Accessors

angularVelocity

  • get angularVelocity(): AngularVelocity

  • Returns AngularVelocity

  • set angularVelocity(velocity): void

  • Parameters

    • velocity: AngularVelocity

    Returns void

calibratedRSSI

  • get calibratedRSSI(): number

  • Get the calibrated rssi at 1 meter

    Returns number

    Calibrated RSSI

  • set calibratedRSSI(calibratedRSSI): void

  • Set the calibrated rssi at 1 meter

    Parameters

    • calibratedRSSI: number

      Calibrated RSSI > 0

    Returns void

environmentFactor

  • get environmentFactor(): number

  • Set the environment factor of the beacon. Nodes such as [[RelativeRSSIProcessing]] can override this.

    Returns number

    environment factor

  • set environmentFactor(environmentFactor): void

  • Parameters

    • environmentFactor: number

    Returns void

linearVelocity

  • get linearVelocity(): LinearVelocity

  • Returns LinearVelocity

  • set linearVelocity(velocity): void

  • Parameters

    • velocity: LinearVelocity

    Returns void

orientation

  • get orientation(): Orientation

  • Get the orientation of the object relative to the global reference space

    Returns Orientation

  • set orientation(orientation): void

  • Set the orientation of the object relative to the global reference space

    Parameters

    • orientation: Orientation

    Returns void

position

  • get position(): AbsolutePosition

  • Get the current absolute position of the object relative to the global reference space

    Returns AbsolutePosition

    Absolute position of data object

  • set position(position): void

  • Set the current absolute position of the object relative to the global reference space

    Parameters

    • position: AbsolutePosition

    Returns void

relativePositions

  • get relativePositions(): RelativePosition<any, Unit>[]

  • Get relative positions

    Returns RelativePosition<any, Unit>[]

    Array of relative positions

  • set relativePositions(relativePostions): void

  • Parameters

    • relativePostions: RelativePosition<any, Unit>[]

    Returns void

services

velocity

  • get velocity(): Velocity

  • Returns Velocity

  • set velocity(velocity): void

  • Parameters

    • velocity: Velocity

    Returns void

Methods

addRelativePosition

  • addRelativePosition(relativePosition): this

  • Add a relative position to this data object

    Parameters

    • relativePosition: RelativePosition<any, Unit>

      Relative position to add

    Returns this

    Data object instance

addService

bind

  • bind(service): DataObjectBinding<BLEObject>

  • Bind the data object to a service

    Parameters

    • service: DataService<string, BLEObject>

      Service to bind it to

    Returns DataObjectBinding<BLEObject>

    Data object binding with a service

clone

  • clone<T>(dataType?): T

  • Clone the data object

    Type Parameters

    Parameters

    • Optional dataType: Constructor<T>

      Data type to clone to

    Returns T

    Cloned data object

getCalibratedRSSI

getPosition

  • getPosition(referenceSpace?): AbsolutePosition

  • Get the current absolute position of the object

    Parameters

    • Optional referenceSpace: TransformationSpace

      Reference space to transform it to

    Returns AbsolutePosition

    Position of the data object

getRelativePosition

  • getRelativePosition(referenceObjectUID, type?): RelativePosition<any, Unit>

  • Get relative position of a specified object

    Parameters

    • referenceObjectUID: string

      Reference object identifier

    • Optional type: string

      Constructor type of the relative position

    Returns RelativePosition<any, Unit>

    Relative position to reference object

getRelativePositions

  • getRelativePositions(referenceObjectUID?): RelativePosition<any, Unit>[]

  • Get relative positions for a different target

    Parameters

    • Optional referenceObjectUID: string

      Reference object identifier

    Returns RelativePosition<any, Unit>[]

    Array of relative positions for the reference object

getServiceByUUID

hasRelativePosition

  • hasRelativePosition(referenceObjectUID): boolean

  • Parameters

    • referenceObjectUID: string

    Returns boolean

parseAdvertisement

  • parseAdvertisement(payload): this

  • Parse advertisement data

    Parameters

    • payload: Uint8Array<ArrayBufferLike>

      Advertisement data

    Returns this

    Instance

parseManufacturerData

  • parseManufacturerData(manufacturer, manufacturerData): this

  • Parameters

    • manufacturer: number
    • manufacturerData: Uint8Array<ArrayBufferLike>

    Returns this

parseScanData

  • parseScanData(payload): this

  • Parse advertisement data

    Parameters

    • payload: Uint8Array<ArrayBufferLike>

      Advertisement data

    Returns this

    Instance

    Deprecated

    Use [parseAdvertisement] instead

parseServiceData

removeRelativePositions

  • removeRelativePositions(referenceObjectUID): void

  • Parameters

    • referenceObjectUID: string

    Returns void

setCalibratedRSSI

  • setCalibratedRSSI(rssi, distance, unit?): this

  • Set the calibrated RSSI at a specific distance

    Parameters

    • rssi: number

      Received signal strength indicator

    • distance: number

      Distance

    • Optional unit: LengthUnit = LengthUnit.METER

      Length Unit

    Returns this

    This instance

setParent

  • setParent(object): this

  • Set a parent object to the data object

    Parameters

    • object: string | DataObject

      Data object or UID to add as parent

    Returns this

    instance

setPosition

  • setPosition(position, referenceSpace?): this

  • Set the current absolute position of the object

    Parameters

    • position: AbsolutePosition

      Position to set

    • Optional referenceSpace: TransformationSpace

      Reference space

    Returns this

    Data object instance

setUID

  • setUID(uid): this

  • Set the unique identifier of this object

    Parameters

    • uid: string

      Unique Identifier

    Returns this

    Data object instance

Static fromAdvertisementData

  • fromAdvertisementData<T>(payload): T

  • Create object from advertisement data

    Type Parameters

    Parameters

    • payload: Uint8Array<ArrayBufferLike>

      Advertisement data

    Returns T

    BLE Object

Settings

Member Visibility

Theme

On This Page

constructoraddressappearancecreatedTimestampdisplayNamefrequencyknownAddressesmanufacturerDatamtuparentUIDrawAdvertisementtxPoweruidangularVelocitycalibratedRSSIenvironmentFactorlinearVelocityorientationpositionrelativePositionsservicesvelocityaddRelativePositionaddServicebindclonegetCalibratedRSSIgetPositiongetRelativePositiongetRelativePositionsgetServiceByUUIDhasRelativePositionparseAdvertisementparseManufacturerDataparseScanDataparseServiceDataremoveRelativePositionssetCalibratedRSSIsetParentsetPositionsetUIDfromAdvertisementData