Class RFTransmitterObject

Hierarchy

DataObject
- RFTransmitterObject
  - WLANObject
  - BLEObject

Implements

RFObject

Index

Constructors

constructor

new RFTransmitterObject(uid?, calibratedRSSI?, txPower?): RFTransmitterObject
Parameters
- Optional uid: string
- Optional calibratedRSSI: number
- Optional txPower: number
Returns RFTransmitterObject
Overrides DataObject.constructor
- Defined in src/data/RFTransmitterObject.ts:19

Properties

createdTimestamp

createdTimestamp: number

Created timestamp

displayName

displayName: string

Object display name

frequency

frequency: number

RF transmission frequency

parentUID

parentUID: string

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
- 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
- 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
- Defined in src/data/RFTransmitterObject.ts:74
set environmentFactor(environmentFactor): void
Parameters
- environmentFactor: number
Returns void
- 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
Implementation of RFObject.position

Inherited from DataObject.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
Implementation of RFObject.position

Inherited from DataObject.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
Implementation of RFObject.relativePositions

Inherited from DataObject.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
Implementation of RFObject.relativePositions

Inherited from DataObject.relativePositions
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:86

Methods

addRelativePosition

addRelativePosition(relativePosition): RFTransmitterObject
Add a relative position to this data object
Parameters
- relativePosition: RelativePosition<any, Unit>
  
  Relative position to add
Returns RFTransmitterObject
Data object instance
Implementation of RFObject.addRelativePosition

Inherited from DataObject.addRelativePosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:99

bind

bind(service): DataObjectBinding<RFTransmitterObject>
Bind the data object to a service
Parameters
- service: DataService<string, RFTransmitterObject>
  
  Service to bind it to
Returns DataObjectBinding<RFTransmitterObject>
Data object binding with a service
Implementation of RFObject.bind

Inherited from DataObject.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 RFTransmitterObject
Parameters
- Optional dataType: Constructor<T>
  
  Data type to clone to
Returns T
Cloned data object
Implementation of RFObject.clone

Inherited from DataObject.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
- 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
Implementation of RFObject.getPosition

Inherited from DataObject.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
Implementation of RFObject.getRelativePosition

Inherited from DataObject.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
Implementation of RFObject.getRelativePositions

Inherited from DataObject.getRelativePositions
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:105

hasRelativePosition

hasRelativePosition(referenceObjectUID): boolean
Parameters
- referenceObjectUID: string
Returns boolean
Implementation of RFObject.hasRelativePosition

Inherited from DataObject.hasRelativePosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:113

removeRelativePositions

removeRelativePositions(referenceObjectUID): void
Parameters
- referenceObjectUID: string
Returns void
Implementation of RFObject.removeRelativePositions

Inherited from DataObject.removeRelativePositions
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:93

setCalibratedRSSI

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

setParent

setParent(object): RFTransmitterObject
Set a parent object to the data object
Parameters
- object: string | DataObject
  
  Data object or UID to add as parent
Returns RFTransmitterObject
instance
Implementation of RFObject.setParent

Inherited from DataObject.setParent
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:92

setPosition

setPosition(position, referenceSpace?): RFTransmitterObject
Set the current absolute position of the object
Parameters
- position: AbsolutePosition
  
  Position to set
- Optional referenceSpace: TransformationSpace
  
  Reference space
Returns RFTransmitterObject
Data object instance
Implementation of RFObject.setPosition

Inherited from DataObject.setPosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:74

setUID

setUID(uid): RFTransmitterObject
Set the unique identifier of this object
Parameters
- uid: string
  
  Unique Identifier
Returns RFTransmitterObject
Data object instance
Implementation of RFObject.setUID

Inherited from DataObject.setUID
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:80

Class RFTransmitterObject

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional uid: string

Optional calibratedRSSI: number

Optional txPower: number

Returns RFTransmitterObject

Properties

createdTimestamp

displayName

frequency

parentUID

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

Methods

addRelativePosition

Parameters

relativePosition: RelativePosition<any, Unit>

Returns RFTransmitterObject

bind

Parameters

service: DataService<string, RFTransmitterObject>

Returns DataObjectBinding<RFTransmitterObject>

clone

Type Parameters

T extends RFTransmitterObject

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

getRelativePosition

Parameters

referenceObjectUID: string

Optional type: string

Returns RelativePosition<any, Unit>

getRelativePositions

Parameters

Optional referenceObjectUID: string

Returns RelativePosition<any, Unit>[]

hasRelativePosition

Parameters

referenceObjectUID: string

`Optional` uid: string

`Optional` calibratedRSSI: number

`Optional` txPower: number

`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