ant-plus-next / HeartRateScanState
Represents the state of a Heart Rate sensor during scanning. Extends the HeartRateSensorState to include additional fields specific to scanning, such as RSSI (Received Signal Strength Indicator) and signal threshold.
new HeartRateScanState(
deviceId):HeartRateScanState
Creates an instance of the HeartRateSensorState.
number
The unique identifier of the sensor device.
const sensorState = new HeartRateSensorState(12345);
HeartRateSensorState.constructor
sensors/heartRate/heartRateSensorState.ts:14
optionalBatteryLevel:number
The battery level of the sensor.
HeartRateSensorState.BatteryLevel
sensors/heartRate/heartRateSensorState.ts:118
optionalBatteryStatus:"New"|"Good"|"Ok"|"Low"|"Critical"|"Invalid"
The battery status of the sensor. Can be “New”, “Good”, “Ok”, “Low”, “Critical”, or “Invalid”.
HeartRateSensorState.BatteryStatus
sensors/heartRate/heartRateSensorState.ts:131
optionalBatteryStatusBit:number
The battery status bit of the sensor.
HeartRateSensorState.BatteryStatusBit
sensors/heartRate/heartRateSensorState.ts:136
optionalBatteryVoltage:number
The battery voltage of the sensor.
HeartRateSensorState.BatteryVoltage
sensors/heartRate/heartRateSensorState.ts:124
BeatCount:
undefined|number
The cumulative count of beat events since the sensor started.
HeartRateSensorState.BeatCount
sensors/heartRate/heartRateSensorState.ts:34
BeatTime:
undefined|number
The time of the last beat event in milliseconds.
sensors/heartRate/heartRateSensorState.ts:28
ComputedHeartRate:
undefined|number
The computed heart rate in beats per minute (BPM).
HeartRateSensorState.ComputedHeartRate
sensors/heartRate/heartRateSensorState.ts:40
DeviceId:
number
The unique identifier of the sensor device.
sensors/heartRate/heartRateSensorState.ts:22
optionalEnabledFeatures:number
The enabled features of the sensor.
HeartRateSensorState.EnabledFeatures
sensors/heartRate/heartRateSensorState.ts:112
optionalHwVersion:number
The hardware version of the sensor.
HeartRateSensorState.HwVersion
sensors/heartRate/heartRateSensorState.ts:64
optionalIntervalAverage:number
The average heart rate over a certain interval.
HeartRateSensorState.IntervalAverage
sensors/heartRate/heartRateSensorState.ts:88
optionalIntervalMax:number
The maximum heart rate over a certain interval.
HeartRateSensorState.IntervalMax
sensors/heartRate/heartRateSensorState.ts:94
optionalManId:number
The manufacturer ID of the sensor.
sensors/heartRate/heartRateSensorState.ts:52
optionalModelNum:number
The model number of the sensor.
sensors/heartRate/heartRateSensorState.ts:76
optionalOperatingTime:number
The cumulative operating time of the sensor in seconds.
HeartRateSensorState.OperatingTime
sensors/heartRate/heartRateSensorState.ts:46
optionalPreviousBeat:number
The time of the previous beat measurement.
HeartRateSensorState.PreviousBeat
sensors/heartRate/heartRateSensorState.ts:82
Rssi:
undefined|number
The received signal strength indicator (RSSI) of the sensor signal.
sensors/heartRate/heartRateScanState.ts:13
optionalSerialNumber:number
The serial number of the sensor.
HeartRateSensorState.SerialNumber
sensors/heartRate/heartRateSensorState.ts:58
optionalSessionAverage:number
The average heart rate over the current session.
HeartRateSensorState.SessionAverage
sensors/heartRate/heartRateSensorState.ts:100
optionalSupportedFeatures:number
The supported features of the sensor.
HeartRateSensorState.SupportedFeatures
sensors/heartRate/heartRateSensorState.ts:106
optionalSwVersion:number
The software version of the sensor.
HeartRateSensorState.SwVersion
sensors/heartRate/heartRateSensorState.ts:70
Threshold:
undefined|number
The signal threshold value for the sensor.