Class BLEEddystoneURL

BLE Beacon Data Object

Hierarchy (View Summary)

BLEEddystone
- BLEEddystoneURL

Constructors

constructor

new BLEEddystoneURL(
address?: MACAddress,
scanData?: Uint8Array,
): BLEEddystoneURL
Parameters
- Optionaladdress: MACAddress
- OptionalscanData: Uint8Array
Returns BLEEddystoneURL
Inherited from BLEEddystone.constructor
- Defined in src/data/BLEEddystone.ts:13

Properties

address

address: MACAddress

Current mac address

`Optional`appearance

appearance?: number

createdTimestamp

createdTimestamp: number

Created timestamp

displayName

displayName: string

Object display name

frame

frame: number

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

txPower

txPower: number

RF transmission power

uid

uid: string

Object identifier

Returns

Unique object identifier

url

url: string

`Static` `Readonly`PREFIXES

PREFIXES: string[] = ...

`Static` `Readonly`SUFFIXES

SUFFIXES: string[] = ...

Accessors

angularVelocity

get angularVelocity(): AngularVelocity
Returns AngularVelocity
Inherited from BLEEddystone.angularVelocity
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:58
set angularVelocity(velocity: AngularVelocity): void
Parameters
- velocity: AngularVelocity
Returns void
Inherited from BLEEddystone.angularVelocity
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:59

calibratedRSSI

get calibratedRSSI(): number
Get the calibrated rssi at 1 meter

Returns number
Calibrated RSSI
Inherited from BLEEddystone.calibratedRSSI
- Defined in src/data/RFTransmitterObject.ts:30
set calibratedRSSI(calibratedRSSI: number): void
Set the calibrated rssi at 1 meter
Parameters
- calibratedRSSI: number
  Calibrated RSSI > 0
Returns void
Inherited from BLEEddystone.calibratedRSSI
- Defined in src/data/RFTransmitterObject.ts:38

environmentFactor

get environmentFactor(): number
Set the environment factor of the beacon. Nodes such as [[RelativeRSSIProcessing]] can override this.

Returns number
environment factor
Inherited from BLEEddystone.environmentFactor
- Defined in src/data/RFTransmitterObject.ts:74
set environmentFactor(environmentFactor: number): void
Parameters
- environmentFactor: number
Returns void
Inherited from BLEEddystone.environmentFactor
- Defined in src/data/RFTransmitterObject.ts:78

linearVelocity

get linearVelocity(): LinearVelocity
Returns LinearVelocity
Inherited from BLEEddystone.linearVelocity
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:56
set linearVelocity(velocity: LinearVelocity): void
Parameters
- velocity: LinearVelocity
Returns void
Inherited from BLEEddystone.linearVelocity
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:57

manufacturerId

get manufacturerId(): number
Get the manufacturer identifier

Returns number
Manufacturer identifier
Inherited from BLEEddystone.manufacturerId
- Defined in src/data/BLEBeaconObject.ts:27
set manufacturerId(value: number): void
Set the manufacturer identifier
Parameters
- value: number
  Manufacturer identifier
Returns void
Inherited from BLEEddystone.manufacturerId
- Defined in src/data/BLEBeaconObject.ts:35

orientation

get orientation(): Orientation
Get the orientation of the object relative to the global reference space

Returns Orientation
Inherited from BLEEddystone.orientation
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:48
set orientation(orientation: Orientation): void
Set the orientation of the object relative to the global reference space
Parameters
- orientation: Orientation
Returns void
Inherited from BLEEddystone.orientation
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:53

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
Inherited from BLEEddystone.position
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:38
set position(position: AbsolutePosition): void
Set the current absolute position of the object relative to the global reference space
Parameters
- position: AbsolutePosition
Returns void
Inherited from BLEEddystone.position
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:43

relativePositions

get relativePositions(): RelativePosition<any, Unit>[]
Get relative positions

Returns RelativePosition<any, Unit>[]
Array of relative positions
Inherited from BLEEddystone.relativePositions
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:83
set relativePositions(relativePostions: RelativePosition<any, Unit>[]): void
Parameters
- relativePostions: RelativePosition<any, Unit>[]
Returns void
Inherited from BLEEddystone.relativePositions
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:84

`Protected`service

