mirror of
https://github.com/node-red/node-red-nodes.git
synced 2025-03-01 10:37:43 +00:00
Improvements to BlinkStick node
* Ability to select BlinkStick by serial number * Look up serial numbers of connected BlinkSticks * Ability to set blink, morph and pulse animations * Ability to control the parameters of those animations like duration, * steps, repeats and delay * Repeat blink and pulse animation until new payload is received * Automatically find BlinkStick if it was removed and then plugged back in * Connectivity status when "Node Status" is enabled in the menu * Override parameters with payload object * Improved text in the info pane
This commit is contained in:
Arvydas Juskevicius
@@ -1,5 +1,6 @@
|
||||
/**
|
||||
* Copyright 2013 IBM Corp.
|
||||
* Copyright 2013-2014 Agile Innovative Ltd.
|
||||
* Based on code written by Dave Conway-Jones, IBM Corp.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
@@ -18,45 +19,232 @@ module.exports = function(RED) {
|
||||
"use strict";
|
||||
var blinkstick = require("blinkstick");
|
||||
|
||||
var availableTasks = ["set_color", "blink", "pulse", "morph"];
|
||||
|
||||
Object.size = function(obj) {
|
||||
var size = 0;
|
||||
for (var key in obj) { if (obj.hasOwnProperty(key)) { size++; } }
|
||||
return size;
|
||||
};
|
||||
|
||||
function BlinkStick(n) {
|
||||
RED.nodes.createNode(this,n);
|
||||
var p1 = /^\#[A-Fa-f0-9]{6}$/
|
||||
var p2 = /[0-9]+,[0-9]+,[0-9]+/
|
||||
this.led = blinkstick.findFirst(); // maybe try findAll() (one day)
|
||||
var node = this;
|
||||
//Helper function to convert decimal number to hex with padding
|
||||
function decimalToHex(d, padding) {
|
||||
var hex = Number(d).toString(16);
|
||||
padding = typeof (padding) === "undefined" || padding === null ? padding = 2 : padding;
|
||||
|
||||
this.on("input", function(msg) {
|
||||
if (Object.size(node.led) !== 0) {
|
||||
try {
|
||||
if (p2.test(msg.payload)) {
|
||||
var rgb = msg.payload.split(",");
|
||||
node.led.setColor(parseInt(rgb[0])&255, parseInt(rgb[1])&255, parseInt(rgb[2])&255);
|
||||
}
|
||||
else {
|
||||
node.led.setColor(msg.payload.toLowerCase().replace(/\s+/g,''));
|
||||
}
|
||||
}
|
||||
catch (err) {
|
||||
node.warn("BlinkStick missing ?");
|
||||
node.led = blinkstick.findFirst();
|
||||
}
|
||||
}
|
||||
else {
|
||||
//node.warn("No BlinkStick found");
|
||||
node.led = blinkstick.findFirst();
|
||||
}
|
||||
});
|
||||
if (Object.size(node.led) === 0) {
|
||||
node.error("No BlinkStick found");
|
||||
while (hex.length < padding) {
|
||||
hex = "0" + hex;
|
||||
}
|
||||
|
||||
return hex;
|
||||
}
|
||||
|
||||
function validateInt(value, defaultValue) {
|
||||
return typeof (value) === "undefined" || value === null ? value = defaultValue : parseInt(value);
|
||||
}
|
||||
|
||||
function validate(value, defaultValue) {
|
||||
return typeof (value) === "undefined" || value === null ? value = defaultValue : value;
|
||||
}
|
||||
|
||||
function validatePayloadObject (obj) {
|
||||
var
|
||||
task = validate(obj.task),
|
||||
delay = validateInt(obj.delay),
|
||||
repeats = validateInt(obj.repeats),
|
||||
duration = validateInt(obj.duration),
|
||||
steps = validateInt(obj.steps),
|
||||
repeat = validate(obj.repeat),
|
||||
color = validate(obj.color);
|
||||
|
||||
if (typeof(task) !== 'undefined' && availableTasks.indexOf(task) === -1) {
|
||||
return "Task is invalid";
|
||||
}
|
||||
|
||||
if (typeof(color) === 'undefined') {
|
||||
return "Color parameter is not set";
|
||||
}
|
||||
|
||||
return { 'task': task, 'delay': delay, 'repeats': repeats, 'duration': duration, 'steps': steps,
|
||||
'repeat': repeat, 'color': color };
|
||||
}
|
||||
|
||||
function BlinkStick(n) {
|
||||
RED.nodes.createNode(this,n);
|
||||
|
||||
this.name = n.name;
|
||||
this.serial = n.serial;
|
||||
this.task = n.task || "set_color";
|
||||
this.delay = n.delay || 500;
|
||||
this.repeats = n.repeats || 1;
|
||||
this.duration = n.duration || 1000;
|
||||
this.steps = n.steps || 50;
|
||||
this.repeat = n.repeat;
|
||||
this.closing = false;
|
||||
this.color = '';
|
||||
this.previousColor = '';
|
||||
|
||||
var p1 = /[0-9]+,[0-9]+,[0-9]+/;
|
||||
var node = this;
|
||||
//Keeps track for active animations
|
||||
var animationComplete = true;
|
||||
|
||||
//Find BlinkStick based on serial number if supplied, otherwise look for first
|
||||
//Blinkstick in the USB device list
|
||||
var findBlinkStick = function (callback) {
|
||||
if (typeof(node.serial) == 'string' && node.serial.replace(/\s+/g,'') !== '') {
|
||||
blinkstick.findBySerial(node.serial, function (device) {
|
||||
node.led = device;
|
||||
|
||||
if (Object.size(node.led) === 0) {
|
||||
node.status({fill:"red",shape:"ring",text:"disconnected"});
|
||||
node.error("BlinkStick with serial number " + node.serial + " not found");
|
||||
} else {
|
||||
node.status({fill:"green",shape:"dot",text:"connected"});
|
||||
if (callback) callback();
|
||||
}
|
||||
});
|
||||
} else {
|
||||
node.led = blinkstick.findFirst();
|
||||
|
||||
if (Object.size(node.led) === 0) {
|
||||
node.status({fill:"red",shape:"ring",text:"disconnected"});
|
||||
node.error("No BlinkStick found");
|
||||
} else {
|
||||
node.status({fill:"green",shape:"dot",text:"connected"});
|
||||
if (callback) callback();
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
//Check if repeat is enabled. Works only for pulse and blink tasks
|
||||
var canRepeat = function () {
|
||||
return node.task == "pulse" || node.task == "blink";
|
||||
};
|
||||
|
||||
//Event handler for all animation complete events
|
||||
var blinkstickAnimationComplete = function (err) {
|
||||
if (typeof(err) !== 'undefined') {
|
||||
node.warn(err);
|
||||
|
||||
if (typeof(err.name) === 'undefined' || err.name !== 'ReferenceError') {
|
||||
//USB error occurred when BlinkStick was animating
|
||||
node.led.close(function (err) {
|
||||
node.led = undefined;
|
||||
findBlinkStick();
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
animationComplete = true;
|
||||
|
||||
//Apply queued color animation
|
||||
if (!node.closing && node.color !== '') {
|
||||
//Apply new color only if there was no error or queued color is different from the previous color
|
||||
if (typeof(err) === 'undefined' || typeof(err) !== 'undefined' && node.color != node.previousColor) {
|
||||
applyColor();
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
var applyColor = function () {
|
||||
animationComplete = false;
|
||||
|
||||
//Store the value of color to check if it has changed
|
||||
node.previousColor = node.color;
|
||||
|
||||
try {
|
||||
//Select animation to perform
|
||||
if (node.task == "pulse") {
|
||||
node.led.pulse(node.color, {'duration': node.duration, 'steps': node.steps }, blinkstickAnimationComplete);
|
||||
} else if (node.task == "morph") {
|
||||
node.led.morph(node.color, {'duration': node.duration, 'steps': node.steps }, blinkstickAnimationComplete);
|
||||
} else if (node.task == "blink") {
|
||||
node.led.blink(node.color,{'repeats': node.repeats, 'delay': node.delay }, blinkstickAnimationComplete);
|
||||
} else {
|
||||
node.led.setColor(node.color, blinkstickAnimationComplete);
|
||||
}
|
||||
} catch (err) {
|
||||
node.warn("BlinkStick missing ? " + err);
|
||||
//Reset animation
|
||||
animationComplete = true;
|
||||
//Clear color
|
||||
node.color = '';
|
||||
//Look for a BlinkStick
|
||||
findBlinkStick();
|
||||
return;
|
||||
}
|
||||
|
||||
//Clear color value until next one is received, unless repeat option is set to true
|
||||
if (!node.repeat || !canRepeat()) {
|
||||
node.color = '';
|
||||
}
|
||||
};
|
||||
|
||||
findBlinkStick();
|
||||
|
||||
this.on("input", function(msg) {
|
||||
if (typeof(msg.payload) === 'object' ) {
|
||||
var data = validatePayloadObject(msg.payload);
|
||||
|
||||
if (typeof(data) === 'object') {
|
||||
node.task = data.task ? data.task : node.task;
|
||||
node.delay = data.delay ? data.delay : node.delay;
|
||||
node.repeats = data.repeats ? data.repeats : node.repeats;
|
||||
node.duration = data.duration ? data.duration : node.duration;
|
||||
node.steps = data.steps ? data.steps : node.steps;
|
||||
node.repeat = data.repeat ? data.repeat : node.repeat;
|
||||
node.color = data.color ? data.color : node.color;
|
||||
} else {
|
||||
node.error(data);
|
||||
return;
|
||||
}
|
||||
|
||||
} else if (p1.test(msg.payload)) {
|
||||
//Color value is represented as "red,green,blue" string of bytes
|
||||
var rgb = msg.payload.split(",");
|
||||
|
||||
//Convert color value back to HEX string for easier implementation
|
||||
node.color = "#" + decimalToHex(parseInt(rgb[0])&255) +
|
||||
decimalToHex(parseInt(rgb[1])&255) + decimalToHex(parseInt(rgb[2])&255);
|
||||
} else {
|
||||
//Sanitize color value
|
||||
node.color = msg.payload.toLowerCase().replace(/\s+/g,'');
|
||||
}
|
||||
|
||||
if (Object.size(node.led) !== 0) {
|
||||
//Start color animation, otherwise the color is queued until current animation completes
|
||||
if (animationComplete) {
|
||||
applyColor();
|
||||
}
|
||||
} else {
|
||||
//Attempt to find BlinkStick and start animation if it's found
|
||||
findBlinkStick(function() {
|
||||
if (animationComplete) {
|
||||
applyColor();
|
||||
}
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
this.on("close", function() {
|
||||
//Set the flag to finish all animations
|
||||
this.closing = true;
|
||||
|
||||
if (Object.size(node.led) !== 0) {
|
||||
//Close device and stop animations
|
||||
this.led.close();
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
RED.nodes.registerType("blinkstick",BlinkStick);
|
||||
}
|
||||
|
||||
RED.httpAdmin.get("/blinksticklist",function(req,res) {
|
||||
blinkstick.findAllSerials(function(serials) {
|
||||
res.writeHead(200, {'Content-Type': 'application/json'});
|
||||
res.write(JSON.stringify(serials));
|
||||
res.end();
|
||||
});
|
||||
});
|
||||
};
|
||||
|
||||
Reference in New Issue
Block a user