ant-plus-next

ant-plus-next v0.3.2


ant-plus-next / CadenceScanState

Class: CadenceScanState

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

Extends

Constructors

new CadenceScanState()

new CadenceScanState(deviceId): CadenceScanState

Creates an instance of the CadenceSensorState.

Parameters

deviceId

number

The unique identifier of the sensor device.

Returns

CadenceScanState

Example

const sensorState = new CadenceSensorState(12345);

Inherited from

CadenceSensorState.constructor

Defined in

sensors/cadence/cadenceSensorState.ts:15

Properties

BatteryStatus?

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

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

Inherited from

CadenceSensorState.BatteryStatus

Defined in

sensors/cadence/cadenceSensorState.ts:90


BatteryStatusBit?

optional BatteryStatusBit: number

The battery status bit of the sensor.

Inherited from

CadenceSensorState.BatteryStatusBit

Defined in

sensors/cadence/cadenceSensorState.ts:95


BatteryVoltage?

optional BatteryVoltage: number

The battery voltage of the sensor.

Inherited from

CadenceSensorState.BatteryVoltage

Defined in

sensors/cadence/cadenceSensorState.ts:83


CadenceEventTime

CadenceEventTime: undefined | number

The time of the last cadence event, in seconds.

Inherited from

CadenceSensorState.CadenceEventTime

Defined in

sensors/cadence/cadenceSensorState.ts:29


CalculatedCadence

CalculatedCadence: undefined | number

The calculated cadence in revolutions per minute (RPM).

Inherited from

CadenceSensorState.CalculatedCadence

Defined in

sensors/cadence/cadenceSensorState.ts:41


CumulativeCadenceRevolutionCount

CumulativeCadenceRevolutionCount: undefined | number

The cumulative number of cadence revolutions counted by the sensor.

Inherited from

CadenceSensorState.CumulativeCadenceRevolutionCount

Defined in

sensors/cadence/cadenceSensorState.ts:35


DeviceId

DeviceId: number

The unique identifier of the sensor device.

Inherited from

CadenceSensorState.DeviceId

Defined in

sensors/cadence/cadenceSensorState.ts:23


HwVersion?

optional HwVersion: number

The hardware version of the sensor.

Inherited from

CadenceSensorState.HwVersion

Defined in

sensors/cadence/cadenceSensorState.ts:65


ManId?

optional ManId: number

The manufacturer ID of the sensor.

Inherited from

CadenceSensorState.ManId

Defined in

sensors/cadence/cadenceSensorState.ts:53


ModelNum?

optional ModelNum: number

The model number of the sensor.

Inherited from

CadenceSensorState.ModelNum

Defined in

sensors/cadence/cadenceSensorState.ts:77


Motion?

optional Motion: boolean

Indicates whether the sensor is in motion.

Inherited from

CadenceSensorState.Motion

Defined in

sensors/cadence/cadenceSensorState.ts:101


OperatingTime?

optional OperatingTime: number

The cumulative operating time of the sensor in seconds.

Inherited from

CadenceSensorState.OperatingTime

Defined in

sensors/cadence/cadenceSensorState.ts:47


Rssi

Rssi: undefined | number

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

Defined in

sensors/cadence/cadenceScanState.ts:14


SerialNumber?

optional SerialNumber: number

The serial number of the sensor.

Inherited from

CadenceSensorState.SerialNumber

Defined in

sensors/cadence/cadenceSensorState.ts:59


SwVersion?

optional SwVersion: number

The software version of the sensor.

Inherited from

CadenceSensorState.SwVersion

Defined in

sensors/cadence/cadenceSensorState.ts:71


Threshold

Threshold: undefined | number

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

Defined in

sensors/cadence/cadenceScanState.ts:21