Updates to match API changes (#392)
* Updates to match API changes Update to the node to match the server API changes. An attempt has been made to leave a legacy path for existing installations that may have not updated the server side. * Updated following comments. Update following comments. Output removed and node.warn or error used. oneeditprepare added. Name moved to last item. In addition, a check added to ensure nodegroup has valid value. Question: I have added a 'return' as I do not want data posted if there is not a valid nodegroup. Is this the best way to exit the function? Always taught that multiple exits was a bad idea. I wondered about raising an error / exception and then catching it but not sure how to do that. * Update documentation for revised node
This commit is contained in:
borpin
Dave Conway-Jones
parent
29694dd2cb
commit
dbea8a484a
|
|
@ -6,22 +6,36 @@
|
|||
</div>
|
||||
<div class="form-row">
|
||||
<label for="node-input-nodegroup"><i class="fa fa-object-group"></i> Node</label>
|
||||
<input type="text" id="node-input-nodegroup" placeholder="number eg: 3">
|
||||
<input type="text" id="node-input-nodegroup" placeholder="or set by msg.nodegroup">
|
||||
</div>
|
||||
<div class="form-row">
|
||||
<label for="node-input-datatype"><i class="fa fa-tag"></i> Data Type</label>
|
||||
<select id="node-input-datatype" style="width:180px;">
|
||||
<option value="legacy">Legacy Processing</option>
|
||||
<option value="fulljson">Valid JSON object</option>
|
||||
<option value="json">Simple JSON</option>
|
||||
<option value="CSV">CSV</option>
|
||||
</select>
|
||||
</div>
|
||||
<div class="form-row">
|
||||
<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
|
||||
<input type="text" id="node-input-name" placeholder="Emoncms">
|
||||
</div>
|
||||
|
||||
</script>
|
||||
|
||||
<script type="text/x-red" data-help-name="emoncms">
|
||||
<p>Posts data to Emoncms.</p>
|
||||
<p>The <code>msg.payload</code> can contain either a comma separated list of name
|
||||
value pairs e.g. <pre>name:value,...</pre> or a comma separated list of values e.g. <pre>1,2,...</pre>
|
||||
or a simple javascript object e.g. <pre>msg.payload = {temp:12}</pre>
|
||||
<p>If <i>Node</i> is left blank <code>msg.nodegroup</code> will used.</p>
|
||||
<p>Insertion time can be manipulated by setting <code>msg.time</code>.
|
||||
This must be in epoch format - seconds since 1970.</p>
|
||||
value pairs (legacy) e.g. <pre>name:value,...</pre> or a comma separated list of values (CSV) e.g. <pre>1,2,...</pre>
|
||||
an Emoncms simple data object e.g. <pre>{temp:12}</pre>
|
||||
or a valid JSON object e.g. <pre>{"Total":3.273,"Yesterday":1.695}</pre>
|
||||
<p>The node must be specified either by the <i>Node</i> element or if left blank by <code>msg.nodegroup</code></p>
|
||||
<p>Data Type must be one of <pre>legacy, json, fulljson, CSV</pre></p>
|
||||
<p>Insertion time can be set by using <code>msg.time</code>.
|
||||
This can either be a valid ISO 8601 format or seconds since 1970. Not setting a time or setting an incorrect
|
||||
time format will result in data being pushed to Emoncms without the time element.</p>
|
||||
<p>The output node contains the server response</p>
|
||||
</script>
|
||||
|
||||
<script type="text/javascript">
|
||||
|
|
@ -29,9 +43,10 @@
|
|||
category: 'output',
|
||||
color:"rgb(91, 192, 222)",
|
||||
defaults: {
|
||||
name: {value:"Emoncms"},
|
||||
name: {value:"Emoncms Push"},
|
||||
emonServer: {type:"emoncms-server", required:true},
|
||||
nodegroup: {value:"", validate:function(v) {return ((v === "")||(/^[\d\w\s.-]*$/).test(v));} }
|
||||
nodegroup: {value:"", validate:function(v) {return ((v === "")||(/^[\d\w\s.-]*$/).test(v));} },
|
||||
datatype: {value:"legacy"}
|
||||
},
|
||||
inputs:1,
|
||||
outputs:0,
|
||||
|
|
@ -42,14 +57,15 @@
|
|||
},
|
||||
labelStyle: function() {
|
||||
return this.name?"node_label_italic":"";
|
||||
},
|
||||
oneditprepare: function() {
|
||||
if (this.datatype === undefined) {
|
||||
$("#node-input-datatype").val("legacy");
|
||||
}
|
||||
}
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/x-red" data-template-name="emoncms in">
|
||||
<div class="form-row">
|
||||
<label for="node-input-emonServer"><i class="fa fa-globe"></i> Emoncms server</label>
|
||||
|
|
|
|||
|
|
@ -22,41 +22,102 @@ module.exports = function(RED) {
|
|||
this.apikey = sc.credentials.apikey;
|
||||
|
||||
this.nodegroup = n.nodegroup || "";
|
||||
this.datatype = n.datatype || "";
|
||||
var node = this;
|
||||
var http;
|
||||
if (this.baseurl.substring(0,5) === "https") { http = require("https"); }
|
||||
else { http = require("http"); }
|
||||
this.on("input", function(msg) {
|
||||
this.url = this.baseurl + '/input/post.json?';
|
||||
if (typeof(msg.payload) !== "string") {
|
||||
this.url += 'json=' + JSON.stringify(msg.payload);
|
||||
}
|
||||
else {
|
||||
if (msg.payload.indexOf(':') > -1) {
|
||||
this.url += 'json={' + msg.payload + '}';
|
||||
|
||||
// setup the data for the URI
|
||||
if (this.datatype == "legacy"){
|
||||
this.url = this.baseurl + '/input/post.json?';
|
||||
if (typeof(msg.payload) !== "string") {
|
||||
this.url += 'json=' + JSON.stringify(msg.payload);
|
||||
}
|
||||
else {
|
||||
this.url += 'csv=' + msg.payload;
|
||||
if (msg.payload.indexOf(':') > -1) {
|
||||
this.url += 'json={' + msg.payload + '}';
|
||||
}
|
||||
else {
|
||||
this.url += 'csv=' + msg.payload;
|
||||
}
|
||||
}
|
||||
}
|
||||
this.url += '&apikey='+this.apikey;
|
||||
else if (this.datatype == "fulljson"){
|
||||
this.url = this.baseurl + '/input/post?';
|
||||
this.url += 'fulljson=' + encodeURIComponent(JSON.stringify(msg.payload));
|
||||
}
|
||||
else if (this.datatype == "json"){
|
||||
this.url = this.baseurl + '/input/post?';
|
||||
this.url += 'json={' + encodeURIComponent(msg.payload) + '}';
|
||||
}
|
||||
else if (this.datatype == "CSV"){
|
||||
this.url = this.baseurl + '/input/post?';
|
||||
this.url += 'csv=' + msg.payload;
|
||||
}
|
||||
else {
|
||||
node.error("ERROR : No valid data type set - " + this.datatype);
|
||||
return;
|
||||
}
|
||||
|
||||
// setup the node group for URI. Must have a node group or exit
|
||||
var nodegroup = this.nodegroup || msg.nodegroup;
|
||||
if (nodegroup !== "") {
|
||||
if (typeof nodegroup === "undefined") {
|
||||
node.error("ERROR: A Node group must be specified - " + nodegroup);
|
||||
node.status({fill:"red",shape:"ring",text:"No Nodegroup"});
|
||||
return;
|
||||
} else {
|
||||
this.url += '&node=' + nodegroup;
|
||||
}
|
||||
if (typeof msg.time !== 'undefined') {
|
||||
if (!isNaN(parseInt(msg.time))) { this.url += '&time=' + msg.time; }
|
||||
|
||||
// setup the API key for URI.
|
||||
this.url += '&apikey=' + this.apikey;
|
||||
|
||||
// check for a time object and setup URI if valid
|
||||
if (typeof msg.time === "undefined") {
|
||||
node.warn("WARN: Time object undefined, no time set");
|
||||
}
|
||||
else {
|
||||
if (!isNaN(msg.time)) {
|
||||
this.url += '&time=' + msg.time;
|
||||
}
|
||||
else {
|
||||
if (isNaN(Date.parse(msg.time))) {
|
||||
// error condition
|
||||
node.warn("WARN: Time object not valid, no time set - " + msg.time);
|
||||
} else {
|
||||
this.url += '&time=' + Date.parse(msg.time)/1000; //seconds
|
||||
}
|
||||
}
|
||||
delete msg.time; // clean it up for the error msg
|
||||
}
|
||||
var URIsent = this.url;
|
||||
|
||||
http.get(this.url, function(res) {
|
||||
msg.topic = "http response";
|
||||
msg.rc = res.statusCode;
|
||||
msg.payload = "";
|
||||
res.setEncoding('utf8');
|
||||
res.on('data', function(chunk) {
|
||||
msg.payload += chunk;
|
||||
});
|
||||
res.on('end', function() {
|
||||
if (msg.rc === 200) {
|
||||
node.send(msg);
|
||||
res.on('end', function() { //A 200 StatusCode does not mean data input sucess
|
||||
try {
|
||||
msg.payload = JSON.parse(msg.payload);
|
||||
if (msg.payload.success) {
|
||||
node.status({fill:"green",shape:"dot",text:"Success"});
|
||||
} else {
|
||||
msg.warning = "ERROR: API Call Failed";
|
||||
msg.payload.urlsent = decodeURIComponent(URIsent);
|
||||
node.error(msg);
|
||||
node.status({fill:"red",shape:"ring",text:"Failed"});
|
||||
}
|
||||
}
|
||||
catch(err) {
|
||||
msg.warning = "ERROR: Http response"
|
||||
node.warn(msg);
|
||||
node.status({fill:"red",shape:"ring",text:"http issue"});
|
||||
}
|
||||
});
|
||||
}).on('error', function(e) {
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
node-red-node-emoncms
|
||||
=====================
|
||||
|
||||
A <a href="http://nodered.org" target="_new">Node-RED</a> node to send fetch/post data to/from <a href="http://emoncms.org" target="_new">emoncms.org</a> or any other emoncms server.
|
||||
A <a href="http://nodered.org" target="_new">Node-RED</a> node to send fetch/post data to/from <a href="http://emoncms.org" target="_new">emoncms.org</a>, local emoncms server or any other emoncms server.
|
||||
|
||||
Install
|
||||
-------
|
||||
|
|
@ -10,30 +10,38 @@ Run the following command in your Node-RED user directory - typically `~/.node-r
|
|||
|
||||
npm install node-red-node-emoncms
|
||||
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
### Emoncms post.
|
||||
### Emoncms post:
|
||||
#### Preferred Data Type
|
||||
|
||||
The `msg.payload` can contain either a comma separated list of name
|
||||
value pairs, e.g.
|
||||
The API now accepts a validated JSON object for the name value pairs. This is the preferred data type.
|
||||
|
||||
name:value,...
|
||||
#### Legacy Data Type Support
|
||||
|
||||
or a comma separated list of values, e.g.
|
||||
The original input API for emoncms used a URI in the format `post.json?`. If the data type of legacy is selected, the `msg.payload` can contain:
|
||||
|
||||
1,2,..
|
||||
A comma separated list of name value pairs, e.g.
|
||||
|
||||
or a simple javascript object e.g.
|
||||
name:value,...
|
||||
|
||||
msg.payload = {temp:12, humidity:56};
|
||||
A comma separated list of values (CSV), e.g.
|
||||
|
||||
If *Nodegroup* is left blank `msg.nodegroup` will used (if set).
|
||||
This should be a numeric value.
|
||||
1,2,..
|
||||
|
||||
Insertion time can be manipulated by setting `msg.time`. This **must** be in
|
||||
epoch format - i.e. seconds since 1970.
|
||||
A simple javascript object (note no quotes) e.g.
|
||||
|
||||
{temp:12, humidity:56};
|
||||
|
||||
#### Node
|
||||
If *Node* is left blank `msg.nodegroup` will be used (if set). A *Node* must be set or the flow will fail.
|
||||
|
||||
#### msg.time
|
||||
Insertion time can be manipulated by setting `msg.time`. This can be an ISO format date/time or a number of seconds in epoch format - i.e. seconds since 1970. If no time is set time now is set by emoncms.
|
||||
|
||||
#### Status
|
||||
The flow will indicate if the node has successfully called the API. This is not a guarantee the data has been inserted to emoncms.
|
||||
|
||||
### Emoncms In:
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue