update documentation

compLib/Display.py

@@ -12,7 +12,7 @@ class Display(object):
     """
 
     @staticmethod
-    def write(line: int, text: string):
+    def write(line: int, text: str):
         """Write a string of text to the integrated display.
 
         :param line: Line to write. Between 1 and 4

compLib/Spi.py

@@ -172,7 +172,6 @@ class Spi(object):
         if Spi.read(Register.IDENTIFICATION_MODEL_ID, 1) != 3:
             Logging.get_logger().error(f"Unable to read Version! Make sure the mainboard is connected!")
             print("Unable to read Version! Make sure the mainboard is connected!")
-            sys.exit()
 
     @staticmethod
     def start_health_check_loop():

compLib/__init__.py

@@ -26,16 +26,16 @@ else:
     print("apt is not installed! This is for local development only!")
     
 if spi_found:
-    import compLib.Spi
+    from compLib.Spi import Spi
-    import compLib.Reset
+    from compLib.Reset import Reset
-    import compLib.Encoder
+    from compLib.Encoder import Encoder
     import logging
 
     print(f"\033[34mInitializing chipmunk board...\033[0m")
-    compLib.Reset.Reset.reset_bot()
+    Reset.reset_bot()
-    compLib.Spi.Spi.health_check()
+    Spi.health_check()
-    compLib.Spi.Spi.start_health_check_loop()
+    Spi.start_health_check_loop()
-    compLib.Encoder.Encoder.clear_all()
+    Encoder.clear_all()
     print(f"\033[34mReady\033[0m\n")
 else:
     print("spidev is not installed! This is for local development only!")

docs/source/index.rst

@@ -1,14 +1,12 @@
-Robo4you Competition Library
+.. image:: images/compair-logo-white.svg
+
+Competition Robot Library
 #############################
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
-
-CompLib is the library used in the robo4you competition 2021.
-
-
 Contents
 *********
 

docs/source/other/usage.rst

@@ -9,12 +9,13 @@ Usage
     from compLib.Motor import *
 
     def forward():
-        for port in range(0, 4):
+        Motor.power(1, -30);
-            Motor.power(port, 30);
+        Motor.power(2, 30);
+
 
     def backward():
-        for port in range(0, 4):
+        Motor.power(1, 30);
-            Motor.power(port, -30);
+        Motor.power(2, -30);
 
     def main():
         print("hallo ich bin ein roboter beep buup")