webduino-js

  • API Docs for Version: 0.7.0

    • Show:

    webduino.module.Dht

    Extends webduino.Module

    The Dht Class.

    DHT is sensor for measuring temperature and humidity.

    Table of Contents

    Constructor

    webduino.module.Dht
    (
    • board
    • pin
    )

    Defined in src/module/Dht.js:36

    Parameters:

    • board webduino.Board

      The board that the DHT is attached to.

    • pin Integer

      The pin that the DHT is connected to.

    Methods

    addListener
    (
    • type
    • listener
    )

    Inherited from webduino.EventEmitter: src/core/EventEmitter.js:117

    Add a listener for a certain type of event.

    Parameters:

    • type String

      Event type.

    • listener Function

      Event listener.

    emit
    (
    • type
    • object,...
    )

    Inherited from webduino.EventEmitter: src/core/EventEmitter.js:58

    Emit an event of certain type.

    Parameters:

    • type String

      Event type.

    • [object,...] Object optional

      Event object(s).

    listeners
    (
    • type
    )

    Inherited from webduino.EventEmitter: src/core/EventEmitter.js:310

    Return the listener list bound to certain type of event.

    Parameters:

    • type String

      Evnet type.

    on
    (
    • type
    • listener
    )

    Inherited from webduino.EventEmitter: src/core/EventEmitter.js:174

    Alias for EventEmitter.addListener(type, listener)

    Parameters:

    • type String

      Event type.

    • listener Function

      Event listener.

    once
    (
    • type
    • listener
    )

    Inherited from webduino.EventEmitter: src/core/EventEmitter.js:183

    Add a one-time listener for a certain type of event.

    Parameters:

    • type String

      Event type.

    • listener Function

      Event listener.

    read
    (
    • callback
    • interval
    )

    Defined in src/module/Dht.js:134

    Start reading data from sensor.

    Parameters:

    • [callback] Function optional

      reading callback.

      • data Object

        returned data from sensor, humidity and temperature will be passed into callback function as parameters.

        callback()

        will be transformed to

         callback({humidity: humidity, temperature: temperature})

        automatically.

    • interval Integer

      reading interval.

    removeAllListeners
    (
    • type
    )

    Inherited from webduino.EventEmitter: src/core/EventEmitter.js:264

    Remove all listeners of certain type.

    Parameters:

    • type String

      Event type.

    removeListener
    (
    • type
    • listener
    )

    Inherited from webduino.EventEmitter: src/core/EventEmitter.js:211

    Remove a listener for certain type of event.

    Parameters:

    • type String

      Event type.

    • listener Function

      Event listener.

    setMaxListeners
    (
    • n
    )

    Inherited from webduino.EventEmitter: src/core/EventEmitter.js:45

    Set maximum number of listeners that is allow to bind on an emitter.

    Parameters:

    • n Number

      Number of listeners.

    stopRead ()

    Defined in src/module/Dht.js:198

    Stop reading value from sensor.

    Attributes

    humidity

    Number humidity readonly

    Defined in src/module/Dht.js:107

    Return the humidity.

    temperature

    Number temperature readonly

    Defined in src/module/Dht.js:120

    Return the temperature.

    type

    String readonly

    Inherited from webduino.Module: src/core/Module.js:30

    Type of the module.

    Events

    DhtEvent.READ

    Defined in src/module/Dht.js:21

    Fires when reading value.

    DhtEvent.READ_ERROR

    Defined in src/module/Dht.js:28

    Fires when error occured while reading value.