boost-movehub/src/peripherals/RgbLed.js

Connects with your Lego Boost Movehub vie Bluetooth Low Energy (BLE).

const Peripheral = require("./Peripheral");
const PortOutput = require("../messages/PortOutput");

const INDEX_MODE = 0x00;
const RGB_MODE = 0x01;

/**
 * Class to set LED colors of the Movehub.
 */
class RgbLed extends Peripheral {
  /**
   * @param {Number} ioType Peripheral Device Type ID (Should be `Peripheral.DEV_RGB_LIGHT`)
   * @param {Number} portId Port ID this peripheral is connected to
   * @param {object} [options.ioMembers] If this has severeal members, it is a virtual device
   * @param {object} [options.logger]
   */
  constructor(ioType, portId, options = undefined) {
    super(ioType, portId, options);
    this.displayName = "RgbLed";
    this.currentColor = RgbLed.COLOR_OFF;
  }

  /**
   * Creates a message that sets color to specific color by it’s number.
   * Sends message as defined in https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#output-sub-command-setrgbcolorno-redcolor-greencolor-bluecolor-n-a
   * TODO: Make flags configurable via options
   *
   * @param {number} color One of `RgbLed.COLOR_*`
   */
  setColor(color) {
    this.mode = INDEX_MODE;
    this.currentColor = color;
    return PortOutput.buildWriteDirectModeData(
      this.portId,
      PortOutput.SC_FLAGS.EXECUTE_IMMEDIATE,
      this.mode,
      [color]
    );
  }

  /**
   * Creates a message that sets LED to a specified RGB value
   * Sends message as defined in https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#output-sub-command-setrgbcolorno-colorno-n-a
   * TODO: Make flags configurable via options
   *
   * FIXME: This does not work yet
   *
   * @param {number} red Red part of RGB value 0…255
   * @param {number} green Green part of RGB value 0…255
   * @param {number} blue Blue part of RGB value 0…255
   */
  setRgbColor(red, green, blue) {
    this.mode = RGB_MODE;
    return PortOutput.buildWriteDirectModeData(
      this.portId,
      PortOutput.SC_FLAGS.NONE,
      this.mode,
      [red, green, blue]
    );
  }

  /**
   * Receives and processes message with value from sensor.
   *
   * @param {PortValueSingleMessage} _msg
   */
  receiveValue(_msg) {
    this._log("info", `.receiveValue not implemetned`);
  }

  receiveCommandFeedback(value) {
    this._log("debug", `rgbLed received feedback:`, value);
  }
}

RgbLed.COLOR_OFF = 0x00;
RgbLed.COLOR_PINK = 0x01;
RgbLed.COLOR_PURPLE = 0x02;
RgbLed.COLOR_BLUE = 0x03;
RgbLed.COLOR_LIGHTBLUE = 0x04;
RgbLed.COLOR_CYAN = 0x05;
RgbLed.COLOR_GREEN = 0x06;
RgbLed.COLOR_YELLOW = 0x07;
RgbLed.COLOR_ORANGE = 0x09;
RgbLed.COLOR_RED = 0x09;
RgbLed.COLOR_WHITE = 0x0a;

module.exports = RgbLed;