From cf4e88fd3538bdd6dbd891eea70039096f04a9f6 Mon Sep 17 00:00:00 2001 From: Konstantin Lampalzer Date: Sun, 12 Sep 2021 13:46:30 +0200 Subject: [PATCH] Documentation --- docs/source/lib/Battery.rst | 23 ----------------------- docs/source/lib/Buzzer.rst | 25 ------------------------- docs/source/lib/IRSensor.rst | 4 +--- docs/source/lib/IRWrapper.rst | 22 ---------------------- docs/source/lib/Motor.rst | 4 ++-- 5 files changed, 3 insertions(+), 75 deletions(-) delete mode 100644 docs/source/lib/Battery.rst delete mode 100644 docs/source/lib/Buzzer.rst delete mode 100644 docs/source/lib/IRWrapper.rst diff --git a/docs/source/lib/Battery.rst b/docs/source/lib/Battery.rst deleted file mode 100644 index c7d1fb1..0000000 --- a/docs/source/lib/Battery.rst +++ /dev/null @@ -1,23 +0,0 @@ -.. _lib_battery: - -Battery -******** - -Class Documentation -==================== - -.. autoclass:: compLib.Battery.Battery - :members: - - -Examples -========= - -Printing percentage --------------------- - -.. code-block:: python - - from compLib.Battery import Battery - - print(Battery.percent()) \ No newline at end of file diff --git a/docs/source/lib/Buzzer.rst b/docs/source/lib/Buzzer.rst deleted file mode 100644 index 56a81c4..0000000 --- a/docs/source/lib/Buzzer.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. _lib_buzzer: - -Buzzer -******* - -Class Documentation -==================== - -.. autoclass:: compLib.Buzzer.Buzzer - :members: - -Examples -========= - -Turning buzzer on and off --------------------------- - -.. code-block:: python - - import time - from compLib.Buzzer import Buzzer - - Buzzer.set(True) - time.sleep(1) - Buzzer.set(False) \ No newline at end of file diff --git a/docs/source/lib/IRSensor.rst b/docs/source/lib/IRSensor.rst index 26332b9..b1dd232 100644 --- a/docs/source/lib/IRSensor.rst +++ b/docs/source/lib/IRSensor.rst @@ -16,7 +16,5 @@ Testing analog sensors from compLib import IRSensor - ir = IRSensor.IRSensor() - while True: - print ("left: {} middle: {} right: {}".format(ir.bottom_left_analog(), ir.bottom_middle_analog(), ir.bottom_right_analog())) \ No newline at end of file + print ("left: {} middle: {} right: {}".format(IRSensor.read(1), IRSensor.read(3), IRSensor.read(5))) \ No newline at end of file diff --git a/docs/source/lib/IRWrapper.rst b/docs/source/lib/IRWrapper.rst deleted file mode 100644 index 15232a7..0000000 --- a/docs/source/lib/IRWrapper.rst +++ /dev/null @@ -1,22 +0,0 @@ -.. _lib_irwrapper: - -Infrared Wrapper -**************** - -.. autoclass:: compLib.IRWrapper.IRWrapper - :members: - -Examples -========= - -Calibrating analog sensors --------------------------- - -.. code-block:: python - - from compLib import IRWrapper - - ir = IRWrapper.IRWrapper() - - ir.calibrate() - print("left {} middle {} right {}".format(ir.bottom_left_calibrated(), ir.bottom_middle_calibrated(), ir.bottom_right_calibrated())) diff --git a/docs/source/lib/Motor.rst b/docs/source/lib/Motor.rst index 5febcfe..e5d6854 100644 --- a/docs/source/lib/Motor.rst +++ b/docs/source/lib/Motor.rst @@ -19,5 +19,5 @@ Driving straight (maybe) from compLib.Motor import Motor - for port in range(0, 4): - Motor.power(port, 50) \ No newline at end of file + Motor.power(1, 50) + Motor.power(2, 50) \ No newline at end of file