Commit e115887e authored by Jorge's avatar Jorge
Browse files

add period attribute

parent 4aa33a4b
......@@ -268,7 +268,7 @@ thread.start( <span class="keyword">function</span>()
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-06-09 00:41:54 </i>
<i style="float:right;">Last updated 2019-06-09 01:11:31 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
......
......@@ -110,7 +110,7 @@ robot.hsm = hsm
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-06-09 00:41:54 </i>
<i style="float:right;">Last updated 2019-06-09 01:11:31 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
......
......@@ -110,7 +110,7 @@ color.color_cb.remove(dump_color_change)</pre>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-06-09 00:41:54 </i>
<i style="float:right;">Last updated 2019-06-09 01:11:31 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
......
......@@ -116,7 +116,7 @@ ledr.clear()</pre>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-06-09 00:41:54 </i>
<i style="float:right;">Last updated 2019-06-09 01:11:31 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
......
......@@ -118,7 +118,7 @@ ledr.clear()
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-06-09 00:41:54 </i>
<i style="float:right;">Last updated 2019-06-09 01:11:31 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
......
......@@ -127,7 +127,7 @@ omni.enable(<span class="keyword">false</span>)</pre>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-06-09 00:41:54 </i>
<i style="float:right;">Last updated 2019-06-09 01:11:31 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
......
......@@ -103,7 +103,7 @@ proximity.enable(<span class="keyword">false</span>)</pre>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-06-09 00:41:54 </i>
<i style="float:right;">Last updated 2019-06-09 01:11:31 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
......
......@@ -103,7 +103,7 @@ wifi_net.cb.append(dump_msg)
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-06-09 00:41:54 </i>
<i style="float:right;">Last updated 2019-06-09 01:11:31 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
......
......@@ -187,7 +187,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-06-09 00:41:54 </i>
<i style="float:right;">Last updated 2019-06-09 01:11:31 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
......
......@@ -188,7 +188,7 @@ cb_list.append( function() print &quot;call!&quot; end )
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-06-09 00:41:54 </i>
<i style="float:right;">Last updated 2019-06-09 01:11:31 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
......
......@@ -263,7 +263,7 @@ color.enable(<span class="keyword">true</span>)</pre>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-06-09 00:41:54 </i>
<i style="float:right;">Last updated 2019-06-09 01:11:31 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
......
......@@ -138,6 +138,10 @@
<td class="name" nowrap><a href="#cb">cb</a></td>
<td class="summary">The callback module for the range sensor ring.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#period">period</a></td>
<td class="summary">Sampling period in ms.</td>
</tr>
</table>
<br/>
......@@ -353,6 +357,29 @@ laser.enable(<span class="keyword">true</span>)</pre>
</dd>
<dt>
<a name = "period"></a>
<strong>period</strong>
</dt>
<dd>
Sampling period in ms. Initalized from <code>nvs.read(&quot;laser&quot;,&quot;period&quot;)</code>.
<ul>
<li><span class="parameter">period</span>
<span class="types"><span class="type">integer</span></span>
(<em>default</em> 100)
</li>
</ul>
</dd>
</dl>
......@@ -361,7 +388,7 @@ laser.enable(<span class="keyword">true</span>)</pre>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-06-09 00:41:54 </i>
<i style="float:right;">Last updated 2019-06-09 01:11:31 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
......
......@@ -384,7 +384,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-06-09 00:41:54 </i>
<i style="float:right;">Last updated 2019-06-09 01:11:31 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
......
......@@ -85,7 +85,7 @@
<p>
<p> Configuration is loaded using <code>nvs.read(&quot;omni&quot;, parameter)</code> calls, where the
available parameters are: </p>
available parameters are:</p>
<ul>
<li><p><code>&quot;maxpower&quot;</code> Limits the maximum power output of the motors as percentage.
......@@ -177,8 +177,6 @@
</dt>
<dd>
Enable/disable motors.
To correctly handle multiple users of the module, please balance enables and
disables: if you enable, please disable when you stop neededing it.
<h3>Parameters:</h3>
......@@ -202,9 +200,7 @@
</dt>
<dd>
Enables the encoder callback.
When enabled, wheel movement will trigger <a href="../modules/omni.html#omni.encoder.cb">omni.encoder.cb</a>. <br/>
To correctly handle multiple users of the module, please balance enables and
disables: if you enable, please disable when you stop neededing it.
When enabled, wheel movement will trigger <a href="../modules/omni.html#omni.encoder.cb">omni.encoder.cb</a>.
<h3>Parameters:</h3>
......@@ -296,7 +292,7 @@ omni.encoder.cb.append( <span class="keyword">function</span> (id, dir, count) <
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-06-09 00:41:54 </i>
<i style="float:right;">Last updated 2019-06-09 01:11:31 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
......
......@@ -202,7 +202,7 @@ proximity.cb.append( <span class="keyword">function</span> (v) <span class="glob
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-06-09 00:41:54 </i>
<i style="float:right;">Last updated 2019-06-09 01:11:31 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
......
......@@ -231,7 +231,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-06-09 00:41:54 </i>
<i style="float:right;">Last updated 2019-06-09 01:11:31 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
......
......@@ -210,7 +210,7 @@ wifi_net.cb.append( <span class="keyword">function</span> (msg, ip, port) <span
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-06-09 00:41:54 </i>
<i style="float:right;">Last updated 2019-06-09 01:11:31 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
......
......@@ -104,7 +104,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-06-09 00:41:54 </i>
<i style="float:right;">Last updated 2019-06-09 01:11:31 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
......
......@@ -81,16 +81,16 @@
<p> Uses state machines to control the robot. This program is intended to
be loaded from the <a href="../scripts/autorun.html#">autorun</a> script. To achieve this, set <code>nvs.write(&quot;autorun&quot;, &quot;main&quot; &quot;main_ahsm.lua&quot;)</code>.
This program loads and initalizes <a href="../modules/robot.html#">robot</a> and ahsm. </p>
This program loads and initalizes <a href="../modules/robot.html#">robot</a> and ahsm.</p>
<p> Configuration is loaded using <code>nvs.read(&quot;ahsm&quot;, parameter)</code> calls, where the
available parameters are: </p>
available parameters are:</p>
<ul>
<li><p><code>&quot;debugger&quot;</code> the debug output system, like ahsm's "debug_plain". Defaults to nil (disabled) </p></li>
<li><p><code>&quot;dot_period&quot;</code> if positive, a period in sec for printing a dot graph of the root state machine. Defaults to -1 (disabled) </p></li>
<li><p><code>&quot;root&quot;</code> a composite state to be used as root for the state machine. This must be the name of library to be required, which will return an ahsm state. Defaults to "states.test" </p></li>
<li><p><code>&quot;timestep&quot;</code> time in ms between sweeps to check for timed out transitions. Defaults to 10 </p></li>
<li><p><code>&quot;debugger&quot;</code> the debug output system, like ahsm's "debug_plain". Defaults to nil (disabled)</p></li>
<li><p><code>&quot;dot_period&quot;</code> if positive, a period in sec for printing a dot graph of the root state machine. Defaults to -1 (disabled)</p></li>
<li><p><code>&quot;root&quot;</code> a composite state to be used as root for the state machine. This must be the name of library to be required, which will return an ahsm state. Defaults to "states.test"</p></li>
<li><p><code>&quot;timestep&quot;</code> time in ms between sweeps to check for timed out transitions. Defaults to 10</p></li>
</ul>
</p>
......@@ -106,7 +106,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-06-09 00:41:54 </i>
<i style="float:right;">Last updated 2019-06-09 01:11:31 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
......
......@@ -97,7 +97,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-06-09 00:41:54 </i>
<i style="float:right;">Last updated 2019-06-09 01:11:31 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment