ant-plus-next

ant-plus-next v0.3.2


ant-plus-next / CadenceScanner

Class: CadenceScanner

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

Extends

Constructors

new CadenceScanner()

new CadenceScanner(stick): CadenceScanner

Constructs an instance of the AntPlusScanner class.

Parameters

stick

USBDriverBase

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

Returns

CadenceScanner

Inherited from

AntPlusScanner.constructor

Defined in

sensors/antPlusScanner.ts:42

Properties

wheelCircumference

wheelCircumference: number = 2.199

The wheel circumference used for cadence calculations, in meters. Defaults to 2.199 meters (70 cm wheel).

Defined in

sensors/cadence/cadenceScanner.ts:28

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


setWheelCircumference()

setWheelCircumference(wheelCircumference): void

Sets the wheel circumference for cadence calculations.

Parameters

wheelCircumference

number

The wheel circumference in meters.

Returns

void

Example

scanner.setWheelCircumference(2.105); // Sets the wheel circumference to 2.105 meters

Defined in

sensors/cadence/cadenceScanner.ts:40