Class BLEObject

Hierarchy

RFTransmitterObject
- BLEObject
  - BLEBeaconObject

Constructors

constructor

new BLEObject(address?): BLEObject
Parameters
- Optional address: string
Returns BLEObject
Overrides RFTransmitterObject.constructor
- Defined in src/data/BLEObject.ts:81
new BLEObject(address?): BLEObject
Parameters
- Optional address: MACAddress
Returns BLEObject
Overrides RFTransmitterObject.constructor
- Defined in src/data/BLEObject.ts:82

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> = ...

`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

Accessors

calibratedRSSI

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

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

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 RFTransmitterObject.position
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:56
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 RFTransmitterObject.position
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:61

relativePositions

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

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

services

get services(): BLEService[]
Get BLE sercices

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

Methods

addRelativePosition

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

addService

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

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

clone

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

getCalibratedRSSI

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

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

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

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

getServiceByUUID

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

hasRelativePosition

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

parseAdvertisement

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

parseManufacturerData

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

parseScanData

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

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

parseServiceData

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

removeRelativePositions

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

setCalibratedRSSI

setCalibratedRSSI(rssi, distance, unit?): BLEObject
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 BLEObject
This instance
Inherited from RFTransmitterObject.setCalibratedRSSI
- Defined in src/data/RFTransmitterObject.ts:62

setParent

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

setPosition

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

setUID

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

`Static` fromAdvertisementData

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

Class BLEObject

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional address: string

Returns BLEObject

Parameters

Optional address: MACAddress

Returns BLEObject

Properties

address

Optional appearance

createdTimestamp

displayName

frequency

knownAddresses

Optional manufacturerData

Optional mtu

parentUID

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 BLEObject

addService

Parameters

service: BLEService

Returns BLEObject

bind

Parameters

service: DataService<string, BLEObject>

Returns DataObjectBinding<BLEObject>

clone

Type Parameters

T extends BLEObject

Parameters

Optional dataType: Constructor<T>

Returns T

getCalibratedRSSI

Parameters

distance: number

Optional unit: LengthUnit = LengthUnit.METER

Returns number

getPosition

Parameters

Optional referenceSpace: TransformationSpace

Returns AbsolutePosition

`Optional` address: string

`Optional` address: MACAddress

`Optional` appearance

`Optional` manufacturerData

`Optional` mtu

`Optional` rawAdvertisement

`Optional` dataType: Constructor<T>

`Optional` unit: LengthUnit = LengthUnit.METER

`Optional` referenceSpace: TransformationSpace

`Optional` type: string

`Optional` referenceObjectUID: string

`Optional` unit: LengthUnit = LengthUnit.METER

`Optional` referenceSpace: TransformationSpace

`Static` fromAdvertisementData