webduino-js

  • API Docs for Version: 0.7.0

    • Show:

    webduino.module.Led

    Extends webduino.Module

    The Led class.

    Table of Contents

    Constructor

    webduino.module.Led
    (
    • board
    • pin
    • driveMode
    )

    Defined in src/module/Led.js:15

    Parameters:

    • board webduino.Board

      The board the LED is attached to.

    • pin webduino.Pin

      The pin the LED is connected to.

    • [driveMode] Number optional

      Drive mode the LED is operating at, either Led.SOURCE_DRIVE or Led.SYNC_DRIVE.

    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.

    off
    (
    • callback
    )

    Defined in src/module/Led.js:114

    Dim the LED.

    Parameters:

    • [callback] Function optional

      LED state changed callback.

    on
    (
    • callback
    )

    Inherited from webduino.EventEmitter but overwritten in src/module/Led.js:100

    Light up the LED.

    Parameters:

    • [callback] Function optional

      LED state changed 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.

    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.

    toggle
    (
    • callback
    )

    Defined in src/module/Led.js:128

    Toggle LED state between on/off.

    Parameters:

    • [callback] Function optional

      State changed callback.

    Properties

    SOURCE_DRIVE

    Number const static

    Defined in src/module/Led.js:181

    Indicates the source LED drive mode.

    SYNC_DRIVE

    Number const static

    Defined in src/module/Led.js:191

    Indicates the synchronous LED drive mode.

    Attributes

    intensity

    Number

    Defined in src/module/Led.js:71

    Intensity of the LED.

    type

    String readonly

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

    Type of the module.