Skip to content

Commit

Permalink
State change meta data attribute (#67)
Browse files Browse the repository at this point in the history
  • Loading branch information
@datech
datech committed Oct 6, 2019
1 parent 300cf80 commit 80eac52
Show file tree
Hide file tree
Showing 2 changed files with 107 additions and 45 deletions.
44 changes: 40 additions & 4 deletions index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,15 +102,33 @@ <h3>Outputs</h3>
<dd>The mired color temperature of the light (min 153, max 500)</dd>

<dt>colormode <span class="property-type">string</span></dt>
<dd>Indicates the color mode (cr - Color Temperature | hs - Hue and Saturation)</dd>
<dd>Indicates the color mode (ct - Color Temperature | hs - Hue and Saturation)</dd>

<dt>rgb <span class="property-type">array</span></dt>
<dd>The light color in RGB format</dd>

<dt>percentage <span class="property-type">number</span></dt>
<dd>The brightness % level (min 1, max 100)</dd>

<dt>changed <span class="property-type">array</span></dt>
<dt>meta <span class="property-type">array</span></dt>
<dd>Meta data hashmap</dd>

<dt>meta.insert.by <span class="property-type">string</span></dt>
<dd>The insert type (alexa | input)</dd>

<dt>meta.insert.date <span class="property-type">string</span></dt>
<dd>The insert date and time</dd>

<dt>meta.insert.details.ip <span class="property-type">string</span></dt>
<dd>Alexa master device IP address.<br/>Only if <b>meta.insert.by</b>=<i>alexa</i></li></dd>

<dt>meta.insert.details.user_agent <span class="property-type">string</span></dt>
<dd>Alexa master device user agent.<br/>Only if <b>meta.insert.by</b>=<i>alexa</i></dd>

<dt>meta.input <span class="property-type">array</span></dt>
<dd>Hashmap with all input attributes</dd>

<dt>meta.changes <span class="property-type">array</span></dt>
<dd>Hashmap of all changed attributes and the corresponding old values</dd>
</dl>
</script>
Expand Down Expand Up @@ -170,15 +188,33 @@ <h3>Outputs</h3>
<dd>The mired color temperature of the light (min 153, max 500)</dd>

<dt>colormode <span class="property-type">string</span></dt>
<dd>Indicates the color mode (cr - Color Temperature | hs - Hue and Saturation)</dd>
<dd>Indicates the color mode (ct - Color Temperature | hs - Hue and Saturation)</dd>

<dt>rgb <span class="property-type">array</span></dt>
<dd>The light color in RGB format</dd>

<dt>percentage <span class="property-type">number</span></dt>
<dd>The brightness % level (min 1, max 100)</dd>

<dt>changed <span class="property-type">array</span></dt>
<dt>meta <span class="property-type">array</span></dt>
<dd>Meta data hashmap</dd>

<dt>meta.insert.by <span class="property-type">string</span></dt>
<dd>The insert type (alexa | input)</dd>

<dt>meta.insert.date <span class="property-type">string</span></dt>
<dd>The insert date and time</dd>

<dt>meta.insert.details.ip <span class="property-type">string</span></dt>
<dd>Alexa master device IP address.<br/>Only if <b>meta.insert.by</b>=<i>alexa</i></li></dd>

<dt>meta.insert.details.user_agent <span class="property-type">string</span></dt>
<dd>Alexa master device user agent.<br/>Only if <b>meta.insert.by</b>=<i>alexa</i></dd>

<dt>meta.input <span class="property-type">array</span></dt>
<dd>Hashmap with all input attributes</dd>

<dt>meta.changes <span class="property-type">array</span></dt>
<dd>Hashmap of all changed attributes and the corresponding old values</dd>
</dl>
</script>
108 changes: 67 additions & 41 deletions index.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ module.exports = function(RED) {
}

// NodeRED registration
RED.nodes.registerType("amazon-echo-device", AmazonEchoDeviceNode, {});
RED.nodes.registerType('amazon-echo-device', AmazonEchoDeviceNode, {});

function AmazonEchoHubNode(config) {

Expand All @@ -39,9 +39,9 @@ module.exports = function(RED) {

httpServer.on('error', function(error) {
hubNode.status({
fill: "red",
shape: "ring",
text: "Unable to start on port " + port
fill: 'red',
shape: 'ring',
text: 'Unable to start on port ' + port
});
RED.log.error(error);
return;
Expand All @@ -51,18 +51,18 @@ module.exports = function(RED) {

if (error) {
hubNode.status({
fill: "red",
shape: "ring",
text: "Unable to start on port " + port
fill: 'red',
shape: 'ring',
text: 'Unable to start on port ' + port
});
RED.log.error(error);
return;
}

hubNode.status({
fill: "green",
shape: "dot",
text: "online"
fill: 'green',
shape: 'dot',
text: 'online'
});

// REST API Settings
Expand All @@ -73,20 +73,20 @@ module.exports = function(RED) {

var nodeDeviceId = null;

if (typeof msg.payload === "object") {
if (typeof msg.payload === 'object') {

if ("nodeid" in msg.payload && msg.payload.nodeid !== null) {
if ('nodeid' in msg.payload && msg.payload.nodeid !== null) {

nodeDeviceId = msg.payload.nodeid
delete msg.payload["nodeid"];
delete msg.payload['nodeid'];

} else {

if ("nodename" in msg.payload && msg.payload.nodename !== null) {
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"];
delete msg.payload['nodename'];
}
});
}
Expand All @@ -109,9 +109,17 @@ module.exports = function(RED) {
}

if (stateChanged) {
setDeviceAttributes(msg.payload.deviceid, msg.payload, hubNode.context());

// Output only if "Process and output" option is selected
var meta = {
insert: {
by: 'input',
details: {}
}
}

setDeviceAttributes(msg.payload.deviceid, msg.payload, meta, hubNode.context());

// Output only if 'Process and output' option is selected
if (config.processinput == 2) {
payloadHandler(hubNode, msg.payload.deviceid);
}
Expand All @@ -123,7 +131,7 @@ module.exports = function(RED) {
httpServer.stop(function() {
if (typeof doneFunction === 'function')
doneFunction();
RED.log.info("Alexa Local Hub closing done...");
RED.log.info('Alexa Local Hub closing done...');
});
setImmediate(function() {
httpServer.emit('close');
Expand All @@ -132,14 +140,14 @@ module.exports = function(RED) {
}

// NodeRED registration
RED.nodes.registerType("amazon-echo-hub", AmazonEchoHubNode, {});
RED.nodes.registerType('amazon-echo-hub', AmazonEchoHubNode, {});

//
// REST API
//
function api(app, hubNode, config) {

const Mustache = require("mustache");
const Mustache = require('mustache');

var fs = require('fs');
var bodyParser = require('body-parser');
Expand All @@ -150,14 +158,14 @@ module.exports = function(RED) {

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));
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));
RED.log.debug('Request body: ' + JSON.stringify(req.body));
next();
});

Expand All @@ -180,7 +188,7 @@ module.exports = function(RED) {
var template = fs.readFileSync(__dirname + '/api/hue/templates/registration.json', 'utf8').toString();

var data = {
username: "c6260f982b43a226b5542b967f612ce"
username: 'c6260f982b43a226b5542b967f612ce'
};

var output = Mustache.render(template, data);
Expand Down Expand Up @@ -227,7 +235,7 @@ module.exports = function(RED) {
app.get('/api/:username/lights/:id', function(req, res) {
var template = fs.readFileSync(__dirname + '/api/hue/templates/lights/get-state.json', 'utf8').toString();

var deviceName = "";
var deviceName = '';

getDevices().forEach(function(device) {
if (req.params.id == device.id)
Expand All @@ -246,7 +254,19 @@ module.exports = function(RED) {

app.put('/api/:username/lights/:id/state', function(req, res) {

setDeviceAttributes(req.params.id, req.body, hubNode.context());
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(__dirname + '/api/hue/templates/lights/set-state.json', 'utf8').toString();

Expand Down Expand Up @@ -310,13 +330,13 @@ module.exports = function(RED) {
function formatUUID(id) {

if (id === null || id === undefined)
return "";
return ("" + id).replace(".", "").trim();
return '';
return ('' + id).replace('.', '').trim();
}

function getHueHubId(config) {

var uuid = "00112233-4455-6677-8899-";
var uuid = '00112233-4455-6677-8899-';
uuid += formatUUID(config.id);
return uuid;
}
Expand All @@ -326,7 +346,7 @@ module.exports = function(RED) {
var devices = [];

RED.nodes.eachNode(function(node) {
if (node.type == "amazon-echo-device") {
if (node.type == 'amazon-echo-device') {
devices.push({
id: formatUUID(node.id),
name: node.name
Expand All @@ -345,7 +365,8 @@ module.exports = function(RED) {
hue: 0,
sat: 254,
ct: 199,
colormode: "ct"
colormode: 'ct',
meta: {}
};

return getOrDefault(id, defaultAttributes, context);
Expand All @@ -364,7 +385,14 @@ module.exports = function(RED) {
return devicesAttributes;
}

function setDeviceAttributes(id, attributes, context) {
function setDeviceAttributes(id, attributes, meta, context) {

var currentAttributes = getDeviceAttributes(id, context);

// Reset meta attribute
meta['insert']['details']['date'] = new Date();
meta['input'] = attributes;
meta['changes'] = {};

if (attributes.xy !== undefined && attributes.xy !== null) {
var xy = attributes.xy;
Expand All @@ -373,26 +401,24 @@ module.exports = function(RED) {
attributes.sat = hsb[1];
}

var currentAttributes = getDeviceAttributes(id, context);

// Set correct color mode
if (attributes.ct !== undefined) {
attributes.colormode = "ct";
attributes.colormode = 'ct';
} else if (attributes.hue !== undefined || attributes.sat !== undefined) {
attributes.colormode = "hs";
attributes.colormode = 'hs';
}

// Reset changed attribute
currentAttributes["changed"] = {};

for (var key in currentAttributes) {
// Find changes
if (attributes[key] !== currentAttributes[key] && attributes[key] !== undefined) {
currentAttributes["changed"][key] = currentAttributes[key];
meta['changes'][key] = currentAttributes[key];
}
currentAttributes[key] = valueOrDefault(attributes[key], currentAttributes[key]);
}

// Include meta
currentAttributes['meta'] = meta;

// Save attributes
context.set(id, currentAttributes);

Expand All @@ -407,9 +433,9 @@ module.exports = function(RED) {
var msg = getDeviceAttributes(deviceId, hubNode.context());
msg.rgb = colorSHB2RGB(msg.hue, msg.sat, 254);
msg.percentage = Math.floor(msg.bri / 253 * 100);
msg.payload = msg.on ? "on" : "off";
msg.payload = msg.on ? 'on' : 'off';
msg.deviceid = deviceId;
msg.topic = "";
msg.topic = '';

hubNode.send(msg);
}
Expand Down

0 comments on commit 80eac52

Please sign in to comment.