From f7a7dd37ed43dc3fc2ec209adffcd4347c645448 Mon Sep 17 00:00:00 2001 From: Konstantin Lampalzer Date: Sat, 16 Jan 2021 02:12:23 +0100 Subject: [PATCH] Update documentation --- _sources/lib/Battery.rst.txt | 4 ++-- _sources/lib/Buzzer.rst.txt | 4 ++-- _sources/lib/IRSensor.rst.txt | 2 +- _sources/lib/Motor.rst.txt | 4 ++-- _sources/lib/Servo.rst.txt | 2 +- genindex.html | 32 ++++++++++++++++---------------- lib/Battery.html | 10 +++++----- lib/Buzzer.html | 10 +++++----- lib/IRSensor.html | 24 ++++++++++++------------ lib/Motor.html | 14 +++++++------- lib/Servo.html | 12 ++++++------ objects.inv | Bin 558 -> 557 bytes searchindex.js | 2 +- 13 files changed, 60 insertions(+), 60 deletions(-) diff --git a/_sources/lib/Battery.rst.txt b/_sources/lib/Battery.rst.txt index 306730e..3a1d26c 100644 --- a/_sources/lib/Battery.rst.txt +++ b/_sources/lib/Battery.rst.txt @@ -6,7 +6,7 @@ Battery Class Documentation ******************** -.. autoclass:: compLIB.Battery.Battery +.. autoclass:: compLib.Battery.Battery :members: @@ -18,6 +18,6 @@ Printing percentage .. code-block:: python - from compLIB.Battery import Battery + from compLib.Battery import Battery print(Battery.percent()) \ No newline at end of file diff --git a/_sources/lib/Buzzer.rst.txt b/_sources/lib/Buzzer.rst.txt index e5f7790..9ce4584 100644 --- a/_sources/lib/Buzzer.rst.txt +++ b/_sources/lib/Buzzer.rst.txt @@ -6,7 +6,7 @@ Buzzer Class Documentation ******************** -.. autoclass:: compLIB.Buzzer.Buzzer +.. autoclass:: compLib.Buzzer.Buzzer :members: Examples @@ -18,7 +18,7 @@ Turning buzzer on and off .. code-block:: python import time - from compLIB.Buzzer import Buzzer + from compLib.Buzzer import Buzzer Buzzer.set(True) time.sleep(1) diff --git a/_sources/lib/IRSensor.rst.txt b/_sources/lib/IRSensor.rst.txt index d320c0f..f955b0a 100644 --- a/_sources/lib/IRSensor.rst.txt +++ b/_sources/lib/IRSensor.rst.txt @@ -3,5 +3,5 @@ Infrared Sensor ================ -.. autoclass:: compLIB.IRSensor.IRSensor +.. autoclass:: compLib.IRSensor.IRSensor :members: \ No newline at end of file diff --git a/_sources/lib/Motor.rst.txt b/_sources/lib/Motor.rst.txt index f5b9d09..a8be270 100644 --- a/_sources/lib/Motor.rst.txt +++ b/_sources/lib/Motor.rst.txt @@ -6,7 +6,7 @@ Motor Class Documentation ******************** -.. autoclass:: compLIB.Motor.Motor +.. autoclass:: compLib.Motor.Motor :members: Examples @@ -17,7 +17,7 @@ Driving straight (maybe) .. code-block:: python - from compLIB.Motor import Motor + from compLib.Motor import Motor for port in range(0, 4): Motor.power(port, 50) \ No newline at end of file diff --git a/_sources/lib/Servo.rst.txt b/_sources/lib/Servo.rst.txt index eebedc7..5f1c65a 100644 --- a/_sources/lib/Servo.rst.txt +++ b/_sources/lib/Servo.rst.txt @@ -3,5 +3,5 @@ Servo ===== -.. autoclass:: compLIB.Servo.Servo +.. autoclass:: compLib.Servo.Servo :members: \ No newline at end of file diff --git a/genindex.html b/genindex.html index f2b65cc..8c6c539 100644 --- a/genindex.html +++ b/genindex.html @@ -165,7 +165,7 @@

A

@@ -173,17 +173,17 @@

B

@@ -191,7 +191,7 @@

I

@@ -199,7 +199,7 @@

M

@@ -207,11 +207,11 @@

P

@@ -219,15 +219,15 @@

S

@@ -235,11 +235,11 @@

T

diff --git a/lib/Battery.html b/lib/Battery.html index 73a7a1f..7323fd7 100644 --- a/lib/Battery.html +++ b/lib/Battery.html @@ -165,12 +165,12 @@

Class Documentation

-
-class compLIB.Battery.Battery
+
+class compLib.Battery.Battery

Used to interact with the battery

-
-static percent() → int
+
+static percent() → int

Get battery percentage

Returns
@@ -189,7 +189,7 @@

Examples

Printing percentage

-
from compLIB.Battery import Battery
+
from compLib.Battery import Battery
 
 print(Battery.percent())
 

diff --git a/lib/Buzzer.html b/lib/Buzzer.html
index bb05f4f..a387b81 100644
--- a/lib/Buzzer.html
+++ b/lib/Buzzer.html
@@ -165,12 +165,12 @@
 

 
Class Documentation

 

-

-class compLIB.Buzzer.Buzzer

+

