webduino-js

  • API Docs for Version: 0.7.0

    • Show:

    webduino.module.ADXL345

    Extends webduino.Module

    The ADXL345 class.

    ADXL345 is a small, thin, ultralow power, 3-axis accelerometer.

    Table of Contents

    Constructor

    webduino.module.ADXL345
    (
    • board
    )

    Defined in src/module/ADXL345.js:24

    Parameters:

    • board webduino.Board

      The board that the ADXL345 accelerometer is attached 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.

    detect
    (
    • callback
    )

    Defined in src/module/ADXL345.js:141

    Start detection.

    Parameters:

    • [callback] Function optional

      Detection callback.

    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.

    off ()

    Defined in src/module/ADXL345.js:195

    Stop detection.

    on
    (
    • callback
    )
    deprecated

    Inherited from webduino.EventEmitter but overwritten in src/module/ADXL345.js:148

    Deprecated: `on()` is deprecated, use `detect()` instead.

    Start detection.

    Parameters:

    • [callback] Function optional

      Detection callback.

    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.

    refresh ()

    Defined in src/module/ADXL345.js:208

    Reset detection value.

    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.

    setBaseAxis
    (
    • axis
    )

    Defined in src/module/ADXL345.js:227

    Set the base axis for calculation.

    Parameters:

    • axis String

      Axis to be set to, either x, y, or z.

    setDetectTime
    (
    • detectTime
    )

    Defined in src/module/ADXL345.js:250

    Set detecting time period.

    Parameters:

    • detectTime Number

      The time period for detecting, in ms.

    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.

    setSensitivity
    (
    • sensitivity
    )

    Defined in src/module/ADXL345.js:237

    Set detection sensitivity.

    Parameters:

    • sensitivity Number

      Detection sensitivity.

    Attributes

    state

    String on or off

    Defined in src/module/ADXL345.js:125

    The state indicating whether the accelerometer is detecting.

    type

    String readonly

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

    Type of the module.

    Events

    ADXL234Event.MESSAGE

    Defined in src/module/ADXL345.js:16

    Fires when the accelerometer senses a value change.