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:
Konstantin Lampalzer 2021-01-23 13:37:07 +01:00
parent f72550146d
commit a7f5dd13c4
No known key found for this signature in database
GPG key ID: 9A60A522835A2AD9
23 changed files with 541 additions and 189 deletions
Download patch file Download diff file Expand all files Collapse all files

10
_sources/lib/Api.rst.txt
View file

@ -1,29 +1,29 @@
.. _lib_api: .. _lib_api:
Api Api
===== ****
Seeding Seeding
******** ========
.. autoclass:: compLib.Api.Seeding .. autoclass:: compLib.Api.Seeding
:members: :members:
Double Elimination Double Elimination
******************* ===================
.. autoclass:: compLib.Api.DoubleElim .. autoclass:: compLib.Api.DoubleElim
:members: :members:
Position Position
********* ========
.. autoclass:: compLib.Api.Position .. autoclass:: compLib.Api.Position
:members: :members:
Examples Examples
********* ========
Calling Seeding API Calling Seeding API
--------------------- ---------------------

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

@ -1,20 +1,20 @@
.. _lib_battery: .. _lib_battery:
Battery Battery
######## ********
Class Documentation Class Documentation
******************** ====================
.. autoclass:: compLib.Battery.Battery .. autoclass:: compLib.Battery.Battery
:members: :members:
Examples Examples
********* =========
Printing percentage Printing percentage
==================== --------------------
.. code-block:: python .. code-block:: python

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

@ -1,19 +1,19 @@
.. _lib_buzzer: .. _lib_buzzer:
Buzzer Buzzer
####### *******
Class Documentation Class Documentation
******************** ====================
.. autoclass:: compLib.Buzzer.Buzzer .. autoclass:: compLib.Buzzer.Buzzer
:members: :members:
Examples Examples
********* =========
Turning buzzer on and off Turning buzzer on and off
========================== --------------------------
.. code-block:: python .. code-block:: python

2
_sources/lib/IRSensor.rst.txt
View file

@ -1,7 +1,7 @@
.. _lib_irsensor: .. _lib_irsensor:
Infrared Sensor Infrared Sensor
================ ****************
.. autoclass:: compLib.IRSensor.IRSensor .. autoclass:: compLib.IRSensor.IRSensor
:members: :members:

22
_sources/lib/Logging.rst.txt Normal file
View file

@ -0,0 +1,22 @@
.. _lib_logging:
Logging
*******
Class Documentation
====================
.. autoclass:: compLib.LogstashLogging.Logging
:members:
Examples
=========
Turn up the logging
--------------------
.. code-block:: python
from compLib.LogstashLogging import Logging
Logging.set_debug()

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

@ -1,19 +1,19 @@
.. _lib_motor: .. _lib_motor:
Motor Motor
###### ******
Class Documentation Class Documentation
******************** ====================
.. autoclass:: compLib.Motor.Motor .. autoclass:: compLib.Motor.Motor
:members: :members:
Examples Examples
********* =========
Driving straight (maybe) Driving straight (maybe)
========================= -------------------------
.. code-block:: python .. code-block:: python

2
_sources/lib/Servo.rst.txt
View file

@ -1,7 +1,7 @@
.. _lib_servo: .. _lib_servo:
Servo Servo
===== ******
.. autoclass:: compLib.Servo.Servo .. autoclass:: compLib.Servo.Servo
:members: :members:

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

@ -1,7 +1,7 @@
.. _lib_vision: .. _lib_vision:
Vision Vision
===== *******
This module provides an interface for grabbing an rtmp stream and using the images to do some processing in opencv. This module provides an interface for grabbing an rtmp stream and using the images to do some processing in opencv.
@ -13,7 +13,7 @@ How do I use this module?
4. You can view the http stream of your processed images in a web browser 4. You can view the http stream of your processed images in a web browser
Opencv Stream Opencv Stream
************* ==============
Because of the rtmp stream needing to buffer some frames and waiting for P-Frames, importing this module might take up Because of the rtmp stream needing to buffer some frames and waiting for P-Frames, importing this module might take up
to 5 Seconds. to 5 Seconds.
@ -22,10 +22,10 @@ to 5 Seconds.
:members: :members:
Examples Examples
********* =========
Using the Vision Module Using the Vision Module
--------------------- -------------------------
.. code-block:: python .. code-block:: python

7
_static/pygments.css
View file

