Class BLEiBeacon

BLE iBeacon Data Object

See

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

Hierarchy

BLEBeaconObject
- BLEiBeacon

Constructors

constructor

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

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
Calibrated RSSI

Returns number
Inherited from BLEBeaconObject.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 BLEBeaconObject.calibratedRSSI
- Defined in src/data/RFTransmitterObject.ts:40

environmentFactor

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

Returns
environment factor

Returns number
Inherited from BLEBeaconObject.environmentFactor
- Defined in src/data/RFTransmitterObject.ts:52
set environmentFactor(environmentFactor: number): void
Parameters
- environmentFactor: number
Returns void
Inherited from BLEBeaconObject.environmentFactor
- Defined in src/data/RFTransmitterObject.ts:57

position

get position(): AbsolutePosition
Get the current absolute position of the object relative to the global reference space

Returns
Absolute position of data object

Returns AbsolutePosition
Inherited from BLEBeaconObject.position
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:60
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 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
Array of relative positions

Returns RelativePosition<any, Unit>[]
Inherited from BLEBeaconObject.relativePositions
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:93
set relativePositions(relativePostions: RelativePosition<any, Unit>[]): 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
BLE services

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

Methods

addRelativePosition

addRelativePosition(relativePosition: RelativePosition<any, Unit>): BLEiBeacon
Add a relative position to this data object

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

addService

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

bind

bind(service: DataService<string, BLEiBeacon>): DataObjectBinding<BLEiBeacon>
Bind the data object to a service

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

clone

clone<T>(dataType?: Constructor<T>): T
Clone the data object

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

getPosition

getPosition(referenceSpace?: TransformationSpace): AbsolutePosition
Get the current absolute position of the object

Returns
Position of the data object
Parameters
- Optional referenceSpace: TransformationSpace
  
  Reference space to transform it to
Returns AbsolutePosition
Inherited from BLEBeaconObject.getPosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:72

getRelativePosition

getRelativePosition(referenceObjectUID: string, type?: string): RelativePosition<any, Unit>
Get relative position of a specified object

Returns
Relative position to reference object
Parameters
- referenceObjectUID: string
  
  Reference object identifier
- Optional type: string
  
  Constructor type of the relative position
Returns RelativePosition<any, Unit>
Inherited from BLEBeaconObject.getRelativePosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:124

getRelativePositions

getRelativePositions(referenceObjectUID?: string): RelativePosition<any, Unit>[]
Get relative positions for a different target

Returns
Array of relative positions for the reference object
Parameters
- Optional referenceObjectUID: string
  
  Reference object identifier
Returns RelativePosition<any, Unit>[]
Inherited from BLEBeaconObject.getRelativePositions
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:116

getServiceByUUID

getServiceByUUID(uuid: BLEUUID): BLEService
Get service by UUID

Returns
BLE Service
Parameters
- uuid: BLEUUID
  
  Service UUID
Returns BLEService
Inherited from BLEBeaconObject.getServiceByUUID
- Defined in src/data/BLEObject.ts:113

hasRelativePosition

hasRelativePosition(referenceObjectUID: string): 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:30

parseAdvertisement

parseAdvertisement(payload: Uint8Array): BLEiBeacon
Parse advertisement data

Returns
Instance
Parameters
- payload: Uint8Array
  
  Advertisement data
Returns BLEiBeacon
Inherited from BLEBeaconObject.parseAdvertisement
- Defined in src/data/BLEObject.ts:146

parseManufacturerData

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

parseScanData

parseScanData(payload: Uint8Array): BLEiBeacon
Parse advertisement data

Deprecated
Use [parseAdvertisement] instead

Returns
Instance
Parameters
- payload: Uint8Array
  
  Advertisement data
Returns BLEiBeacon
Inherited from BLEBeaconObject.parseScanData
- Defined in src/data/BLEObject.ts:136

parseServiceData

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

removeRelativePositions

removeRelativePositions(referenceObjectUID: string): 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: string | DataObject): BLEiBeacon
Set a parent object to the data object

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

setPosition

setPosition(position: AbsolutePosition, referenceSpace?: TransformationSpace): BLEiBeacon
Set the current absolute position of the object

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

setUID

setUID(uid: string): BLEiBeacon
Set the unique identifier of this object

Returns
Data object instance
Parameters
- uid: string
  
  Unique Identifier
Returns BLEiBeacon
Inherited from BLEBeaconObject.setUID
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:87

`Static` fromAdvertisementData

fromAdvertisementData<T>(payload: Uint8Array): T
Create object from advertisement data

Returns
BLE Object
Type Parameters
- T extends BLEObject<T>
Parameters
- payload: Uint8Array
  
  Advertisement data
Returns T
Inherited from BLEBeaconObject.fromAdvertisementData
- Defined in src/data/BLEObject.ts:125

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

Returns number

Parameters

calibratedRSSI: number

Returns void

environmentFactor

Returns

Returns number

Parameters

environmentFactor: number

Returns void

position

Returns

Returns AbsolutePosition

Parameters

position: AbsolutePosition

Returns void

relativePositions

Returns

Returns RelativePosition<any, Unit>[]

Parameters

relativePostions: RelativePosition<any, Unit>[]

Returns void

services

Returns

Returns BLEService[]

Methods

addRelativePosition

Returns

Parameters

relativePosition: RelativePosition<any, Unit>

Returns BLEiBeacon

addService

Parameters

service: BLEService

Returns BLEiBeacon

bind

Returns

Parameters

service: DataService<string, BLEiBeacon>

Returns DataObjectBinding<BLEiBeacon>

clone

Returns

Type Parameters

T extends BLEiBeacon<T>

Parameters

Optional dataType: Constructor<T>

`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