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

4
_sources/lib/classes/DoubleElimination.rst.txt
View file

@ -3,8 +3,8 @@
Double Elimination
*******************
Dokumentation der Klasse
========================
Dokumentation des Double Elimination Moduls
============================================
.. autoclass:: compLib.DoubleElimination.Position
:members:

4
_sources/lib/classes/Seeding.rst.txt
View file

@ -3,8 +3,8 @@
Seeding
*******
Dokumentation der Klasse
========================
Dokumentation des Seeding Moduls
================================
.. autoclass:: compLib.Seeding.Gamestate
:members:

8
_sources/lib/index.rst.txt
View file

@ -3,6 +3,8 @@ compLib
.. toctree::
:maxdepth: 5
:glob:
classes/*
classes/Motor
classes/Encoder
classes/IRSensor
classes/Seeding
classes/DoubleElimination

101
lib/classes/DoubleElimination.html
View file

@ -20,9 +20,7 @@
<script src="../../_static/translations.js"></script>
<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="Encoder" href="Encoder.html" />
<link rel="prev" title="compLib" href="../index.html" />
<link rel="search" title="Suche" href="../../search.html" />
</head>
<body class="wy-body-for-nav">
@ -41,26 +39,12 @@
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../gettingStarted/index.html">Erste Schritte</a></li>
<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="reference internal" href="../index.html">compLib</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">Double Elimination</a><ul>
<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.DoubleElimination.Position"><code class="docutils literal notranslate"><span class="pre">Position</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#compLib.DoubleElimination.DoubleElim"><code class="docutils literal notranslate"><span class="pre">DoubleElim</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="Encoder.html">Encoder</a></li>
<li class="toctree-l2"><a class="reference internal" href="IRSensor.html">Infrarot Sensoren</a></li>
<li class="toctree-l2"><a class="reference internal" href="Motor.html">Motoren</a></li>
<li class="toctree-l2"><a class="reference internal" href="Seeding.html">Seeding</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../index.html">compLib</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../other/hardware.html">Hardware</a></li>
</ul>
@ -78,7 +62,6 @@
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html" class="icon icon-home"></a></li>
<li class="breadcrumb-item"><a href="../index.html">compLib</a></li>
<li class="breadcrumb-item active">Double Elimination</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/lib/classes/DoubleElimination.rst.txt" rel="nofollow"> Quelltext anzeigen</a>
@ -91,12 +74,21 @@
<section id="double-elimination">
<span id="lib-doubleelim"></span><h1>Double Elimination<a class="headerlink" href="#double-elimination" title="Permalink to this heading"></a></h1>
<section id="dokumentation-der-klasse">
<h2>Dokumentation der Klasse<a class="headerlink" href="#dokumentation-der-klasse" title="Permalink to this heading"></a></h2>
<section id="dokumentation-des-double-elimination-moduls">
<h2>Dokumentation des Double Elimination Moduls<a class="headerlink" href="#dokumentation-des-double-elimination-moduls" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="compLib.DoubleElimination.Position">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compLib.DoubleElimination.</span></span><span class="sig-name descname"><span class="pre">Position</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">degrees</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#compLib.DoubleElimination.Position" title="Link zu dieser Definition"></a></dt>
<dd><p>Datenstruktur, welche eine Position representiert.</p>
<dl class="field-list simple">
<dt class="field-odd">Variablen</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>x</strong> – X Position in Centimeter</p></li>
<li><p><strong>y</strong> – Y Position in Centimeter</p></li>
<li><p><strong>degrees</strong> – Rotation in Grad von -180 bis 180</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
@ -106,41 +98,71 @@
<dl class="py method">
<dt class="sig sig-object py" id="compLib.DoubleElimination.DoubleElim.get_goal">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_goal</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#compLib.DoubleElimination.Position" title="compLib.DoubleElimination.Position"><span class="pre">Position</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#compLib.DoubleElimination.DoubleElim.get_goal" title="Link zu dieser Definition"></a></dt>
<dd><p>Makes the /api/getGoal call to the api.
:return: A Position object with x and y coordinates of the goal, rotation is always -1
:rtype: Tuple[Position, int]</p>
<dd><p>Führt den /api/getGoal Aufruf an die API aus.</p>
<dl class="field-list simple">
<dt class="field-odd">Rückgabe</dt>
<dd class="field-odd"><p>Ein Objekt der Klasse <a class="reference internal" href="#compLib.DoubleElimination.Position" title="compLib.DoubleElimination.Position"><code class="xref py py-class docutils literal notranslate"><span class="pre">Position</span></code></a> mit der Position des Ziels relativ zum eigenen Roboter und der Status Code</p>
</dd>
<dt class="field-even">Rückgabetyp</dt>
<dd class="field-even"><p>Tuple[<a class="reference internal" href="#compLib.DoubleElimination.Position" title="compLib.DoubleElimination.Position">Position</a>, int]</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="compLib.DoubleElimination.DoubleElim.get_items">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_items</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Dict</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#compLib.DoubleElimination.DoubleElim.get_items" title="Link zu dieser Definition"></a></dt>
<dd><p>Makes the /api/getItems call to the api.
:return: A list will all items currently on the game field. Items are dictionaries that look like: {„id“: 0, „x“: 0, „y“: 0}
:rtype: Tuple[List[Dict], int]</p>
<dd><p>Führt den /api/getItems Aufruf an die API aus.</p>
<dl class="field-list simple">
<dt class="field-odd">Rückgabe</dt>
<dd class="field-odd"><p>Eine Liste aller Items, die sich derzeit auf dem Spielfeld befinden. Items sind „dictionaries“, die wie folgt aussehen: {„id“: 0, „x“: 0, „y“: 0}</p>
</dd>
<dt class="field-even">Rückgabetyp</dt>
<dd class="field-even"><p>Tuple[List[Dict], int]</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="compLib.DoubleElimination.DoubleElim.get_opponent">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_opponent</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#compLib.DoubleElimination.Position" title="compLib.DoubleElimination.Position"><span class="pre">Position</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#compLib.DoubleElimination.DoubleElim.get_opponent" title="Link zu dieser Definition"></a></dt>
<dd><p>Makes the /api/getOp call to the api.
:return: A Position object with opponents robot position
:rtype: Tuple[Position, int]</p>
<dd><p>Führt den /api/getOp Aufruf an die API aus.</p>
<dl class="field-list simple">
<dt class="field-odd">Rückgabe</dt>
<dd class="field-odd"><p>Ein Objekt der Klasse <a class="reference internal" href="#compLib.DoubleElimination.Position" title="compLib.DoubleElimination.Position"><code class="xref py py-class docutils literal notranslate"><span class="pre">Position</span></code></a> mit der Position des gegnerischen Roboters relativ zum eigenen Roboter und der Status Code</p>
</dd>
<dt class="field-even">Rückgabetyp</dt>
<dd class="field-even"><p>Tuple[<a class="reference internal" href="#compLib.DoubleElimination.Position" title="compLib.DoubleElimination.Position">Position</a>, int]</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="compLib.DoubleElimination.DoubleElim.get_pos">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_pos</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#compLib.DoubleElimination.Position" title="compLib.DoubleElimination.Position"><span class="pre">Position</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#compLib.DoubleElimination.DoubleElim.get_pos" title="Link zu dieser Definition"></a></dt>
<dd><p>Führt den /api/getPos Aufruf an die API aus.
:return: Ein Objekt der Klasse <a class="reference internal" href="#compLib.DoubleElimination.Position" title="compLib.DoubleElimination.Position"><code class="xref py py-class docutils literal notranslate"><span class="pre">Position</span></code></a> mit der Position des Roboters und der Status Code
:rtype: Tuple[Position, int]</p>
<dd><p>Führt den /api/getPos Aufruf an die API aus.</p>
<dl class="field-list simple">
<dt class="field-odd">Rückgabe</dt>
<dd class="field-odd"><p>Ein Objekt der Klasse <a class="reference internal" href="#compLib.DoubleElimination.Position" title="compLib.DoubleElimination.Position"><code class="xref py py-class docutils literal notranslate"><span class="pre">Position</span></code></a> mit der Position des Roboters und der Status Code</p>
</dd>
<dt class="field-even">Rückgabetyp</dt>
<dd class="field-even"><p>Tuple[<a class="reference internal" href="#compLib.DoubleElimination.Position" title="compLib.DoubleElimination.Position">Position</a>, int]</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="compLib.DoubleElimination.DoubleElim.get_scores">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_scores</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">Dict</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#compLib.DoubleElimination.DoubleElim.get_scores" title="Link zu dieser Definition"></a></dt>
<dd><p>Makes the /api/getScores call to the api.
:return: A dictionary with all scores included like: {„self“:2,“opponent“:0}
:rtype: Tuple[Dict, int]</p>
<dd><p>Führt den /api/getScores Aufruf an die API aus.</p>
<dl class="field-list simple">
<dt class="field-odd">Rückgabe</dt>
<dd class="field-odd"><p>Ein „dictionary“ mit dem eignen Score und dem des Gegners: {„self“:2,“opponent“:0}</p>
</dd>
<dt class="field-even">Rückgabetyp</dt>
<dd class="field-even"><p>Tuple[Dict, int]</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
@ -151,10 +173,7 @@
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../index.html" class="btn btn-neutral float-left" title="compLib" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Zurück</a>
<a href="Encoder.html" class="btn btn-neutral float-right" title="Encoder" accesskey="n" rel="next">Weiter <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<footer>
<hr/>

27
lib/classes/Encoder.html
View file

@ -20,9 +20,7 @@
<script src="../../_static/translations.js"></script>
<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="Infrarot Sensoren" href="IRSensor.html" />
<link rel="prev" title="Double Elimination" href="DoubleElimination.html" />
<link rel="search" title="Suche" href="../../search.html" />
</head>
<body class="wy-body-for-nav">
@ -41,25 +39,12 @@
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../gettingStarted/index.html">Erste Schritte</a></li>
<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="reference internal" href="../index.html">compLib</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="DoubleElimination.html">Double Elimination</a></li>
<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><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>
<li class="toctree-l2"><a class="reference internal" href="Motor.html">Motoren</a></li>
<li class="toctree-l2"><a class="reference internal" href="Seeding.html">Seeding</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../index.html">compLib</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../other/hardware.html">Hardware</a></li>
</ul>
@ -77,7 +62,6 @@
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html" class="icon icon-home"></a></li>
<li class="breadcrumb-item"><a href="../index.html">compLib</a></li>
<li class="breadcrumb-item active">Encoder</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/lib/classes/Encoder.rst.txt" rel="nofollow"> Quelltext anzeigen</a>
@ -126,10 +110,7 @@
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="DoubleElimination.html" class="btn btn-neutral float-left" title="Double Elimination" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Zurück</a>
<a href="IRSensor.html" class="btn btn-neutral float-right" title="Infrarot Sensoren" accesskey="n" rel="next">Weiter <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<footer>
<hr/>

27
lib/classes/IRSensor.html
View file

@ -20,9 +20,7 @@
<script src="../../_static/translations.js"></script>
<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="Motoren" href="Motor.html" />
<link rel="prev" title="Encoder" href="Encoder.html" />
<link rel="search" title="Suche" href="../../search.html" />
</head>
<body class="wy-body-for-nav">
@ -41,25 +39,12 @@
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../gettingStarted/index.html">Erste Schritte</a></li>
<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="reference internal" href="../index.html">compLib</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="DoubleElimination.html">Double Elimination</a></li>
<li class="toctree-l2"><a class="reference internal" href="Encoder.html">Encoder</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Infrarot Sensoren</a><ul>
<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.IRSensor.IRSensor"><code class="docutils literal notranslate"><span class="pre">IRSensor</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="Motor.html">Motoren</a></li>
<li class="toctree-l2"><a class="reference internal" href="Seeding.html">Seeding</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../index.html">compLib</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../other/hardware.html">Hardware</a></li>
</ul>
@ -77,7 +62,6 @@
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html" class="icon icon-home"></a></li>
<li class="breadcrumb-item"><a href="../index.html">compLib</a></li>
<li class="breadcrumb-item active">Infrarot Sensoren</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/lib/classes/IRSensor.rst.txt" rel="nofollow"> Quelltext anzeigen</a>
@ -127,10 +111,7 @@
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="Encoder.html" class="btn btn-neutral float-left" title="Encoder" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Zurück</a>
<a href="Motor.html" class="btn btn-neutral float-right" title="Motoren" accesskey="n" rel="next">Weiter <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<footer>
<hr/>

36
lib/classes/Motor.html
View file

@ -20,9 +20,7 @@
<script src="../../_static/translations.js"></script>
<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="Seeding" href="Seeding.html" />
<link rel="prev" title="Infrarot Sensoren" href="IRSensor.html" />
<link rel="search" title="Suche" href="../../search.html" />
</head>
<body class="wy-body-for-nav">
@ -41,34 +39,12 @@
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../gettingStarted/index.html">Erste Schritte</a></li>
<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="reference internal" href="../index.html">compLib</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="DoubleElimination.html">Double Elimination</a></li>
<li class="toctree-l2"><a class="reference internal" href="Encoder.html">Encoder</a></li>
<li class="toctree-l2"><a class="reference internal" href="IRSensor.html">Infrarot Sensoren</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Motoren</a><ul>
<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.Motor.Motor"><code class="docutils literal notranslate"><span class="pre">Motor</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#genauere-informationen">Genauere Informationen</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#power-vs-speed-vs-pulsewidth">Power vs Speed vs PulseWidth</a></li>
<li class="toctree-l4"><a class="reference internal" href="#normal-vs-multiple">Normal vs Multiple</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#beispiele">Beispiele</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#vorwarts-fahren">Vorwärts fahren</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="Seeding.html">Seeding</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../index.html">compLib</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../other/hardware.html">Hardware</a></li>
</ul>
@ -86,7 +62,6 @@
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html" class="icon icon-home"></a></li>
<li class="breadcrumb-item"><a href="../index.html">compLib</a></li>
<li class="breadcrumb-item active">Motoren</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/lib/classes/Motor.rst.txt" rel="nofollow"> Quelltext anzeigen</a>
@ -242,10 +217,7 @@ Dabei ist zu beachten, dass ein Motor in die entgegengesetzte Richtung zum anere
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="IRSensor.html" class="btn btn-neutral float-left" title="Infrarot Sensoren" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Zurück</a>
<a href="Seeding.html" class="btn btn-neutral float-right" title="Seeding" accesskey="n" rel="next">Weiter <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<footer>
<hr/>

31
lib/classes/Seeding.html
View file

@ -20,9 +20,7 @@
<script src="../../_static/translations.js"></script>
<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="Hardware" href="../../other/hardware.html" />
<link rel="prev" title="Motoren" href="Motor.html" />
<link rel="search" title="Suche" href="../../search.html" />
</head>
<body class="wy-body-for-nav">
@ -41,25 +39,12 @@
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../gettingStarted/index.html">Erste Schritte</a></li>
<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="reference internal" href="../index.html">compLib</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="DoubleElimination.html">Double Elimination</a></li>
<li class="toctree-l2"><a class="reference internal" href="Encoder.html">Encoder</a></li>
<li class="toctree-l2"><a class="reference internal" href="IRSensor.html">Infrarot Sensoren</a></li>
<li class="toctree-l2"><a class="reference internal" href="Motor.html">Motoren</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Seeding</a><ul>
<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.Seeding.Gamestate"><code class="docutils literal notranslate"><span class="pre">Gamestate</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../index.html">compLib</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../other/hardware.html">Hardware</a></li>
</ul>
@ -77,7 +62,6 @@
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html" class="icon icon-home"></a></li>
<li class="breadcrumb-item"><a href="../index.html">compLib</a></li>
<li class="breadcrumb-item active">Seeding</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/lib/classes/Seeding.rst.txt" rel="nofollow"> Quelltext anzeigen</a>
@ -90,8 +74,8 @@
<section id="seeding">
<span id="lib-seeding"></span><h1>Seeding<a class="headerlink" href="#seeding" title="Permalink to this heading"></a></h1>
<section id="dokumentation-der-klasse">
<h2>Dokumentation der Klasse<a class="headerlink" href="#dokumentation-der-klasse" title="Permalink to this heading"></a></h2>
<section id="dokumentation-des-seeding-moduls">
<h2>Dokumentation des Seeding Moduls<a class="headerlink" href="#dokumentation-des-seeding-moduls" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="compLib.Seeding.Gamestate">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compLib.Seeding.</span></span><span class="sig-name descname"><span class="pre">Gamestate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#compLib.Seeding.Gamestate" title="Link zu dieser Definition"></a></dt>
@ -136,10 +120,7 @@
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="Motor.html" class="btn btn-neutral float-left" title="Motoren" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Zurück</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>
<footer>
<hr/>

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/>

4
other/hardware.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="prev" title="Seeding" href="../lib/classes/Seeding.html" />
<link rel="prev" title="compLib" href="../lib/index.html" />
</head>
<body class="wy-body-for-nav">
@ -153,7 +153,7 @@ Zusätzlich befinden sich auf der Unterseite des Mainboards Lötstellen, welche
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../lib/classes/Seeding.html" class="btn btn-neutral float-left" title="Seeding" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Zurück</a>
<a href="../lib/index.html" class="btn btn-neutral float-left" title="compLib" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Zurück</a>
</div>
<hr/>

2
searchindex.js
View file

File diff suppressed because one or more lines are too long