Difference between revisions of "WISE-PaaS 2.0 NodeRed"
From ESS-WIKI
Line 43: | Line 43: | ||
node red.js | node red.js | ||
+ | |||
+ | |||
Line 48: | Line 50: | ||
= NodeRed Plug-ins Catogries = | = NodeRed Plug-ins Catogries = | ||
− | {| | + | {| border="1" cellspacing="1" cellpadding="1" style="width: 1065px;" |
|- | |- | ||
− | + | | style="text-align: center; width: 80px;" | '''Category'''<br/> | |
− | + | | style="text-align: center; width: 812px;" | '''Description'''<br/> | |
− | + | | style="text-align: center; width: 150px;" | '''Nodes'''<br/> | |
|- | |- | ||
− | | General | + | | style="width: 80px; text-align: center;" | General<br/> |
− | | The settings of IP address, port number, login username/password of WISE-PaaS server. Retrieval of device and sensor information. | + | | style="width: 812px;" | The settings of IP address, port number, login username/password of WISE-PaaS server. Retrieval of device and sensor information.<br/> |
− | | | + | | style="width: 150px;" | |
− | + | #ServerConfig | |
|- | |- | ||
− | | Common | + | | style="width: 80px; text-align: center;" | Common |
− | | Query the data | + | | style="width: 812px;" | Query the history data and the information of devices, plugins and sensors |
− | | | + | | style="width: 150px;" | |
− | + | #DevicesQuery | |
− | + | #PluginsQuery | |
− | + | #SensorsQuery | |
− | + | #DataQuery | |
− | |||
− | |||
− | |||
|} | |} | ||
Line 75: | Line 74: | ||
− | = | + | = NodeRed Plug-ins Description = |
− | = | + | {| border="1" cellspacing="1" cellpadding="1" style="width: 1348px;" |
+ | |- | ||
+ | | style="text-align: center;" | '''Node Name''' | ||
+ | | style="text-align: center; width: 551px;" | '''Description'''<br/> | ||
+ | | style="text-align: center; width: 214px;" | '''Input'''<br/> | ||
+ | | style="text-align: center; width: 439px;" | '''Output'''<br/> | ||
+ | |- | ||
+ | | style="text-align: center;" | ServerConfig | ||
+ | | style="width: 551px;" | ''Set url, port, username and password for '''WISE PaaS 2.0''' server. The node provides '''Basic '''type and '''SSO '''type.''<br/> | ||
+ | | style="width: 214px;" | ''A timestamp trigger or button trgger.''<br/> | ||
+ | | style="width: 439px;" | ''msg.url, msg.port, msg.encodestr.''<br/> | ||
+ | |- | ||
+ | | style="text-align: center;" | DevicesQuery<br/> | ||
+ | | style="width: 551px;" | ''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.''<br/> | ||
+ | | style="width: 214px;" | '''''ServerSetting'''''<i>Node.</i><br/> | ||
+ | | style="width: 439px;" | '''''Devices '''information list.''<br/> | ||
+ | |- | ||
+ | | style="text-align: center;" | PluginsQuery<br/> | ||
+ | | 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;" | '''''ServerSetting'''''<i>Node.</i><br/> | ||
+ | | style="width: 439px;" | '''''Plugin '''Information list.''<br/> | ||
+ | |- | ||
+ | | style="text-align: center;" | SensorsQuery<br/> | ||
+ | | 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, begin timestamp, end timestamp, amount and type.''<br/> | ||
+ | | style="width: 214px;" | '''''ServerSetting'''''<i>Node.</i><br/> | ||
+ | | style="width: 439px;" | '''''Sensor '''Information list.''<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: 214px;" | '''''ServerSetting'''''<i>Node.</i><br/> | ||
+ | | style="width: 439px;" | ''The '''history '''data or '''statistic '''data by specific device Id within a time range.''<br/> | ||
+ | |} | ||
− | |||
− | |||
− | = | + | = Document = |
− | |||
− |
Revision as of 10:40, 31 May 2017
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.
Accroding to the restful API of WISE-PaaS 2.0, we created several nodes.
How to install NodeRed Plug-ins for RMM
- 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
NodeRed Plug-ins Catogries
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 history data and the information of devices, plugins and sensors |
|
NodeRed 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 trgger. |
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. |
ServerSettingNode. |
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. |
ServerSettingNode. |
Plugin 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, begin timestamp, end timestamp, amount and type. |
ServerSettingNode. |
Sensor Information list. |
DataQuery |
Retrieve data from WISE PaaS 2.0 server. The node provides three types, they are history, latest and statistic |
ServerSettingNode. |
The history data or statistic data by specific device Id within a time range. |