Context Navigation

Changes between Version 12 and Version 13 of ZigbeeGateway

Timestamp:: Oct 4, 2010, 1:45:14 PM (14 years ago)
Author:: Sensei
Comment:: --

Legend:

: Unmodified
: Added
: Removed
: Modified

ZigbeeGateway

-                      v12
+                      v13
 The executable files will be located on ".\bin\release" or ".\bin\debug" directory (depending on the configuration).
-== Specification ==
-The two ways of connecting to a Zigbee island (dongle or concentrator) are quite similar, the dongle and external concentrator have primitives for connecting to a Zigbee island and for interchanging messages. In the case of dongle it is done through a library (*.dll). In the case of the external concentrator it is done using a TCP/IP messaging.
-The software engages to the island, discovers nodes, and for each node it discovers resources, that is, sensors and actuators. This software operates under the following Zigbee configuration:
-* It has been tested upon Zigbee 2007. Zigbee Pro should work depending on the Zigbee dongle or concentrator.
-* It is needed to known a priori physical Zigbee parameters:
-       * Frequency channel number (11 to 26).
-       * Zigbee net password.
-       * Extended PAN Identification helps but not needed.
-* Not all the Zigbee profiles are detected. It have been tested under temperature, light, human presence, acceleration sensors, proprietary location sensors and electricity on/off actuator.
-The Gateway has the following features regarding **Resource End Point (REP) implementation**:
-* Allows **publication** of individual resources (sensors and actuators) into a Resource Directory.
-* Allows **getting** data from resources and **acting** over them using **RESTful** access.
-* Allows **subscription** to resources. Notification can be requested upon one or several of the following conditions:
-       * **Periodic time**. If active, it sends a new notification after "period time" passes without having sent a notification.
-       * **Value change**. If active, it sends a notification when detected that the value has changed.
-       * **Threshold**. When the value goes beyond a threshold a notification is sent.
-* Allows **mobility**. Several gateways can be located in the vicinity and in the case that the Zigbee island allows nodes to move, both gateways communicate each other to properly handle the mobility.
-In order to not saturate the islands with possible huge requests coming from the internet world, the gateway do not bypass all the requests to the island. For that reason the gateways stores the last value of the resources in order to respond by itself to requests targeting the same resource that arrives at the same time.
 == Configuration ==
 Two xml files need to be edited for configuring properly the software package before running it. These configuration files allow to establish most of the behaviour of the package without the need of compile the software.
 …
 The upper side tags are used for debugging. It contains **Commands** that can be raised manually to the island for testing purposes, **Events** receives from WS&AN, and traces of **Orders** receives from SENSEI.
 == Troubleshooting ==
+=== Troubleshooting ===
 **It appears the error message: //"Error while connecting to Zigbee dongle"//:** Ensure that a zigbee dongle is properly inserted in the PC. Ensure that no other application is using the dongle. Remove and insert it again.
 …
 **It does not publish the resources in the Resource Directory:** Ensure that the proxy variables are properly adjusted depending on your internet connection, and the resource directory URL is properly filled in the configuration file.
+== Mobility ==
+== Specification ==
+The two ways of connecting to a Zigbee island (dongle or concentrator) are quite similar, the dongle and external concentrator have primitives for connecting to a Zigbee island and for interchanging messages. In the case of dongle it is done through a library (*.dll). In the case of the external concentrator it is done using a TCP/IP messaging.
+The software engages to the island, discovers nodes, and for each node it discovers resources, that is, sensors and actuators. This software operates under the following Zigbee configuration:
+* It has been tested upon Zigbee 2007. Zigbee Pro should work depending on the Zigbee dongle or concentrator.
+* It is needed to known a priori physical Zigbee parameters:
+       * Frequency channel number (11 to 26).
+       * Zigbee net password.
+       * Extended PAN Identification helps but not needed.
+* Not all the Zigbee profiles are detected. It have been tested under temperature, light, human presence, acceleration sensors, proprietary location sensors and electricity on/off actuator.
+The Gateway has the following features regarding **Resource End Point (REP) implementation**:
+* Allows **publication** of individual resources (sensors and actuators) into a Resource Directory.
+* Allows **getting** data from resources and **acting** over them using **RESTful** access.
+* Allows **subscription** to resources. Notification can be requested upon one or several of the following conditions:
+       * **Periodic time**. If active, it sends a new notification after "period time" passes without having sent a notification.
+       * **Value change**. If active, it sends a notification when detected that the value has changed.
+       * **Threshold**. When the value goes beyond a threshold a notification is sent.
+* Allows **mobility**. Several gateways can be located in the vicinity and in the case that the Zigbee island allows nodes to move, both gateways communicate each other to properly handle the mobility.
+In order to not saturate the islands with possible huge requests coming from the internet world, the gateway do not bypass all the requests to the island. For that reason the gateways stores the last value of the resources in order to respond by itself to requests targeting the same resource that arrives at the same time.
+=== RAI interface ===
+This Gateway creates a REST interface for allowing applications to iterate with the Zigbee island resources. This interface is defined in [[#RpObservationMeasurement]] (**Check proper LINK to the xml specification TODELETE**).
+Each resource has its one URL, with the following format: "//**BASE_URL/nodeMAC/X/number**//"
+* //nodeMAC// is the node MAC address in hexadecimal capital letters (16 characters).
+* //X// is the letter "s" for a sensor or "a" for an actuator.
+* //number// is the number of sensor or actuator, starting with "0".
+Over this resource URL the following operations can be done:
+* GET http method is used for getting a "xml" with the sensor or actuator value. An xml with the format defined in [[#RpObservationMeasurement]] is obtained.
+* PUT http method is used for changing a parameter, or acting over an actuator.
+=== Subscriptions ===
+A POST http method over the resource URL is used for adding a new subscription. For that, the URL must contain after the resource URL the subscription identity:
+"//**BASE_URL/nodeMAC/X/number/SubscriptionID**//". //"SubscriptionID"// is whatever text allowed in the URL names. The xml format for a subscription request is (**PUT A LINK TO XML SUBSCRIPTION FORMAT IF ANY**).
+* A PUT http method over this subscription URL is used for modifying it.
+* A GET http method over this subscription URL returns the subscription xml information.
+* A DELETE http method over this subscription URL is used for deleting it.
+* A POST http method over this subscription URL returns an error if it exist or add a new subscription if it does not exist.
+GET over "//BASE_URL/nodeMAC/X/number**?Subscription**//" can be used for getting the list of subscriptions of a resource.
+GET over "//**BASE_URL/nodeMAC **//" returns an html page with node information, sensors and actuators, and links for the subscriptions.
+=== Mobility ===
 Zigbee gateway resolves the mobility of a node between several gateways. In the case of Zigbee there is no possibility of storing information inside nodes that helps to the mobility. So gateways need to resolve the problem by themselves.
 Figure shows how mobility is treated by Zigbee gateways.
 …
 }}}
+== RAI interface ==
+This Gateway creates a REST interface for allowing applications to iterate with the Zigbee island. This interface is defined in [RpObservationMeasurement] (**Check proper LINK to the xml specification TODELETE**).
+Each resource has its one URL, with the following format: "//**BASE_URL/nodeMAC/X/number**//"
+* //nodeMAC// is the node MAC address in hexadecimal capital letters (16 characters).
+* //X// is the letter "s" for a sensor or "a" for an actuator.
+* //number// is the number of sensor or actuator, starting with "0".
+Over this resource URL the following operations can be done:
+* GET http method is used for getting a "xml" with the sensor or actuator value.
+* PUT http method is used for changing a parameter, or acting over an actuator.
+=== Subscriptions ===
+A POST http method over the resource URL is used for adding a new subscription. For that, the URL must contain after the resource URL the subscription identity:
+"//**BASE_URL/nodeMAC/X/number/SubscriptionID**//". //"SubscriptionID"// is whatever text allowed in the URL names. The xml format for a subscription request is (**PUT A LINK TO XML SUBSCRIPTION FORMAT**).
+* A PUT http method over this subscription URL is used for modifying it.
+* A GET http method over this subscription URL returns the subscription xml information.
+* A DELETE http method over this subscription URL is used for deleting it.
+* A POST http method over this subscription URL returns an error if it exist or add a new subscription if it does not exist.
+GET over "//BASE_URL/nodeMAC/X/number**?Subscription**//" can be used for getting the list of subscriptions of a resource.
+GET over "//**BASE_URL/nodeMAC **//" returns an html page with node information, sensors and actuators, and links for the subscriptions.