npm.io
1.1.3 • Published 2 years ago

@types/pigpio-dht

Licence
MIT
Version
1.1.3
Deps
1
Size
4 kB
Vulns
0
Weekly
0
Stars
51.4K

Installation

npm install --save @types/pigpio-dht

Summary

This package contains type definitions for pigpio-dht (https://github.com/depuits/pigpio-dht).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/pigpio-dht.

index.d.ts

/// <reference types="node" />

export = dht;

/**
 * Returns a new DHT object for accessing a DHT11 or DHT22/AM2302 via GPIO.
 * @param gpio      an unsigned integer specifying the GPIO number
 * @param type      11 to initialize for reading a DHT11, 22 for DHT22/AM2302
 */
declare function dht(gpio: number, type: number): dht.Dht;

declare namespace dht {
    interface Dht extends NodeJS.EventEmitter {
        /**
         * Starts reading the sensor value. Emits the 'start' event before starting,
         * the 'end' event on end whether or not an error occurred, the 'result'
         * event with a DhtResult on success, and the 'badChecksum' event on a
         * receive failure.
         * @returns false if a read is already underway, true if a new read was started.
         */
        read(): boolean;
    }

    /**
     * Result from a successful sensor read.
     */
    interface DhtResult {
        /** The temperature value in degrees Celsius. */
        temperature: number;

        /** The humidity value in percentage points. */
        humidity: number;
    }
}

Additional Details

  • Last updated: Tue, 07 Nov 2023 0939 GMT
  • Dependencies: @types/node

Credits

These definitions were written by .