ant-plus-next / MuscleOxygenSensorState
Represents the state of a Muscle Oxygen sensor. This class holds the data fields associated with the state of a Muscle Oxygen sensor, including event count, device details, measurement data, and battery status.
new MuscleOxygenSensorState(
deviceId
):MuscleOxygenSensorState
Creates an instance of the MuscleOxygenSensorState.
number
The unique identifier of the sensor device.
const sensorState = new MuscleOxygenSensorState(12345);
sensors/muscleOxygen/muscleOxygenSensorState.ts:14
optional
_EventCount:number
The count of events detected by the sensor.
sensors/muscleOxygen/muscleOxygenSensorState.ts:22
optional
BatteryStatus:"New"
|"Good"
|"Ok"
|"Low"
|"Critical"
|"Invalid"
The battery status of the sensor. Can be “New”, “Good”, “Ok”, “Low”, “Critical”, or “Invalid”.
sensors/muscleOxygen/muscleOxygenSensorState.ts:117
optional
BatteryStatusBit:number
The battery status bit of the sensor.
sensors/muscleOxygen/muscleOxygenSensorState.ts:122
optional
BatteryVoltage:number
The battery voltage of the sensor.
sensors/muscleOxygen/muscleOxygenSensorState.ts:110
optional
CurrentSaturatedHemoglobinPercentage:number
|"Invalid"
|"AmbientLightTooHigh"
The percentage of saturated hemoglobin from the current measurement. Can be a numeric value, “AmbientLightTooHigh”, or “Invalid”.
sensors/muscleOxygen/muscleOxygenSensorState.ts:68
DeviceId:
number
The unique identifier of the sensor device.
sensors/muscleOxygen/muscleOxygenSensorState.ts:28
optional
HwVersion:number
The hardware version of the sensor.
sensors/muscleOxygen/muscleOxygenSensorState.ts:74
optional
ManId:number
The manufacturer ID of the sensor.
sensors/muscleOxygen/muscleOxygenSensorState.ts:80
optional
MeasurementInterval:1
|2
|0.5
|0.25
The measurement interval in seconds. Possible values: 0.25, 0.5, 1, or 2 seconds.
sensors/muscleOxygen/muscleOxygenSensorState.ts:47
optional
ModelNum:number
The model number of the sensor.
sensors/muscleOxygen/muscleOxygenSensorState.ts:86
optional
OperatingTime:number
The cumulative operating time of the sensor in seconds.
sensors/muscleOxygen/muscleOxygenSensorState.ts:104
optional
PreviousSaturatedHemoglobinPercentage:number
|"Invalid"
|"AmbientLightTooHigh"
The percentage of saturated hemoglobin from the previous measurement. Can be a numeric value, “AmbientLightTooHigh”, or “Invalid”.
sensors/muscleOxygen/muscleOxygenSensorState.ts:61
optional
SerialNumber:number
The serial number of the sensor.
sensors/muscleOxygen/muscleOxygenSensorState.ts:98
optional
SupportANTFS:boolean
Indicates whether ANT-FS is supported by the sensor.
sensors/muscleOxygen/muscleOxygenSensorState.ts:40
optional
SwVersion:number
The software version of the sensor.
sensors/muscleOxygen/muscleOxygenSensorState.ts:92
optional
TotalHemoglobinConcentration:number
|"Invalid"
|"AmbientLightTooHigh"
The total hemoglobin concentration. Can be a numeric value, “AmbientLightTooHigh”, or “Invalid”.
sensors/muscleOxygen/muscleOxygenSensorState.ts:54
optional
UTCTimeRequired:boolean
Indicates whether UTC time is required by the sensor.