get service(): BLEService
Returns BLEService
Inherited from BLEEddystone.service
- Defined in src/data/BLEEddystone.ts:49

services

get services(): BLEService[]
Get BLE sercices

Returns BLEService[]
BLE services
Inherited from BLEEddystone.services
- Defined in src/data/BLEObject.ts:97

velocity

get velocity(): Velocity
Returns Velocity
Inherited from BLEEddystone.velocity
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:54
set velocity(velocity: Velocity): void
Parameters
- velocity: Velocity
Returns void
Inherited from BLEEddystone.velocity
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:55

Methods

addRelativePosition

addRelativePosition(relativePosition: RelativePosition<any>): this
Add a relative position to this data object
Parameters
- relativePosition: RelativePosition<any>
  Relative position to add
Returns this
Data object instance
Inherited from BLEEddystone.addRelativePosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:97

addService

addService(service: BLEService): this
Parameters
- service: BLEService
Returns this
Inherited from BLEEddystone.addService
- Defined in src/data/BLEObject.ts:101

bind

bind(
service: DataService<string, BLEEddystoneURL>,
): DataObjectBinding<BLEEddystoneURL>
Bind the data object to a service
Parameters
- service: DataService<string, BLEEddystoneURL>
  Service to bind it to
Returns DataObjectBinding<BLEEddystoneURL>
Data object binding with a service
Inherited from BLEEddystone.bind
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:117

clone

clone<T extends BLEEddystoneURL>(dataType?: Constructor<T>): T
Clone the data object
Type Parameters
- T extends BLEEddystoneURL
Parameters
- OptionaldataType: Constructor<T>
  Data type to clone to
Returns T
Cloned data object
Inherited from BLEEddystone.clone
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:123

computeUID

computeUID(): string
Returns string
Overrides BLEEddystone.computeUID
- Defined in src/data/BLEEddystoneURL.ts:35

getCalibratedRSSI

getCalibratedRSSI(distance: number, unit?: LengthUnit): number
Get the calibrated RSSI at a specific distance
Parameters
- distance: number
  Distance
- Optionalunit: LengthUnit = LengthUnit.METER
  Length Unit
Returns number
RSSI at distance
Inherited from BLEEddystone.getCalibratedRSSI
- Defined in src/data/RFTransmitterObject.ts:50

getPosition

getPosition(referenceSpace?: TransformationSpace): AbsolutePosition
Get the current absolute position of the object
Parameters
- OptionalreferenceSpace: TransformationSpace
  Reference space to transform it to
Returns AbsolutePosition
Position of the data object
Inherited from BLEEddystone.getPosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:65

getRelativePosition

getRelativePosition(
referenceObjectUID: string,
type?: string,
): RelativePosition<any>
Get relative position of a specified object
Parameters
- referenceObjectUID: string
  Reference object identifier
- Optionaltype: string
  Constructor type of the relative position
Returns RelativePosition<any>
Relative position to reference object
Inherited from BLEEddystone.getRelativePosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:110

getRelativePositions

getRelativePositions(referenceObjectUID?: string): RelativePosition<any, Unit>[]
Get relative positions for a different target
Parameters
- OptionalreferenceObjectUID: string
  Reference object identifier
Returns RelativePosition<any, Unit>[]
Array of relative positions for the reference object
Inherited from BLEEddystone.getRelativePositions
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:103

getServiceByUUID

getServiceByUUID(uuid: BLEUUID): BLEService
Get service by UUID
Parameters
- uuid: BLEUUID
  Service UUID
Returns BLEService
BLE Service
Inherited from BLEEddystone.getServiceByUUID
- Defined in src/data/BLEObject.ts:111

hasRelativePosition

hasRelativePosition(referenceObjectUID: string): boolean
Parameters
- referenceObjectUID: string
Returns boolean
Inherited from BLEEddystone.hasRelativePosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:111

isValid

isValid(): boolean
Returns boolean
Overrides BLEEddystone.isValid
- Defined in src/data/BLEEddystoneURL.ts:31

parseAdvertisement

parseAdvertisement(payload: Uint8Array): this
Parse advertisement data
Parameters
- payload: Uint8Array
  Advertisement data
