ant-plus-next

ant-plus-next v0.3.2


ant-plus-next / MuscleOxygenScanState

Class: MuscleOxygenScanState

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

Extends

Constructors

new MuscleOxygenScanState()

new MuscleOxygenScanState(deviceId): MuscleOxygenScanState

Creates an instance of the MuscleOxygenSensorState.

Parameters

deviceId

number

The unique identifier of the sensor device.

Returns

MuscleOxygenScanState

Example

const sensorState = new MuscleOxygenSensorState(12345);

Inherited from

MuscleOxygenSensorState.constructor

Defined in

sensors/muscleOxygen/muscleOxygenSensorState.ts:14

Properties

_EventCount?

optional _EventCount: number

The count of events detected by the sensor.

Inherited from

MuscleOxygenSensorState._EventCount

Defined in

sensors/muscleOxygen/muscleOxygenSensorState.ts:22


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

MuscleOxygenSensorState.BatteryStatus

Defined in

sensors/muscleOxygen/muscleOxygenSensorState.ts:117


BatteryStatusBit?

optional BatteryStatusBit: number

The battery status bit of the sensor.

Inherited from

MuscleOxygenSensorState.BatteryStatusBit

Defined in

sensors/muscleOxygen/muscleOxygenSensorState.ts:122


BatteryVoltage?

optional BatteryVoltage: number

The battery voltage of the sensor.

Inherited from

MuscleOxygenSensorState.BatteryVoltage

Defined in

sensors/muscleOxygen/muscleOxygenSensorState.ts:110


CurrentSaturatedHemoglobinPercentage?

optional CurrentSaturatedHemoglobinPercentage: number | "Invalid" | "AmbientLightTooHigh"

The percentage of saturated hemoglobin from the current measurement. Can be a numeric value, “AmbientLightTooHigh”, or “Invalid”.

Inherited from

MuscleOxygenSensorState.CurrentSaturatedHemoglobinPercentage

Defined in

sensors/muscleOxygen/muscleOxygenSensorState.ts:68


DeviceId

DeviceId: number

The unique identifier of the sensor device.

Inherited from

MuscleOxygenSensorState.DeviceId

Defined in

sensors/muscleOxygen/muscleOxygenSensorState.ts:28


HwVersion?

optional HwVersion: number

The hardware version of the sensor.

Inherited from

MuscleOxygenSensorState.HwVersion

Defined in

sensors/muscleOxygen/muscleOxygenSensorState.ts:74


ManId?

optional ManId: number

The manufacturer ID of the sensor.

Inherited from

MuscleOxygenSensorState.ManId

Defined in

sensors/muscleOxygen/muscleOxygenSensorState.ts:80


MeasurementInterval?

optional MeasurementInterval: 1 | 2 | 0.5 | 0.25

The measurement interval in seconds. Possible values: 0.25, 0.5, 1, or 2 seconds.

Inherited from

MuscleOxygenSensorState.MeasurementInterval

Defined in

sensors/muscleOxygen/muscleOxygenSensorState.ts:47


ModelNum?

optional ModelNum: number

The model number of the sensor.

Inherited from

MuscleOxygenSensorState.ModelNum

Defined in

sensors/muscleOxygen/muscleOxygenSensorState.ts:86


OperatingTime?

optional OperatingTime: number

The cumulative operating time of the sensor in seconds.

Inherited from

MuscleOxygenSensorState.OperatingTime

Defined in

sensors/muscleOxygen/muscleOxygenSensorState.ts:104


PreviousSaturatedHemoglobinPercentage?

optional PreviousSaturatedHemoglobinPercentage: number | "Invalid" | "AmbientLightTooHigh"

The percentage of saturated hemoglobin from the previous measurement. Can be a numeric value, “AmbientLightTooHigh”, or “Invalid”.

Inherited from

MuscleOxygenSensorState.PreviousSaturatedHemoglobinPercentage

Defined in

sensors/muscleOxygen/muscleOxygenSensorState.ts:61


Rssi

Rssi: undefined | number

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

Defined in

sensors/muscleOxygen/muscleOxygenScanState.ts:13


SerialNumber?

optional SerialNumber: number

The serial number of the sensor.

Inherited from

MuscleOxygenSensorState.SerialNumber

Defined in

sensors/muscleOxygen/muscleOxygenSensorState.ts:98


SupportANTFS?

optional SupportANTFS: boolean

Indicates whether ANT-FS is supported by the sensor.

Inherited from

MuscleOxygenSensorState.SupportANTFS

Defined in

sensors/muscleOxygen/muscleOxygenSensorState.ts:40


SwVersion?

optional SwVersion: number

The software version of the sensor.

Inherited from

MuscleOxygenSensorState.SwVersion

Defined in

sensors/muscleOxygen/muscleOxygenSensorState.ts:92


Threshold

Threshold: undefined | number

The signal threshold value for the sensor.

Defined in

sensors/muscleOxygen/muscleOxygenScanState.ts:19


TotalHemoglobinConcentration?

optional TotalHemoglobinConcentration: number | "Invalid" | "AmbientLightTooHigh"

The total hemoglobin concentration. Can be a numeric value, “AmbientLightTooHigh”, or “Invalid”.

Inherited from

MuscleOxygenSensorState.TotalHemoglobinConcentration

Defined in

sensors/muscleOxygen/muscleOxygenSensorState.ts:54


UTCTimeRequired?

optional UTCTimeRequired: boolean

Indicates whether UTC time is required by the sensor.

Inherited from

MuscleOxygenSensorState.UTCTimeRequired

Defined in

sensors/muscleOxygen/muscleOxygenSensorState.ts:34