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-18 16:46:58 +01:00
parent 64ff14b9b1
commit 75185f19b6
36 changed files with 14537 additions and 3800 deletions
Download patch file Download diff file Expand all files Collapse all files

216
lib/index.html
View file

@ -1,73 +1,32 @@
<!DOCTYPE html>
<html class="writer-html5" lang="de" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>compLib &mdash; CompLib 0.2.3 Dokumentation</title>
<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" />
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>compLib &mdash; CompLib 0.2.3 Dokumentation</title><link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<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 id="documentation_options" data-url_root="../" 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>
<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="classes/Motor.html" />
<link rel="prev" title="Beispiele" href="../other/usage.html" />
</head>
<body class="wy-body-for-nav">
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../index.html">
<img src="../_static/compair-logo-white.svg" class="logo" alt="Logo"/>
<a href="../index.html"><img src="../_static/compair-logo-white.svg" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Dokumentation durchsuchen" />
@ -75,18 +34,7 @@
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<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>
@ -98,91 +46,42 @@
<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/Seeding.html">Seeding</a></li>
<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/Opencv.html">Camera und OpenCV</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../other/hardware.html">Hardware</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">CompLib</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
<li>compLib</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/lib/index.rst.txt" rel="nofollow"> Quelltext anzeigen</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="complib">
<h1>compLib<a class="headerlink" href="#complib" title="Permalink to this heading"></a></h1>
<h1>compLib<a class="headerlink" href="#complib" title="Link zu dieser Überschrift"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<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#dokumentation-der-klasse">Dokumentation der Klasse</a></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>
@ -195,54 +94,26 @@
</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>
<li class="toctree-l2"><a class="reference internal" href="classes/Encoder.html#dokumentation-der-klasse">Dokumentation der Klasse</a></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>
<li class="toctree-l2"><a class="reference internal" href="classes/IRSensor.html#dokumentation-der-klasse">Dokumentation der Klasse</a></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-des-seeding-moduls">Dokumentation des Seeding Moduls</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>
<li class="toctree-l3"><a class="reference internal" href="classes/Seeding.html#beispiele">Beispiele</a></li>
</ul>
</li>
</ul>
</li>
<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-des-double-elimination-moduls">Dokumentation des Double Elimination Moduls</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>
<li class="toctree-l2"><a class="reference internal" href="classes/DoubleElimination.html#dokumentation-des-double-elimination-moduls">Dokumentation des Double Elimination Moduls</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="classes/Opencv.html">Camera und OpenCV</a><ul>
<li class="toctree-l2"><a class="reference internal" href="classes/Opencv.html#dokumentation-des-camera-moduls">Dokumentation des Camera Moduls</a></li>
</ul>
</li>
</ul>
@ -251,58 +122,33 @@
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="classes/Motor.html" class="btn btn-neutral float-right" title="Motoren" accesskey="n" rel="next">Weiter <span class="fa fa-arrow-circle-right"></span></a>
<a href="../other/usage.html" class="btn btn-neutral float-left" title="Beispiele" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Zurück</a>
<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/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>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2022, Verein zur Förderung von Wissenschaft und Technik an Schulen (F-WuTS)
</p>
<p>&#169; Copyright 2022, Verein zur Förderung von Wissenschaft und Technik an Schulen (F-WuTS).</p>
</div>
Erstellt mit <a href="http://sphinx-doc.org/">Sphinx</a> mit einem
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
bereitgestellt von <a href="https://readthedocs.org">Read the Docs</a>.
Erstellt mit <a href="https://www.sphinx-doc.org/">Sphinx</a> mit einem
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
bereitgestellt von <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</script>
</body>
</html>