ant-plus-next/dist/sensors/cadence/cadenceScanner.d.ts

A modern Node.js module for working with ANT+ USB sticks and sensors.

import { AntPlusScanner } from "../antPlusScanner.js";
/**
 * Represents a scanner for Cadence sensors.
 * Extends the AntPlusScanner class to handle scanning and state updates for multiple cadence sensors.
 *
 * @category Sensors
 */
export declare class CadenceScanner extends AntPlusScanner {
    /**
     * Returns the device type code for Cadence sensors.
     *
     * @protected
     * @returns {number} The device type code for Cadence sensors.
     */
    protected deviceType(): number;
    /**
     * The wheel circumference used for cadence calculations, in meters.
     * Defaults to 2.199 meters (70 cm wheel).
     * @type {number}
     */
    wheelCircumference: number;
    /**
     * Sets the wheel circumference for cadence calculations.
     *
     * @public
     * @param {number} wheelCircumference - The wheel circumference in meters.
     * @returns {void}
     *
     * @example
     * scanner.setWheelCircumference(2.105); // Sets the wheel circumference to 2.105 meters
     */
    setWheelCircumference(wheelCircumference: number): void;
    /**
     * A dictionary to store the states of detected Cadence sensors by their device ID.
     * @private
     * @type {{ [id: number]: CadenceScanState }}
     */
    private states;
    /**
     * Creates a new state entry for a sensor if it does not already exist.
     *
     * @protected
     * @param {number} deviceId - The unique identifier of the sensor device.
     * @returns {void}
     *
     * @example
     * scanner.createStateIfNew(12345); // Creates a new state for device ID 12345 if it does not exist.
     */
    protected createStateIfNew(deviceId: number): void;
    /**
     * Updates the RSSI (Received Signal Strength Indicator) and signal threshold for a specific sensor.
     *
     * @protected
     * @param {number} deviceId - The unique identifier of the sensor device.
     * @param {number} rssi - The received signal strength indicator of the device.
     * @param {number} threshold - The signal threshold value for the device.
     * @returns {void}
     *
     * @example
     * scanner.updateRssiAndThreshold(12345, -70, 30); // Updates the RSSI and threshold for device ID 12345.
     */
    protected updateRssiAndThreshold(deviceId: number, rssi: number, threshold: number): void;
    /**
     * Updates the state of a sensor based on incoming data.
     *
     * @protected
     * @param {number} deviceId - The unique identifier of the sensor device.
     * @param {DataView} data - The raw data buffer received from the sensor.
     * @returns {void}
     *
     * @example
     * const dataBuffer = getDataFromSensor(); // Assume this function gets data from a sensor
     * scanner.updateState(12345, dataBuffer); // Updates the state for device ID 12345.
     */
    protected updateState(deviceId: number, data: DataView): void;
}
//# sourceMappingURL=cadenceScanner.d.ts.map