webduino-js

  • API Docs for Version: 0.7.0

    • Show:

    webduino.module.Ultrasonic

    Extends webduino.Module

    The Ultrasonic class.

    Table of Contents

    Constructor

    webduino.module.Ultrasonic
    (
    • board
    • trigger
    • echo
    )

    Defined in src/module/Ultrasonic.js:36

    Parameters:

    • board webduino.Board

      The board the ultrasonic sensor is attached to.

    • trigger webduino.Pin

      The trigger pin the sensor is connected to.

    • echo webduino.Pin

      The echo pin the sensor 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.

    ping
    (
    • callback
    • interval
    )
    Promise

    Defined in src/module/Ultrasonic.js:113

    Transmit an ultrasonic to sense the distance at a (optional) given interval.

    Parameters:

    • [callback] Function optional

      Callback when a response is returned.

    • [interval] Number optional

      Interval between each transmission. If omitted the ultrasonic will be transmitted once.

    Returns:

    Promise:

    A promise when the ping response is returned. Will not return anything if a callback function is given.

    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.

    stopPing ()

    Defined in src/module/Ultrasonic.js:162

    Stop transmitting any ultrasonic.

    Attributes

    distance

    Number readonly

    Defined in src/module/Ultrasonic.js:99

    Distance returned from the previous transmission.

    type

    String readonly

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

    Type of the module.

    Events

    UltrasonicEvent.PING

    Defined in src/module/Ultrasonic.js:21

    Fires when receiving a ping response.

    UltrasonicEvent.PING_ERROR

    Defined in src/module/Ultrasonic.js:28

    Fires when receiving a ping-error response.