doc update

OnosTeam · Aug 10, 2016 · e738088 · e738088
1 parent 37f2086
commit e738088
Show file tree

Hide file tree

Showing 39 changed files with 438 additions and 29 deletions.
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/doctrees/node_query_handler.doctree b/docs/_build/doctrees/node_query_handler.doctree
diff --git a/docs/_build/doctrees/router_handler.doctree b/docs/_build/doctrees/router_handler.doctree
diff --git a/docs/_build/html/_modules/arduino_handler.html b/docs/_build/html/_modules/arduino_handler.html
@@ -296,7 +296,18 @@ <h1>Source code for arduino_handler</h1><div class="highlight"><pre>
           SphinxRtdTheme.StickyNav.enable();
       });
   </script>
-
+
+
+<script type="text/javascript">
+var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
+document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
+</script>
+<script type="text/javascript">
+try {
+var pageTracker = _gat._getTracker("UA-45976563-4");
+pageTracker._trackPageview();
+} catch(err) {}</script>
+
 
 </body>
 </html>
diff --git a/docs/_build/html/_modules/arduinoserial.html b/docs/_build/html/_modules/arduinoserial.html
@@ -601,7 +601,18 @@ <h1>Source code for arduinoserial</h1><div class="highlight"><pre>
           SphinxRtdTheme.StickyNav.enable();
       });
   </script>
-
+
+
+<script type="text/javascript">
+var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
+document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
+</script>
+<script type="text/javascript">
+try {
+var pageTracker = _gat._getTracker("UA-45976563-4");
+pageTracker._trackPageview();
+} catch(err) {}</script>
+
 
 </body>
 </html>
diff --git a/docs/_build/html/_modules/conf.html b/docs/_build/html/_modules/conf.html
@@ -421,7 +421,18 @@ <h1>Source code for conf</h1><div class="highlight"><pre>
           SphinxRtdTheme.StickyNav.enable();
       });
   </script>
-
+
+
+<script type="text/javascript">
+var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
+document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
+</script>
+<script type="text/javascript">
+try {
+var pageTracker = _gat._getTracker("UA-45976563-4");
+pageTracker._trackPageview();
+} catch(err) {}</script>
+
 
 </body>
 </html>
diff --git a/docs/_build/html/_modules/globalVar.html b/docs/_build/html/_modules/globalVar.html
@@ -2000,7 +2000,18 @@ <h1>Source code for globalVar</h1><div class="highlight"><pre>
           SphinxRtdTheme.StickyNav.enable();
       });
   </script>
-
+
+
+<script type="text/javascript">
+var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
+document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
+</script>
+<script type="text/javascript">
+try {
+var pageTracker = _gat._getTracker("UA-45976563-4");
+pageTracker._trackPageview();
+} catch(err) {}</script>
+
 
 </body>
 </html>
diff --git a/docs/_build/html/_modules/hw_node.html b/docs/_build/html/_modules/hw_node.html
@@ -890,7 +890,18 @@ <h1>Source code for hw_node</h1><div class="highlight"><pre>
           SphinxRtdTheme.StickyNav.enable();
       });
   </script>
-
+
+
+<script type="text/javascript">
+var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
+document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
+</script>
+<script type="text/javascript">
+try {
+var pageTracker = _gat._getTracker("UA-45976563-4");
+pageTracker._trackPageview();
+} catch(err) {}</script>
+
 
 </body>
 </html>
diff --git a/docs/_build/html/_modules/index.html b/docs/_build/html/_modules/index.html
@@ -166,7 +166,18 @@ <h1>All modules for which code is available</h1>
           SphinxRtdTheme.StickyNav.enable();
       });
   </script>
-
+
+
+<script type="text/javascript">
+var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
+document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
+</script>
+<script type="text/javascript">
+try {
+var pageTracker = _gat._getTracker("UA-45976563-4");
+pageTracker._trackPageview();
+} catch(err) {}</script>
+
 
 </body>
 </html>
