Difference between revisions of "WISE-PaaS 2.0 NodeRed"
From ESS-WIKI
Chihyu.yeh (talk | contribs) |
|||
(One intermediate revision by one other user not shown) | |||
Line 86: | Line 86: | ||
|- | |- | ||
| style="text-align: center;" | PluginsQuery<br/> | | style="text-align: center;" | PluginsQuery<br/> | ||
− | | style="width: 551px;" | ''Retrieve plugins by | + | | style="width: 551px;" | ''Retrieve plugins by Device ID within a time range. The maximum number of values is 10000 from '''WISE-PaaS 2.0''' server. User can set the conditions about plugins here. Ex: Device ID, Agent ID, begin timestamp, end timestamp, amount and type.''<br/> |
| style="width: 214px;" | '''''ServerConfig '''''<i>Node.</i><br/> | | style="width: 214px;" | '''''ServerConfig '''''<i>Node.</i><br/> | ||
− | | style="width: 439px;" | ''''' | + | | style="width: 439px;" | '''''Plugins '''Information list.''<br/> |
|- | |- | ||
| style="text-align: center;" | SensorsQuery<br/> | | style="text-align: center;" | SensorsQuery<br/> | ||
− | | style="width: 551px;" | ''Retrieve sensors by | + | | style="width: 551px;" | ''Retrieve sensors by Device ID & plugin within a time range. The maximum number of values is 10000 from '''WISE-PaaS 2.0''' server. User can set the conditions about sensor here. Ex: Device ID, Agent ID, Plugin Name, begin timestamp, end timestamp, amount and type.''<br/> |
| style="width: 214px;" | '''''ServerConfig '''''<i>Node.</i><br/> | | style="width: 214px;" | '''''ServerConfig '''''<i>Node.</i><br/> | ||
− | | style="width: 439px;" | ''''' | + | | style="width: 439px;" | '''''Sensors '''Information list.''<br/> |
|- | |- | ||
| style="text-align: center;" | DataQuery<br/> | | style="text-align: center;" | DataQuery<br/> | ||
| style="width: 551px;" | ''Retrieve data from '''WISE-PaaS 2.0''' server. The node provides three types, they are '''history''', '''latest''' and '''statistic'''''<br/> | | style="width: 551px;" | ''Retrieve data from '''WISE-PaaS 2.0''' server. The node provides three types, they are '''history''', '''latest''' and '''statistic'''''<br/> | ||
| style="width: 214px;" | '''''ServerConfig '''''<i>Node.</i><br/> | | style="width: 214px;" | '''''ServerConfig '''''<i>Node.</i><br/> | ||
− | | style="width: 439px;" | ''The '''history ''' | + | | style="width: 439px;" | ''The data of'''history''', '''statistic '''or'''latest''' by specific device Id within a time range.''<br/> |
|} | |} | ||
= Document = | = Document = | ||
− | [http://ess-wiki.advantech.com.tw/wiki/images/2/ | + | [http://ess-wiki.advantech.com.tw/wiki/images/2/23/NodeRed_for_WISE-PaaS.pdf Node-Red Plug-ins User Menual Doc for WISE-PaaS 2.0] |
Latest revision as of 11:11, 8 January 2018
Contents
Introduction
Node-RED is a visual wiring tool for the Internet of Things and is provided by IBM Emerging Technologies. Node-Red has several features, including browser-based flow editing, built on Node.js and social development. Because of browser-based, the user can use it more easily. Node-Red is based on Node.js, so user can use its nodes by using JavaScript. Node-Red also have many active communities. If the user finds bugs, he can find a solution and fix it easily. The user can use JSON format string to import or export the created flow easily.
According to the restful API of WISE-PaaS 2.0, we created several nodes.
How to install Node-Red Plug-ins for WISE-PaaS 2.0
- Clone EI-NodeRed from GitLab
- Open cmd.exe and navigate to ./EI-NodeRed folder
cd ./EI-NodeRed
- Type command line"npm install" to install the node-red dependencies
npm install
- Type command line"npm run build" to build the code of Node-Red
npm run build
- Type command line"npm start" or "node red.js" to run Node-Red
npm start
or
node red.js
Node-Red Plug-ins Categories
Category |
Description |
Nodes |
General |
The settings of IP address, port number, login username/password of WISE-PaaS server. Retrieval of device and sensor information. |
|
Common | Query the data and the information of devices, plugins and sensors |
|
Node-Red Plug-ins Description
Node Name | Description |
Input |
Output |
ServerConfig | Set url, port, username and password for WISE-PaaS 2.0 server. The node provides Basic type and SSO type. |
A timestamp trigger or button trigger. |
msg.url, msg.port, msg.encodestr. |
DevicesQuery |
Retrieve devices information from WISE-PaaS 2.0 server. User can fill a specific device id. The text of DeviceID can be blank if user wants to retrieve all devices. |
ServerConfig Node. |
Devices information list. |
PluginsQuery |
Retrieve plugins by Device ID within a time range. The maximum number of values is 10000 from WISE-PaaS 2.0 server. User can set the conditions about plugins here. Ex: Device ID, Agent ID, begin timestamp, end timestamp, amount and type. |
ServerConfig Node. |
Plugins Information list. |
SensorsQuery |
Retrieve sensors by Device ID & plugin within a time range. The maximum number of values is 10000 from WISE-PaaS 2.0 server. User can set the conditions about sensor here. Ex: Device ID, Agent ID, Plugin Name, begin timestamp, end timestamp, amount and type. |
ServerConfig Node. |
Sensors Information list. |
DataQuery |
Retrieve data from WISE-PaaS 2.0 server. The node provides three types, they are history, latest and statistic |
ServerConfig Node. |
The data ofhistory, statistic orlatest by specific device Id within a time range. |