Class BLEiBeacon

BLE iBeacon Data Object

See

https://wiki.aprbrother.com/en/iBeacon_Packet.html

Hierarchy

BLEBeaconObject
- BLEiBeacon

Constructors

constructor

new BLEiBeacon(address?, scanData?): BLEiBeacon
Parameters
- Optional address: MACAddress
- Optional scanData: Uint8Array
Returns BLEiBeacon
Overrides BLEBeaconObject.constructor
- Defined in src/data/BLEiBeacon.ts:22

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

major

major: number

`Optional` manufacturerData

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

minor

minor: number

`Optional` mtu

mtu?: number

parentUID

parentUID: string

proximityUUID

proximityUUID: BLEUUID

`Optional` rawAdvertisement

rawAdvertisement?: Uint8Array

txPower

txPower: number

RF transmission power

uid

uid: string

Object identifier

Returns

Unique object identifier

Accessors

calibratedRSSI

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

Returns number
Calibrated RSSI
Inherited from BLEBeaconObject.calibratedRSSI
- Defined in src/data/RFTransmitterObject.ts:29
set calibratedRSSI(calibratedRSSI): void
Set the calibrated rssi at 1 meter
Parameters
- calibratedRSSI: number
  
  Calibrated RSSI > 0
Returns void
Inherited from BLEBeaconObject.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 BLEBeaconObject.environmentFactor
- Defined in src/data/RFTransmitterObject.ts:49
set environmentFactor(environmentFactor): void
Parameters
- environmentFactor: number
Returns void
Inherited from BLEBeaconObject.environmentFactor
- Defined in src/data/RFTransmitterObject.ts:54

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

relativePositions

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

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

services

get services(): BLEService[]
Get BLE sercices

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

Methods

addRelativePosition

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

addService

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

bind

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

clone

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

computeUID

computeUID(): string
Returns string
Overrides BLEBeaconObject.computeUID
- Defined in src/data/BLEiBeacon.ts:29

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
Inherited from BLEBeaconObject.getPosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:72

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
Inherited from BLEBeaconObject.getRelativePosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:124

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
Inherited from BLEBeaconObject.getRelativePositions
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:116

getServiceByUUID

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

hasRelativePosition

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

isValid

isValid(): boolean
Returns boolean
Overrides BLEBeaconObject.isValid
- Defined in src/data/BLEiBeacon.ts:37

parseAdvertisement

parseAdvertisement(payload): BLEiBeacon
Parse advertisement data
Parameters
- payload: Uint8Array
  
  Advertisement data
Returns BLEiBeacon
Instance
Inherited from BLEBeaconObject.parseAdvertisement
- Defined in src/data/BLEObject.ts:141

parseManufacturerData

parseManufacturerData(manufacturer, manufacturerData): BLEiBeacon
Parameters
- manufacturer: number
- manufacturerData: Uint8Array
Returns BLEiBeacon
Overrides BLEBeaconObject.parseManufacturerData
- Defined in src/data/BLEiBeacon.ts:41

parseScanData

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

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

parseServiceData

parseServiceData(uuid, serviceData): BLEiBeacon
Parameters
- uuid: BLEUUID
- serviceData: Uint8Array
Returns BLEiBeacon
Inherited from BLEBeaconObject.parseServiceData
- Defined in src/data/BLEObject.ts:209

removeRelativePositions

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

setParent

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

setPosition

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

setUID

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

`Static` fromAdvertisementData

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

Class BLEiBeacon

See

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional address: MACAddress

Optional scanData: Uint8Array

Returns BLEiBeacon

Properties

address

Optional appearance

createdTimestamp

displayName

frequency

knownAddresses

major

Optional manufacturerData

minor

Optional mtu

parentUID

proximityUUID

Optional rawAdvertisement

txPower

uid

Returns

Accessors

calibratedRSSI

Returns number

Parameters

calibratedRSSI: number

Returns void

environmentFactor

Returns number

Parameters

environmentFactor: number

Returns void

position

Returns AbsolutePosition

Parameters

position: AbsolutePosition

Returns void

relativePositions

Returns RelativePosition<any, Unit>[]

Parameters

relativePostions: RelativePosition<any, Unit>[]

Returns void

services

Returns BLEService[]

Methods

addRelativePosition

Parameters

relativePosition: RelativePosition<any, Unit>

Returns BLEiBeacon

addService

Parameters

service: BLEService

Returns BLEiBeacon

bind

Parameters

service: DataService<string, BLEiBeacon>

Returns DataObjectBinding<BLEiBeacon>

clone

Type Parameters

T extends BLEiBeacon<T>

Parameters

Optional dataType: Constructor<T>

Returns T

computeUID

Returns string

getPosition

Parameters

Optional referenceSpace: TransformationSpace

Returns AbsolutePosition

getRelativePosition

`Optional` address: MACAddress

`Optional` scanData: Uint8Array

`Optional` appearance

`Optional` manufacturerData

`Optional` mtu

`Optional` rawAdvertisement

`Optional` dataType: Constructor<T>

`Optional` referenceSpace: TransformationSpace

`Optional` type: string

`Optional` referenceObjectUID: string

`Optional` referenceSpace: TransformationSpace

`Static` fromAdvertisementData