Move client foler

docs/source/lib/classes/DoubleElimination.rst

@@ -0,0 +1,13 @@
+.. _lib_doubleElim:
+
+Double Elimination
+*******************
+
+Dokumentation des Double Elimination Moduls
+============================================
+
+.. autoclass:: compLib.DoubleElimination.Position
+   :members:
+
+.. autoclass:: compLib.DoubleElimination.DoubleElim
+   :members:

docs/source/lib/classes/Encoder.rst

@@ -0,0 +1,10 @@
+.. _lib_encoder:
+
+Encoder
+*******
+
+Dokumentation der Klasse
+========================
+
+.. autoclass:: compLib.Encoder.Encoder
+   :members:

docs/source/lib/classes/IRSensor.rst

@@ -0,0 +1,10 @@
+.. _lib_irsensor:
+
+Infrarot Sensoren
+*****************
+
+Dokumentation der Klasse
+========================
+
+.. autoclass:: compLib.IRSensor.IRSensor
+   :members:

docs/source/lib/classes/Motor.rst

@@ -0,0 +1,50 @@
+.. _lib_motor:
+
+Motoren
+********
+
+Dokumentation der Klasse
+========================
+
+.. autoclass:: compLib.Motor.Motor
+   :members:
+
+Genauere Informationen
+======================
+
+Power vs Speed vs PulseWidth
+-----------------------------
+Zur ansteuerung der Motoren kann entweder ``Motor.power(...)``, ``Motor.speed(...)`` oder ``Motor.pulse_width(...)``` verwendet werden.
+Der Unterschied der 3 Funktionen liegt dabei in der Einheit des 2. Parameters.
+
+| Bei ``Motor.power()`` wird dabei ein Wert zwischen -100% und 100% der maximalen Geschwindigkeit angegeben.
+| ``Motor.speed()`` verwendet die Encoder um die Geschwindigkeit der Motoren mittels closed-loop zu steuern. Diese Funktion sollte nur verwendet werden, wenn ``Motor.power()`` nicht zur Ansteuerung ausreicht.
+| ``Motor.pulse_width()`` stellt die Geschwindigkeit des Motors mittels der Pulsbreite der PWM-Steuerung des Motors ein. Diese Funktion ist so nah an der Hardware wie möglich und sollte auch nur verwendet werden, wenn es einen expliziten Grund dafür gibt.
+
+Normal vs Multiple
+------------------
+Der Aufruf der funktionen kann entweder über ``Motor.power(port, percent)`` oder ``Motor.power((port, percent), (port, percent), ..)`` erfolgen.
+Der zweite Aufruf ermöglicht dem Entwickler dabei beide Motoren in einem Aufruf anzusteuern und bringt einen kleinen Vorteil in der Leistungsfähigkeit der Software.
+
+
+Beispiele
+=========
+
+Vorwärts fahren
+---------------
+
+Mit folgenden Programm drehen sich beide Motoren mit 50% ihrer maximalen Geschwindigkeit.
+Dabei ist zu beachten, dass ein Motor in die entgegengesetzte Richtung zum aneren Motor gedreht werden muss, da diese spiegelverkehrt montiert sind.
+
+Zusätzlich ist ein ``time.sleep(5)`` notwendig, welches das Programm für 5 Sekunden pausiert. Diese Pause wird benötigt, da der Roboter automatisch alle Motoren beim Ende des Progammes deaktiviert.
+
+.. code-block:: python
+
+    from compLib.Motor import Motor
+    import time
+
+    Motor.power(0, -50)
+    Motor.power(3, 50)
+
+    time.sleep(5)
+

docs/source/lib/classes/Opencv.rst

@@ -0,0 +1,13 @@
+.. _lib_camera:
+
+Camera und OpenCV
+*******************
+
+Dokumentation des Camera Moduls
+================================
+
+.. autoclass:: compLib.Camera.Marker
+   :members:
+
+.. autoclass:: compLib.Camera.Camera
+   :members:

docs/source/lib/classes/Seeding.rst

@@ -0,0 +1,36 @@
+.. _lib_seeding:
+
+Seeding
+*******
+
+Dokumentation des Seeding Moduls
+================================
+
+.. autoclass:: compLib.Seeding.Gamestate
+   :members:
+
+Beispiele
+----------
+
+| In ``Zeile 1`` wird das Seeding Modul importiert.
+| In ``Zeile 2`` definieren wir dann eine Variable, in der wir den "Seed" des Gamestates den wir erstellen wollten speichern.
+| In ``Zeile 3`` erstellen wir dann einen neuen Gamestate mit dem Seed und speichern ihn in die Variable ``gamestate``.
+| In ``Zeile 4`` geben wir dann den Gamestate aus, damit wir ihn auf der Konsole ansehen können.
+
+.. code-block:: python
+
+    import compLib.Seeding as Seeding
+    seed = 42
+    gamestate = Seeding.Gamestate(seed)
+    print(gamestate)
+
+In der Ausgabe des Print Statements sehen wir den generierten Gamestate.
+
+.. code-block::
+
+    Seed: 42
+    Heu Color: 1
+    Material Pairs: [[3, 0], [2, 3], [0, 2], [1, 2]]
+    Material Zones: [2, 1, 3, 2]
+    Logistic Plan: [12, 13, 12, 13, 10, 11, 13, 10, 13, 12, 11, 10, 11, 13, 10, 11, 12, 11, 12, 10, 12]
+    Logistic Centers: [[0, 3, 1, 1], [1, 0, 2, 2], [1, 2, 0, 2], [3, 0, 2, 0]]

docs/source/lib/index.rst

@@ -0,0 +1,12 @@
+compLib
+#######
+
+.. toctree::
+    :maxdepth: 5
+
+    classes/Motor
+    classes/Encoder
+    classes/IRSensor
+    classes/Seeding
+    classes/DoubleElimination
+    classes/Opencv