documentation, IP writing service

client_s2/docs/source/lib/classes/Motor.rst

@@ -0,0 +1,47 @@
+.. _lib_motor:
+
+Motoren
+********
+
+Dokumentation der Klasse
+========================
+
+.. autoclass:: compLib.Motor.Motor
+   :members:
+
+Genauere Informationen
+======================
+
+Power vs Speed
+--------------
+Zur ansteuerung der Motoren kann entweder ``Motor.power(...)`` oder ``Motor.speed(...)`` verwendet werden.
+Der Unterschied der 2 Funktionen liegt dabei in der Einheit des 2. Parameters. Bei ``Motor.power()`` wird dabei ein Wert zwischen -100% und 100% der maximalen Geschwindigkeit angegeben.
+Im Gegensatz dazu erlaubt einem ``Motor.speed()`` eine Geschwindigkeit in Umdrehungen pro Minute.
+
+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)
+

client_s2/docs/source/lib/index.rst

@@ -0,0 +1,8 @@
+compLib
+#######
+
+.. toctree::
+    :maxdepth: 5
+    :glob:
+
+    classes/*