From ccd46ee8a75107ad23500fca43489f80bcdc0ab4 Mon Sep 17 00:00:00 2001 From: Konstantin Lampalzer Date: Sun, 12 Sep 2021 13:46:58 +0200 Subject: [PATCH] Update documentation --- _sources/lib/Display.rst.txt | 23 +++ _sources/lib/Encoder.rst.txt | 10 ++ _sources/lib/IRSensor.rst.txt | 4 +- _sources/lib/Motor.rst.txt | 4 +- genindex.html | 151 ++---------------- index.html | 28 +--- lib/Api.html | 135 +--------------- lib/Aruco.html | 9 +- lib/Display.html | 244 ++++++++++++++++++++++++++++ lib/Encoder.html | 288 ++++++++++++++++++++++++++++++++++ lib/IRSensor.html | 135 +--------------- lib/Linefollower.html | 9 +- lib/Logging.html | 5 +- lib/Motor.html | 38 +---- lib/Servo.html | 31 +--- lib/Vision.html | 40 +---- objects.inv | Bin 940 -> 634 bytes other/usage.html | 5 +- search.html | 5 +- searchindex.js | 2 +- 20 files changed, 623 insertions(+), 543 deletions(-) create mode 100644 _sources/lib/Display.rst.txt create mode 100644 _sources/lib/Encoder.rst.txt create mode 100644 lib/Display.html create mode 100644 lib/Encoder.html diff --git a/_sources/lib/Display.rst.txt b/_sources/lib/Display.rst.txt new file mode 100644 index 0000000..6701845 --- /dev/null +++ b/_sources/lib/Display.rst.txt @@ -0,0 +1,23 @@ +.. _lib_display: + +Display +******* + +Class Documentation +==================== + +.. autoclass:: compLib.Display.Display + :members: + +Examples +========= + +Write a line to the display +--------------------------- + +.. code-block:: python + + import time + from compLib.Display import Display + + Display.write(1, "Hello World!") \ No newline at end of file diff --git a/_sources/lib/Encoder.rst.txt b/_sources/lib/Encoder.rst.txt new file mode 100644 index 0000000..1d5bf30 --- /dev/null +++ b/_sources/lib/Encoder.rst.txt @@ -0,0 +1,10 @@ +.. _lib_encoder: + +Encoder +******* + +Class Documentation +==================== + +.. autoclass:: compLib.Encoder.Encoder + :members: diff --git a/_sources/lib/IRSensor.rst.txt b/_sources/lib/IRSensor.rst.txt index 26332b9..b1dd232 100644 --- a/_sources/lib/IRSensor.rst.txt +++ b/_sources/lib/IRSensor.rst.txt @@ -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/_sources/lib/Motor.rst.txt b/_sources/lib/Motor.rst.txt index 5febcfe..e5d6854 100644 --- a/_sources/lib/Motor.rst.txt +++ b/_sources/lib/Motor.rst.txt @@ -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 diff --git a/genindex.html b/genindex.html index 22e7db9..05541e5 100644 --- a/genindex.html +++ b/genindex.html @@ -84,10 +84,9 @@
  • Usage
  • Api
  • Aruco
    • -
  • Battery
    • -
  • Buzzer
    • +
  • Display
    • +
  • Encoder
  • Infrared Sensor
    • -
  • Infrared Wrapper
  • Linefollower Examples
  • Logging
  • Motor
    • @@ -160,82 +159,30 @@

    Index

    - _ - | A - | B - | C - | D + C + | E | G - | I | L - | M - | P + | R | S - | T
    -

    _

    - - -
    - -

    A

    - - - -
    - -

    B

    - - - -
    -

    C

    +
    -

    D

    +

    E

    @@ -243,35 +190,7 @@

    G

    - -
    - -

    I

    - - -
    @@ -284,62 +203,22 @@ -

    M

    +

    R

    -
    - -

    P

    - -

    S

    - -
    - -

    T

    - - -
    diff --git a/index.html b/index.html index 7ebe355..2ca1bcf 100644 --- a/index.html +++ b/index.html @@ -85,10 +85,9 @@
  • Usage
  • Api
  • Aruco
    • -
  • Battery
    • -
  • Buzzer
    • +
  • Display
    • +
  • Encoder
  • Infrared Sensor
    • -
  • Infrared Wrapper
  • Linefollower Examples
  • Logging
  • Motor
    • @@ -188,20 +187,16 @@ -
  • Battery