compLIB.Battery.Battery¶compLib.Battery.Battery¶Used to interact with the battery
percent() → int¶percent() → int¶Get battery 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
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
diff --git a/objects.inv b/objects.inv
index e6e29c3..a746205 100644
Binary files a/objects.inv and b/objects.inv differ
diff --git a/searchindex.js b/searchindex.js
index 3047632..806e349 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({docnames:["index","lib/Battery","lib/Buzzer","lib/IRSensor","lib/Motor","lib/Servo"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst","lib/Battery.rst","lib/Buzzer.rst","lib/IRSensor.rst","lib/Motor.rst","lib/Servo.rst"],objects:{"compLIB.Battery":{Battery:[1,0,1,""]},"compLIB.Battery.Battery":{percent:[1,1,1,""]},"compLIB.Buzzer":{Buzzer:[2,0,1,""]},"compLIB.Buzzer.Buzzer":{set:[2,1,1,""]},"compLIB.IRSensor":{IRSensor:[3,0,1,""]},"compLIB.IRSensor.IRSensor":{bottom_left:[3,1,1,""],bottom_middle:[3,1,1,""],bottom_right:[3,1,1,""],top_left_percent:[3,1,1,""],top_right_percent:[3,1,1,""]},"compLIB.Motor":{Motor:[4,0,1,""]},"compLIB.Motor.Motor":{all_off:[4,1,1,""],power:[4,1,1,""]},"compLIB.Servo":{Servo:[5,0,1,""]},"compLIB.Servo.Servo":{set_position:[5,1,1,""],setup_position:[5,1,1,""]}},objnames:{"0":["py","class","Python class"],"1":["py","method","Python method"]},objtypes:{"0":"py:class","1":"py:method"},terms:{"100":[1,3,4],"class":[0,3,5],"import":[1,2,4],"int":[1,3,4,5],"return":[1,3],"static":[1,2,3,4,5],"true":[2,3],Used:[1,2],access:3,all:4,all_off:4,angl:5,batteri:0,between:[1,3,4,5],bool:[2,3],bottom:3,bottom_left:3,bottom_middl:3,bottom_right:3,buzzer:0,channel:5,complib:[1,2,3,4,5],connect:[4,5],control:[4,5],detect:3,differ:3,drive:0,dure:5,exampl:0,fals:2,from:[1,2,4],get:[1,3],index:0,infrar:0,interact:[1,2],irsensor:3,left:[3,4],max:4,mayb:0,middl:3,modul:0,motor:0,off:0,page:0,paramet:[2,4,5],percent:[1,4],percentag:[0,3,4],port:[4,5],posit:5,power:4,print:0,process:5,rang:4,right:[3,4],robot:[3,5],search:0,sensor:0,servo:0,set:[2,4,5],set_posit:5,setup:5,setup_posit:5,signal:3,sleep:2,specifi:4,speed:4,statu:3,straight:0,time:2,top:[3,4],top_left_perc:3,top_right_perc:3,turn:[0,4],type:[1,3],used:[4,5],which:4},titles:["Welcome to CompLib\u2019s documentation!","Battery","Buzzer","Infrared Sensor","Motor","Servo"],titleterms:{"class":[1,2,4],batteri:1,buzzer:2,complib:0,content:0,document:[0,1,2,4],drive:4,exampl:[1,2,4],indic:0,infrar:3,mayb:4,motor:4,off:2,percentag:1,print:1,sensor:3,servo:5,straight:4,tabl:0,turn:2,welcom:0}})
\ No newline at end of file
+Search.setIndex({docnames:["index","lib/Battery","lib/Buzzer","lib/IRSensor","lib/Motor","lib/Servo"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst","lib/Battery.rst","lib/Buzzer.rst","lib/IRSensor.rst","lib/Motor.rst","lib/Servo.rst"],objects:{"compLib.Battery":{Battery:[1,0,1,""]},"compLib.Battery.Battery":{percent:[1,1,1,""]},"compLib.Buzzer":{Buzzer:[2,0,1,""]},"compLib.Buzzer.Buzzer":{set:[2,1,1,""]},"compLib.IRSensor":{IRSensor:[3,0,1,""]},"compLib.IRSensor.IRSensor":{bottom_left:[3,1,1,""],bottom_middle:[3,1,1,""],bottom_right:[3,1,1,""],top_left_percent:[3,1,1,""],top_right_percent:[3,1,1,""]},"compLib.Motor":{Motor:[4,0,1,""]},"compLib.Motor.Motor":{all_off:[4,1,1,""],power:[4,1,1,""]},"compLib.Servo":{Servo:[5,0,1,""]},"compLib.Servo.Servo":{set_position:[5,1,1,""],setup_position:[5,1,1,""]}},objnames:{"0":["py","class","Python class"],"1":["py","method","Python method"]},objtypes:{"0":"py:class","1":"py:method"},terms:{"100":[1,3,4],"class":[0,3,5],"import":[1,2,4],"int":[1,3,4,5],"return":[1,3],"static":[1,2,3,4,5],"true":[2,3],Used:[1,2],access:3,all:4,all_off:4,angl:5,batteri:0,between:[1,3,4,5],bool:[2,3],bottom:3,bottom_left:3,bottom_middl:3,bottom_right:3,buzzer:0,channel:5,complib:[1,2,3,4,5],connect:[4,5],control:[4,5],detect:3,differ:3,drive:0,dure:5,exampl:0,fals:2,from:[1,2,4],get:[1,3],index:0,infrar:0,interact:[1,2],irsensor:3,left:[3,4],max:4,mayb:0,middl:3,modul:0,motor:0,off:0,page:0,paramet:[2,4,5],percent:[1,4],percentag:[0,3,4],port:[4,5],posit:5,power:4,print:0,process:5,rang:4,right:[3,4],robot:[3,5],search:0,sensor:0,servo:0,set:[2,4,5],set_posit:5,setup:5,setup_posit:5,signal:3,sleep:2,specifi:4,speed:4,statu:3,straight:0,time:2,top:[3,4],top_left_perc:3,top_right_perc:3,turn:[0,4],type:[1,3],used:[4,5],which:4},titles:["Welcome to CompLib\u2019s documentation!","Battery","Buzzer","Infrared Sensor","Motor","Servo"],titleterms:{"class":[1,2,4],batteri:1,buzzer:2,complib:0,content:0,document:[0,1,2,4],drive:4,exampl:[1,2,4],indic:0,infrar:3,mayb:4,motor:4,off:2,percentag:1,print:1,sensor:3,servo:5,straight:4,tabl:0,turn:2,welcom:0}})
\ No newline at end of file