webduino-js

  • API Docs for Version: 0.7.0

    • Show:

    webduino.module.Button

    Extends webduino.Module

    The Button Class.

    Table of Contents

    Constructor

    webduino.module.Button
    (
    • board
    • pin
    • buttonMode
    • sustainedPressInterval
    )

    Defined in src/module/Button.js:45

    Parameters:

    • board webduino.Board

      The board the button is attached to.

    • pin webduino.pin

      The pin the button is connected to.

    • [buttonMode] Number optional

      Type of resistor the button is connected to, either Button.PULL_DOWN or Button.PULL_UP.

    • [sustainedPressInterval] Number optional

      A period of time when the button is pressed and hold for that long, it would be considered a "sustained press." Measured in ms.

    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.

    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.

    Properties

    INTERNAL_PULL_UP

    Number const static

    Defined in src/module/Button.js:192

    Indicates the internal-pull-up resistor type.

    PULL_DOWN

    Number const static

    Defined in src/module/Button.js:172

    Indicates the pull-down resistor type.

    PULL_UP

    Number const static

    Defined in src/module/Button.js:182

    Indicates the pull-up resistor type.

    Attributes

    buttonMode

    Number buttonMode readonly

    Defined in src/module/Button.js:142

    Return the button mode.

    sustainedPressInterval

    Number

    Defined in src/module/Button.js:155

    Return the sustained-press interval.

    type

    String readonly

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

    Type of the module.

    Events

    ButtonEvent.LONG_PRESS

    Defined in src/module/Button.js:30

    Fires when a button is long-pressed.

    ButtonEvent.PRESS

    Defined in src/module/Button.js:16

    Fires when a button is pressed.

    ButtonEvent.RELEASE

    Defined in src/module/Button.js:23

    Fires when a button is released.

    ButtonEvent.SUSTAINED_PRESS

    Defined in src/module/Button.js:37

    Fires when a button is sustained-pressed.