ant-plus-next

ant-plus-next v0.3.2


ant-plus-next / EnvironmentScanState

Class: EnvironmentScanState

Represents the state of an Environment Sensor during scanning. Extends the EnvironmentSensorState to include additional fields specific to scanning, such as RSSI (Received Signal Strength Indicator) and signal threshold.

Extends

Constructors

new EnvironmentScanState()

new EnvironmentScanState(deviceId): EnvironmentScanState

Creates an instance of the EnvironmentSensorState.

Parameters

deviceId

number

The unique identifier of the sensor device.

Returns

EnvironmentScanState

Example

const sensorState = new EnvironmentSensorState(12345);

Inherited from

EnvironmentSensorState.constructor

Defined in

sensors/environment/environmentSensorState.ts:15

Properties

DeviceId

DeviceId: number

The unique identifier of the sensor device.

Inherited from

EnvironmentSensorState.DeviceId

Defined in

sensors/environment/environmentSensorState.ts:23


EventCount

EventCount: undefined | number

The event count recorded by the sensor.

Inherited from

EnvironmentSensorState.EventCount

Defined in

sensors/environment/environmentSensorState.ts:29


Rssi

Rssi: undefined | number

The received signal strength indicator (RSSI) of the sensor signal. Indicates the strength of the received signal from the environment sensor.

Defined in

sensors/environment/environmentScanState.ts:14


Temperature

Temperature: undefined | number

The temperature measured by the sensor, in degrees Celsius.

Inherited from

EnvironmentSensorState.Temperature

Defined in

sensors/environment/environmentSensorState.ts:35


Threshold

Threshold: undefined | number

The signal threshold value for the sensor. Represents the minimum signal strength required for a reliable connection.

Defined in

sensors/environment/environmentScanState.ts:21