ant-plus-next

ant-plus-next v0.3.2


ant-plus-next / MuscleOxygenScanner

Class: MuscleOxygenScanner

Represents a scanner for Muscle Oxygen sensors. Extends the AntPlusScanner class to handle scanning and state updates for multiple Muscle Oxygen sensors.

Extends

Constructors

new MuscleOxygenScanner()

new MuscleOxygenScanner(stick): MuscleOxygenScanner

Constructs an instance of the AntPlusScanner class.

Parameters

stick

USBDriverBase

The USB driver instance used for communication with the ANT+ stick.

Returns

MuscleOxygenScanner

Inherited from

AntPlusScanner.constructor

Defined in

sensors/antPlusScanner.ts:42

Methods

detach()

detach(): Promise<void>

Detaches the sensor from its assigned channel and stops communication.

Returns

Promise<void>

Throws

Will throw an error if there is an issue detaching.

Inherited from

AntPlusScanner.detach

Defined in

sensors/baseSensor.ts:249


scan()

scan(): Promise<void>

Initiates a scan for ANT+ sensors by receiving broadcast messages.

Returns

Promise<void>

A promise that resolves when the scanning process is complete.

Example

// Example usage:
const scanner = new AntPlusScanner();
scanner.scan();

Inherited from

AntPlusScanner.scan

Defined in

sensors/antPlusScanner.ts:58