ant-plus-next

ant-plus-next v0.3.2


ant-plus-next / SpeedScanState

Class: SpeedScanState

Represents the state of a Speed sensor during scanning. Extends the SpeedSensorState to include additional fields specific to scanning, such as RSSI (Received Signal Strength Indicator) and signal threshold.

Extends

Constructors

new SpeedScanState()

new SpeedScanState(deviceId): SpeedScanState

Creates an instance of the SpeedSensorState.

Parameters

deviceId

number

The unique identifier of the sensor device.

Returns

SpeedScanState

Example

const sensorState = new SpeedSensorState(12345);

Inherited from

SpeedSensorState.constructor

Defined in

sensors/speed/speedSensorState.ts:14

Properties

BatteryStatus?

optional BatteryStatus: "New" | "Good" | "Ok" | "Low" | "Critical" | "Invalid"

The battery status of the sensor. Can be “New”, “Good”, “Ok”, “Low”, “Critical”, or “Invalid”.

Inherited from

SpeedSensorState.BatteryStatus

Defined in

sensors/speed/speedSensorState.ts:95


BatteryStatusBit?

optional BatteryStatusBit: number

The battery status bit of the sensor.

Inherited from

SpeedSensorState.BatteryStatusBit

Defined in

sensors/speed/speedSensorState.ts:100


BatteryVoltage?

optional BatteryVoltage: number

The battery voltage of the sensor.

Inherited from

SpeedSensorState.BatteryVoltage

Defined in

sensors/speed/speedSensorState.ts:88


CalculatedDistance

CalculatedDistance: undefined | number

The calculated distance traveled in meters.

Inherited from

SpeedSensorState.CalculatedDistance

Defined in

sensors/speed/speedSensorState.ts:40


CalculatedSpeed

CalculatedSpeed: undefined | number

The calculated speed in meters per second (m/s).

Inherited from

SpeedSensorState.CalculatedSpeed

Defined in

sensors/speed/speedSensorState.ts:46


CumulativeSpeedRevolutionCount

CumulativeSpeedRevolutionCount: undefined | number

The cumulative count of speed revolutions since the sensor started.

Inherited from

SpeedSensorState.CumulativeSpeedRevolutionCount

Defined in

sensors/speed/speedSensorState.ts:34


DeviceId

DeviceId: number

The unique identifier of the sensor device.

Inherited from

SpeedSensorState.DeviceId

Defined in

sensors/speed/speedSensorState.ts:22


HwVersion?

optional HwVersion: number

The hardware version of the sensor.

Inherited from

SpeedSensorState.HwVersion

Defined in

sensors/speed/speedSensorState.ts:70


ManId?

optional ManId: number

The manufacturer ID of the sensor.

Inherited from

SpeedSensorState.ManId

Defined in

sensors/speed/speedSensorState.ts:58


ModelNum?

optional ModelNum: number

The model number of the sensor.

Inherited from

SpeedSensorState.ModelNum

Defined in

sensors/speed/speedSensorState.ts:82


Motion?

optional Motion: boolean

Indicates whether the sensor detects motion.

Inherited from

SpeedSensorState.Motion

Defined in

sensors/speed/speedSensorState.ts:106


OperatingTime?

optional OperatingTime: number

The cumulative operating time of the sensor in seconds.

Inherited from

SpeedSensorState.OperatingTime

Defined in

sensors/speed/speedSensorState.ts:52


Rssi

Rssi: undefined | number

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

Defined in

sensors/speed/speedScanState.ts:13


SerialNumber?

optional SerialNumber: number

The serial number of the sensor.

Inherited from

SpeedSensorState.SerialNumber

Defined in

sensors/speed/speedSensorState.ts:64


SpeedEventTime

SpeedEventTime: undefined | number

The time of the last speed event in seconds, measured as a fractional part.

Inherited from

SpeedSensorState.SpeedEventTime

Defined in

sensors/speed/speedSensorState.ts:28


SwVersion?

optional SwVersion: number

The software version of the sensor.

Inherited from

SpeedSensorState.SwVersion

Defined in

sensors/speed/speedSensorState.ts:76


Threshold

Threshold: undefined | number

The signal threshold value for the sensor.

Defined in

sensors/speed/speedScanState.ts:19