ant-plus-next/dist/sensors/speed/speedSensor.d.ts

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

import { AntPlusSensor } from "../antPlusSensor.js";
/**
 * Represents a Bicycle Speed sensor.
 * This class extends the AntPlusSensor class to handle specific data related to speed measurement.
 *
 * @category Sensors
 */
export declare class SpeedSensor extends AntPlusSensor {
    /**
     * The device type code for Bicycle Speed sensors.
     * @type {number}
     * @readonly
     */
    static deviceType: number;
    /**
     * The wheel circumference in meters, used to calculate speed.
     * @type {number}
     * @default 2.199
     */
    wheelCircumference: number;
    /**
     * Sets the wheel circumference for speed calculation.
     *
     * @public
     * @param {number} wheelCircumference - The wheel circumference in meters.
     * @returns {void}
     *
     * @example
     * const sensor = new SpeedSensor();
     * sensor.setWheelCircumference(2.105); // Sets the wheel circumference to 2.105 meters
     */
    setWheelCircumference(wheelCircumference: number): void;
    /**
     * Attaches the sensor to a specified ANT+ channel and initializes its state.
     *
     * @public
     * @param {number} channel - The ANT+ channel number used for communication with the sensor.
     * @param {number} deviceId - The unique identifier of the sensor device.
     * @returns {void}
     *
     * @example
     * const sensor = new SpeedSensor();
     * sensor.attach(1, 12345); // Attaches to channel 1 with device ID 12345
     */
    attach(channel: number, deviceId: number): Promise<void>;
    /**
     * The current state of the Bicycle Speed sensor.
     * @private
     * @type {SpeedSensorState}
     */
    private state;
    /**
     * Updates the state of the 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
     * sensor.updateState(12345, dataBuffer);
     */
    protected updateState(deviceId: number, data: DataView): void;
}
//# sourceMappingURL=speedSensor.d.ts.map