Update documentation
This commit is contained in:
Konstantin Lampalzer
parent
527965ac0f
commit
ccd46ee8a7
20 changed files with 623 additions and 543 deletions
151
genindex.html
151
genindex.html
|
|
@ -84,10 +84,9 @@
|
|||
<li class="toctree-l1"><a class="reference internal" href="other/usage.html">Usage</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="lib/Api.html">Api</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="lib/Aruco.html">Aruco</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="lib/Battery.html">Battery</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="lib/Buzzer.html">Buzzer</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="lib/Display.html">Display</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="lib/Encoder.html">Encoder</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="lib/IRSensor.html">Infrared Sensor</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="lib/IRWrapper.html">Infrared Wrapper</a></li>
|
||||
<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>
|
||||
|
|
@ -160,82 +159,30 @@
|
|||
<h1 id="index">Index</h1>
|
||||
|
||||
<div class="genindex-jumpbox">
|
||||
<a href="#_"><strong>_</strong></a>
|
||||
| <a href="#A"><strong>A</strong></a>
|
||||
| <a href="#B"><strong>B</strong></a>
|
||||
| <a href="#C"><strong>C</strong></a>
|
||||
| <a href="#D"><strong>D</strong></a>
|
||||
<a href="#C"><strong>C</strong></a>
|
||||
| <a href="#E"><strong>E</strong></a>
|
||||
| <a href="#G"><strong>G</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="#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>
|
||||
|
||||
</div>
|
||||
<h2 id="_">_</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="lib/Vision.html#compLib.Vision.__Streaming">__Streaming (class in compLib.Vision)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="A">A</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="lib/IRWrapper.html#compLib.IRWrapper.IRWrapper.adjust_for_calibration">adjust_for_calibration() (compLib.IRWrapper.IRWrapper 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>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="B">B</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="lib/Battery.html#compLib.Battery.Battery">Battery (class in compLib.Battery)</a>
|
||||
</li>
|
||||
<li><a href="lib/IRSensor.html#compLib.IRSensor.IRSensor.bottom_left">bottom_left() (compLib.IRSensor.IRSensor static method)</a>
|
||||
</li>
|
||||
<li><a href="lib/IRSensor.html#compLib.IRSensor.IRSensor.bottom_left_analog">bottom_left_analog() (compLib.IRSensor.IRSensor static method)</a>
|
||||
</li>
|
||||
<li><a href="lib/IRWrapper.html#compLib.IRWrapper.IRWrapper.bottom_left_calibrated">bottom_left_calibrated() (compLib.IRWrapper.IRWrapper static method)</a>
|
||||
</li>
|
||||
<li><a href="lib/IRSensor.html#compLib.IRSensor.IRSensor.bottom_middle">bottom_middle() (compLib.IRSensor.IRSensor static method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="lib/IRSensor.html#compLib.IRSensor.IRSensor.bottom_middle_analog">bottom_middle_analog() (compLib.IRSensor.IRSensor static method)</a>
|
||||
</li>
|
||||
<li><a href="lib/IRWrapper.html#compLib.IRWrapper.IRWrapper.bottom_middle_calibrated">bottom_middle_calibrated() (compLib.IRWrapper.IRWrapper static method)</a>
|
||||
</li>
|
||||
<li><a href="lib/IRSensor.html#compLib.IRSensor.IRSensor.bottom_right">bottom_right() (compLib.IRSensor.IRSensor static method)</a>
|
||||
</li>
|
||||
<li><a href="lib/IRSensor.html#compLib.IRSensor.IRSensor.bottom_right_analog">bottom_right_analog() (compLib.IRSensor.IRSensor static method)</a>
|
||||
</li>
|
||||
<li><a href="lib/IRWrapper.html#compLib.IRWrapper.IRWrapper.bottom_right_calibrated">bottom_right_calibrated() (compLib.IRWrapper.IRWrapper static method)</a>
|
||||
</li>
|
||||
<li><a href="lib/Buzzer.html#compLib.Buzzer.Buzzer">Buzzer (class in compLib.Buzzer)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="C">C</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="lib/IRWrapper.html#compLib.IRWrapper.IRWrapper.calibrate">calibrate() (compLib.IRWrapper.IRWrapper static method)</a>
|
||||
<li><a href="lib/Encoder.html#compLib.Encoder.Encoder.clear">clear() (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.clear_all">clear_all() (compLib.Encoder.Encoder static method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="D">D</h2>
|
||||
<h2 id="E">E</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.DoubleElim">DoubleElim (class in compLib.Api)</a>
|
||||
<li><a href="lib/Encoder.html#compLib.Encoder.Encoder">Encoder (class in compLib.Encoder)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
|
@ -243,35 +190,7 @@
|
|||
<h2 id="G">G</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="lib/Vision.html#compLib.Vision.__Streaming.get_frame">get_frame() (compLib.Vision.__Streaming method)</a>
|
||||
</li>
|
||||
<li><a href="lib/Api.html#compLib.Api.DoubleElim.get_goal">get_goal() (compLib.Api.DoubleElim static method)</a>
|
||||
</li>
|
||||
<li><a href="lib/Api.html#compLib.Api.DoubleElim.get_items">get_items() (compLib.Api.DoubleElim static method)</a>
|
||||
</li>
|
||||
<li><a href="lib/Logging.html#compLib.LogstashLogging.Logging.get_logger">get_logger() (compLib.LogstashLogging.Logging static method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="lib/Api.html#compLib.Api.DoubleElim.get_opponent">get_opponent() (compLib.Api.DoubleElim static method)</a>
|
||||
</li>
|
||||
<li><a href="lib/Api.html#compLib.Api.Seeding.get_park">get_park() (compLib.Api.Seeding static 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>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="I">I</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="lib/IRSensor.html#compLib.IRSensor.IRSensor">IRSensor (class in compLib.IRSensor)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="lib/IRWrapper.html#compLib.IRWrapper.IRWrapper">IRWrapper (class in compLib.IRWrapper)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
|
@ -284,62 +203,22 @@
|
|||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="M">M</h2>
|
||||
<h2 id="R">R</h2>
|
||||
<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">Motor (class in compLib.Motor)</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>
|
||||
<li><a href="lib/Api.html#compLib.Api.Seeding.pay_park">pay_park() (compLib.Api.Seeding static method)</a>
|
||||
</li>
|
||||
<li><a href="lib/Battery.html#compLib.Battery.Battery.percent">percent() (compLib.Battery.Battery static method)</a>
|
||||
<li><a href="lib/Encoder.html#compLib.Encoder.Encoder.read">read() (compLib.Encoder.Encoder static method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="lib/Api.html#compLib.Api.Position">Position (class in compLib.Api)</a>
|
||||
</li>
|
||||
<li><a href="lib/Motor.html#compLib.Motor.Motor.power">power() (compLib.Motor.Motor static method)</a>
|
||||
</li>
|
||||
<li><a href="lib/Vision.html#compLib.Vision.__Streaming.publish_frame">publish_frame() (compLib.Vision.__Streaming method)</a>
|
||||
<li><a href="lib/Encoder.html#compLib.Encoder.Encoder.read_raw">read_raw() (compLib.Encoder.Encoder static method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="S">S</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">Seeding (class in compLib.Api)</a>
|
||||
</li>
|
||||
<li><a href="lib/Servo.html#compLib.Servo.Servo">Servo (class in compLib.Servo)</a>
|
||||
</li>
|
||||
<li><a href="lib/Buzzer.html#compLib.Buzzer.Buzzer.set">set() (compLib.Buzzer.Buzzer static method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="lib/Logging.html#compLib.LogstashLogging.Logging.set_debug">set_debug() (compLib.LogstashLogging.Logging static method)</a>
|
||||
</li>
|
||||
<li><a href="lib/Servo.html#compLib.Servo.Servo.set_position">set_position() (compLib.Servo.Servo static method)</a>
|
||||
</li>
|
||||
<li><a href="lib/Servo.html#compLib.Servo.Servo.setup_position">setup_position() (compLib.Servo.Servo static method)</a>
|
||||
</li>
|
||||
<li><a href="lib/Api.html#compLib.Api.Seeding.simon_says">simon_says() (compLib.Api.Seeding static method)</a>
|
||||
</li>
|
||||
</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/IRSensor.html#compLib.IRSensor.IRSensor.top_left_percent">top_left_percent() (compLib.IRSensor.IRSensor static method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="lib/IRSensor.html#compLib.IRSensor.IRSensor.top_right_percent">top_right_percent() (compLib.IRSensor.IRSensor static method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
|
|
|||
Reference in a new issue