@ -1,5 +1,10 @@
pre { line-height: 125%; }
td.linenos pre { color: #000000; background-color: #f0f0f0; padding-left: 5px; padding-right: 5px; }
span.linenos { color: #000000; background-color: #f0f0f0; padding-left: 5px; padding-right: 5px; }
td.linenos pre.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
.highlight .hll { background-color: #ffffcc } .highlight .hll { background-color: #ffffcc }
.highlight { background: #f8f8f8; } .highlight { background: #f8f8f8; }
.highlight .c { color: #408080; font-style: italic } /* Comment */ .highlight .c { color: #408080; font-style: italic } /* Comment */
.highlight .err { border: 1px solid #FF0000 } /* Error */ .highlight .err { border: 1px solid #FF0000 } /* Error */
.highlight .k { color: #008000; font-weight: bold } /* Keyword */ .highlight .k { color: #008000; font-weight: bold } /* Keyword */

36
genindex.html
View file

@ -3,9 +3,9 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Index &mdash; CompLib 0.0.2 documentation</title> <title>Index &mdash; CompLib 0.0.2 documentation</title>
@ -16,13 +16,10 @@
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
@ -51,7 +48,7 @@
<a href="index.html" class="icon icon-home"> CompLib <a href="index.html" class="icon icon-home" alt="Documentation Home"> CompLib
@ -89,6 +86,7 @@
<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/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/Buzzer.html">Buzzer</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/IRSensor.html">Infrared Sensor</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> <li class="toctree-l1"><a class="reference internal" href="lib/Motor.html">Motor</a></li>
<li class="toctree-l1"><a class="reference internal" href="lib/Servo.html">Servo</a></li> <li class="toctree-l1"><a class="reference internal" href="lib/Servo.html">Servo</a></li>
<li class="toctree-l1"><a class="reference internal" href="lib/Vision.html">Vision</a></li> <li class="toctree-l1"><a class="reference internal" href="lib/Vision.html">Vision</a></li>
@ -132,8 +130,6 @@
<div role="navigation" aria-label="breadcrumbs navigation"> <div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
@ -145,7 +141,7 @@
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
</li> </li>
@ -167,6 +163,7 @@
| <a href="#D"><strong>D</strong></a> | <a href="#D"><strong>D</strong></a>
| <a href="#G"><strong>G</strong></a> | <a href="#G"><strong>G</strong></a>
| <a href="#I"><strong>I</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="#M"><strong>M</strong></a>
| <a href="#P"><strong>P</strong></a> | <a href="#P"><strong>P</strong></a>
| <a href="#S"><strong>S</strong></a> | <a href="#S"><strong>S</strong></a>
@ -226,6 +223,8 @@
</li> </li>
</ul></td> </ul></td>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="lib/Logging.html#compLib.LogstashLogging.Logging.get_logger">get_logger() (compLib.LogstashLogging.Logging static method)</a>
</li>
<li><a href="lib/Api.html#compLib.Api.DoubleElim.get_opponent">get_opponent() (compLib.Api.DoubleElim static method)</a> <li><a href="lib/Api.html#compLib.Api.DoubleElim.get_opponent">get_opponent() (compLib.Api.DoubleElim static method)</a>
</li> </li>
<li><a href="lib/Api.html#compLib.Api.Seeding.get_park">get_park() (compLib.Api.Seeding static method)</a> <li><a href="lib/Api.html#compLib.Api.Seeding.get_park">get_park() (compLib.Api.Seeding static method)</a>
@ -243,6 +242,14 @@
</ul></td> </ul></td>
</tr></table> </tr></table>
<h2 id="L">L</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="lib/Logging.html#compLib.LogstashLogging.Logging">Logging (class in compLib.LogstashLogging)</a>
</li>
</ul></td>
</tr></table>
<h2 id="M">M</h2> <h2 id="M">M</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
@ -280,6 +287,8 @@
</li> </li>
</ul></td> </ul></td>
<td style="width: 33%; vertical-align: top;"><ul> <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><a href="lib/Servo.html#compLib.Servo.Servo.set_position">set_position() (compLib.Servo.Servo static method)</a>
</li> </li>
<li><a href="lib/Servo.html#compLib.Servo.Servo.setup_position">setup_position() (compLib.Servo.Servo static method)</a> <li><a href="lib/Servo.html#compLib.Servo.Servo.setup_position">setup_position() (compLib.Servo.Servo static method)</a>
@ -307,25 +316,28 @@
</div> </div>
<footer> <footer>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<p> <p>
&#169; Copyright 2021, robo4you.
&copy; Copyright 2021, robo4you
</p> </p>
</div> </div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>. provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer> </footer>
</div> </div>
</div> </div>

37
index.html
View file

@ -3,9 +3,9 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Robo4you Competition Library &mdash; CompLib 0.0.2 documentation</title> <title>Robo4you Competition Library &mdash; CompLib 0.0.2 documentation</title>
@ -16,13 +16,10 @@
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
@ -52,7 +49,7 @@
<a href="#" class="icon icon-home"> CompLib <a href="#" class="icon icon-home" alt="Documentation Home"> CompLib
@ -90,6 +87,7 @@
<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/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/Buzzer.html">Buzzer</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/IRSensor.html">Infrared Sensor</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> <li class="toctree-l1"><a class="reference internal" href="lib/Motor.html">Motor</a></li>
<li class="toctree-l1"><a class="reference internal" href="lib/Servo.html">Servo</a></li> <li class="toctree-l1"><a class="reference internal" href="lib/Servo.html">Servo</a></li>
<li class="toctree-l1"><a class="reference internal" href="lib/Vision.html">Vision</a></li> <li class="toctree-l1"><a class="reference internal" href="lib/Vision.html">Vision</a></li>
@ -133,8 +131,6 @@
<div role="navigation" aria-label="breadcrumbs navigation"> <div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
@ -146,7 +142,7 @@
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a> <a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
@ -199,6 +195,14 @@
</ul> </ul>
</li> </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/IRSensor.html">Infrared Sensor</a></li>
<li class="toctree-l1"><a class="reference internal" href="lib/Logging.html">Logging</a><ul>
<li class="toctree-l2"><a class="reference internal" href="lib/Logging.html#class-documentation">Class Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/Logging.html#examples">Examples</a><ul>
<li class="toctree-l3"><a class="reference internal" href="lib/Logging.html#turn-up-the-logging">Turn up the logging</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="lib/Motor.html">Motor</a><ul> <li class="toctree-l1"><a class="reference internal" href="lib/Motor.html">Motor</a><ul>
<li class="toctree-l2"><a class="reference internal" href="lib/Motor.html#class-documentation">Class Documentation</a></li> <li class="toctree-l2"><a class="reference internal" href="lib/Motor.html#class-documentation">Class Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/Motor.html#examples">Examples</a><ul> <li class="toctree-l2"><a class="reference internal" href="lib/Motor.html#examples">Examples</a><ul>
@ -227,28 +231,35 @@
</div> </div>
<footer> <footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="other/usage.html" class="btn btn-neutral float-right" title="Usage" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="other/usage.html" class="btn btn-neutral float-right" title="Usage" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
</div> </div>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<p> <p>
&#169; Copyright 2021, robo4you.
&copy; Copyright 2021, robo4you
</p> </p>
</div> </div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>. provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer> </footer>
</div> </div>
</div> </div>

48
lib/Api.html
View file

@ -3,9 +3,9 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Api &mdash; CompLib 0.0.2 documentation</title> <title>Api &mdash; CompLib 0.0.2 documentation</title>
@ -16,13 +16,10 @@
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script> <script src="../_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
@ -53,7 +50,7 @@
<a href="../index.html" class="icon icon-home"> CompLib <a href="../index.html" class="icon icon-home" alt="Documentation Home"> CompLib
@ -101,6 +98,7 @@
<li class="toctree-l1"><a class="reference internal" href="Battery.html">Battery</a></li> <li class="toctree-l1"><a class="reference internal" href="Battery.html">Battery</a></li>
<li class="toctree-l1"><a class="reference internal" href="Buzzer.html">Buzzer</a></li> <li class="toctree-l1"><a class="reference internal" href="Buzzer.html">Buzzer</a></li>
<li class="toctree-l1"><a class="reference internal" href="IRSensor.html">Infrared Sensor</a></li> <li class="toctree-l1"><a class="reference internal" href="IRSensor.html">Infrared Sensor</a></li>
<li class="toctree-l1"><a class="reference internal" href="Logging.html">Logging</a></li>
<li class="toctree-l1"><a class="reference internal" href="Motor.html">Motor</a></li> <li class="toctree-l1"><a class="reference internal" href="Motor.html">Motor</a></li>
<li class="toctree-l1"><a class="reference internal" href="Servo.html">Servo</a></li> <li class="toctree-l1"><a class="reference internal" href="Servo.html">Servo</a></li>
<li class="toctree-l1"><a class="reference internal" href="Vision.html">Vision</a></li> <li class="toctree-l1"><a class="reference internal" href="Vision.html">Vision</a></li>
@ -144,8 +142,6 @@
<div role="navigation" aria-label="breadcrumbs navigation"> <div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
@ -157,7 +153,7 @@
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
<a href="../_sources/lib/Api.rst.txt" rel="nofollow"> View page source</a> <a href="../_sources/lib/Api.rst.txt" rel="nofollow"> View page source</a>
@ -305,14 +301,14 @@
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">compLib.Api</span> <span class="kn">import</span> <span class="n">Seeding</span> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">compLib.Api</span> <span class="kn">import</span> <span class="n">Seeding</span>
<span class="n">park</span> <span class="o">=</span> <span class="n">Seeding</span><span class="o">.</span><span class="n">get_park</span><span class="p">()</span> <span class="n">park</span> <span class="o">=</span> <span class="n">Seeding</span><span class="o">.</span><span class="n">get_park</span><span class="p">()</span>
<span class="k">print</span><span class="p">(</span><span class="n">f</span><span class="s2">&quot;I should move to parking position: {park}&quot;</span><span class="p">)</span> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;I should move to parking position: </span><span class="si">{</span><span class="n">park</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="k">if</span> <span class="n">park</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> <span class="k">if</span> <span class="n">park</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">print</span><span class="p">(</span><span class="n">f</span><span class="s2">&quot;I can&#39;t move to this position yet :(&quot;</span><span class="p">)</span> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;I can&#39;t move to this position yet :(&quot;</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">park</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span> <span class="k">elif</span> <span class="n">park</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">print</span><span class="p">(</span><span class="n">f</span><span class="s2">&quot;Moving to position 1!&quot;</span><span class="p">)</span> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Moving to position 1!&quot;</span><span class="p">)</span>
<span class="c1"># drive to parking position using Motors module...</span> <span class="c1"># drive to parking position using Motors module...</span>
<span class="k">print</span><span class="p">(</span><span class="n">f</span><span class="s2">&quot;Now hopefully at position 1&quot;</span><span class="p">)</span> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Now hopefully at position 1&quot;</span><span class="p">)</span>
<span class="c1"># drive back using Motors module...</span> <span class="c1"># drive back using Motors module...</span>
<span class="k">elif</span> <span class="n">park</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span> <span class="k">elif</span> <span class="n">park</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
<span class="c1"># do something similar to park == 1..</span> <span class="c1"># do something similar to park == 1..</span>
@ -321,9 +317,9 @@
<span class="n">success</span> <span class="o">=</span> <span class="n">Seeding</span><span class="o">.</span><span class="n">pay_park</span><span class="p">()</span> <span class="n">success</span> <span class="o">=</span> <span class="n">Seeding</span><span class="o">.</span><span class="n">pay_park</span><span class="p">()</span>
<span class="k">if</span> <span class="n">success</span><span class="p">:</span> <span class="k">if</span> <span class="n">success</span><span class="p">:</span>
<span class="k">print</span><span class="p">(</span><span class="n">f</span><span class="s2">&quot;We scored some points!&quot;</span><span class="p">)</span> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;We scored some points!&quot;</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span> <span class="k">else</span><span class="p">:</span>
<span class="k">print</span><span class="p">(</span><span class="n">f</span><span class="s2">&quot;We failed :(&quot;</span><span class="p">)</span> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;We failed :(&quot;</span><span class="p">)</span>
</pre></div> </pre></div>
</div> </div>
</div> </div>
@ -332,10 +328,10 @@
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">compLib.Api</span> <span class="kn">import</span> <span class="n">DoubleElim</span> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">compLib.Api</span> <span class="kn">import</span> <span class="n">DoubleElim</span>
<span class="n">position</span> <span class="o">=</span> <span class="n">DoubleElim</span><span class="o">.</span><span class="n">get_position</span><span class="p">()</span> <span class="n">position</span> <span class="o">=</span> <span class="n">DoubleElim</span><span class="o">.</span><span class="n">get_position</span><span class="p">()</span>
<span class="k">print</span><span class="p">(</span><span class="n">f</span><span class="s2">&quot;Position of my robot is: x={position.x}, y={position.y} and rotation is: {position.degrees}&quot;</span><span class="p">)</span> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Position of my robot is: x=</span><span class="si">{</span><span class="n">position</span><span class="o">.</span><span class="n">x</span><span class="si">}</span><span class="s2">, y=</span><span class="si">{</span><span class="n">position</span><span class="o">.</span><span class="n">y</span><span class="si">}</span><span class="s2"> and rotation is: </span><span class="si">{</span><span class="n">position</span><span class="o">.</span><span class="n">degrees</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="n">goal</span> <span class="o">=</span> <span class="n">DoubleElim</span><span class="o">.</span><span class="n">get_goal</span><span class="p">()</span> <span class="n">goal</span> <span class="o">=</span> <span class="n">DoubleElim</span><span class="o">.</span><span class="n">get_goal</span><span class="p">()</span>
<span class="k">print</span><span class="p">(</span><span class="n">f</span><span class="s2">&quot;Goal is at: x={goal.x}, y={goal.y}&quot;</span><span class="p">)</span> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Goal is at: x=</span><span class="si">{</span><span class="n">goal</span><span class="o">.</span><span class="n">x</span><span class="si">}</span><span class="s2">, y=</span><span class="si">{</span><span class="n">goal</span><span class="o">.</span><span class="n">y</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
</pre></div> </pre></div>
</div> </div>
</div> </div>
@ -347,29 +343,37 @@
</div> </div>
<footer> <footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="Battery.html" class="btn btn-neutral float-right" title="Battery" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="../other/usage.html" class="btn btn-neutral float-left" title="Usage" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <a href="Battery.html" class="btn btn-neutral float-right" title="Battery" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../other/usage.html" class="btn btn-neutral float-left" title="Usage" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div> </div>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<p> <p>
&#169; Copyright 2021, robo4you.
&copy; Copyright 2021, robo4you
</p> </p>
</div> </div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>. provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer> </footer>
</div> </div>
</div> </div>

34
lib/Battery.html
View file

@ -3,9 +3,9 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Battery &mdash; CompLib 0.0.2 documentation</title> <title>Battery &mdash; CompLib 0.0.2 documentation</title>
@ -16,13 +16,10 @@
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script> <script src="../_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
@ -53,7 +50,7 @@
<a href="../index.html" class="icon icon-home"> CompLib <a href="../index.html" class="icon icon-home" alt="Documentation Home"> CompLib
@ -98,6 +95,7 @@
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="Buzzer.html">Buzzer</a></li> <li class="toctree-l1"><a class="reference internal" href="Buzzer.html">Buzzer</a></li>
<li class="toctree-l1"><a class="reference internal" href="IRSensor.html">Infrared Sensor</a></li> <li class="toctree-l1"><a class="reference internal" href="IRSensor.html">Infrared Sensor</a></li>
<li class="toctree-l1"><a class="reference internal" href="Logging.html">Logging</a></li>
<li class="toctree-l1"><a class="reference internal" href="Motor.html">Motor</a></li> <li class="toctree-l1"><a class="reference internal" href="Motor.html">Motor</a></li>
<li class="toctree-l1"><a class="reference internal" href="Servo.html">Servo</a></li> <li class="toctree-l1"><a class="reference internal" href="Servo.html">Servo</a></li>
<li class="toctree-l1"><a class="reference internal" href="Vision.html">Vision</a></li> <li class="toctree-l1"><a class="reference internal" href="Vision.html">Vision</a></li>
@ -141,8 +139,6 @@
<div role="navigation" aria-label="breadcrumbs navigation"> <div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
@ -154,7 +150,7 @@
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
<a href="../_sources/lib/Battery.rst.txt" rel="nofollow"> View page source</a> <a href="../_sources/lib/Battery.rst.txt" rel="nofollow"> View page source</a>
@ -199,7 +195,7 @@
<h3>Printing percentage<a class="headerlink" href="#printing-percentage" title="Permalink to this headline"></a></h3> <h3>Printing percentage<a class="headerlink" href="#printing-percentage" title="Permalink to this headline"></a></h3>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">compLib.Battery</span> <span class="kn">import</span> <span class="n">Battery</span> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">compLib.Battery</span> <span class="kn">import</span> <span class="n">Battery</span>
<span class="k">print</span><span class="p">(</span><span class="n">Battery</span><span class="o">.</span><span class="n">percent</span><span class="p">())</span> <span class="nb">print</span><span class="p">(</span><span class="n">Battery</span><span class="o">.</span><span class="n">percent</span><span class="p">())</span>
</pre></div> </pre></div>
</div> </div>
</div> </div>
@ -211,29 +207,37 @@
</div> </div>
<footer> <footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="Buzzer.html" class="btn btn-neutral float-right" title="Buzzer" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="Api.html" class="btn btn-neutral float-left" title="Api" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <a href="Buzzer.html" class="btn btn-neutral float-right" title="Buzzer" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="Api.html" class="btn btn-neutral float-left" title="Api" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div> </div>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<p> <p>
&#169; Copyright 2021, robo4you.
&copy; Copyright 2021, robo4you
</p> </p>
</div> </div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>. provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer> </footer>
</div> </div>
</div> </div>

36
lib/Buzzer.html
View file

@ -3,9 +3,9 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Buzzer &mdash; CompLib 0.0.2 documentation</title> <title>Buzzer &mdash; CompLib 0.0.2 documentation</title>
@ -16,13 +16,10 @@
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script> <script src="../_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
@ -53,7 +50,7 @@
<a href="../index.html" class="icon icon-home"> CompLib <a href="../index.html" class="icon icon-home" alt="Documentation Home"> CompLib
@ -98,6 +95,7 @@
</ul> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="IRSensor.html">Infrared Sensor</a></li> <li class="toctree-l1"><a class="reference internal" href="IRSensor.html">Infrared Sensor</a></li>
<li class="toctree-l1"><a class="reference internal" href="Logging.html">Logging</a></li>
<li class="toctree-l1"><a class="reference internal" href="Motor.html">Motor</a></li> <li class="toctree-l1"><a class="reference internal" href="Motor.html">Motor</a></li>
<li class="toctree-l1"><a class="reference internal" href="Servo.html">Servo</a></li> <li class="toctree-l1"><a class="reference internal" href="Servo.html">Servo</a></li>
<li class="toctree-l1"><a class="reference internal" href="Vision.html">Vision</a></li> <li class="toctree-l1"><a class="reference internal" href="Vision.html">Vision</a></li>
@ -141,8 +139,6 @@
<div role="navigation" aria-label="breadcrumbs navigation"> <div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
@ -154,7 +150,7 @@
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
<a href="../_sources/lib/Buzzer.rst.txt" rel="nofollow"> View page source</a> <a href="../_sources/lib/Buzzer.rst.txt" rel="nofollow"> View page source</a>
@ -197,9 +193,9 @@
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">time</span> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">time</span>
<span class="kn">from</span> <span class="nn">compLib.Buzzer</span> <span class="kn">import</span> <span class="n">Buzzer</span> <span class="kn">from</span> <span class="nn">compLib.Buzzer</span> <span class="kn">import</span> <span class="n">Buzzer</span>
<span class="n">Buzzer</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="bp">True</span><span class="p">)</span> <span class="n">Buzzer</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="kc">True</span><span class="p">)</span>
<span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span> <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
<span class="n">Buzzer</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="bp">False</span><span class="p">)</span> <span class="n">Buzzer</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="kc">False</span><span class="p">)</span>
</pre></div> </pre></div>
</div> </div>
</div> </div>
@ -211,29 +207,37 @@
</div> </div>
<footer> <footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="IRSensor.html" class="btn btn-neutral float-right" title="Infrared Sensor" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="Battery.html" class="btn btn-neutral float-left" title="Battery" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <a href="IRSensor.html" class="btn btn-neutral float-right" title="Infrared Sensor" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="Battery.html" class="btn btn-neutral float-left" title="Battery" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div> </div>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<p> <p>
&#169; Copyright 2021, robo4you.
&copy; Copyright 2021, robo4you
</p> </p>
</div> </div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>. provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer> </footer>
</div> </div>
</div> </div>

34
lib/IRSensor.html
View file

@ -3,9 +3,9 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Infrared Sensor &mdash; CompLib 0.0.2 documentation</title> <title>Infrared Sensor &mdash; CompLib 0.0.2 documentation</title>
@ -16,13 +16,10 @@
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script> <script src="../_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
@ -38,7 +35,7 @@
<link rel="index" title="Index" href="../genindex.html" /> <link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" /> <link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Motor" href="Motor.html" /> <link rel="next" title="Logging" href="Logging.html" />
<link rel="prev" title="Buzzer" href="Buzzer.html" /> <link rel="prev" title="Buzzer" href="Buzzer.html" />
</head> </head>
@ -53,7 +50,7 @@
<a href="../index.html" class="icon icon-home"> CompLib <a href="../index.html" class="icon icon-home" alt="Documentation Home"> CompLib
@ -91,6 +88,7 @@
<li class="toctree-l1"><a class="reference internal" href="Battery.html">Battery</a></li> <li class="toctree-l1"><a class="reference internal" href="Battery.html">Battery</a></li>
<li class="toctree-l1"><a class="reference internal" href="Buzzer.html">Buzzer</a></li> <li class="toctree-l1"><a class="reference internal" href="Buzzer.html">Buzzer</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Infrared Sensor</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Infrared Sensor</a></li>
<li class="toctree-l1"><a class="reference internal" href="Logging.html">Logging</a></li>
<li class="toctree-l1"><a class="reference internal" href="Motor.html">Motor</a></li> <li class="toctree-l1"><a class="reference internal" href="Motor.html">Motor</a></li>
<li class="toctree-l1"><a class="reference internal" href="Servo.html">Servo</a></li> <li class="toctree-l1"><a class="reference internal" href="Servo.html">Servo</a></li>
<li class="toctree-l1"><a class="reference internal" href="Vision.html">Vision</a></li> <li class="toctree-l1"><a class="reference internal" href="Vision.html">Vision</a></li>
@ -134,8 +132,6 @@
<div role="navigation" aria-label="breadcrumbs navigation"> <div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
@ -147,7 +143,7 @@
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
<a href="../_sources/lib/IRSensor.rst.txt" rel="nofollow"> View page source</a> <a href="../_sources/lib/IRSensor.rst.txt" rel="nofollow"> View page source</a>
@ -246,29 +242,37 @@
</div> </div>
<footer> <footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="Motor.html" class="btn btn-neutral float-right" title="Motor" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="Buzzer.html" class="btn btn-neutral float-left" title="Buzzer" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <a href="Logging.html" class="btn btn-neutral float-right" title="Logging" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="Buzzer.html" class="btn btn-neutral float-left" title="Buzzer" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div> </div>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<p> <p>
&#169; Copyright 2021, robo4you.
&copy; Copyright 2021, robo4you
</p> </p>
</div> </div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>. provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer> </footer>
</div> </div>
</div> </div>

268
lib/Logging.html Normal file
View file

@ -0,0 +1,268 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Logging &mdash; CompLib 0.0.2 documentation</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 src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Motor" href="Motor.html" />
<link rel="prev" title="Infrared Sensor" href="IRSensor.html" />
</head>
<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" class="icon icon-home" alt="Documentation Home"> CompLib
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<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">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../index.html">Robo4you Competition Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="../other/usage.html">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="Api.html">Api</a></li>
<li class="toctree-l1"><a class="reference internal" href="Battery.html">Battery</a></li>
<li class="toctree-l1"><a class="reference internal" href="Buzzer.html">Buzzer</a></li>
<li class="toctree-l1"><a class="reference internal" href="IRSensor.html">Infrared Sensor</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Logging</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#class-documentation">Class Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="#examples">Examples</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#turn-up-the-logging">Turn up the logging</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Motor.html">Motor</a></li>
<li class="toctree-l1"><a class="reference internal" href="Servo.html">Servo</a></li>
<li class="toctree-l1"><a class="reference internal" href="Vision.html">Vision</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">
<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">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
<li>Logging</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/lib/Logging.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="logging">
<span id="lib-logging"></span><h1>Logging<a class="headerlink" href="#logging" title="Permalink to this headline"></a></h1>
<div class="section" id="class-documentation">
<h2>Class Documentation<a class="headerlink" href="#class-documentation" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="compLib.LogstashLogging.Logging">
<em class="property">class </em><code class="sig-prename descclassname">compLib.LogstashLogging.</code><code class="sig-name descname">Logging</code><a class="headerlink" href="#compLib.LogstashLogging.Logging" title="Permalink to this definition"></a></dt>
<dd><p>Can be used to manually use the logger or turn up the logging level used for debugging this library.</p>
<dl class="py method">
<dt id="compLib.LogstashLogging.Logging.get_logger">
<em class="property">static </em><code class="sig-name descname">get_logger</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; logging.Logger<a class="headerlink" href="#compLib.LogstashLogging.Logging.get_logger" title="Permalink to this definition"></a></dt>
<dd><p>Get the logger object used to communicate with logstash</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Python logger</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>logging.Logger</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="compLib.LogstashLogging.Logging.set_debug">
<em class="property">static </em><code class="sig-name descname">set_debug</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#compLib.LogstashLogging.Logging.set_debug" title="Permalink to this definition"></a></dt>
<dd><p>Turns up the logging level of the library to debug. Should be used, when debugging with the
Competition organizers</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="section" id="turn-up-the-logging">
<h3>Turn up the logging<a class="headerlink" href="#turn-up-the-logging" title="Permalink to this headline"></a></h3>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">compLib.LogstashLogging</span> <span class="kn">import</span> <span class="n">Logging</span>
<span class="n">Logging</span><span class="o">.</span><span class="n">set_debug</span><span class="p">()</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="Motor.html" class="btn btn-neutral float-right" title="Motor" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="IRSensor.html" class="btn btn-neutral float-left" title="Infrared Sensor" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2021, robo4you
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

39
lib/Motor.html
View file

@ -3,9 +3,9 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Motor &mdash; CompLib 0.0.2 documentation</title> <title>Motor &mdash; CompLib 0.0.2 documentation</title>
@ -16,13 +16,10 @@
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script> <script src="../_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
@ -39,7 +36,7 @@
<link rel="index" title="Index" href="../genindex.html" /> <link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" /> <link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Servo" href="Servo.html" /> <link rel="next" title="Servo" href="Servo.html" />
<link rel="prev" title="Infrared Sensor" href="IRSensor.html" /> <link rel="prev" title="Logging" href="Logging.html" />
</head> </head>
<body class="wy-body-for-nav"> <body class="wy-body-for-nav">
@ -53,7 +50,7 @@
<a href="../index.html" class="icon icon-home"> CompLib <a href="../index.html" class="icon icon-home" alt="Documentation Home"> CompLib
@ -91,6 +88,7 @@
<li class="toctree-l1"><a class="reference internal" href="Battery.html">Battery</a></li> <li class="toctree-l1"><a class="reference internal" href="Battery.html">Battery</a></li>
<li class="toctree-l1"><a class="reference internal" href="Buzzer.html">Buzzer</a></li> <li class="toctree-l1"><a class="reference internal" href="Buzzer.html">Buzzer</a></li>
<li class="toctree-l1"><a class="reference internal" href="IRSensor.html">Infrared Sensor</a></li> <li class="toctree-l1"><a class="reference internal" href="IRSensor.html">Infrared Sensor</a></li>
<li class="toctree-l1"><a class="reference internal" href="Logging.html">Logging</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Motor</a><ul> <li class="toctree-l1 current"><a class="current reference internal" href="#">Motor</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#class-documentation">Class Documentation</a></li> <li class="toctree-l2"><a class="reference internal" href="#class-documentation">Class Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="#examples">Examples</a><ul> <li class="toctree-l2"><a class="reference internal" href="#examples">Examples</a><ul>
@ -141,8 +139,6 @@
<div role="navigation" aria-label="breadcrumbs navigation"> <div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
@ -154,7 +150,7 @@
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
<a href="../_sources/lib/Motor.rst.txt" rel="nofollow"> View page source</a> <a href="../_sources/lib/Motor.rst.txt" rel="nofollow"> View page source</a>
@ -184,7 +180,7 @@
<dl class="py method"> <dl class="py method">
<dt id="compLib.Motor.Motor.power"> <dt id="compLib.Motor.Motor.power">
<em class="property">static </em><code class="sig-name descname">power</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">port</span><span class="p">:</span> <span class="n">int</span></em>, <em class="sig-param"><span class="n">percent</span><span class="p">:</span> <span class="n">int</span></em><span class="sig-paren">)</span><a class="headerlink" href="#compLib.Motor.Motor.power" title="Permalink to this definition"></a></dt> <em class="property">static </em><code class="sig-name descname">power</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">port</span><span class="p">:</span> <span class="n">int</span></em>, <em class="sig-param"><span class="n">percent</span><span class="p">:</span> <span class="n">float</span></em><span class="sig-paren">)</span><a class="headerlink" href="#compLib.Motor.Motor.power" title="Permalink to this definition"></a></dt>
<dd><p>Set specified motor to percentage power</p> <dd><p>Set specified motor to percentage power</p>
<dl class="field-list simple"> <dl class="field-list simple">
<dt class="field-odd">Parameters</dt> <dt class="field-odd">Parameters</dt>
@ -193,6 +189,9 @@
<li><p><strong>percent</strong> – Percentage of max speed. between -100 and 100</p></li> <li><p><strong>percent</strong> – Percentage of max speed. between -100 and 100</p></li>
</ul> </ul>
</dd> </dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p>IndexError</p>
</dd>
</dl> </dl>
</dd></dl> </dd></dl>
@ -218,29 +217,37 @@
</div> </div>
<footer> <footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="Servo.html" class="btn btn-neutral float-right" title="Servo" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="IRSensor.html" class="btn btn-neutral float-left" title="Infrared Sensor" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <a href="Servo.html" class="btn btn-neutral float-right" title="Servo" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="Logging.html" class="btn btn-neutral float-left" title="Logging" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div> </div>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<p> <p>
&#169; Copyright 2021, robo4you.
&copy; Copyright 2021, robo4you
</p> </p>
</div> </div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>. provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer> </footer>
</div> </div>
</div> </div>

32
lib/Servo.html
View file

@ -3,9 +3,9 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Servo &mdash; CompLib 0.0.2 documentation</title> <title>Servo &mdash; CompLib 0.0.2 documentation</title>
@ -16,13 +16,10 @@
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script> <script src="../_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
@ -53,7 +50,7 @@
<a href="../index.html" class="icon icon-home"> CompLib <a href="../index.html" class="icon icon-home" alt="Documentation Home"> CompLib
@ -91,6 +88,7 @@
<li class="toctree-l1"><a class="reference internal" href="Battery.html">Battery</a></li> <li class="toctree-l1"><a class="reference internal" href="Battery.html">Battery</a></li>
<li class="toctree-l1"><a class="reference internal" href="Buzzer.html">Buzzer</a></li> <li class="toctree-l1"><a class="reference internal" href="Buzzer.html">Buzzer</a></li>
<li class="toctree-l1"><a class="reference internal" href="IRSensor.html">Infrared Sensor</a></li> <li class="toctree-l1"><a class="reference internal" href="IRSensor.html">Infrared Sensor</a></li>
<li class="toctree-l1"><a class="reference internal" href="Logging.html">Logging</a></li>
<li class="toctree-l1"><a class="reference internal" href="Motor.html">Motor</a></li> <li class="toctree-l1"><a class="reference internal" href="Motor.html">Motor</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Servo</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Servo</a></li>
<li class="toctree-l1"><a class="reference internal" href="Vision.html">Vision</a></li> <li class="toctree-l1"><a class="reference internal" href="Vision.html">Vision</a></li>
@ -134,8 +132,6 @@
<div role="navigation" aria-label="breadcrumbs navigation"> <div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
@ -147,7 +143,7 @@
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
<a href="../_sources/lib/Servo.rst.txt" rel="nofollow"> View page source</a> <a href="../_sources/lib/Servo.rst.txt" rel="nofollow"> View page source</a>
@ -196,29 +192,37 @@
</div> </div>
<footer> <footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="Vision.html" class="btn btn-neutral float-right" title="Vision" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="Motor.html" class="btn btn-neutral float-left" title="Motor" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <a href="Vision.html" class="btn btn-neutral float-right" title="Vision" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="Motor.html" class="btn btn-neutral float-left" title="Motor" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div> </div>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<p> <p>
&#169; Copyright 2021, robo4you.
&copy; Copyright 2021, robo4you
</p> </p>
</div> </div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>. provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer> </footer>
</div> </div>
</div> </div>

31
lib/Vision.html
View file

@ -3,9 +3,9 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Vision &mdash; CompLib 0.0.2 documentation</title> <title>Vision &mdash; CompLib 0.0.2 documentation</title>
@ -16,13 +16,10 @@
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script> <script src="../_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
@ -52,7 +49,7 @@
<a href="../index.html" class="icon icon-home"> CompLib <a href="../index.html" class="icon icon-home" alt="Documentation Home"> CompLib
@ -90,6 +87,7 @@
<li class="toctree-l1"><a class="reference internal" href="Battery.html">Battery</a></li> <li class="toctree-l1"><a class="reference internal" href="Battery.html">Battery</a></li>
<li class="toctree-l1"><a class="reference internal" href="Buzzer.html">Buzzer</a></li> <li class="toctree-l1"><a class="reference internal" href="Buzzer.html">Buzzer</a></li>
<li class="toctree-l1"><a class="reference internal" href="IRSensor.html">Infrared Sensor</a></li> <li class="toctree-l1"><a class="reference internal" href="IRSensor.html">Infrared Sensor</a></li>
<li class="toctree-l1"><a class="reference internal" href="Logging.html">Logging</a></li>
<li class="toctree-l1"><a class="reference internal" href="Motor.html">Motor</a></li> <li class="toctree-l1"><a class="reference internal" href="Motor.html">Motor</a></li>
<li class="toctree-l1"><a class="reference internal" href="Servo.html">Servo</a></li> <li class="toctree-l1"><a class="reference internal" href="Servo.html">Servo</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Vision</a><ul> <li class="toctree-l1 current"><a class="current reference internal" href="#">Vision</a><ul>
@ -141,8 +139,6 @@
<div role="navigation" aria-label="breadcrumbs navigation"> <div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
@ -154,7 +150,7 @@
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
<a href="../_sources/lib/Vision.rst.txt" rel="nofollow"> View page source</a> <a href="../_sources/lib/Vision.rst.txt" rel="nofollow"> View page source</a>
@ -258,7 +254,7 @@ point your raspberry pi camera to a chessboard and it should be detected.</p>
<span class="n">gray</span> <span class="o">=</span> <span class="n">cv2</span><span class="o">.</span><span class="n">cvtColor</span><span class="p">(</span><span class="n">frame</span><span class="p">,</span> <span class="n">cv2</span><span class="o">.</span><span class="n">COLOR_BGR2GRAY</span><span class="p">)</span> <span class="n">gray</span> <span class="o">=</span> <span class="n">cv2</span><span class="o">.</span><span class="n">cvtColor</span><span class="p">(</span><span class="n">frame</span><span class="p">,</span> <span class="n">cv2</span><span class="o">.</span><span class="n">COLOR_BGR2GRAY</span><span class="p">)</span>
<span class="c1"># find the chessboard corners</span> <span class="c1"># find the chessboard corners</span>
<span class="n">ret</span><span class="p">,</span> <span class="n">corners</span> <span class="o">=</span> <span class="n">cv2</span><span class="o">.</span><span class="n">findChessboardCorners</span><span class="p">(</span><span class="n">gray</span><span class="p">,</span> <span class="p">(</span><span class="mi">6</span><span class="p">,</span> <span class="mi">9</span><span class="p">),</span> <span class="bp">None</span><span class="p">)</span> <span class="n">ret</span><span class="p">,</span> <span class="n">corners</span> <span class="o">=</span> <span class="n">cv2</span><span class="o">.</span><span class="n">findChessboardCorners</span><span class="p">(</span><span class="n">gray</span><span class="p">,</span> <span class="p">(</span><span class="mi">6</span><span class="p">,</span> <span class="mi">9</span><span class="p">),</span> <span class="kc">None</span><span class="p">)</span>
<span class="c1"># draw detected chessboard position onto the image</span> <span class="c1"># draw detected chessboard position onto the image</span>
<span class="n">cv2</span><span class="o">.</span><span class="n">drawChessboardCorners</span><span class="p">(</span><span class="n">frame</span><span class="p">,</span> <span class="p">(</span><span class="mi">6</span><span class="p">,</span> <span class="mi">9</span><span class="p">),</span> <span class="n">corners</span><span class="p">,</span> <span class="n">ret</span><span class="p">)</span> <span class="n">cv2</span><span class="o">.</span><span class="n">drawChessboardCorners</span><span class="p">(</span><span class="n">frame</span><span class="p">,</span> <span class="p">(</span><span class="mi">6</span><span class="p">,</span> <span class="mi">9</span><span class="p">),</span> <span class="n">corners</span><span class="p">,</span> <span class="n">ret</span><span class="p">)</span>
@ -281,28 +277,35 @@ point your raspberry pi camera to a chessboard and it should be detected.</p>
</div> </div>
<footer> <footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="Servo.html" class="btn btn-neutral float-left" title="Servo" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="Servo.html" class="btn btn-neutral float-left" title="Servo" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div> </div>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<p> <p>
&#169; Copyright 2021, robo4you.
&copy; Copyright 2021, robo4you
</p> </p>
</div> </div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>. provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer> </footer>
</div> </div>
</div> </div>

BIN
objects.inv
View file

Binary file not shown.

34
other/usage.html
View file

@ -3,9 +3,9 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Usage &mdash; CompLib 0.0.2 documentation</title> <title>Usage &mdash; CompLib 0.0.2 documentation</title>
@ -16,13 +16,10 @@
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script> <script src="../_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
@ -53,7 +50,7 @@
<a href="../index.html" class="icon icon-home"> CompLib <a href="../index.html" class="icon icon-home" alt="Documentation Home"> CompLib
@ -91,6 +88,7 @@
<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/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/Buzzer.html">Buzzer</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/IRSensor.html">Infrared Sensor</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> <li class="toctree-l1"><a class="reference internal" href="../lib/Motor.html">Motor</a></li>
<li class="toctree-l1"><a class="reference internal" href="../lib/Servo.html">Servo</a></li> <li class="toctree-l1"><a class="reference internal" href="../lib/Servo.html">Servo</a></li>
<li class="toctree-l1"><a class="reference internal" href="../lib/Vision.html">Vision</a></li> <li class="toctree-l1"><a class="reference internal" href="../lib/Vision.html">Vision</a></li>
@ -134,8 +132,6 @@
<div role="navigation" aria-label="breadcrumbs navigation"> <div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
@ -147,7 +143,7 @@
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
<a href="../_sources/other/usage.rst.txt" rel="nofollow"> View page source</a> <a href="../_sources/other/usage.rst.txt" rel="nofollow"> View page source</a>
@ -175,7 +171,7 @@
<span class="n">Motor</span><span class="o">.</span><span class="n">power</span><span class="p">(</span><span class="n">port</span><span class="p">,</span> <span class="o">-</span><span class="mi">30</span><span class="p">);</span> <span class="n">Motor</span><span class="o">.</span><span class="n">power</span><span class="p">(</span><span class="n">port</span><span class="p">,</span> <span class="o">-</span><span class="mi">30</span><span class="p">);</span>
<span class="k">def</span> <span class="nf">main</span><span class="p">():</span> <span class="k">def</span> <span class="nf">main</span><span class="p">():</span>
<span class="k">print</span><span class="p">(</span><span class="s2">&quot;hallo ich bin ein roboter beep buup&quot;</span><span class="p">)</span> <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;hallo ich bin ein roboter beep buup&quot;</span><span class="p">)</span>
<span class="n">forward</span><span class="p">()</span> <span class="n">forward</span><span class="p">()</span>
<span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span> <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
@ -193,29 +189,37 @@
</div> </div>
<footer> <footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../lib/Api.html" class="btn btn-neutral float-right" title="Api" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="../index.html" class="btn btn-neutral float-left" title="Robo4you Competition Library" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <a href="../lib/Api.html" class="btn btn-neutral float-right" title="Api" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../index.html" class="btn btn-neutral float-left" title="Robo4you Competition Library" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div> </div>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<p> <p>
&#169; Copyright 2021, robo4you.
&copy; Copyright 2021, robo4you
</p> </p>
</div> </div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>. provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer> </footer>
</div> </div>
</div> </div>

24
search.html
View file

@ -3,9 +3,9 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Search &mdash; CompLib 0.0.2 documentation</title> <title>Search &mdash; CompLib 0.0.2 documentation</title>
@ -16,13 +16,10 @@
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
@ -38,7 +35,6 @@
<script type="text/javascript" src="_static/searchtools.js"></script> <script type="text/javascript" src="_static/searchtools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="#" /> <link rel="search" title="Search" href="#" />
</head> </head>
@ -54,7 +50,7 @@
<a href="index.html" class="icon icon-home"> CompLib <a href="index.html" class="icon icon-home" alt="Documentation Home"> CompLib
@ -92,6 +88,7 @@
<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/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/Buzzer.html">Buzzer</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/IRSensor.html">Infrared Sensor</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> <li class="toctree-l1"><a class="reference internal" href="lib/Motor.html">Motor</a></li>
<li class="toctree-l1"><a class="reference internal" href="lib/Servo.html">Servo</a></li> <li class="toctree-l1"><a class="reference internal" href="lib/Servo.html">Servo</a></li>
<li class="toctree-l1"><a class="reference internal" href="lib/Vision.html">Vision</a></li> <li class="toctree-l1"><a class="reference internal" href="lib/Vision.html">Vision</a></li>
@ -135,8 +132,6 @@
<div role="navigation" aria-label="breadcrumbs navigation"> <div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
@ -148,6 +143,8 @@
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
</li> </li>
</ul> </ul>
@ -175,25 +172,28 @@
</div> </div>
<footer> <footer>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<p> <p>
&#169; Copyright 2021, robo4you.
&copy; Copyright 2021, robo4you
</p> </p>
</div> </div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>. provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer> </footer>
</div> </div>
</div> </div>

2
searchindex.js
View file

@ -1 +1 @@
Search.setIndex({docnames:["index","lib/Api","lib/Battery","lib/Buzzer","lib/IRSensor","lib/Motor","lib/Servo","lib/Vision","other/usage"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst","lib/Api.rst","lib/Battery.rst","lib/Buzzer.rst","lib/IRSensor.rst","lib/Motor.rst","lib/Servo.rst","lib/Vision.rst","other/usage.rst"],objects:{"compLib.Api":{DoubleElim:[1,0,1,""],Position:[1,0,1,""],Seeding:[1,0,1,""]},"compLib.Api.DoubleElim":{get_goal:[1,1,1,""],get_items:[1,1,1,""],get_opponent:[1,1,1,""],get_position:[1,1,1,""]},"compLib.Api.Seeding":{get_park:[1,1,1,""],pay_park:[1,1,1,""],simon_says:[1,1,1,""]},"compLib.Battery":{Battery:[2,0,1,""]},"compLib.Battery.Battery":{percent:[2,1,1,""]},"compLib.Buzzer":{Buzzer:[3,0,1,""]},"compLib.Buzzer.Buzzer":{set:[3,1,1,""]},"compLib.IRSensor":{IRSensor:[4,0,1,""]},"compLib.IRSensor.IRSensor":{bottom_left:[4,1,1,""],bottom_middle:[4,1,1,""],bottom_right:[4,1,1,""],top_left_percent:[4,1,1,""],top_right_percent:[4,1,1,""]},"compLib.Motor":{Motor:[5,0,1,""]},"compLib.Motor.Motor":{all_off:[5,1,1,""],power:[5,1,1,""]},"compLib.Servo":{Servo:[6,0,1,""]},"compLib.Servo.Servo":{set_position:[6,1,1,""],setup_position:[6,1,1,""]},"compLib.Vision":{__Streaming:[7,0,1,""]},"compLib.Vision.__Streaming":{get_frame:[7,1,1,""],publish_frame:[7,1,1,""]}},objnames:{"0":["py","class","Python class"],"1":["py","method","Python method"]},objtypes:{"0":"py:class","1":"py:method"},terms:{"001":7,"100":[2,4,5],"2021":0,"9898":7,"class":[0,1,4,6,7],"import":[1,2,3,5,7,8],"int":[1,2,4,5,6],"return":[1,2,4,7],"static":[1,2,3,4,5,6],"true":[1,3,4],"while":7,BUT:7,For:7,NOT:7,The:7,Use:7,Used:[2,3],Using:0,__main__:8,__name__:8,__stream:7,access:4,after:1,all:[1,5],all_off:5,alwai:1,angl:6,api:0,automat:7,back:1,backward:8,batteri:0,becaus:7,beep:8,between:[1,2,4,5,6],bin:8,bit:7,bool:[1,3,4],bottom:4,bottom_left:4,bottom_middl:4,bottom_right:4,browser:7,buffer:7,buup:8,buzzer:0,call:0,cam:7,camera:7,can:[1,7],captur:7,channel:6,chessboard:0,color_bgr2grai:7,come:7,commun:1,complib:[0,1,2,3,4,5,6,7,8],connect:[5,6,7],control:[5,6],convert:7,coordin:1,corner:7,creat:7,criteria:7,current:1,cv2:7,cvtcolor:7,datastructur:1,def:8,degre:1,detect:[0,4],dictionari:1,differ:4,displai:7,document:[0,7],done:7,doubl:0,doubleelim:1,draw:7,drawchessboardcorn:7,drive:[0,1],dure:6,ein:8,elif:1,elimin:0,els:1,exampl:0,fail:1,fals:[1,3],field:1,find:7,findchessboardcorn:7,forward:8,frame:7,from:[1,2,3,5,7,8],game:1,get:[1,2,4,7],get_fram:7,get_goal:1,get_item:1,get_oppon:1,get_park:1,get_posit:1,goal:1,grab:7,grai:7,grayscal:7,hallo:8,handl:7,here:7,hold:1,hopefulli:1,how:7,http:7,ich:8,imag:7,infrar:0,instanc:7,interact:[2,3],interfac:7,internet:7,irsensor:4,item:1,lag:7,left:[4,5],like:[1,7],list:1,littl:7,look:[1,7],main:8,make:1,max:5,mayb:0,middl:4,might:7,modul:[0,1],motor:[0,1,8],move:1,need:7,newest:7,next:1,none:7,note:7,now:1,object:1,off:0,onto:7,opencv:0,oppon:1,output:7,own:7,pai:1,paramet:[3,5,6,7],park:1,parkingsapc:1,pay_park:1,percent:[2,5],percentag:[0,4,5],point:[1,7],port:[5,6,8],posit:[0,6,7],power:[5,8],print:[0,1,8],process:[6,7],provid:7,publish:7,publish_fram:7,rang:[5,8],raspberri:7,realtim:7,record:7,request:1,ret:7,right:[4,5],robot:[1,4,6,8],rotat:1,rtmp:7,run:7,sai:1,score:1,screenshot:7,second:7,seed:0,sensor:0,server:7,servo:0,set:[3,5,6],set_posit:6,setup:6,setup_posit:6,should:[1,7],show:7,signal:4,similar:1,simon:1,simon_sai:1,sleep:[3,8],some:[1,7],someth:1,specifi:5,speed:5,statu:4,straight:0,stream:0,success:1,take:7,term_criteria_ep:7,term_criteria_max_it:7,test:7,thi:[1,7],time:[1,3,8],top:[4,5],top_left_perc:4,top_right_perc:4,turn:[0,5],type:[1,2,4],usag:0,use:7,used:[0,1,5,6],using:[1,7],view:7,vision:0,wait:7,want:7,web:7,webserv:7,websit:7,whatev:7,when:7,which:[5,7],yet:1,you:7,your:7,your_raspi_ip:7,yourself:7,zone:1},titles:["Robo4you Competition Library","Api","Battery","Buzzer","Infrared Sensor","Motor","Servo","Vision","Usage"],titleterms:{"class":[2,3,5],Using:7,api:1,batteri:2,buzzer:3,call:1,chessboard:7,competit:0,content:0,detect:7,document:[2,3,5],doubl:1,drive:5,elimin:1,exampl:[1,2,3,5,7],infrar:4,librari:0,mayb:5,modul:7,motor:5,off:3,opencv:7,percentag:2,posit:1,print:2,robo4y:0,seed:1,sensor:4,servo:6,straight:5,stream:7,turn:3,usag:8,vision:7}}) Search.setIndex({docnames:["index","lib/Api","lib/Battery","lib/Buzzer","lib/IRSensor","lib/Logging","lib/Motor","lib/Servo","lib/Vision","other/usage"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst","lib/Api.rst","lib/Battery.rst","lib/Buzzer.rst","lib/IRSensor.rst","lib/Logging.rst","lib/Motor.rst","lib/Servo.rst","lib/Vision.rst","other/usage.rst"],objects:{"compLib.Api":{DoubleElim:[1,0,1,""],Position:[1,0,1,""],Seeding:[1,0,1,""]},"compLib.Api.DoubleElim":{get_goal:[1,1,1,""],get_items:[1,1,1,""],get_opponent:[1,1,1,""],get_position:[1,1,1,""]},"compLib.Api.Seeding":{get_park:[1,1,1,""],pay_park:[1,1,1,""],simon_says:[1,1,1,""]},"compLib.Battery":{Battery:[2,0,1,""]},"compLib.Battery.Battery":{percent:[2,1,1,""]},"compLib.Buzzer":{Buzzer:[3,0,1,""]},"compLib.Buzzer.Buzzer":{set:[3,1,1,""]},"compLib.IRSensor":{IRSensor:[4,0,1,""]},"compLib.IRSensor.IRSensor":{bottom_left:[4,1,1,""],bottom_middle:[4,1,1,""],bottom_right:[4,1,1,""],top_left_percent:[4,1,1,""],top_right_percent:[4,1,1,""]},"compLib.LogstashLogging":{Logging:[5,0,1,""]},"compLib.LogstashLogging.Logging":{get_logger:[5,1,1,""],set_debug:[5,1,1,""]},"compLib.Motor":{Motor:[6,0,1,""]},"compLib.Motor.Motor":{all_off:[6,1,1,""],power:[6,1,1,""]},"compLib.Servo":{Servo:[7,0,1,""]},"compLib.Servo.Servo":{set_position:[7,1,1,""],setup_position:[7,1,1,""]},"compLib.Vision":{__Streaming:[8,0,1,""]},"compLib.Vision.__Streaming":{get_frame:[8,1,1,""],publish_frame:[8,1,1,""]}},objnames:{"0":["py","class","Python class"],"1":["py","method","Python method"]},objtypes:{"0":"py:class","1":"py:method"},terms:{"001":8,"100":[2,4,6],"2021":0,"9898":8,"class":[0,1,4,7,8],"float":6,"import":[1,2,3,5,6,8,9],"int":[1,2,4,6,7],"return":[1,2,4,5,8],"static":[1,2,3,4,5,6,7],"true":[1,3,4],"while":8,BUT:8,For:8,NOT:8,The:8,Use:8,Used:[2,3],Using:0,__main__:9,__name__:9,__stream:8,access:4,after:1,all:[1,6],all_off:6,alwai:1,angl:7,api:0,automat:8,back:1,backward:9,batteri:0,becaus:8,beep:9,between:[1,2,4,6,7],bin:9,bit:8,bool:[1,3,4],bottom:4,bottom_left:4,bottom_middl:4,bottom_right:4,browser:8,buffer:8,buup:9,buzzer:0,call:0,cam:8,camera:8,can:[1,5,8],captur:8,channel:7,chessboard:0,color_bgr2grai:8,come:8,commun:[1,5],competit:5,complib:[0,1,2,3,4,5,6,7,8,9],connect:[6,7,8],control:[6,7],convert:8,coordin:1,corner:8,creat:8,criteria:8,current:1,cv2:8,cvtcolor:8,datastructur:1,debug:5,def:9,degre:1,detect:[0,4],dictionari:1,differ:4,displai:8,document:[0,8],done:8,doubl:0,doubleelim:1,draw:8,drawchessboardcorn:8,drive:[0,1],dure:7,ein:9,elif:1,elimin:0,els:1,exampl:0,fail:1,fals:[1,3],field:1,find:8,findchessboardcorn:8,forward:9,frame:8,from:[1,2,3,5,6,8,9],game:1,get:[1,2,4,5,8],get_fram:8,get_goal:1,get_item:1,get_logg:5,get_oppon:1,get_park:1,get_posit:1,goal:1,grab:8,grai:8,grayscal:8,hallo:9,handl:8,here:8,hold:1,hopefulli:1,how:8,http:8,ich:9,imag:8,indexerror:6,infrar:0,instanc:8,interact:[2,3],interfac:8,internet:8,irsensor:4,item:1,lag:8,left:[4,6],level:5,librari:5,like:[1,8],list:1,littl:8,log:0,logger:5,logstash:5,logstashlog:5,look:[1,8],main:9,make:1,manual:5,max:6,mayb:0,middl:4,might:8,modul:[0,1],motor:[0,1,9],move:1,need:8,newest:8,next:1,none:8,note:8,now:1,object:[1,5],off:0,onto:8,opencv:0,oppon:1,organ:5,output:8,own:8,pai:1,paramet:[3,6,7,8],park:1,parkingsapc:1,pay_park:1,percent:[2,6],percentag:[0,4,6],point:[1,8],port:[6,7,9],posit:[0,7,8],power:[6,9],print:[0,1,9],process:[7,8],provid:8,publish:8,publish_fram:8,python:5,rais:6,rang:[6,9],raspberri:8,realtim:8,record:8,request:1,ret:8,right:[4,6],robot:[1,4,7,9],rotat:1,rtmp:8,run:8,sai:1,score:1,screenshot:8,second:8,seed:0,sensor:0,server:8,servo:0,set:[3,6,7],set_debug:5,set_posit:7,setup:7,setup_posit:7,should:[1,5,8],show:8,signal:4,similar:1,simon:1,simon_sai:1,sleep:[3,9],some:[1,8],someth:1,specifi:6,speed:6,statu:4,straight:0,stream:0,success:1,take:8,term_criteria_ep:8,term_criteria_max_it:8,test:8,thi:[1,5,8],time:[1,3,9],top:[4,6],top_left_perc:4,top_right_perc:4,turn:[0,6],type:[1,2,4,5],usag:0,use:[5,8],used:[0,1,5,6,7],using:[1,8],view:8,vision:0,wait:8,want:8,web:8,webserv:8,websit:8,whatev:8,when:[5,8],which:[6,8],yet:1,you:8,your:8,your_raspi_ip:8,yourself:8,zone:1},titles:["Robo4you Competition Library","Api","Battery","Buzzer","Infrared Sensor","Logging","Motor","Servo","Vision","Usage"],titleterms:{"class":[2,3,5,6],Using:8,api:1,batteri:2,buzzer:3,call:1,chessboard:8,competit:0,content:0,detect:8,document:[2,3,5,6],doubl:1,drive:6,elimin:1,exampl:[1,2,3,5,6,8],infrar:4,librari:0,log:5,mayb:6,modul:8,motor:6,off:3,opencv:8,percentag:2,posit:1,print:2,robo4y:0,seed:1,sensor:4,servo:7,straight:6,stream:8,turn:[3,5],usag:9,vision:8}})