webduino-js

  • API Docs for Version: 0.7.0

    • Show:

    webduino.module.RGBLed

    Extends webduino.Module

    The RGBLed Class.

    Table of Contents

    Constructor

    webduino.module.RGBLed
    (
    • board
    • redLedPin
    • greenLedPin
    • blueLedPin
    • driveMode
    )

    Defined in src/module/RGBLed.js:14

    Parameters:

    • board webduino.Board

      The board the RGB LED is attached to.

    • redLedPin webduino.Pin

      The pin the red LED is connected to.

    • greenLedPin webduino.Pin

      The pin the green LED is connected to.

    • blueLedPin webduino.Pin

      The pin the blue LED is connected to.

    • [driveMode] Number optional

      Drive mode the RGB LED is operating at, either RGBLed.COMMON_ANODE or RGBLed.COMMON_CATHODE.

    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.

    setColor
    (
    • red
    • green
    • blue
    • callback
    )

    Defined in src/module/RGBLed.js:64

    Light up and mix colors with the LEDs.

    Parameters:

    • red Number

      The brightness of the red LED.

    • green Number

      The brightness of the green LED.

    • blue Number

      The brightness of the blue LED.

    • [callback] Function optional

      Function to call when the color is set.

    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

    COMMON_ANODE

    Number const static

    Defined in src/module/RGBLed.js:106

    Indicates the common anode drive mode.

    COMMON_CATHODE

    Number const static

    Defined in src/module/RGBLed.js:116

    Indicates the common cathode drive mode.

    Attributes

    type

    String readonly

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

    Type of the module.