diff --git a/docs/_build/html/_modules/mail_agent.html b/docs/_build/html/_modules/mail_agent.html
@@ -386,7 +386,18 @@ <h1>Source code for mail_agent</h1><div class="highlight"><pre>
           SphinxRtdTheme.StickyNav.enable();
       });
   </script>
-
+
+
+<script type="text/javascript">
+var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
+document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
+</script>
+<script type="text/javascript">
+try {
+var pageTracker = _gat._getTracker("UA-45976563-4");
+pageTracker._trackPageview();
+} catch(err) {}</script>
+
 
 </body>
 </html>
diff --git a/docs/_build/html/_modules/node_query_handler.html b/docs/_build/html/_modules/node_query_handler.html
@@ -105,6 +105,17 @@
 
   <h1>Source code for node_query_handler</h1><div class="highlight"><pre>
 <span class="c"># -*- coding: UTF-8 -*-</span>
+
+<span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">| This Modules handles all the query to the nodes.</span>
+<span class="sd">| it will receive the data from the router_handler and it will send the query to the nodes.</span>
+<span class="sd">| It will also retry sending the message if the node doesn&#39;t answer right or if doesn&#39;t answer at all.</span>
+<span class="sd">| If the nodes confirm the command was received then this module will tell onos to set the web object status </span>
+<span class="sd">| to reflect the new node status after the command was received.</span>
+<span class="sd">|</span>
+<span class="sd">&quot;&quot;&quot;</span>
+
+
 <span class="kn">from</span> <span class="nn">globalVar</span> <span class="kn">import</span> <span class="o">*</span>
 
 
@@ -366,7 +377,18 @@ <h1>Source code for node_query_handler</h1><div class="highlight"><pre>
           SphinxRtdTheme.StickyNav.enable();
       });
   </script>
-
+
+
+<script type="text/javascript">
+var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
+document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
+</script>
+<script type="text/javascript">
+try {
+var pageTracker = _gat._getTracker("UA-45976563-4");
+pageTracker._trackPageview();
+} catch(err) {}</script>
+
 
 </body>
 </html>
diff --git a/docs/_build/html/_modules/pcduino.html b/docs/_build/html/_modules/pcduino.html
@@ -858,7 +858,18 @@ <h1>Source code for pcduino</h1><div class="highlight"><pre>
           SphinxRtdTheme.StickyNav.enable();
       });
   </script>
-
+
+
+<script type="text/javascript">
+var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
+document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
+</script>
+<script type="text/javascript">
+try {
+var pageTracker = _gat._getTracker("UA-45976563-4");
+pageTracker._trackPageview();
+} catch(err) {}</script>
+
 
 </body>
 </html>
diff --git a/docs/_build/html/_modules/router_handler.html b/docs/_build/html/_modules/router_handler.html
@@ -106,6 +106,30 @@
   <h1>Source code for router_handler</h1><div class="highlight"><pre>
 <span class="c"># -*- coding: UTF-8 -*-</span>
 
+
+<span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">| This Modules handles all the comunication to nodes.</span>
+<span class="sd">| It will routes the varius commands knowing where to send them based on the node address.</span>
+<span class="sd">|</span>
+<span class="sd">| If the node_address of the given receiver is 0 the data will be written to the local OnosCenter pins.</span>
+<span class="sd">|</span>
+<span class="sd">| if the node_address of the given receiver is 1 the data will be sent to the OnosCenter serial port to an arduino (not implemented yet)</span>
+<span class="sd">|</span>
+<span class="sd">| If the node_address of the given receiver is between 2 to 255 :</span>
+<span class="sd">|   OnosCenter will send the command to write the data to an arduino wich will then transmit it to the desired wireless node.(not implemented yet)</span>
+<span class="sd">|</span>
+<span class="sd">| If the node_address of the given receiver is a string greater than 6 characters:</span>
+<span class="sd">    The data will be sent over ethernet commmunication.</span>
+<span class="sd">|</span>
+
+
+
+
+<span class="sd">&quot;&quot;&quot;</span>
+
+
+
+
 <span class="kn">from</span> <span class="nn">globalVar</span> <span class="kn">import</span> <span class="o">*</span>
 <span class="kn">from</span> <span class="nn">node_query_handler</span> <span class="kn">import</span> <span class="o">*</span>
 
