Difference between revisions of "IoTGateway/Node-Red for GW EIS"

From ESS-WIKI
Jump to: navigation, search
m (add descriptions)
(finish node descriptions)
Line 36: Line 36:
 
! Node Name
 
! Node Name
 
! Description
 
! Description
! Input
+
! style="width: 17%;" | Input
! Output
+
! style="width: 17%;" | Output
|-
 
| Alljoyn Actions
 
| Get action descriptions from any Alljoyn services and perform action via remote call
 
| A timer or button triggered events<br/>
 
| Outputs a&nbsp;'''msg'''&nbsp;containing&nbsp;'''msg.topic'''&nbsp;which defaults to the sensor name, and&nbsp;'''msg.payload'''containing the reading
 
 
|-
 
|-
 
| nr_ui_flow_creator
 
| nr_ui_flow_creator
|  
+
| Auto-generate dashboard flow with node-red-dashboard nodes.<br/>Require [https://github.com/ADVANTECH-Corp/node-SUSI node-susi] and [https://github.com/ADVANTECH-Corp/node-SUSIIoT node-susiiot] packages.
Auto-generate dashboard flow with node-red-dashboard nodes.<br/>Require [https://github.com/ADVANTECH-Corp/node-SUSI node-susi] and [https://github.com/ADVANTECH-Corp/node-SUSIIoT node-susiiot] packages.
+
| Auto-generated an inject node after flow deployment.
 
+
| Auto-generated outputs according to user selected groups after flow deployment.
| 1.nder
 
| bbbb
 
 
|-
 
|-
 
| nr_ui_creator_ctrl
 
| nr_ui_creator_ctrl
|  
+
| Control devices according injected values&nbsp;.<br/>Require [https://github.com/ADVANTECH-Corp/node-SUSI node-susi] and [https://github.com/ADVANTECH-Corp/node-SUSIIoT node-susiiot] packages.
Control devices according injected values&nbsp;.<br/>Require [https://github.com/ADVANTECH-Corp/node-SUSI node-susi] and [https://github.com/ADVANTECH-Corp/node-SUSIIoT node-susiiot] packages.
+
| SUSIIoT control information in <span style="color:red">'topic'</span> propery and control value in <span style="color:red">'payload'</span> property.
 
+
| Control result returned by SUSIIoT.
| 1.nder
 
| bbbb
 
 
|-
 
|-
 
| WISE-Cloud-Sender
 
| WISE-Cloud-Sender
Line 62: Line 53:
 
Send injected IPSO JSON string to [[WISE-PaaS/RMM_Agent|RMM agent]].
 
Send injected IPSO JSON string to [[WISE-PaaS/RMM_Agent|RMM agent]].
  
| 1.nder
+
| A&nbsp;<span style="color:red">string</span> in <span style="color:red">'payload'</span> property which will be passed to RMM agent.<br/>
| bbbb
+
| None
 
|-
 
|-
 
| WISE-Cloud-Receiver
 
| WISE-Cloud-Receiver
 
|  
 
|  
Receive messages from [[WISE-PaaS/RMM_Agent|RMM agent]] with specified&nbsp;name and topics.
+
Receive messages from [[WISE-PaaS/RMM_Agent|RMM agent]] with specified name and topics.
  
| 1.nder
+
| None
| bbbb
+
| The received message (or RESTful request) from RMM agent is included in <span style="color:red">'req'</span> property.
 
|-
 
|-
 
| style="white-space: nowrap;" | WISE-Cloud-Responder
 
| style="white-space: nowrap;" | WISE-Cloud-Responder
Line 76: Line 67:
 
Response RESTful requests. The injected data must contain the source request information.
 
Response RESTful requests. The injected data must contain the source request information.
  
| 1.nder
+
| Source request is included in <span style="color:red">'req'</span> property and the corresponding response is in <span style="color:red">'rep'</span> property.
| bbbb
+
| None
 
|}
 
|}
  

Revision as of 09:59, 13 January 2017

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.
RMM server provides many restful API. But some API is maybe required complex parameter, it usually makes the user to call restful API more difficultly. Hance RMM team creates several common nodes in Node-Red. These nodes can help the user to use restful API that RMM server provided more easily and fast.


NodeRedSample.png


Node-Red Plug-ins Catogries

Node-RED_Nodes_for_IoTGW.jpg

Category Description Nodes
UI-Flow-Creator Provid  functions to auto-generate a dashboard flow with node-red-dashboard nodes. UI-Flow-Creator nodes depend on node-susi and node-susiiot packages to read data and control devices. 1.nr_ui_flow_creator
2.ui_ui_creator_ctrl
WISE-Cloud

WISE-Cloud provide nodes to communicate with RMM Agent. Sending data to agent, receiving messages from agent and response RMM RESTful requests.

1.WISE-Cloud-Sender
2.WISE-Cloud-Receiver
3.WISE-Cloud-Responder

NodeRed Plug-ins Description

Node Name Description Input Output
nr_ui_flow_creator Auto-generate dashboard flow with node-red-dashboard nodes.
Require node-susi and node-susiiot packages.
Auto-generated an inject node after flow deployment. Auto-generated outputs according to user selected groups after flow deployment.
nr_ui_creator_ctrl Control devices according injected values .
Require node-susi and node-susiiot packages.
SUSIIoT control information in 'topic' propery and control value in 'payload' property. Control result returned by SUSIIoT.
WISE-Cloud-Sender

Send injected IPSO JSON string to RMM agent.

string in 'payload' property which will be passed to RMM agent.
None
WISE-Cloud-Receiver

Receive messages from RMM agent with specified name and topics.

None The received message (or RESTful request) from RMM agent is included in 'req' property.
WISE-Cloud-Responder

Response RESTful requests. The injected data must contain the source request information.

Source request is included in 'req' property and the corresponding response is in 'rep' property. None

Demo Video Clips

Video Demo Title Link
NodeRED server IoT gateway installation and demonstration
link