Update documentation

This commit is contained in:
Konstantin Lampalzer 2022-10-20 19:55:14 +02:00
parent 49c4040072
commit 3173308b54
31 changed files with 13061 additions and 1263 deletions

View file

@ -13,6 +13,8 @@
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
@ -26,9 +28,12 @@
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
<script src="../../_static/jquery.js"></script>
<script src="../../_static/underscore.js"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="../../_static/doctools.js"></script>
<script src="../../_static/sphinx_highlight.js"></script>
<script src="../../_static/translations.js"></script>
<script type="text/javascript" src="../../_static/js/theme.js"></script>
@ -89,7 +94,10 @@
<li class="toctree-l1"><a class="reference internal" href="../../other/usage.html">Beispiele</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">compLib</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">Encoder</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#dokumentation-der-klasse">Dokumentation der Klasse</a></li>
<li class="toctree-l3"><a class="reference internal" href="#dokumentation-der-klasse">Dokumentation der Klasse</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#compLib.Encoder.Encoder"><code class="docutils literal notranslate"><span class="pre">Encoder</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="IRSensor.html">Infrarot Sensoren</a></li>
@ -164,16 +172,16 @@
<div itemprop="articleBody">
<div class="section" id="encoder">
<span id="lib-encoder"></span><h1>Encoder<a class="headerlink" href="#encoder" title="Link zu dieser Überschrift"></a></h1>
<span id="lib-encoder"></span><h1>Encoder<a class="headerlink" href="#encoder" title="Permalink to this heading"></a></h1>
<div class="section" id="dokumentation-der-klasse">
<h2>Dokumentation der Klasse<a class="headerlink" href="#dokumentation-der-klasse" title="Link zu dieser Überschrift"></a></h2>
<h2>Dokumentation der Klasse<a class="headerlink" href="#dokumentation-der-klasse" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt id="compLib.Encoder.Encoder">
<em class="property">class </em><code class="sig-prename descclassname">compLib.Encoder.</code><code class="sig-name descname">Encoder</code><a class="headerlink" href="#compLib.Encoder.Encoder" title="Link zu dieser Definition"></a></dt>
<dt class="sig sig-object py" id="compLib.Encoder.Encoder">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compLib.Encoder.</span></span><span class="sig-name descname"><span class="pre">Encoder</span></span><a class="headerlink" href="#compLib.Encoder.Encoder" title="Link zu dieser Definition"></a></dt>
<dd><p>Klasse zum Zugriff auf die Encoder der einzelnen Motoren</p>
<dl class="py method">
<dt id="compLib.Encoder.Encoder.read_all_positions">
<em class="property">static </em><code class="sig-name descname">read_all_positions</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#compLib.Encoder.Encoder.read_all_positions" title="Link zu dieser Definition"></a></dt>
<dt class="sig sig-object py" id="compLib.Encoder.Encoder.read_all_positions">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">read_all_positions</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#compLib.Encoder.Encoder.read_all_positions" title="Link zu dieser Definition"></a></dt>
<dd><p>Lesen aller absoluten Positionen der einzelnen Encoder</p>
<dl class="field-list simple">
<dt class="field-odd">Rückgabe</dt>
@ -183,8 +191,8 @@
</dd></dl>
<dl class="py method">
<dt id="compLib.Encoder.Encoder.read_all_velocities">
<em class="property">static </em><code class="sig-name descname">read_all_velocities</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#compLib.Encoder.Encoder.read_all_velocities" title="Link zu dieser Definition"></a></dt>
<dt class="sig sig-object py" id="compLib.Encoder.Encoder.read_all_velocities">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">read_all_velocities</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#compLib.Encoder.Encoder.read_all_velocities" title="Link zu dieser Definition"></a></dt>
<dd><p>Lesen der Geschwindigkeit aller angeschlossenen Motoren.</p>
<dl class="field-list simple">
<dt class="field-odd">Rückgabe</dt>