compAIR/compLIB
compAIR/compLIB
Archived
4
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Update documentation

Browse source
This commit is contained in:
Joel Klimont 2022-11-09 02:27:47 +01:00
parent 7cd41068fc
commit e289671c82
11 changed files with 93 additions and 242 deletions
Download patch file Download diff file Expand all files Collapse all files

91
lib/index.html
View file

@ -21,7 +21,7 @@
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Stichwortverzeichnis" href="../genindex.html" />
<link rel="search" title="Suche" href="../search.html" />
<link rel="next" title="Double Elimination" href="classes/DoubleElimination.html" />
<link rel="next" title="Hardware" href="../other/hardware.html" />
<link rel="prev" title="Beispiele" href="../other/usage.html" />
</head>
@ -46,14 +46,7 @@
<li class="toctree-l1"><a class="reference internal" href="../software/installation.html">Installationsanweisungen</a></li>
<li class="toctree-l1"><a class="reference internal" href="../faq.html">FAQ</a></li>
<li class="toctree-l1"><a class="reference internal" href="../other/usage.html">Beispiele</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">compLib</a><ul>
<li class="toctree-l2"><a class="reference internal" href="classes/DoubleElimination.html">Double Elimination</a></li>
<li class="toctree-l2"><a class="reference internal" href="classes/Encoder.html">Encoder</a></li>
<li class="toctree-l2"><a class="reference internal" href="classes/IRSensor.html">Infrarot Sensoren</a></li>
<li class="toctree-l2"><a class="reference internal" href="classes/Motor.html">Motoren</a></li>
<li class="toctree-l2"><a class="reference internal" href="classes/Seeding.html">Seeding</a></li>
</ul>
</li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">compLib</a></li>
<li class="toctree-l1"><a class="reference internal" href="../other/hardware.html">Hardware</a></li>
</ul>
@ -83,84 +76,6 @@
<section id="complib">
<h1>compLib<a class="headerlink" href="#complib" title="Permalink to this heading"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="classes/DoubleElimination.html">Double Elimination</a><ul>
<li class="toctree-l2"><a class="reference internal" href="classes/DoubleElimination.html#dokumentation-der-klasse">Dokumentation der Klasse</a><ul>
<li class="toctree-l3"><a class="reference internal" href="classes/DoubleElimination.html#compLib.DoubleElimination.Position"><code class="docutils literal notranslate"><span class="pre">Position</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="classes/DoubleElimination.html#compLib.DoubleElimination.DoubleElim"><code class="docutils literal notranslate"><span class="pre">DoubleElim</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="classes/DoubleElimination.html#compLib.DoubleElimination.DoubleElim.get_goal"><code class="docutils literal notranslate"><span class="pre">DoubleElim.get_goal()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="classes/DoubleElimination.html#compLib.DoubleElimination.DoubleElim.get_items"><code class="docutils literal notranslate"><span class="pre">DoubleElim.get_items()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="classes/DoubleElimination.html#compLib.DoubleElimination.DoubleElim.get_opponent"><code class="docutils literal notranslate"><span class="pre">DoubleElim.get_opponent()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="classes/DoubleElimination.html#compLib.DoubleElimination.DoubleElim.get_pos"><code class="docutils literal notranslate"><span class="pre">DoubleElim.get_pos()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="classes/DoubleElimination.html#compLib.DoubleElimination.DoubleElim.get_scores"><code class="docutils literal notranslate"><span class="pre">DoubleElim.get_scores()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="classes/Encoder.html">Encoder</a><ul>
<li class="toctree-l2"><a class="reference internal" href="classes/Encoder.html#dokumentation-der-klasse">Dokumentation der Klasse</a><ul>
<li class="toctree-l3"><a class="reference internal" href="classes/Encoder.html#compLib.Encoder.Encoder"><code class="docutils literal notranslate"><span class="pre">Encoder</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="classes/Encoder.html#compLib.Encoder.Encoder.read_all_positions"><code class="docutils literal notranslate"><span class="pre">Encoder.read_all_positions()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="classes/Encoder.html#compLib.Encoder.Encoder.read_all_velocities"><code class="docutils literal notranslate"><span class="pre">Encoder.read_all_velocities()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="classes/IRSensor.html">Infrarot Sensoren</a><ul>
<li class="toctree-l2"><a class="reference internal" href="classes/IRSensor.html#dokumentation-der-klasse">Dokumentation der Klasse</a><ul>
<li class="toctree-l3"><a class="reference internal" href="classes/IRSensor.html#compLib.IRSensor.IRSensor"><code class="docutils literal notranslate"><span class="pre">IRSensor</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="classes/IRSensor.html#compLib.IRSensor.IRSensor.disable"><code class="docutils literal notranslate"><span class="pre">IRSensor.disable()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="classes/IRSensor.html#compLib.IRSensor.IRSensor.enable"><code class="docutils literal notranslate"><span class="pre">IRSensor.enable()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="classes/IRSensor.html#compLib.IRSensor.IRSensor.read_all"><code class="docutils literal notranslate"><span class="pre">IRSensor.read_all()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="classes/Motor.html">Motoren</a><ul>
<li class="toctree-l2"><a class="reference internal" href="classes/Motor.html#dokumentation-der-klasse">Dokumentation der Klasse</a><ul>
<li class="toctree-l3"><a class="reference internal" href="classes/Motor.html#compLib.Motor.Motor"><code class="docutils literal notranslate"><span class="pre">Motor</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="classes/Motor.html#compLib.Motor.Motor.multiple_power"><code class="docutils literal notranslate"><span class="pre">Motor.multiple_power()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="classes/Motor.html#compLib.Motor.Motor.multiple_pulse_width"><code class="docutils literal notranslate"><span class="pre">Motor.multiple_pulse_width()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="classes/Motor.html#compLib.Motor.Motor.multiple_speed"><code class="docutils literal notranslate"><span class="pre">Motor.multiple_speed()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="classes/Motor.html#compLib.Motor.Motor.power"><code class="docutils literal notranslate"><span class="pre">Motor.power()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="classes/Motor.html#compLib.Motor.Motor.pulse_width"><code class="docutils literal notranslate"><span class="pre">Motor.pulse_width()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="classes/Motor.html#compLib.Motor.Motor.speed"><code class="docutils literal notranslate"><span class="pre">Motor.speed()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="classes/Motor.html#genauere-informationen">Genauere Informationen</a><ul>
<li class="toctree-l3"><a class="reference internal" href="classes/Motor.html#power-vs-speed-vs-pulsewidth">Power vs Speed vs PulseWidth</a></li>
<li class="toctree-l3"><a class="reference internal" href="classes/Motor.html#normal-vs-multiple">Normal vs Multiple</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="classes/Motor.html#beispiele">Beispiele</a><ul>
<li class="toctree-l3"><a class="reference internal" href="classes/Motor.html#vorwarts-fahren">Vorwärts fahren</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="classes/Seeding.html">Seeding</a><ul>
<li class="toctree-l2"><a class="reference internal" href="classes/Seeding.html#dokumentation-der-klasse">Dokumentation der Klasse</a><ul>
<li class="toctree-l3"><a class="reference internal" href="classes/Seeding.html#compLib.Seeding.Gamestate"><code class="docutils literal notranslate"><span class="pre">Gamestate</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="classes/Seeding.html#compLib.Seeding.Gamestate.get_heuballen"><code class="docutils literal notranslate"><span class="pre">Gamestate.get_heuballen()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="classes/Seeding.html#compLib.Seeding.Gamestate.get_logistic_plan"><code class="docutils literal notranslate"><span class="pre">Gamestate.get_logistic_plan()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="classes/Seeding.html#compLib.Seeding.Gamestate.get_material_deliveries"><code class="docutils literal notranslate"><span class="pre">Gamestate.get_material_deliveries()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</section>
@ -168,7 +83,7 @@
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../other/usage.html" class="btn btn-neutral float-left" title="Beispiele" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Zurück</a>
<a href="classes/DoubleElimination.html" class="btn btn-neutral float-right" title="Double Elimination" accesskey="n" rel="next">Weiter <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="../other/hardware.html" class="btn btn-neutral float-right" title="Hardware" accesskey="n" rel="next">Weiter <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>