+class compLib.Buzzer.Buzzer

 
Used to interact with the buzzer

 

-

-static set(on: bool)

+

+static set(on: bool)

 
Turn the buzzer on / off

 

 
Parameters

@@ -187,7 +187,7 @@
 

 
Turning buzzer on and off

 
import time
-from compLIB.Buzzer import Buzzer
+from compLib.Buzzer import Buzzer
 
 Buzzer.set(True)
 time.sleep(1)
diff --git a/lib/IRSensor.html b/lib/IRSensor.html
index 15115a1..20ef5c0 100644
--- a/lib/IRSensor.html
+++ b/lib/IRSensor.html
@@ -156,12 +156,12 @@
   

 
Infrared Sensor

 

-

-class compLIB.IRSensor.IRSensor

+

+class compLib.IRSensor.IRSensor

 
Access the different IR Sensors at top / bottom of the robot

 

-

-static bottom_left() → bool

+

+static bottom_left() → bool

 
Get bottom left infrared sensor status

 

 
Returns

@@ -174,8 +174,8 @@
 

 
 

-

-static bottom_middle() → bool

+

+static bottom_middle() → bool

 
Get bottom middle infrared sensor status

 

 
Returns

@@ -188,8 +188,8 @@
 

 
 

-

-static bottom_right() → bool

+

+static bottom_right() → bool

 
Get bottom right infrared sensor status

 

 
Returns

@@ -202,8 +202,8 @@
 

 
 

-

-static top_left_percent() → int

+

+static top_left_percent() → int

 
Get top left infrared sensor percentage

 

 
Returns

@@ -216,8 +216,8 @@
 

 
 

-

-static top_right_percent() → int

+

+static top_right_percent() → int

 
Get top right infrared sensor percentage

 

 
Returns

diff --git a/lib/Motor.html b/lib/Motor.html
index b52f177..7579c14 100644
--- a/lib/Motor.html
+++ b/lib/Motor.html
@@ -165,18 +165,18 @@
 

 
Class Documentation

 

-

-class compLIB.Motor.Motor

+

+class compLib.Motor.Motor

 
Class used to control the motors

 

-

-static all_off()

+

+static all_off()

 
Turns of all motors

 

 
 

-

-static power(port: int, percent: int)

+

+static power(port: int, percent: int)

 
Set specified motor to percentage power

 

 
Parameters

@@ -195,7 +195,7 @@
 
Examples

 

 
Driving straight (maybe)

-
from compLIB.Motor import Motor
+
from compLib.Motor import Motor
 
 for port in range(0, 4):
     Motor.power(port, 50)
diff --git a/lib/Servo.html b/lib/Servo.html
index 371ef18..d3683a4 100644
--- a/lib/Servo.html
+++ b/lib/Servo.html
@@ -155,12 +155,12 @@
   

 
Servo

 

-

-class compLIB.Servo.Servo

+

+class compLib.Servo.Servo

 
Control the servo ports on the robot

 

-

-static set_position(channel: int, angle: int)

+

+static set_position(channel: int, angle: int)

 
Set position of servo connected to port

 

 
Parameters

@@ -173,8 +173,8 @@
 

 
 

-

-static setup_position()

+

+static setup_position()

 
Set position of servos to the position used during the setup process

 

 
diff --git a/objects.inv b/objects.inv
index e6e29c31c14d07bcc209e7fe700cdfcc3297e53a..a74620581a3a96529a150c47f710078876a567be 100644
GIT binary patch
delta 448
zcmV;x0YCn(1g!*+cYnQ3!!Quu^Atv~Ca7yim@0u((Sgx&;!9)6i6h$q(uvpL^>`BE
zxN)4HwxO`Zm%Hz~e>)L*`NZPrfoKh~?oL$J>x2`f&WOjB^~nlkX>ZM|_}QLaH)xj6<6Sl-?lmPOfS<$})aU|ENq
qp_>7%nitV-qi4N9+t$tY7elrJB9m-Lw7PDHt$j=O5c~k^<$yB^7v&fL

delta 449
zcmV;y0Y3h%1g->-cYjN6gD?=?a|&1O7OHHsOjnUwDQXs7T7ZXuWH7Q#Te9jkdcB^c
z{sdz_O=#K;9%kN~zn!wOe%x-NO)MqwwmVVXu2UKdfmVnX$$e+eWl3-EP#C21yr>4A
zLM1i71er5((Lr-O0zVy-u-15<6bYD#_XBhLyoX9K?u2nj2Y@J|E%tuvF-72ckhRBH1bkII_PF`}4K%(83}ZvnMtZ+0P<
z5cj}enf;Elw5D?my}-C;qL2lvCJ~qMn|iT_15`yt;2jA`)-+ClqHu*et-+zK7K0u}
zSgJuD;svNm1%Hra=s~AcBwrt&0x4iqstLzBlbgW1`o5p>i-1l)L4S28@cu$0D+m7K
zjNyZYQsrbk=0K2D25ypLT0dT7#K84$jO?3=jHr<~@k(`_ojiX^5q3zgaGdmo56RwJ
zX1EsDcL5h%^j#QmhZjq;9d@QExO7b!c=5JgyRazNAUZ5ug9a>b?=;JzY_m#6W_GY{
r!_LsnfHdkwwA<)eFVJ?a+Wu