node-red-contrib-amazon-echo
Version:
Alexa-controlled Node-RED nodes for the latest Amazon Echo devices.
492 lines (375 loc) • 12.6 kB
JavaScript
module.exports = function(RED) {
'use strict';
const helpers = require('./lib/helpers.js')();
const HueColor = require('hue-colors').default;
function AmazonEchoHubNode(config) {
RED.nodes.createNode(this, config);
var hubNode = this;
var port = config.port > 0 && config.port < 65536 ? config.port : 80;
// Start SSDP service
var ssdpServer = ssdp(port, config);
if (config.discovery) {
ssdpServer.start();
}
// Stoppable kill the server on deploy
const graceMilliseconds = 500;
var stoppable = require('stoppable');
var http = require('http');
var app = require('express')();
var httpServer = stoppable(http.createServer(app), graceMilliseconds);
httpServer.on('error', function(error) {
hubNode.status({
fill: 'red',
shape: 'ring',
text: 'Unable to start on port ' + port
});
RED.log.error(error);
return;
});
httpServer.listen(port, function(error) {
if (error) {
hubNode.status({
fill: 'red',
shape: 'ring',
text: 'Unable to start on port ' + port
});
RED.log.error(error);
return;
}
hubNode.status({
fill: 'green',
shape: 'dot',
text: 'online'
});
// REST API Settings
api(app, hubNode, config);
});
hubNode.on('input', function(msg) {
var nodeDeviceId = null;
if (typeof msg.payload === 'object') {
if ('nodeid' in msg.payload && msg.payload.nodeid !== null) {
nodeDeviceId = msg.payload.nodeid
delete msg.payload['nodeid'];
} else {
if ('nodename' in msg.payload && msg.payload.nodename !== null) {
getDevices().forEach(function(device) {
if (msg.payload.nodename == device.name) {
nodeDeviceId = device.id
delete msg.payload['nodename'];
}
});
}
}
}
if (config.processinput > 0 && nodeDeviceId !== null) {
var deviceid = helpers.formatUUID(nodeDeviceId);
var meta = {
insert: {
by: 'input',
details: {}
}
}
var deviceAttributes = setDeviceAttributes(deviceid, msg.payload, meta, hubNode.context());
// Output if
// 'Process and output' OR
// 'Process and output on state change' option is selected
if (config.processinput == 2 || (config.processinput == 3 && Object.keys(deviceAttributes.meta.changes).length > 0)) {
payloadHandler(hubNode, deviceid, msg.topic);
}
}
});
hubNode.on('close', function(removed, doneFunction) {
// Stop SSDP server
ssdpServer.stop();
// Stop HTTP server
httpServer.stop(function() {
if (typeof doneFunction === 'function')
doneFunction();
RED.log.info('Alexa Local Hub closing done...');
});
setImmediate(function() {
httpServer.emit('close');
});
});
}
// NodeRED registration
RED.nodes.registerType('amazon-echo-hub', AmazonEchoHubNode, {});
//
// REST API
//
function api(app, hubNode, config) {
const Mustache = require('mustache');
var fs = require('fs');
var bodyParser = require('body-parser');
var apiTemplateDir = __dirname + '/resources/api/hue/templates';
app.use(bodyParser.json({
type: '*/*'
}));
app.use(function(err, req, res, next) {
if (err instanceof SyntaxError && err.status === 400 && 'body' in err) {
RED.log.debug('Error: Invalid JSON request: ' + JSON.stringify(err.body));
}
next();
});
app.use(function(req, res, next) {
if (Object.keys(req.body).length > 0)
RED.log.debug('Request body: ' + JSON.stringify(req.body));
next();
});
app.get('/description.xml', function(req, res) {
var template = fs.readFileSync(apiTemplateDir + '/description.xml').toString();
var data = {
address: req.hostname,
port: req.connection.localPort,
huehubid: helpers.getHueHubId(config)
};
var output = Mustache.render(template, data);
res.type('application/xml');
res.send(output);
});
app.post('/api', function(req, res) {
var template = fs.readFileSync(apiTemplateDir + '/registration.json', 'utf8').toString();
var data = {
username: 'c6260f982b43a226b5542b967f612ce'
};
var output = Mustache.render(template, data);
output = JSON.parse(output);
res.json(output);
});
app.get('/api/nouser/config', function(req, res) {
var template = fs.readFileSync(apiTemplateDir + '/nouser/config.json', 'utf8').toString();
var data = {
};
var output = Mustache.render(template, data);
output = JSON.parse(output);
res.json(output);
});
app.get('/api/:username/config', function(req, res) {
var template = fs.readFileSync(apiTemplateDir + '/config.json', 'utf8').toString();
var data = {
address: req.hostname,
username: req.params.username,
date: new Date().toISOString().split('.').shift()
};
var output = Mustache.render(template, data);
output = JSON.parse(output);
res.json(output);
});
app.get('/api/:username', function(req, res) {
var lightsTemplate = fs.readFileSync(apiTemplateDir + '/lights/all.json', 'utf8').toString();
var template = fs.readFileSync(apiTemplateDir + '/state.json', 'utf8').toString();
var data = {
lights: getDevicesAttributes(hubNode.context()),
address: req.hostname,
username: req.params.username,
date: new Date().toISOString().split('.').shift(),
uniqueid: function() {
return helpers.hueUniqueId(this.id);
}
}
var output = Mustache.render(template, data, {
lightsTemplate: lightsTemplate
});
output = JSON.parse(output);
delete output.lights.last;
res.json(output);
});
app.get('/api/:username/lights', function(req, res) {
var template = fs.readFileSync(apiTemplateDir + '/lights/all.json', 'utf8').toString();
var data = {
lights: getDevicesAttributes(hubNode.context()),
date: new Date().toISOString().split('.').shift(),
uniqueid: function() {
return helpers.hueUniqueId(this.id);
}
}
var output = Mustache.render(template, data);
output = JSON.parse(output);
delete output.last;
res.json(output);
});
app.get('/api/:username/lights/:id', function(req, res) {
var template = fs.readFileSync(apiTemplateDir + '/lights/get-state.json', 'utf8').toString();
var deviceName = '';
getDevices().forEach(function(device) {
if (req.params.id == device.id)
deviceName = device.name
});
var data = getDeviceAttributes(req.params.id, hubNode.context());
data.name = deviceName;
data.date = new Date().toISOString().split('.').shift();
var output = Mustache.render(template, data);
output = JSON.parse(output);
res.json(output);
});
app.put('/api/:username/lights/:id/state', function(req, res) {
var meta = {
insert: {
by: 'alexa',
details: {
ip: req.headers['x-forwarded-for'] ||
req.connection.remoteAddress ||
'',
user_agent: req.headers['user-agent']
}
}
}
setDeviceAttributes(req.params.id, req.body, meta, hubNode.context());
var template = fs.readFileSync(apiTemplateDir + '/lights/set-state.json', 'utf8').toString();
var data = getDeviceAttributes(req.params.id, hubNode.context());
var output = Mustache.render(template, data);
output = JSON.parse(output);
res.json(output);
payloadHandler(hubNode, req.params.id);
});
}
//
// SSDP
//
function ssdp(port, config) {
var ssdpService = require('node-ssdp').Server,
server = new ssdpService({
location: {
port: port,
path: '/description.xml'
},
udn: 'uuid:' + helpers.getHueHubId(config),
ssdpSig: 'FreeRTOS/7.4.2 UPnP/1.0 IpBridge/1.16.0',
ssdpTtl: 2,
explicitSocketBind: true
})
server._extraHeaders = Object.assign({}, server._extraHeaders, {
'hue-bridgeid': 'AABBCCDDFF001122',
'CACHE-CONTROL': 'max-age=100'
});
server.addUSN('upnp:rootdevice');
server.addUSN('urn:schemas-upnp-org:device:basic:1');
return server;
}
//
// helperss
//
function getOrDefault(key, defaultValue, context) {
var value = null;
var storageValue = context.get(key);
// Clone value
if (storageValue !== undefined) {
value = Object.assign({}, storageValue);
}
return valueOrDefault(value, defaultValue);
}
function valueOrDefault(value, defaultValue) {
if (value === undefined || value === null) {
value = defaultValue;
}
return value;
}
function getDevices() {
var devices = [];
RED.nodes.eachNode(function(node) {
if (node.type == 'amazon-echo-device') {
devices.push({
id: helpers.formatUUID(node.id),
name: node.name
});
}
});
return devices;
}
function getDeviceAttributes(id, context) {
var defaultAttributes = {
on: false,
bri: 254,
percentage: 100,
hue: 0,
sat: 254,
xy: [0.6484272236872118, 0.33085610147277794],
ct: 199,
rgb: [254, 0, 0],
colormode: 'ct',
meta: {}
};
return getOrDefault(id, defaultAttributes, context);
}
function getDevicesAttributes(context) {
var devices = getDevices();
var devicesAttributes = [];
for (var key in devices) {
var attributes = getDeviceAttributes(devices[key].id, context);
devicesAttributes.push(Object.assign({}, attributes, devices[key]));
}
return devicesAttributes;
}
function setDeviceAttributes(id, attributes, meta, context) {
// Reset meta attribute
meta['insert']['details']['date'] = new Date();
meta['input'] = attributes;
meta['changes'] = {};
var saved = getDeviceAttributes(id, context);
var current = {};
// Set defaults
for (var key in saved) {
current[key] = valueOrDefault(attributes[key], saved[key]);
}
// Set color temperature
if (attributes.ct !== undefined) {
current.colormode = 'ct';
}
// Set Hue color
if (attributes.hue !== undefined && attributes.sat !== undefined) {
var hueColor = HueColor.fromHsb(current.hue, current.sat, current.bri);
var cie = hueColor.toCie();
var rgb = hueColor.toRgb();
current.xy = [cie[0] || 0, cie[1] || 0];
current.rgb = rgb;
current.colormode = 'hs';
}
// Set CIE
if (attributes.xy !== undefined && Array.isArray(attributes.xy) && attributes.xy.length == 2) {
var hueColor = HueColor.fromCIE(current.xy[0], current.xy[1], current.bri);
var hsb = hueColor.toHsb();
var rgb = hueColor.toRgb();
current.hue = hsb[0] || 0;
current.sat = hsb[1] || 0;
current.rgb = rgb;
current.colormode = 'hs';
}
// Set RGB
if (attributes.rgb !== undefined && Array.isArray(attributes.rgb) && attributes.rgb.length == 3) {
var hueColor = HueColor.fromRgb(current.rgb[0], current.rgb[1], current.rgb[2]);
var hsb = hueColor.toHsb();
var cie = hueColor.toCie();
current.hue = hsb[0] || 0;
current.sat = hsb[1] || 0;
current.bri = hsb[2] || 0;
current.xy = [cie[0] || 0, cie[1] || 0]
current.colormode = 'hs';
}
// Set brightness percentage
current.percentage = Math.floor(current.bri / 254 * 100);
// Populate meta.changes
for (var key in saved) {
if (JSON.stringify(saved[key]) !== JSON.stringify(current[key])) {
meta['changes'][key] = saved[key];
}
}
// Include meta
current['meta'] = meta;
// Save attributes
context.set(id, current);
// Set payload
current.payload = current.on ? 'on' : 'off';
return getOrDefault(id, current, context);
}
//
// Handlers
//
function payloadHandler(hubNode, deviceId, topic = null) {
var msg = getDeviceAttributes(deviceId, hubNode.context());
msg.deviceid = deviceId;
if (topic !== null) {
msg.topic = topic;
}
hubNode.send(msg);
}
}