@@ -708,7 +732,18 @@ <h1>Source code for router_handler</h1><div class="highlight"><pre>
           SphinxRtdTheme.StickyNav.enable();
       });
   </script>
-
+
+
+<script type="text/javascript">
+var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
+document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
+</script>
+<script type="text/javascript">
+try {
+var pageTracker = _gat._getTracker("UA-45976563-4");
+pageTracker._trackPageview();
+} catch(err) {}</script>
+
 
 </body>
 </html>
diff --git a/docs/_build/html/_modules/web_object.html b/docs/_build/html/_modules/web_object.html
@@ -858,7 +858,18 @@ <h1>Source code for web_object</h1><div class="highlight"><pre>
           SphinxRtdTheme.StickyNav.enable();
       });
   </script>
-
+
+
+<script type="text/javascript">
+var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
+document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
+</script>
+<script type="text/javascript">
+try {
+var pageTracker = _gat._getTracker("UA-45976563-4");
+pageTracker._trackPageview();
+} catch(err) {}</script>
+
 
 </body>
 </html>
diff --git a/docs/_build/html/_modules/webserver.html b/docs/_build/html/_modules/webserver.html
@@ -5874,7 +5874,18 @@ <h1>Source code for webserver</h1><div class="highlight"><pre>
           SphinxRtdTheme.StickyNav.enable();
       });
   </script>
-
+
+
+<script type="text/javascript">
+var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
+document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
+</script>
+<script type="text/javascript">
+try {
+var pageTracker = _gat._getTracker("UA-45976563-4");
+pageTracker._trackPageview();
+} catch(err) {}</script>
+
 
 </body>
 </html>
diff --git a/docs/_build/html/_sources/index.txt b/docs/_build/html/_sources/index.txt
@@ -31,4 +31,7 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
+.. image:: https://ga-beacon.appspot.com/UA-45976563-4/beacon.en.html?pixel
+
+
 
diff --git a/docs/_build/html/arduino_handler.html b/docs/_build/html/arduino_handler.html
@@ -214,7 +214,18 @@
           SphinxRtdTheme.StickyNav.enable();
       });
   </script>
-
+
+
+<script type="text/javascript">
+var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
+document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
+</script>
+<script type="text/javascript">
+try {
+var pageTracker = _gat._getTracker("UA-45976563-4");
+pageTracker._trackPageview();
+} catch(err) {}</script>
+
 
 </body>
 </html>
diff --git a/docs/_build/html/arduinoserial.html b/docs/_build/html/arduinoserial.html
@@ -237,7 +237,18 @@
           SphinxRtdTheme.StickyNav.enable();
       });
   </script>
-
+
+
+<script type="text/javascript">
+var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
+document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
+</script>
+<script type="text/javascript">
+try {
+var pageTracker = _gat._getTracker("UA-45976563-4");
+pageTracker._trackPageview();
+} catch(err) {}</script>
+
 
 </body>
 </html>
diff --git a/docs/_build/html/conf.html b/docs/_build/html/conf.html
@@ -214,7 +214,18 @@
           SphinxRtdTheme.StickyNav.enable();
       });
   </script>
-
+
+
+<script type="text/javascript">
+var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
+document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
+</script>
+<script type="text/javascript">
+try {
+var pageTracker = _gat._getTracker("UA-45976563-4");
+pageTracker._trackPageview();
+} catch(err) {}</script>
+
 
 </body>
 </html>
diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html
@@ -1198,7 +1198,18 @@ <h2 id="W">W</h2>
           SphinxRtdTheme.StickyNav.enable();
       });
   </script>
-
+
+
+<script type="text/javascript">
+var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
+document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
+</script>
+<script type="text/javascript">
+try {
+var pageTracker = _gat._getTracker("UA-45976563-4");
+pageTracker._trackPageview();
+} catch(err) {}</script>
+
 
 </body>
 </html>