Class BLEEddystone

BLE Beacon Data Object

Hierarchy

Constructors

Properties

address: MACAddress

Current mac address

appearance?: number
createdTimestamp: number

Created timestamp

displayName: string

Object display name

frame: number
frequency: number

RF transmission frequency

knownAddresses: MACAddress[] = []

A list of known mac address

manufacturerData?: Map<number, Uint8Array> = ...
mtu?: number
parentUID: string
rawAdvertisement?: Uint8Array
txPower: number

RF transmission power

uid: string

Object identifier

Returns

Unique object identifier

Accessors

  • 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

  • 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

  • get manufacturerId(): number
  • Get the manufacturer identifier

    Returns number

    Manufacturer identifier

  • set manufacturerId(value): void
  • Set the manufacturer identifier

    Parameters

    • value: number

      Manufacturer identifier

    Returns void

  • 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

  • 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

Methods

  • Add a relative position to this data object

    Parameters

    • relativePosition: RelativePosition<any, Unit>

      Relative position to add

    Returns BLEEddystone

    Data object instance

  • Bind the data object to a service

    Parameters

    • service: DataService<string, BLEEddystone>

      Service to bind it to

    Returns DataObjectBinding<BLEEddystone>

    Data object binding with a service

  • Clone the data object

    Type Parameters

    Parameters

    • Optional dataType: Constructor<T>

      Data type to clone to

    Returns T

    Cloned data object

  • 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

  • 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

  • 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

  • Parameters

    • referenceObjectUID: string

    Returns boolean

  • Parameters

    • referenceObjectUID: string

    Returns void

  • Set a parent object to the data object

    Parameters

    • object: string | DataObject

      Data object or UID to add as parent

    Returns BLEEddystone

    instance

  • Set the current absolute position of the object

    Parameters

    • position: AbsolutePosition

      Position to set

    • Optional referenceSpace: TransformationSpace

      Reference space

    Returns BLEEddystone

    Data object instance

  • Set the unique identifier of this object

    Parameters

    • uid: string

      Unique Identifier

    Returns BLEEddystone

    Data object instance