EIS RESTfulAPI ProcWSNData - Revision history

Eric.liang at 06:09, 2 July 2018

2018-07-02T06:09:36Z

Eric.liang at 03:59, 16 May 2018

2018-05-16T03:59:39Z

Eric.liang at 06:47, 27 November 2017

2017-11-27T06:47:15Z

Eric.liang at 02:03, 26 December 2016

2016-12-26T02:03:12Z

Eric.liang at 07:19, 8 December 2016

2016-12-08T07:19:51Z

Eric.liang at 07:01, 8 December 2016

2016-12-08T07:01:34Z

Eric.liang at 07:01, 8 December 2016

2016-12-08T07:01:03Z

Eric.liang at 04:48, 29 November 2016

2016-11-29T04:48:51Z

Eric.liang at 04:48, 29 November 2016

2016-11-29T04:48:24Z

Eric.liang at 04:47, 29 November 2016

2016-11-29T04:47:19Z

@@ Line 313: / Line 313: @@
 === <span style="color:#FF0000;">Websocket of WSNManage&nbsp;</span> ===
-Endpoint: ws://ServerIP:Port/WSNManage
+<span style="font-size:large;">'''Endpoint: ws://ServerIP:Port/WSNManage'''</span>
 Client request Server by this Endpoint to require "WSNManage" service. Server will auto push WSNManage&nbsp;event to client.

@@ Line 7: / Line 7: @@
 === <span style="color:#FF0000;">GET</span> ===
-'''Path: restapi/WSNManage/Connectivity'''
+'''Path: APIGw-Site:3000/restapi/WSNManage/Connectivity'''
 -> All Capability ( without data )
@@ Line 61: / Line 61: @@
+   }
-'''Path: '''''WSNManage/Connectivity/IoTGW/WSN/0000852CF4B7B0E8/Info'''
+'''Path: '''''APIGw-Site:3000/restapi/WSNManage/Connectivity/IoTGW/WSN/0000852CF4B7B0E8/Info'''
 '''Reply: with latest data value'''
@@ Line 76: / Line 76: @@
 === <span style="color:#FF0000;">Put</span> ===
-'''Path: 'restapi/WSNManage/Connectivity/IoTGW/WSN/0000852CF4B7B0E8/Info/reset'''
+'''Path: APIGw-Site:3000/restapi/WSNManage/Connectivity/IoTGW/WSN/0000852CF4B7B0E8/Info/reset'''
 '''Data:&nbsp;'''
@@ Line 92: / Line 92: @@
 === <span style="color:#FF0000;">Get</span> ===
-'''1.Path: restapi/WSNManage/SenHub/AllSenHubList'''
+'''1.Path: APIGw-Site:3000/restapi/WSNManage/SenHub/AllSenHubList'''
 '''Reply:'''
@@ Line 98: / Line 98: @@
   {"n":"AllSenHubList","sv":"xxxxxx,0017000E40000001,xxxxx"}
-'''2. Path: WSNManage/SenHub/&lt;DeviceID&gt;/DevInfo''' &lt;/br&gt;
+'''2. Path: APIGw-Site:3000/restapi/WSNManage/SenHub/&lt;DeviceID&gt;/DevInfo'''
 '''Reply:'''
@@ Line 121: / Line 121: @@
-'''3. Path:&nbsp;restapi/WSNManage/SenHub/&lt;DeviceID&gt;'''
+'''3. Path:&nbsp;APIGw-Site:3000/restapi/WSNManage/SenHub/&lt;DeviceID&gt;'''
 '''Reply:&nbsp;Capability ( without data )'''
@@ Line 148: / Line 148: @@
 }</pre>
-'''4. Path:&nbsp;restapi/WSNManage/SenHub/&lt;DeviceID&gt;/SenHub'''
+'''4. Path:&nbsp;APIGw-Site:3000/restapi/WSNManage/SenHub/&lt;DeviceID&gt;/SenHub'''
 '''Reply: with latest&nbsp;data value&nbsp;'''
@@ Line 173: / Line 173: @@
 }</pre>
-'''5. Path:&nbsp;restapi/WSNManage/SenHub/&lt;DeviceID&gt;/SenHub/SenData'''
+'''5. Path:&nbsp;APIGw-Site:3000/restapi/WSNManage/SenHub/&lt;DeviceID&gt;/SenHub/SenData'''
 '''Reply: with latest&nbsp;data'''
@@ Line 186: / Line 186: @@
 }</pre>
-'''6. restapi/WSNManage/SenHub/&lt;DeviceID&gt;/SenHub/SenData/Temperature'''
+'''6. APIGw-Site:3000/restapi/WSNManage/SenHub/&lt;DeviceID&gt;/SenHub/SenData/Temperature'''
 '''Reply: with latest&nbsp;data'''
@@ Line 197: / Line 197: @@
 '''Ex: To&nbsp;chagne SenHub's Name by 'PUT' RESTful method'''
