node-red-contrib-planex-dokodemo-sensor-api

The Node node-red-contrib-planex-dokodemo-sensor-api connects datas using PLANEX Dokodemo sensor API.

This is simple node for PLANEX Dokodemo sensor.

https://www.planex.co.jp/products/ws-usb/

Japanease Readme

Let look when you need this japanease Readme!

https://github.com/1ft-seabass/node-red-contrib-planex-dokodemo-sensor-api/blob/master/README_ja.md

Install from Palette Manager

This node almost will success installing from Palette Manager.

Install manually

Move your Node-RED user directory ~/.node-red

Mac

sudo npm i --unsafe-perm node-red-contrib-planex-dokodemo-sensor-api

Windows

npm i --unsafe-perm node-red-contrib-planex-dokodemo-sensor-api

Usage

Check your Dokodemo sensor admin page.

Move Menu > Device setting.

Note your trying sensor setting.

• デバイス
• MAC
• TOKEN

and let think your getting datetime term.

simple Node-RED flow (planex-dokodemo-sensor)

This is simple getting data Node-RED flow.

[{"id":"1f929a8d.552fd5","type":"planex-dokodemo-sensor","z":"d3d7f120.bc949","sensor_type":"WS-USB01-THP","sensor_mac_address":"24:72:60:40:21:A6","sensor_datetime_from":"2019-05-31 11:33:44","sensor_datetime_to":"2019-05-31 22:33:44","x":560,"y":700,"wires":[["f0973053.e7ab7"]]},{"id":"c6e9e704.8e1128","type":"inject","z":"d3d7f120.bc949","name":"","topic":"","payload":"","payloadType":"str","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":350,"y":700,"wires":[["1f929a8d.552fd5"]]},{"id":"f0973053.e7ab7","type":"debug","z":"d3d7f120.bc949","name":"","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"payload","x":770,"y":700,"wires":[]}]

Let import it your Node-RED.

this node setting.

• Token is admin page as "TOKEN".
• Device is admin page as "デバイス".
• MAC Address page as "MAC".

Enter From and To input area with the UTC datetime format you need to get.

Click inject node button!

The debug tab will display Dokodemo sensor datas if your settings is correct.

It is the payload of get raw responced API datas.

Trouble Shooting

Especially be careful with the following settings.

• Is the device information of Dokodemo sensor admin page correctly input to Token, Device, MAC input area?
• Are the date ranges in the From and To input areas correct?
• Are UTC format in the From and To input areas correct?

Getting one latest data Node-RED flow (planex-dokodemo-sensor-latest)

This is getting one latest data Node-RED flow.

Important note for planex-dokodemo-sensor-latest

This node is supporting this usecase that the planex dokodemo environment sensor ( WS-USB01-THP ) continue to measure and store data constantly.

If you need measuring datas when its sensor shutdown for some reason in the past. Could you please select UTC time period using planex-dokodemo-sensor node.

Honesty I hope that the "true" function getting automatically latest data is added to the API. ;) Until then, I will develop the current usecase by UTC time period specification.

Getting one latest data flow

[{"id":"889efdb0.7805","type":"planex-dokodemo-sensor-latest","z":"d3d7f120.bc949","sensor_type":"WS-USB01-THP","sensor_mac_address":"24:72:60:40:21:A6","name":"","x":840,"y":860,"wires":[["4cb1f556.003e1c"]]},{"id":"cc6f4181.f4e32","type":"inject","z":"d3d7f120.bc949","name":"","topic":"","payload":"","payloadType":"str","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":650,"y":860,"wires":[["889efdb0.7805"]]},{"id":"cb82c664.98a138","type":"debug","z":"d3d7f120.bc949","name":"","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"payload","x":1190,"y":940,"wires":[]},{"id":"4cb1f556.003e1c","type":"change","z":"d3d7f120.bc949","name":"renamed data","rules":[{"t":"set","p":"payload","pt":"msg","to":"{\t  \"datetime\":payload[0],\t  \"temperature\":payload[1],\t  \"humidity\":payload[2],\t  \"pressure\":payload[3]\t}","tot":"jsonata"}],"action":"","property":"","from":"","to":"","reg":false,"x":980,"y":940,"wires":[["cb82c664.98a138"]]},{"id":"80f7311d.2d62f","type":"comment","z":"d3d7f120.bc949","name":"WS-USB01-THP latest data sample","info":"","x":720,"y":820,"wires":[]}]

Let import it your Node-RED.

this node setting.

• Token is admin page as "TOKEN".
• Device is admin page as "デバイス".
• MAC Address page as "MAC".

Click inject node button!

The debug tab will display Dokodemo sensor datas if your settings is correct.

It is the payload of get raw responced API datas.

About internal time period setting rule

This node has setting time period processes.

• It checks current server time using Moment module.
• It makes a time period for 1 minute from the current time.
  • A planex dokodemo environment sensor ( WS-USB01-THP ) continue to measure and store data every about 20 sec. So its node can get between 2 to 3 datas certainly when it use 1 minute period. And it outputs selected a latest data.
• It requests to the API using the period.

History

• ver 0.0.7
  • added status ring.
  • fixed object about clone error temporarily.
• ver 0.0.6
  • Restore function ver 0.0.4 at planex-dokodemo-sensor-latest node.
    • Realized that I shouldn't adjust to a specific sensor value specification. It restored from version 0.0.4 specification that it outputs raw API data.
  • Changed planex-dokodemo-sensor-latest sample flow.
    • It added change node for converted from the raw API data to environment sensor data.
• ver 0.0.5
  • Readme Enhancement Timing!
    • Wrote about planex-dokodemo-sensor-latest node detail.
    • Wrote about installing from Palette Manager and installing manually.
• ver 0.0.4
  • Setting input node UTC datetime parameters fitting Node-RED popular parameter rules. Replaced msg.payload.to to to msg.to. Replaced msg.payload.from to to msg.from.
  • Added getting latest a sensor data node!
  • fixed a bit Readme.

License

MIT License