ant-plus-next

ant-plus-next v0.3.2


ant-plus-next / FitnessEquipmentScanState

Class: FitnessEquipmentScanState

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

Extends

Constructors

new FitnessEquipmentScanState()

new FitnessEquipmentScanState(deviceId): FitnessEquipmentScanState

Creates an instance of the FitnessEquipmentSensorState.

Parameters

deviceId

number

The unique identifier of the sensor device.

Returns

FitnessEquipmentScanState

Example

const sensorState = new FitnessEquipmentSensorState(12345);

Inherited from

FitnessEquipmentSensorState.constructor

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:16

Properties

_EventCount0x19?

optional _EventCount0x19: number

The event count for page 0x19.

Inherited from

FitnessEquipmentSensorState._EventCount0x19

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:24


_EventCount0x1A?

optional _EventCount0x1A: number

The event count for page 0x1A.

Inherited from

FitnessEquipmentSensorState._EventCount0x1A

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:30


AccumulatedPower?

optional AccumulatedPower: number

The total accumulated power output, in watts.

Inherited from

FitnessEquipmentSensorState.AccumulatedPower

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:177


AscendedDistance?

optional AscendedDistance: number

The distance ascended, in meters.

Inherited from

FitnessEquipmentSensorState.AscendedDistance

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:147


AveragePower?

optional AveragePower: number

The average power output, in watts.

Inherited from

FitnessEquipmentSensorState.AveragePower

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:189


Cadence?

optional Cadence: number

The current cadence, in revolutions per minute (RPM).

Inherited from

FitnessEquipmentSensorState.Cadence

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:171


CaloricBurnRate?

optional CaloricBurnRate: number

The caloric burn rate, in kilocalories per hour.

Inherited from

FitnessEquipmentSensorState.CaloricBurnRate

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:135


Calories?

optional Calories: number

The total calories burned.

Inherited from

FitnessEquipmentSensorState.Calories

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:141


CycleLength?

optional CycleLength: number

The cycle length of the equipment, in meters.

Inherited from

FitnessEquipmentSensorState.CycleLength

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:111


DescendedDistance?

optional DescendedDistance: number

The distance descended, in meters.

Inherited from

FitnessEquipmentSensorState.DescendedDistance

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:153


DeviceId

DeviceId: number

The unique identifier of the sensor device.

Inherited from

FitnessEquipmentSensorState.DeviceId

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:36


Distance?

optional Distance: number

The total distance traveled, in meters.

Inherited from

FitnessEquipmentSensorState.Distance

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:73


ElapsedTime?

optional ElapsedTime: number

The total elapsed time, in seconds.

Inherited from

FitnessEquipmentSensorState.ElapsedTime

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:67


EquipmentType?

optional EquipmentType: "Treadmill" | "Elliptical" | "Reserved" | "Rower" | "Climber" | "NordicSkier" | "Trainer/StationaryBike" | "General"

The type of fitness equipment. Can be “Treadmill”, “Elliptical”, “Reserved”, “Rower”, “Climber”, “NordicSkier”, “Trainer/StationaryBike”, or “General”.

Inherited from

FitnessEquipmentSensorState.EquipmentType

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:61


HeartRate?

optional HeartRate: number

The current heart rate, in beats per minute (BPM).

Inherited from

FitnessEquipmentSensorState.HeartRate

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:91


HeartRateSource?

optional HeartRateSource: "HandContact" | "EM" | "ANT+"

The source of the heart rate data. Can be “HandContact”, “EM”, or “ANT+”.

Inherited from

FitnessEquipmentSensorState.HeartRateSource

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:98


HwVersion?

optional HwVersion: number

The hardware version of the sensor.

Inherited from

FitnessEquipmentSensorState.HwVersion

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:226


Incline?

optional Incline: number

The incline of the equipment, in percentage.

Inherited from

FitnessEquipmentSensorState.Incline

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:117


InstantaneousPower?

optional InstantaneousPower: number

The instantaneous power output, in watts.

Inherited from

FitnessEquipmentSensorState.InstantaneousPower

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:183


ManId?

optional ManId: number

The manufacturer ID of the sensor.

Inherited from

FitnessEquipmentSensorState.ManId

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:232


METs?

optional METs: number

The metabolic equivalent (MET) value.

Inherited from

FitnessEquipmentSensorState.METs

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:129


ModelNum?

optional ModelNum: number

The model number of the sensor.

Inherited from

FitnessEquipmentSensorState.ModelNum

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:238


PairedDevices

PairedDevices: PairedDevice[] = []

The list of paired devices associated with the sensor.

Inherited from

FitnessEquipmentSensorState.PairedDevices

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:256


RealSpeed?

optional RealSpeed: number

The real speed of the equipment, in meters per second.

Inherited from

FitnessEquipmentSensorState.RealSpeed

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:79


Resistance?

optional Resistance: number

The resistance level of the equipment.

Inherited from

FitnessEquipmentSensorState.Resistance

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:123


Rssi

Rssi: undefined | number

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

Defined in

sensors/fitnessEquipment/fitnessEquipmentScanState.ts:14


SerialNumber?

optional SerialNumber: number

The serial number of the sensor.

Inherited from

FitnessEquipmentSensorState.SerialNumber

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:250


SpinDownTime?

optional SpinDownTime: number

The spin-down time for the sensor, in seconds.

Inherited from

FitnessEquipmentSensorState.SpinDownTime

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:54


State?

optional State: "OFF" | "READY" | "IN_USE" | "FINISHED"

The state of the equipment. Can be “OFF”, “READY”, “IN_USE”, or “FINISHED”.

Inherited from

FitnessEquipmentSensorState.State

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:105


Strides?

optional Strides: number

The total number of strides taken.

Inherited from

FitnessEquipmentSensorState.Strides

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:159


Strokes?

optional Strokes: number

The total number of strokes taken.

Inherited from

FitnessEquipmentSensorState.Strokes

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:165


SwVersion?

optional SwVersion: number

The software version of the sensor.

Inherited from

FitnessEquipmentSensorState.SwVersion

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:244


TargetStatus?

optional TargetStatus: "OnTarget" | "LowSpeed" | "HighSpeed"

The target status of the equipment. Can be “OnTarget”, “LowSpeed”, or “HighSpeed”.

Inherited from

FitnessEquipmentSensorState.TargetStatus

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:202


Temperature?

optional Temperature: number

The temperature measured by the sensor, in degrees Celsius.

Inherited from

FitnessEquipmentSensorState.Temperature

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:42


Threshold

Threshold: undefined | number

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

Defined in

sensors/fitnessEquipment/fitnessEquipmentScanState.ts:21


Torque?

optional Torque: number

The torque value, in newton-meters.

Inherited from

FitnessEquipmentSensorState.Torque

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:220


TrainerStatus?

optional TrainerStatus: number

The trainer status, typically indicating the current mode or condition of the trainer.

Inherited from

FitnessEquipmentSensorState.TrainerStatus

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:195


VirtualSpeed?

optional VirtualSpeed: number

The virtual speed of the equipment, in meters per second.

Inherited from

FitnessEquipmentSensorState.VirtualSpeed

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:85


WheelPeriod?

optional WheelPeriod: number

The wheel period, in seconds.

Inherited from

FitnessEquipmentSensorState.WheelPeriod

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:214


WheelTicks?

optional WheelTicks: number

The total number of wheel ticks.

Inherited from

FitnessEquipmentSensorState.WheelTicks

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:208


ZeroOffset?

optional ZeroOffset: number

The zero offset calibration value for the sensor.

Inherited from

FitnessEquipmentSensorState.ZeroOffset

Defined in

sensors/fitnessEquipment/fitnessEquipmentSensorState.ts:48