Returns this
Instance
Inherited from BLEEddystone.parseAdvertisement
- Defined in src/data/BLEEddystone.ts:24

parseManufacturerData

parseManufacturerData(manufacturer: number, manufacturerData: Uint8Array): this
Parameters
- manufacturer: number
- manufacturerData: Uint8Array
Returns this
Inherited from BLEEddystone.parseManufacturerData
- Defined in src/data/BLEObject.ts:214

parseScanData

parseScanData(payload: Uint8Array): this
Parse advertisement data
Parameters
- payload: Uint8Array
  Advertisement data
Returns this
Instance

Deprecated
Use [parseAdvertisement] instead
Inherited from BLEEddystone.parseScanData
- Defined in src/data/BLEObject.ts:132

parseServiceData

parseServiceData(uuid: BLEUUID, serviceData: Uint8Array): this
Parameters
- uuid: BLEUUID
- serviceData: Uint8Array
Returns this
Overrides BLEEddystone.parseServiceData
- Defined in src/data/BLEEddystoneURL.ts:39

removeRelativePositions

removeRelativePositions(referenceObjectUID: string): void
Parameters
- referenceObjectUID: string
Returns void
Inherited from BLEEddystone.removeRelativePositions
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:91

setCalibratedRSSI

setCalibratedRSSI(rssi: number, distance: number, unit?: LengthUnit): this
Set the calibrated RSSI at a specific distance
Parameters
- rssi: number
  Received signal strength indicator
- distance: number
  Distance
- Optionalunit: LengthUnit = LengthUnit.METER
  Length Unit
Returns this
This instance
Inherited from BLEEddystone.setCalibratedRSSI
- Defined in src/data/RFTransmitterObject.ts:62

setParent

setParent(object: string | DataObject): this
Set a parent object to the data object
Parameters
- object: string | DataObject
  Data object or UID to add as parent
Returns this
instance
Inherited from BLEEddystone.setParent
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:90

setPosition

setPosition(
position: AbsolutePosition,
referenceSpace?: TransformationSpace,
): this
Set the current absolute position of the object
Parameters
- position: AbsolutePosition
  Position to set
- OptionalreferenceSpace: TransformationSpace
  Reference space
Returns this
Data object instance
Inherited from BLEEddystone.setPosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:72

setUID

setUID(uid: string): this
Set the unique identifier of this object
Parameters
- uid: string
  Unique Identifier
Returns this
Data object instance
Inherited from BLEEddystone.setUID
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:78

`Static`fromAdvertisementData

fromAdvertisementData<T extends BLEObject>(payload: Uint8Array): T
Create object from advertisement data
Type Parameters
- T extends BLEObject
Parameters
- payload: Uint8Array
  Advertisement data
Returns T
BLE Object
Inherited from BLEEddystone.fromAdvertisementData
- Defined in src/data/BLEObject.ts:122

Class BLEEddystoneURL

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BLEEddystoneURL

Properties

address

Optionalappearance

createdTimestamp

displayName

frame

frequency

knownAddresses

OptionalmanufacturerData

Optionalmtu

parentUID

OptionalrawAdvertisement

txPower

uid

Returns

url

Static ReadonlyPREFIXES

Static ReadonlySUFFIXES

Accessors

angularVelocity

Returns AngularVelocity

Parameters

Returns void

calibratedRSSI

Returns number

Parameters

Returns void

environmentFactor

Returns number

Parameters

Returns void

linearVelocity

Returns LinearVelocity

Parameters

Returns void

manufacturerId

Returns number

Parameters

Returns void

orientation

Returns Orientation

Parameters

Returns void

position

Returns AbsolutePosition

Parameters

Returns void

relativePositions

Returns RelativePosition<any, Unit>[]

Parameters

Returns void

Protectedservice

Returns BLEService

services

Returns BLEService[]

velocity

Returns Velocity

Parameters

Returns void

Methods

addRelativePosition

Parameters

Returns this

addService

Parameters

Returns this

bind

Parameters

Returns DataObjectBinding<BLEEddystoneURL>

`Optional`appearance

`Optional`manufacturerData

`Optional`mtu

`Optional`rawAdvertisement

`Static` `Readonly`PREFIXES

`Static` `Readonly`SUFFIXES

`Protected`service

`Static`fromAdvertisementData