node-red-contrib-lifx-api/lifx-api/lifx.js

A collection of Node-RED nodes to control LIFX globes using the HTTP Remote Control API.

/**
 * Copyright 2016 Alisdair Smyth
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 **/
module.exports = function(RED) {
  "use strict";
  var lifxObj = require("lifx-http-api");

  function lifxConfig(n) {
    RED.nodes.createNode(this, n);
    this.name = n.name;
    this.token = n.token;
  }
  RED.nodes.registerType("lifx-config", lifxConfig);

  function defaultTo(val, def) {
    return typeof val != "undefined" ? val : def != "" ? def : null;
  }

  function defaultToNumber(val, def) {
    var tmp = defaultTo(val, def)
    return typeof tmp === "number"
      ? tmp
      : typeof tmp === "string"
        ? tmp != ""
          ? Number(tmp)
          : null
        : null
  }

  function defaultToBoolean(val, def) {
    var tmp = defaultTo(val, def)
    return typeof tmp === "boolean"
      ? tmp
      : typeof tmp === "string"
        ? tmp.toLowerCase() === "true"
        : null
  }

  function prepareSettings(settings) {
    var tmp = {}
    for (var setting in settings) {
      if (settings[setting] != null) {
        tmp[setting] = settings[setting]
      }
    }
    return tmp
  }

  function togglePower(config) {
    RED.nodes.createNode(this, config);
    this.selector = config.selector;

    // Retrieve the config node
    this.api = RED.nodes.getNode(config.api);

    var lifx = new lifxObj({ bearerToken: this.api.token });
    var node = this;
    this.on("input", function(msg) {
      msg.payload = defaultTo(msg.payload, {});
      var selector = defaultTo(msg.payload.selector, this.selector);
      lifx.togglePower(selector, 0, function(err, data) {
        if (err) {
          node.error(err);
          return;
        }
      });
    });
  }
  RED.nodes.registerType("lifx-toggle-power", togglePower);

  function pulseEffect(config) {
    RED.nodes.createNode(this, config);
    this.selector = config.selector;
    this.color = config.color;
    this.from_color = config.from_color;
    this.period = config.period;
    this.cycles = config.cycles;
    this.persist = config.persist;
    this.power_on = config.power_on;

    // Retrieve the config node
    this.api = RED.nodes.getNode(config.api);

    var lifx = new lifxObj({ bearerToken: this.api.token });
    var node = this;
    this.on("input", function(msg) {
      msg.payload = defaultTo(msg.payload, {});
      var selector = defaultTo(msg.payload.selector, this.selector);
      var settings = prepareSettings({
        color: defaultTo(msg.payload.color, this.color),
        from_color: defaultTo(msg.payload.from_color, this.from_color),
        period: defaultToNumber(msg.payload.period, this.period),
        cycles: defaultToNumber(msg.payload.cycles, this.cycles),
        persist: defaultToBoolean(msg.payload.persist, this.persist),
        power_on: defaultToBoolean(msg.payload.power_on, this.power_on)
      });
      lifx.pulse(selector, settings, function(err, data) {
        if (err) {
          node.error(err);
          return;
        }
      });
    });
  }
  RED.nodes.registerType("lifx-pulse-effect", pulseEffect);

  function breatheEffect(config) {
    RED.nodes.createNode(this, config);
    this.selector = config.selector;
    this.color = config.color;
    this.from_color = config.from_color;
    this.period = config.period;
    this.cycles = config.cycles;
    this.persist = config.persist;
    this.power_on = config.power_on;
    this.peak = config.peak;

    // Retrieve the config node
    this.api = RED.nodes.getNode(config.api);

    var lifx = new lifxObj({ bearerToken: this.api.token });
    var node = this;
    this.on("input", function(msg) {
      msg.payload = defaultTo(msg.payload, {});
      var selector = defaultTo(msg.payload.selector, this.selector);
      var settings = prepareSettings({
        color: defaultTo(msg.payload.color, this.color),
        from_color: defaultTo(msg.payload.from_color, this.from_color),
        period: defaultToNumber(msg.payload.period, this.period),
        cycles: defaultToNumber(msg.payload.cycles, this.cycles),
        persist: defaultToBoolean(msg.payload.persist, this.persist),
        power_on: defaultToBoolean(msg.payload.power_on, this.power_on),
        peak: defaultToNumber(msg.payload.peak, this.peak)
      });
      lifx.breathe(selector, settings, function(err, data) {
        if (err) {
          node.error(err);
          return;
        }
      });
    });
  }
  RED.nodes.registerType("lifx-breathe-effect", breatheEffect);

  function listLights(config) {
    RED.nodes.createNode(this, config);
    this.selector = config.selector;

    // Retrieve the config node
    this.api = RED.nodes.getNode(config.api);

    var lifx = new lifxObj({ bearerToken: this.api.token });
    var node = this;
    this.on("input", function(msg) {
      msg.payload = defaultTo(msg.payload, {});
      var selector = defaultTo(msg.payload.selector, this.selector);
      lifx.listLights(selector, function(err, data) {
        if (err) {
          node.error(err);
          return;
        }
        msg.payload = data;
        node.send(msg);
      });
    });
  }
  RED.nodes.registerType("lifx-list-lights", listLights);

  function setState(config) {
    RED.nodes.createNode(this, config);
    this.selector = config.selector;

    // Retrieve the config node
    this.api = RED.nodes.getNode(config.api);
    this.power = config.power;
    this.color = config.color;
    this.brightness = config.brightness;
    this.duration = config.duration;
    this.infrared = config.infrared;
    this.fast = config.fast;

    var lifx = new lifxObj({ bearerToken: this.api.token });
    var node = this;
    this.on("input", function(msg) {
      msg.payload = defaultTo(msg.payload, {});
      var selector = defaultTo(msg.payload.selector, this.selector);
      var settings = prepareSettings({
        power: defaultTo(msg.payload.power, this.power),
        color: defaultTo(msg.payload.color, this.color),
        brightness: defaultToNumber(msg.payload.brightness, this.brightness),
        duration: defaultToNumber(msg.payload.duration, this.duration),
        infrared: defaultToNumber(msg.payload.infrared, this.infrared),
        fast: defaultToBoolean(msg.payload.fast, this.fast)
      });
      node.log(JSON.stringify(settings))
      lifx.setState(selector, settings, function(err, data) {
        if (err) {
          node.error(err);
          return;
        }
      });
    });
  }
  RED.nodes.registerType("lifx-set-state", setState);

  function setStates(config) {
    RED.nodes.createNode(this, config);

    // Retrieve the config node
    this.api = RED.nodes.getNode(config.api);

    var lifx = new lifxObj({ bearerToken: this.api.token });
    var node = this;
    this.on("input", function(msg) {
      var states = defaultTo(msg.payload, {});
      lifx.setStates(states, function(err, data) {
        if (err) {
          node.error(err);
          return;
        }
      });
    });
  }
  RED.nodes.registerType("lifx-set-states", setStates);

  function cycle(config) {
    RED.nodes.createNode(this, config);

    // Retrieve the config node
    this.api = RED.nodes.getNode(config.api);
    this.selector = config.selector;

    var lifx = new lifxObj({ bearerToken: this.api.token });
    var node = this;
    this.on("input", function(msg) {
      msg.payload = defaultTo(msg.payload, {});
      var selector = defaultTo(msg.payload.selector, this.selector);
      var states = msg.payload;
      lifx.cycle(selector, states, function(err, data) {
        if (err) {
          node.error(err);
          return;
        }
      });
    });
  }
  RED.nodes.registerType("lifx-cycle", cycle);

  function listScenes(config) {
    RED.nodes.createNode(this, config);

    // Retrieve the config node
    this.api = RED.nodes.getNode(config.api);

    var lifx = new lifxObj({ bearerToken: this.api.token });
    var node = this;
    this.on("input", function(msg) {
      lifx.listScenes(function(err, data) {
        if (err) {
          node.error(err);
          return;
        }
        msg.payload = data;
        node.send(msg);
      });
    });
  }
  RED.nodes.registerType("lifx-list-scenes", listScenes);

  function activateScene(config) {
    RED.nodes.createNode(this, config);
    this.selector = config.selector;

    // Retrieve the config node
    this.api = RED.nodes.getNode(config.api);
    this.duration = config.duration;

    var lifx = new lifxObj({ bearerToken: this.api.token });
    var node = this;
    this.on("input", function(msg) {
      msg.payload = defaultTo(msg.payload, {});
      var selector = defaultTo(msg.payload.selector, this.selector);
      var duration = defaultToNumber(msg.payload.duration, this.duration);
      lifx.activateScene(selector, duration, function(err, data) {
        if (err) {
          node.error(err);
          return;
        }
        msg.payload = data;
        node.send(msg);
      });
    });
  }
  RED.nodes.registerType("lifx-activate-scene", activateScene);

  function validateColor(config) {
    RED.nodes.createNode(this, config);

    // Retrieve the config node
    this.api = RED.nodes.getNode(config.api);
    this.color = config.color;

    var lifx = new lifxObj({ bearerToken: this.api.token });
    var node = this;
    this.on("input", function(msg) {
      msg.payload = defaultTo(msg.payload, {});
      var color = defaultTo(msg.payload.color, this.color);
      lifx.validateColor(color, function(err, data) {
        if (err) {
          node.error(err);
          return;
        }
        msg.payload = data;
        node.send(msg);
      });
    });
  }
  RED.nodes.registerType("lifx-validate-color", validateColor);
};