Update documentation
This commit is contained in:
Konstantin Lampalzer
parent
e9d663963d
commit
16a3609f9f
21 changed files with 854 additions and 28 deletions
|
|
@ -90,7 +90,9 @@
|
|||
<li class="toctree-l1"><a class="reference internal" href="lib/Linefollower.html">Linefollower Examples</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="lib/Logging.html">Logging</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="lib/Motor.html">Motor</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="lib/Odom.html">Odometry</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="lib/QC.html">Quality Control</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="lib/Robot.html">Robot</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="lib/Servo.html">Servo</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="lib/Vision.html">Vision</a></li>
|
||||
</ul>
|
||||
|
|
@ -166,12 +168,16 @@
|
|||
| <a href="#D"><strong>D</strong></a>
|
||||
| <a href="#E"><strong>E</strong></a>
|
||||
| <a href="#G"><strong>G</strong></a>
|
||||
| <a href="#H"><strong>H</strong></a>
|
||||
| <a href="#I"><strong>I</strong></a>
|
||||
| <a href="#L"><strong>L</strong></a>
|
||||
| <a href="#M"><strong>M</strong></a>
|
||||
| <a href="#O"><strong>O</strong></a>
|
||||
| <a href="#P"><strong>P</strong></a>
|
||||
| <a href="#R"><strong>R</strong></a>
|
||||
| <a href="#S"><strong>S</strong></a>
|
||||
| <a href="#T"><strong>T</strong></a>
|
||||
| <a href="#U"><strong>U</strong></a>
|
||||
| <a href="#W"><strong>W</strong></a>
|
||||
|
||||
</div>
|
||||
|
|
@ -187,10 +193,14 @@
|
|||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="lib/Motor.html#compLib.Motor.Motor.active_break">active_break() (compLib.Motor.Motor static method)</a>
|
||||
</li>
|
||||
<li><a href="lib/Motor.html#compLib.Motor.Motor.all_off">all_off() (compLib.Motor.Motor static method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="lib/Motor.html#compLib.Motor.Motor.all_off">all_off() (compLib.Motor.Motor static method)</a>
|
||||
<li><a href="lib/Robot.html#compLib.Robot.Robot.ARBOR_LENGTH_M">ARBOR_LENGTH_M (compLib.Robot.Robot attribute)</a>
|
||||
</li>
|
||||
<li><a href="lib/Robot.html#compLib.Robot.Robot.ARBOR_LENGTH_MM">ARBOR_LENGTH_MM (compLib.Robot.Robot attribute)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
|
@ -202,6 +212,8 @@
|
|||
|
||||
<ul>
|
||||
<li><a href="lib/Encoder.html#compLib.Encoder.Encoder.clear">(compLib.Encoder.Encoder static method)</a>
|
||||
</li>
|
||||
<li><a href="lib/Odom.html#compLib.Odom.Odom.clear">(compLib.Odom.Odom static method)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
</ul></td>
|
||||
|
|
@ -246,21 +258,37 @@
|
|||
</li>
|
||||
<li><a href="lib/Api.html#compLib.Api.DoubleElim.get_items">get_items() (compLib.Api.DoubleElim static method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="lib/Logging.html#compLib.LogstashLogging.Logging.get_logger">get_logger() (compLib.LogstashLogging.Logging static method)</a>
|
||||
</li>
|
||||
<li><a href="lib/Api.html#compLib.Api.Seeding.get_material">get_material() (compLib.Api.Seeding static method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="lib/Api.html#compLib.Api.DoubleElim.get_meteoroids">get_meteoroids() (compLib.Api.DoubleElim static method)</a>
|
||||
</li>
|
||||
<li><a href="lib/Motor.html#compLib.Motor.Motor.get_motor_curve">get_motor_curve() (compLib.Motor.Motor static method)</a>
|
||||
</li>
|
||||
<li><a href="lib/Odom.html#compLib.Odom.Odom.get_odom">get_odom() (compLib.Odom.Odom static method)</a>
|
||||
</li>
|
||||
<li><a href="lib/Api.html#compLib.Api.DoubleElim.get_opponent">get_opponent() (compLib.Api.DoubleElim static method)</a>
|
||||
</li>
|
||||
<li><a href="lib/Odom.html#compLib.Odom.Odometry.get_orientation">get_orientation() (compLib.Odom.Odometry method)</a>
|
||||
</li>
|
||||
<li><a href="lib/Api.html#compLib.Api.DoubleElim.get_position">get_position() (compLib.Api.DoubleElim static method)</a>
|
||||
</li>
|
||||
<li><a href="lib/Api.html#compLib.Api.DoubleElim.get_scores">get_scores() (compLib.Api.DoubleElim static method)</a>
|
||||
</li>
|
||||
<li><a href="lib/Odom.html#compLib.Odom.Odometry.get_x">get_x() (compLib.Odom.Odometry method)</a>
|
||||
</li>
|
||||
<li><a href="lib/Odom.html#compLib.Odom.Odometry.get_y">get_y() (compLib.Odom.Odometry method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="H">H</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="lib/Encoder.html#compLib.Encoder.Encoder.handle_wrap">handle_wrap() (compLib.Encoder.Encoder static method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
|
@ -276,10 +304,12 @@
|
|||
<h2 id="L">L</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="lib/Api.html#compLib.Api.Seeding.list_cargo">list_cargo() (compLib.Api.Seeding static method)</a>
|
||||
<li><a href="lib/Robot.html#compLib.Robot.Robot.LEFT_PORT">LEFT_PORT (compLib.Robot.Robot attribute)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="lib/Api.html#compLib.Api.Seeding.list_cargo">list_cargo() (compLib.Api.Seeding static method)</a>
|
||||
</li>
|
||||
<li><a href="lib/Logging.html#compLib.LogstashLogging.Logging">Logging (class in compLib.LogstashLogging)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
|
|
@ -293,6 +323,18 @@
|
|||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="O">O</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="lib/Odom.html#compLib.Odom.Odom">Odom (class in compLib.Odom)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="lib/Odom.html#compLib.Odom.Odometry">Odometry (class in compLib.Odom)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="P">P</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
|
|
@ -320,9 +362,17 @@
|
|||
<li><a href="lib/IRSensor.html#compLib.IRSensor.IRSensor.read">(compLib.IRSensor.IRSensor static method)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="lib/Encoder.html#compLib.Encoder.Encoder.read_all">read_all() (compLib.Encoder.Encoder static method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="lib/Encoder.html#compLib.Encoder.Encoder.read_all_raw">read_all_raw() (compLib.Encoder.Encoder static method)</a>
|
||||
</li>
|
||||
<li><a href="lib/Encoder.html#compLib.Encoder.Encoder.read_raw">read_raw() (compLib.Encoder.Encoder static method)</a>
|
||||
</li>
|
||||
<li><a href="lib/Robot.html#compLib.Robot.Robot.RIGHT_PORT">RIGHT_PORT (compLib.Robot.Robot attribute)</a>
|
||||
</li>
|
||||
<li><a href="lib/Robot.html#compLib.Robot.Robot">Robot (class in compLib.Robot)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
|
@ -349,8 +399,32 @@
|
|||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="T">T</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="lib/Robot.html#compLib.Robot.Robot.TICKS_PER_METER">TICKS_PER_METER (compLib.Robot.Robot attribute)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="lib/Robot.html#compLib.Robot.Robot.TICKS_PER_TURN">TICKS_PER_TURN (compLib.Robot.Robot attribute)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="U">U</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="lib/Odom.html#compLib.Odom.Odom.update">update() (compLib.Odom.Odom static method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="W">W</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="lib/Robot.html#compLib.Robot.Robot.WHEEL_CIRCUMFERENCE_MM">WHEEL_CIRCUMFERENCE_MM (compLib.Robot.Robot attribute)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="lib/Display.html#compLib.Display.Display.write">write() (compLib.Display.Display static method)</a>
|
||||
</li>
|
||||
|
|
@ -370,7 +444,7 @@
|
|||
<div role="contentinfo">
|
||||
<p>
|
||||
|
||||
© Copyright 2021, robo4you
|
||||
© Copyright 2022, Verein zur Förderung von Wissenschaft und Technik an Schulen (F-WuTS)
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
|
|
|||
Reference in a new issue