Changes between Version 17 and Version 18 of ZigbeeGateway


Ignore:
Timestamp:
Oct 18, 2010, 2:50:22 PM (14 years ago)
Author:
Sensei
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • ZigbeeGateway

    v17 v18  
    1515 
    1616
    17 == Installation ==
    18 There is not an installation package available. To run this software just copy and paste the files contain in the [#PackageContent package] in a directory and run the exe file "Zb2SenseiGw.exe". Prior to that, it is convenient to adjust the configuration file (see [#Configuration Configuration section]).
    19 
    20 === Requirements ===
     17== Requirements ==
    2118The package requires:
    2219* Windows operating system, version XP or upper.
    … …  
    2421* External Hardware:
    2522       * Zigbee dongle. It has been tested the Zigbee dongle of "Integration" model "IA DAUB-DK1 2400".
    26               * Drivers of this dongle should be properly installed before running the package.
     23              * Drivers of this dongle should be properly installed before running the package. After installation, the following library will be available on the path: //STKUSB.dll// and //ZBDLL.dll//. Alternatively these libraries can be copied to the same folder where package is installed.
     24
    2725       * External concentrator, that convert the Zigbee messages into IP for transmitting using TCP/IP protocol.
    2826* IP connection. Make sure that the firewall allows the package to establish a TCP server.
    2927
     28== Installation ==
     29Package is available [https://svn-batch.grid.pub.ro/svn/Sensei-Cookbook/Zigbee_to_Sensei_Gateway here]. Just unzip the package files in a directory. Previously to run this software, it is necessary to adjust the configuration file (see [#Configuration Configuration section]).
     30
    3031=== Package Content ===
    31 * Main executable file:
     32* Main exe file:
    3233       * //ZB2SenseiGW.exe//
    3334* Resource files on "//./Resources//" directory:
    … …  
    3536* Configuration files:
    3637       * //ZB2SenseiGW.exe.config//, //rpi.xml// (more configuration files can be added, see [#rpi.xmlfile Configuration section])
    37 * Libraries of Zigbee dongle:
    38        * //STKUSB.dll//, //ZB.dll//
    39 
    40 === Compilation ===
    41 The sources are written in C# language. Microsoft Visual Studio 2010.
    42 Open "ZB2SenseiGW.sln" solution and compile the project.
    43 The executable files will be located on ".\bin\release" or ".\bin\debug" directory (depending on the configuration).
    4438
    4539== Configuration ==
    46 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.
     40Two xml files need to be edited for properly configuring the software package before running it. These configuration files allow establishing most of the behaviour of the package without the need of compile the software.
    4741
    4842Remember that these files are read when application starts. So if you change a value, it will not be considered after restarting the application.
    4943
    50 It is not needed special editor for changing these files. Whichever text editor used is enough. But special care should be followed for not modifying the overall xml structure, and the rest of the tags. Read this section before proceed to edit the files.
    51 
    52 Do not worry if you are not familiar with **xml basis**. Look for the target name that follow the text "//key=//", and you must **edit only** the text between double apostrophes after the "//value=//" text.
     44It is not needed special editor for changing these files. Whichever text editor used is enough. But special care should be followed for not modifying the overall xml structure, and the rest of the tags. Read this section before proceed to edit the files. Look for the target name that follow the text "//key=//", and you must **edit only** the text between double apostrophes after the "//value=//" text.
    5345
    5446=== Zb2SenseiGw.exe.config file===
    … …  
    7870"**//Sensei_RAI_BaseURL//**": Base URL for the SENSEI Resource Access Interface (RAI ) server. For example "//http://myIP:8081/sensei/rai/resources/ //". If empty, the application will not implement the RAI server. It is mandatory to include the port event if the default port is used. It is also mandatory to end in "/". The text "//myIP//" will be replaced by first computer IP address. If the computer has several IP addresses and you want to use another, put it explicitly instead of "//myIP//". Each resource is acceded through **BaseURL/ //nodeID/[s or a]/number//** (see [#RAIinterface RAI Interface] for more details).
    7971
    80 "**//Sensei_RPI_RAIBaseURL//**": Base URL that will contain the "<RAI-Description> <REP-Locator>" tag when a resource is published in the Resource Directory.  If empty it will take previous //Sensei_RAI_BaseURL// variable, but it can be different. It is needed for example if the gateway access through a proxy or a router that changes the local IP (used when mounting an http RAI server) into a public IP (that is the IP seen from outside). Same rules as before apply: End with "/", application will append "//nodeID/[s or a]/number//" to this URL; and "//myIP//" text will be replaced by first computer IP address.
     72"**//Sensei_RPI_RAIBaseURL//**": Base URL that will contain the "<Rai-Description> <REP-Locator>" tag when a resource is published in the Resource Directory.  If empty it will take previous //Sensei_RAI_BaseURL// variable, but it can be different. It is needed for example if the gateway access through a proxy or a router that changes the local IP (used when mounting an http RAI server) into a public IP (that is the IP seen from outside). Same rules as before apply: End with "/", application will append "//nodeID/[s or a]/number//" to this URL; and "//myIP//" text will be replaced by first computer IP address.
    8173
    8274"**//Sensei_RPI_URL//**": Target SENSEI Resource Directory URL for publishing. Leave Empty for not publishing resources into Resource Directory. End always with "/". Application will add "rpi", "rli" or "rd" suffix when needed. For example "//http://sensei-dev1.grid.pub.ro:8184/ //".
    … …  
    112104* "//**_ RAI**//": value of the "//Sensei_RPI_RAIBaseURL//" variable of the "//Zb2SenseiGw.exe.config//" file.
    113105
    114 == User manual ==
    115 
    116 Figure shows the main screen of the application.
     106== Running. User manual ==
     107
     108Execute the exe file "Zb2SenseiGw.exe" to run this software. Figure shows the main screen of the application.
    117109[[Image(zb2senseigw_mainsreen.jpg, 50%, center)]]
    118110 
    119111
    120 On the upper side, appears the type of connection to the Zigbee island. The "**USB**" is through a dongle and the "**IP**" through an external concentrator. The "**IP/Ch**" select box contains the Zigbee channel for USB or the connection name (see [#Zb2SenseiGw.exe.configfile <netConn> idNet in Configuration]) for IP. The button "**Connect**" and "**Disconnect**" starts the attaching or detaching to the Zigbee island.
    121 
    122 The connection process takes a while, firtsly it engages in the Zigbee island. Secondly it discovers the nodes and resources. The node list appears on the "**Tree of nodes**" tree box.
     112On the upper side, the type of connection to the Zigbee island is shown. The "**USB**" is through a dongle and the "**IP**" through an external concentrator. The "**IP/Ch**" select box contains the Zigbee channel for USB or the connection name (see [#Zb2SenseiGw.exe.configfile <netConn> idNet in Configuration]) for IP. The button "**Connect**" and "**Disconnect**" starts the attaching or detaching to the Zigbee island.
     113
     114The connection process takes a while, firstly it engages in the Zigbee island. Secondly it discovers the nodes and resources. The node list appears on the "**Tree of nodes**" tree box.
    123115
    124116Details of a node selected in the tree box are shown on the right side of the screen:
    … …  
    224216For optimization, mobility commands interchanged between gateways are not sent at a resource basis, but only once for all the resources of a node.
    225217=== Mobility format interchanged between gateways===
    226 This section details the message (7.) of figure. The new gateway informs about node mobility to the old gateway with a PUT http method addressing the node id (not resource id) with the following xml content:
     218This section details the message (7.) of previous figure. The new gateway informs about node mobility to the old gateway with a PUT http method addressing the node id (not resource id) with the following xml content:
    227219{{{
    228220<?xml version="1.0" encoding="UTF-8"?>