-'''Path: restapi/WSNManage/SenHub/&lt;DeviceID&gt;/SenHub/SenData/GPI01'''
+'''Path: APIGw-Site:3000/restapi/WSNManage/SenHub/&lt;DeviceID&gt;/SenHub/SenData/GPI01'''
 '''Data:&nbsp;'''

@@ Line 391: / Line 391: @@
 '''data:'''Update Health
 <pre>{
-    "data":{
+   "IoTGW": {
-       "IoTGW": {
+        "WSN": {
-           "WSN": {
+             "0000852CF4B7B0E8":{
-             "0000852CF4B7B0E8"{
+              "Info": {
                          "e": [{"n":"Health","v":30}],
                          "bn":"Info"
+              },
                "bn":"0000852CF4B7B0E8",
                "ver":1
-            },
+           },
-            "bn":"WSN"
+           "bn":"WSN"
          },
      "ver": 1
+     }
 }</pre>
 === A new SenHub connected ===

@@ Line 302: / Line 302: @@
 WebSocket is designed to be implemented in&nbsp;[https://en.wikipedia.org/wiki/Web_browser web browsers]&nbsp;and&nbsp;[https://en.wikipedia.org/wiki/Web_server web servers], but it can be used by any client or server application. The WebSocket Protocol is an independent TCP-based protocol. Its only relationship to&nbsp;[https://en.wikipedia.org/wiki/HTTP HTTP]&nbsp;is that its&nbsp;[https://en.wikipedia.org/wiki/Handshaking handshake]&nbsp;is interpreted by HTTP servers as an&nbsp;[https://en.wikipedia.org/wiki/HTTP/1.1_Upgrade_header Upgrade request].<sup id="cite_ref-1">[https://en.wikipedia.org/wiki/WebSocket#cite_note-1 [1]]</sup>&nbsp;The WebSocket protocol makes more interaction between a browser and a web server possible, facilitating the real-time data transfer from and to the server. This is made possible by providing a standardized way for the server to send content to the browser without being solicited by the client, and allowing for messages to be passed back and forth while keeping the connection open. In this way, a two-way (bi-directional) ongoing conversation can take place between a browser and the server. The communications are done over TCP&nbsp;[https://en.wikipedia.org/wiki/Port_(computer_networking) port]&nbsp;number 80, which is of benefit for those environments which block non-web Internet connections using a&nbsp;[https://en.wikipedia.org/wiki/Firewall_(computing) firewall]. Similar two-way browser-server communications have been achieved in non-standardized ways using stopgap technologies such as&nbsp;[https://en.wikipedia.org/wiki/Comet_(programming) Comet].
@@ Line 312: / Line 318: @@
 Please refer to "<span style="color:#FF0000;">'''WSNManage evnent message"'''</span>&nbsp;for WSNManage's event and data format.
 = <span style="color:#0000FF;">WSNManage evnent message</span> =

@@ Line 186: / Line 186: @@
 }</pre>
-'''6. WSNManage/SenHub/&lt;DeviceID&gt;/SenHub/SenData/Temperature'''
+'''6. restapi/WSNManage/SenHub/&lt;DeviceID&gt;/SenHub/SenData/Temperature'''
 '''Reply: with latest&nbsp;data'''
@@ Line 197: / Line 197: @@
 '''Ex: To&nbsp;chagne SenHub's Name by 'PUT' RESTful method'''
-'''Path: WSNManage/SenHub/&lt;DeviceID&gt;/SenHub/Info/Name'''
+'''Path: restapi/WSNManage/SenHub/&lt;DeviceID&gt;/SenHub/SenData/GPI01'''
 '''Data:&nbsp;'''
-<pre>{"sv":"Room"}</pre>
+<pre>{"bv":1}</pre>
 '''Reply:'''
@@ Line 207: / Line 207: @@
 '''Data:&nbsp;'''
-<pre>{"sv":"Room"}</pre>
+<pre>{"bv":1}</pre>
 = <span style="color:#0000FF;">Socket.io</span> =

← Older revision		Revision as of 04:48, 29 November 2016
Line 305:		Line 305:


−	=== <span style="color:#FF0000;">~~'''~~Websocket of WSNManage ~~'''~~</span> ===	+	=== <span style="color:#FF0000;">Websocket of WSNManage </span> ===

	Endpoint: ws://ServerIP:Port/WSNManage		Endpoint: ws://ServerIP:Port/WSNManage

@@ Line 3: / Line 3: @@
 &nbsp;This document is about EIS RESTful API service of&nbsp;Wireless Sensor Manage (WSNManage). There are two major classes in WSNManage service one is&nbsp;"Connectiviy" another is&nbsp;"SenHub". Connectivity is wireless interfaces information in the EIS IoT Gateway solution. "SenHub" is short of sensor hub.&nbsp;
-== '''<span style="background-color:#AFEEEE;">Connectivity</span>''' ==
+== <span style="background-color:#AFEEEE;">Connectivity</span> ==
-=== <span style="color:#FF0000;">'''GET'''</span> ===
+=== <span style="color:#FF0000;">GET</span> ===
 '''Path: WSNManage/Connectivity'''
@@ Line 74: / Line 74: @@
 }</pre>
-=== <span style="color:#FF0000;">'''Put'''</span> ===
+=== <span style="color:#FF0000;">Put</span> ===
 '''Path: 'WSNManage/Connectivity/IoTGW/WSN/0000852CF4B7B0E8/Info/reset'''
@@ Line 88: / Line 88: @@
 <pre>{"bv":1}</pre>
-== '''<span style="background-color:#00FFFF;">SenHub</span>''' ==
+== <span style="background-color:#00FFFF;">SenHub</span> ==
-=== <span style="color:#FF0000;">'''Get'''</span> ===
+=== <span style="color:#FF0000;">Get</span> ===
 '''1.Path: WSNManage/SenHub/AllSenHubList'''
@@ Line 191: / Line 191: @@
 <pre>{"v":26}</pre>
-=== <span style="color:#FF0000;">'''Put'''</span> ===
+=== <span style="color:#FF0000;">Put</span> ===
 '''EIS RESTful only supports change one resource in each request.'''
@@ Line 213: / Line 213: @@
 There are&nbsp;two&nbsp;methods ( 1. request / response, 2. auto push message to client ) to get&nbsp;information by Socket.io.&nbsp;
-=== <span style="color:#FF0000;">'''Request'''</span> ===
+=== <span style="color:#FF0000;">Request</span> ===
 '''Direction: '''Client -> Socket.io Server
@@ Line 231: / Line 231: @@
 "'''sessionId'''": &nbsp;Unique interger&nbsp;number of&nbsp;each request for&nbsp;distinguish. Server would&nbsp;response and fill the same sessionId.
-=== <span style="color:#FF0000;">'''Response'''</span> ===
+=== <span style="color:#FF0000;">Response</span> ===
 '''Direction:&nbsp;'''Server -> Client
@@ Line 247: / Line 247: @@
-=== <span style="color:#FF0000;">'''Example of Action'''</span> ===
+=== <span style="color:#FF0000;">Example of Action</span> ===
 ==== <span style="color:#0000FF;">'''service:&nbsp;'''</span>Client query which event services provided by Socket.io Server ====
@@ Line 277: / Line 277: @@
-=== '''<span style="color:#FF0000;">Message</span>''' ===
+=== <span style="color:#FF0000;">Message</span> ===
 '''Direction:&nbsp;'''Server -> Client
@@ Line 297: / Line 297: @@
-= <span style="color:#0000FF;">'''WebSocket Service'''</span> =
+= <span style="color:#0000FF;">WebSocket Service</span> =
 '''WebSocket'''&nbsp;is a computer&nbsp;[https://en.wikipedia.org/wiki/Communications_protocol communications protocol], providing&nbsp;[https://en.wikipedia.org/wiki/Full-duplex full-duplex]&nbsp;communication channels over a single&nbsp;[https://en.wikipedia.org/wiki/Transmission_Control_Protocol TCP]&nbsp;connection. The WebSocket protocol was standardized by the&nbsp;[https://en.wikipedia.org/wiki/Internet_Engineering_Task_Force IETF]&nbsp;as&nbsp;[https://en.wikipedia.org/wiki/Request_for_Comments RFC]&nbsp;6455 in 2011, and the WebSocket&nbsp;[https://en.wikipedia.org/wiki/Application_programming_interface API]&nbsp;in&nbsp;[https://en.wikipedia.org/wiki/Web_IDL Web IDL]&nbsp;is being standardized by the&nbsp;[https://en.wikipedia.org/wiki/World_Wide_Web_Consortium W3C].

@@ Line 1: / Line 1: @@
-= <span style="color:#0000FF;">'''RESTful API Path Rule for WSNManage'''</span> =
+= <span style="color:#0000FF;">RESTful API Path Rule for WSNManage</span> =
 &nbsp;This document is about EIS RESTful API service of&nbsp;Wireless Sensor Manage (WSNManage). There are two major classes in WSNManage service one is&nbsp;"Connectiviy" another is&nbsp;"SenHub". Connectivity is wireless interfaces information in the EIS IoT Gateway solution. "SenHub" is short of sensor hub.&nbsp;
@@ Line 209: / Line 209: @@
 <pre>{"sv":"Room"}</pre>
-= <span style="color:#0000FF;">'''Socket.io'''</span> =
+= <span style="color:#0000FF;">Socket.io</span> =
 There are&nbsp;two&nbsp;methods ( 1. request / response, 2. auto push message to client ) to get&nbsp;information by Socket.io.&nbsp;
@@ Line 317: / Line 317: @@
-= <span style="color:#0000FF;">'''WSNManage evnent message'''</span> =
+= <span style="color:#0000FF;">WSNManage evnent message</span> =
   events:[