Class SensorChannel

Represents a channel of sensors.

Index

Constructors

Accessors

activated mode groups id name low high factor

Methods

findGroupByName getState activate update addGroup remove cleanup

Constructors

constructor

new SensorChannel(
    sensorManager: SensorManager,
    _id: Int64,
    _name: string,
    _low: number,
    _high: number,
    _factor: number,
): SensorChannel
Parameters
- sensorManager: SensorManager
- _id: Int64
- _name: string
- _low: number
- _high: number
- _factor: number
Returns SensorChannel
- Defined in sensors/sensors.ts:310

Accessors

activated

get activated(): boolean
Gets whether the channel is activated.

Returns boolean
- Defined in sensors/sensors.ts:350

mode

get mode(): BIM_SENSOR_VISUALIZATION_OPTIONS
Gets the mode of the sensor channel.

Returns BIM_SENSOR_VISUALIZATION_OPTIONS
- Defined in sensors/sensors.ts:357
set mode(mode: BIM_SENSOR_VISUALIZATION_OPTIONS): void
Sets the mode of the sensor channel.
Parameters
- mode: BIM_SENSOR_VISUALIZATION_OPTIONS
Returns void
- Defined in sensors/sensors.ts:364

groups

get groups(): SensorGroup[]
Gets the groups of the sensor channel.

Returns SensorGroup[]
- Defined in sensors/sensors.ts:390

id

get id(): Int64
Gets the ID of the sensor channel.

Returns Int64
- Defined in sensors/sensors.ts:397

name

get name(): string
Gets the name of the sensor channel.

Returns string
- Defined in sensors/sensors.ts:404
set name(name: string): void
Sets the name of the sensor channel.
Parameters
- name: string
Returns void
- Defined in sensors/sensors.ts:411

low

get low(): number
Gets the low value of the sensor channel.

Returns number
- Defined in sensors/sensors.ts:418

high

get high(): number
Gets the high value of the sensor channel.

Returns number
- Defined in sensors/sensors.ts:425

factor

get factor(): number
Gets the factor of the sensor channel.

Returns number
- Defined in sensors/sensors.ts:432

Methods

findGroupByName

findGroupByName(groupName: string): SensorGroup
Finds a group by its name.
Parameters
- groupName: string
Returns SensorGroup
- Defined in sensors/sensors.ts:317

getState

getState(): SensorChannelState
Gets the state of the sensor channel.

Returns SensorChannelState
- Defined in sensors/sensors.ts:326

activate

activate(mode?: BIM_SENSOR_VISUALIZATION_OPTIONS): Promise<void>
Activates the sensor channel.
Parameters
- Optionalmode: BIM_SENSOR_VISUALIZATION_OPTIONS
Returns Promise<void>
- Defined in sensors/sensors.ts:371

update

update(low?: number, high?: number, factor?: number): Promise<boolean>
Updates the sensor channel with new low, high, and/or factor values.
Parameters
- Optionallow: number
- Optionalhigh: number
- Optionalfactor: number
Returns Promise<boolean>
- Defined in sensors/sensors.ts:439

addGroup

addGroup(name: string): Promise<SensorGroup>
Adds a group to the sensor channel.
Parameters
- name: string
Returns Promise<SensorGroup>
- Defined in sensors/sensors.ts:451

remove

remove(removeFromChannelsArray?: boolean): Promise<boolean>
Removes the sensor channel.
Parameters
- removeFromChannelsArray: boolean = true
Returns Promise<boolean>
- Defined in sensors/sensors.ts:468

cleanup

cleanup(): Promise<void>
Cleans up the sensor channel by removing all groups.

Returns Promise<void>
- Defined in sensors/sensors.ts:489