compAIR/compLIB
compAIR/compLIB
Archived
4
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Update documentation

Browse source
This commit is contained in:
Konstantin Lampalzer 2021-01-16 02:12:23 +01:00
parent d555d55b2c
commit f7a7dd37ed
No known key found for this signature in database
GPG key ID: 9A60A522835A2AD9
13 changed files with 60 additions and 60 deletions
Download patch file Download diff file Expand all files Collapse all files

4
_sources/lib/Battery.rst.txt
View file

@ -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())

4
_sources/lib/Buzzer.rst.txt
View file

@ -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)

2
_sources/lib/IRSensor.rst.txt
View file

@ -3,5 +3,5 @@
Infrared Sensor
================
.. autoclass:: compLIB.IRSensor.IRSensor
.. autoclass:: compLib.IRSensor.IRSensor
:members:

4
_sources/lib/Motor.rst.txt
View file

@ -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)

2
_sources/lib/Servo.rst.txt
View file

@ -3,5 +3,5 @@
Servo
=====
.. autoclass:: compLIB.Servo.Servo
.. autoclass:: compLib.Servo.Servo
:members:

32
genindex.html
View file

@ -165,7 +165,7 @@
<h2 id="A">A</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="lib/Motor.html#compLIB.Motor.Motor.all_off">all_off() (compLIB.Motor.Motor static method)</a>
<li><a href="lib/Motor.html#compLib.Motor.Motor.all_off">all_off() (compLib.Motor.Motor static method)</a>
</li>
</ul></td>
</tr></table>
@ -173,17 +173,17 @@
<h2 id="B">B</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="lib/Battery.html#compLIB.Battery.Battery">Battery (class in compLIB.Battery)</a>
<li><a href="lib/Battery.html#compLib.Battery.Battery">Battery (class in compLib.Battery)</a>
</li>
<li><a href="lib/IRSensor.html#compLIB.IRSensor.IRSensor.bottom_left">bottom_left() (compLIB.IRSensor.IRSensor static method)</a>
<li><a href="lib/IRSensor.html#compLib.IRSensor.IRSensor.bottom_left">bottom_left() (compLib.IRSensor.IRSensor static method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="lib/IRSensor.html#compLIB.IRSensor.IRSensor.bottom_middle">bottom_middle() (compLIB.IRSensor.IRSensor static method)</a>
<li><a href="lib/IRSensor.html#compLib.IRSensor.IRSensor.bottom_middle">bottom_middle() (compLib.IRSensor.IRSensor static method)</a>
</li>
<li><a href="lib/IRSensor.html#compLIB.IRSensor.IRSensor.bottom_right">bottom_right() (compLIB.IRSensor.IRSensor static method)</a>
<li><a href="lib/IRSensor.html#compLib.IRSensor.IRSensor.bottom_right">bottom_right() (compLib.IRSensor.IRSensor static method)</a>
</li>
<li><a href="lib/Buzzer.html#compLIB.Buzzer.Buzzer">Buzzer (class in compLIB.Buzzer)</a>
<li><a href="lib/Buzzer.html#compLib.Buzzer.Buzzer">Buzzer (class in compLib.Buzzer)</a>
</li>
</ul></td>
</tr></table>
@ -191,7 +191,7 @@
<h2 id="I">I</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="lib/IRSensor.html#compLIB.IRSensor.IRSensor">IRSensor (class in compLIB.IRSensor)</a>
<li><a href="lib/IRSensor.html#compLib.IRSensor.IRSensor">IRSensor (class in compLib.IRSensor)</a>
</li>
</ul></td>
</tr></table>
@ -199,7 +199,7 @@
<h2 id="M">M</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="lib/Motor.html#compLIB.Motor.Motor">Motor (class in compLIB.Motor)</a>
<li><a href="lib/Motor.html#compLib.Motor.Motor">Motor (class in compLib.Motor)</a>
</li>
</ul></td>
</tr></table>
@ -207,11 +207,11 @@
<h2 id="P">P</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="lib/Battery.html#compLIB.Battery.Battery.percent">percent() (compLIB.Battery.Battery static method)</a>
<li><a href="lib/Battery.html#compLib.Battery.Battery.percent">percent() (compLib.Battery.Battery static method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="lib/Motor.html#compLIB.Motor.Motor.power">power() (compLIB.Motor.Motor static method)</a>
<li><a href="lib/Motor.html#compLib.Motor.Motor.power">power() (compLib.Motor.Motor static method)</a>
</li>
</ul></td>
</tr></table>
@ -219,15 +219,15 @@
<h2 id="S">S</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="lib/Servo.html#compLIB.Servo.Servo">Servo (class in compLIB.Servo)</a>
<li><a href="lib/Servo.html#compLib.Servo.Servo">Servo (class in compLib.Servo)</a>
</li>
<li><a href="lib/Buzzer.html#compLIB.Buzzer.Buzzer.set">set() (compLIB.Buzzer.Buzzer static method)</a>
<li><a href="lib/Buzzer.html#compLib.Buzzer.Buzzer.set">set() (compLib.Buzzer.Buzzer static method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="lib/Servo.html#compLIB.Servo.Servo.set_position">set_position() (compLIB.Servo.Servo static method)</a>
<li><a href="lib/Servo.html#compLib.Servo.Servo.set_position">set_position() (compLib.Servo.Servo static method)</a>
</li>
<li><a href="lib/Servo.html#compLIB.Servo.Servo.setup_position">setup_position() (compLIB.Servo.Servo static method)</a>
<li><a href="lib/Servo.html#compLib.Servo.Servo.setup_position">setup_position() (compLib.Servo.Servo static method)</a>
</li>
</ul></td>
</tr></table>
@ -235,11 +235,11 @@
<h2 id="T">T</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="lib/IRSensor.html#compLIB.IRSensor.IRSensor.top_left_percent">top_left_percent() (compLIB.IRSensor.IRSensor static method)</a>
<li><a href="lib/IRSensor.html#compLib.IRSensor.IRSensor.top_left_percent">top_left_percent() (compLib.IRSensor.IRSensor static method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="lib/IRSensor.html#compLIB.IRSensor.IRSensor.top_right_percent">top_right_percent() (compLIB.IRSensor.IRSensor static method)</a>
<li><a href="lib/IRSensor.html#compLib.IRSensor.IRSensor.top_right_percent">top_right_percent() (compLib.IRSensor.IRSensor static method)</a>
</li>
</ul></td>
</tr></table>

10
lib/Battery.html
View file

@ -165,12 +165,12 @@
<div class="section" id="class-documentation">
<h2>Class Documentation<a class="headerlink" href="#class-documentation" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="compLIB.Battery.Battery">
<em class="property">class </em><code class="sig-prename descclassname">compLIB.Battery.</code><code class="sig-name descname">Battery</code><a class="headerlink" href="#compLIB.Battery.Battery" title="Permalink to this definition"></a></dt>
<dt id="compLib.Battery.Battery">
<em class="property">class </em><code class="sig-prename descclassname">compLib.Battery.</code><code class="sig-name descname">Battery</code><a class="headerlink" href="#compLib.Battery.Battery" title="Permalink to this definition"></a></dt>
<dd><p>Used to interact with the battery</p>
<dl class="py method">
<dt id="compLIB.Battery.Battery.percent">
<em class="property">static </em><code class="sig-name descname">percent</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; int<a class="headerlink" href="#compLIB.Battery.Battery.percent" title="Permalink to this definition"></a></dt>
<dt id="compLib.Battery.Battery.percent">
<em class="property">static </em><code class="sig-name descname">percent</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; int<a class="headerlink" href="#compLib.Battery.Battery.percent" title="Permalink to this definition"></a></dt>
<dd><p>Get battery percentage</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
@ -189,7 +189,7 @@
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="section" id="printing-percentage">
<h3>Printing percentage<a class="headerlink" href="#printing-percentage" title="Permalink to this headline"></a></h3>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">compLIB.Battery</span> <span class="kn">import</span> <span class="n">Battery</span>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">compLib.Battery</span> <span class="kn">import</span> <span class="n">Battery</span>
<span class="nb">print</span><span class="p">(</span><span class="n">Battery</span><span class="o">.</span><span class="n">percent</span><span class="p">())</span>
</pre></div>

10
lib/Buzzer.html
View file

@ -165,12 +165,12 @@
<div class="section" id="class-documentation">
<h2>Class Documentation<a class="headerlink" href="#class-documentation" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="compLIB.Buzzer.Buzzer">
<em class="property">class </em><code class="sig-prename descclassname">compLIB.Buzzer.</code><code class="sig-name descname">Buzzer</code><a class="headerlink" href="#compLIB.Buzzer.Buzzer" title="Permalink to this definition"></a></dt>
<dt id="compLib.Buzzer.Buzzer">
<em class="property">class </em><code class="sig-prename descclassname">compLib.Buzzer.</code><code class="sig-name descname">Buzzer</code><a class="headerlink" href="#compLib.Buzzer.Buzzer" title="Permalink to this definition"></a></dt>
<dd><p>Used to interact with the buzzer</p>
<dl class="py method">
<dt id="compLIB.Buzzer.Buzzer.set">
<em class="property">static </em><code class="sig-name descname">set</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">on</span><span class="p">:</span> <span class="n">bool</span></em><span class="sig-paren">)</span><a class="headerlink" href="#compLIB.Buzzer.Buzzer.set" title="Permalink to this definition"></a></dt>
<dt id="compLib.Buzzer.Buzzer.set">
<em class="property">static </em><code class="sig-name descname">set</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">on</span><span class="p">:</span> <span class="n">bool</span></em><span class="sig-paren">)</span><a class="headerlink" href="#compLib.Buzzer.Buzzer.set" title="Permalink to this definition"></a></dt>
<dd><p>Turn the buzzer on / off</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
@ -187,7 +187,7 @@
<div class="section" id="turning-buzzer-on-and-off">
<h3>Turning buzzer on and off<a class="headerlink" href="#turning-buzzer-on-and-off" title="Permalink to this headline"></a></h3>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">time</span>
<span class="kn">from</span> <span class="nn">compLIB.Buzzer</span> <span class="kn">import</span> <span class="n">Buzzer</span>
<span class="kn">from</span> <span class="nn">compLib.Buzzer</span> <span class="kn">import</span> <span class="n">Buzzer</span>
<span class="n">Buzzer</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="kc">True</span><span class="p">)</span>
<span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>

24
lib/IRSensor.html
View file

@ -156,12 +156,12 @@
<div class="section" id="infrared-sensor">
<span id="lib-irsensor"></span><h1>Infrared Sensor<a class="headerlink" href="#infrared-sensor" title="Permalink to this headline"></a></h1>
<dl class="py class">
<dt id="compLIB.IRSensor.IRSensor">
<em class="property">class </em><code class="sig-prename descclassname">compLIB.IRSensor.</code><code class="sig-name descname">IRSensor</code><a class="headerlink" href="#compLIB.IRSensor.IRSensor" title="Permalink to this definition"></a></dt>
<dt id="compLib.IRSensor.IRSensor">
<em class="property">class </em><code class="sig-prename descclassname">compLib.IRSensor.</code><code class="sig-name descname">IRSensor</code><a class="headerlink" href="#compLib.IRSensor.IRSensor" title="Permalink to this definition"></a></dt>
<dd><p>Access the different IR Sensors at top / bottom of the robot</p>
<dl class="py method">
<dt id="compLIB.IRSensor.IRSensor.bottom_left">
<em class="property">static </em><code class="sig-name descname">bottom_left</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; bool<a class="headerlink" href="#compLIB.IRSensor.IRSensor.bottom_left" title="Permalink to this definition"></a></dt>
<dt id="compLib.IRSensor.IRSensor.bottom_left">
<em class="property">static </em><code class="sig-name descname">bottom_left</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; bool<a class="headerlink" href="#compLib.IRSensor.IRSensor.bottom_left" title="Permalink to this definition"></a></dt>
<dd><p>Get bottom left infrared sensor status</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
@ -174,8 +174,8 @@
</dd></dl>
<dl class="py method">
<dt id="compLIB.IRSensor.IRSensor.bottom_middle">
<em class="property">static </em><code class="sig-name descname">bottom_middle</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; bool<a class="headerlink" href="#compLIB.IRSensor.IRSensor.bottom_middle" title="Permalink to this definition"></a></dt>
<dt id="compLib.IRSensor.IRSensor.bottom_middle">
<em class="property">static </em><code class="sig-name descname">bottom_middle</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; bool<a class="headerlink" href="#compLib.IRSensor.IRSensor.bottom_middle" title="Permalink to this definition"></a></dt>
<dd><p>Get bottom middle infrared sensor status</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
@ -188,8 +188,8 @@
</dd></dl>
<dl class="py method">
<dt id="compLIB.IRSensor.IRSensor.bottom_right">
<em class="property">static </em><code class="sig-name descname">bottom_right</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; bool<a class="headerlink" href="#compLIB.IRSensor.IRSensor.bottom_right" title="Permalink to this definition"></a></dt>
<dt id="compLib.IRSensor.IRSensor.bottom_right">
<em class="property">static </em><code class="sig-name descname">bottom_right</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; bool<a class="headerlink" href="#compLib.IRSensor.IRSensor.bottom_right" title="Permalink to this definition"></a></dt>
<dd><p>Get bottom right infrared sensor status</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
@ -202,8 +202,8 @@
</dd></dl>
<dl class="py method">
<dt id="compLIB.IRSensor.IRSensor.top_left_percent">
<em class="property">static </em><code class="sig-name descname">top_left_percent</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; int<a class="headerlink" href="#compLIB.IRSensor.IRSensor.top_left_percent" title="Permalink to this definition"></a></dt>
<dt id="compLib.IRSensor.IRSensor.top_left_percent">
<em class="property">static </em><code class="sig-name descname">top_left_percent</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; int<a class="headerlink" href="#compLib.IRSensor.IRSensor.top_left_percent" title="Permalink to this definition"></a></dt>
<dd><p>Get top left infrared sensor percentage</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
@ -216,8 +216,8 @@
</dd></dl>
<dl class="py method">
<dt id="compLIB.IRSensor.IRSensor.top_right_percent">
<em class="property">static </em><code class="sig-name descname">top_right_percent</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; int<a class="headerlink" href="#compLIB.IRSensor.IRSensor.top_right_percent" title="Permalink to this definition"></a></dt>
<dt id="compLib.IRSensor.IRSensor.top_right_percent">
<em class="property">static </em><code class="sig-name descname">top_right_percent</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; int<a class="headerlink" href="#compLib.IRSensor.IRSensor.top_right_percent" title="Permalink to this definition"></a></dt>
<dd><p>Get top right infrared sensor percentage</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>

14
lib/Motor.html
View file

@ -165,18 +165,18 @@
<div class="section" id="class-documentation">
<h2>Class Documentation<a class="headerlink" href="#class-documentation" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="compLIB.Motor.Motor">
<em class="property">class </em><code class="sig-prename descclassname">compLIB.Motor.</code><code class="sig-name descname">Motor</code><a class="headerlink" href="#compLIB.Motor.Motor" title="Permalink to this definition"></a></dt>
<dt id="compLib.Motor.Motor">
<em class="property">class </em><code class="sig-prename descclassname">compLib.Motor.</code><code class="sig-name descname">Motor</code><a class="headerlink" href="#compLib.Motor.Motor" title="Permalink to this definition"></a></dt>
<dd><p>Class used to control the motors</p>
<dl class="py method">
<dt id="compLIB.Motor.Motor.all_off">
<em class="property">static </em><code class="sig-name descname">all_off</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#compLIB.Motor.Motor.all_off" title="Permalink to this definition"></a></dt>
<dt id="compLib.Motor.Motor.all_off">
<em class="property">static </em><code class="sig-name descname">all_off</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#compLib.Motor.Motor.all_off" title="Permalink to this definition"></a></dt>
<dd><p>Turns of all motors</p>
</dd></dl>
<dl class="py method">
<dt id="compLIB.Motor.Motor.power">
<em class="property">static </em><code class="sig-name descname">power</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">port</span><span class="p">:</span> <span class="n">int</span></em>, <em class="sig-param"><span class="n">percent</span><span class="p">:</span> <span class="n">int</span></em><span class="sig-paren">)</span><a class="headerlink" href="#compLIB.Motor.Motor.power" title="Permalink to this definition"></a></dt>
<dt id="compLib.Motor.Motor.power">
<em class="property">static </em><code class="sig-name descname">power</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">port</span><span class="p">:</span> <span class="n">int</span></em>, <em class="sig-param"><span class="n">percent</span><span class="p">:</span> <span class="n">int</span></em><span class="sig-paren">)</span><a class="headerlink" href="#compLib.Motor.Motor.power" title="Permalink to this definition"></a></dt>
<dd><p>Set specified motor to percentage power</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
@ -195,7 +195,7 @@
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="section" id="driving-straight-maybe">
<h3>Driving straight (maybe)<a class="headerlink" href="#driving-straight-maybe" title="Permalink to this headline"></a></h3>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">compLIB.Motor</span> <span class="kn">import</span> <span class="n">Motor</span>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">compLib.Motor</span> <span class="kn">import</span> <span class="n">Motor</span>
<span class="k">for</span> <span class="n">port</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">4</span><span class="p">):</span>
<span class="n">Motor</span><span class="o">.</span><span class="n">power</span><span class="p">(</span><span class="n">port</span><span class="p">,</span> <span class="mi">50</span><span class="p">)</span>

12
lib/Servo.html
View file

@ -155,12 +155,12 @@
<div class="section" id="servo">
<span id="lib-servo"></span><h1>Servo<a class="headerlink" href="#servo" title="Permalink to this headline"></a></h1>
<dl class="py class">
<dt id="compLIB.Servo.Servo">
<em class="property">class </em><code class="sig-prename descclassname">compLIB.Servo.</code><code class="sig-name descname">Servo</code><a class="headerlink" href="#compLIB.Servo.Servo" title="Permalink to this definition"></a></dt>
<dt id="compLib.Servo.Servo">
<em class="property">class </em><code class="sig-prename descclassname">compLib.Servo.</code><code class="sig-name descname">Servo</code><a class="headerlink" href="#compLib.Servo.Servo" title="Permalink to this definition"></a></dt>
<dd><p>Control the servo ports on the robot</p>
<dl class="py method">
<dt id="compLIB.Servo.Servo.set_position">
<em class="property">static </em><code class="sig-name descname">set_position</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">channel</span><span class="p">:</span> <span class="n">int</span></em>, <em class="sig-param"><span class="n">angle</span><span class="p">:</span> <span class="n">int</span></em><span class="sig-paren">)</span><a class="headerlink" href="#compLIB.Servo.Servo.set_position" title="Permalink to this definition"></a></dt>
<dt id="compLib.Servo.Servo.set_position">
<em class="property">static </em><code class="sig-name descname">set_position</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">channel</span><span class="p">:</span> <span class="n">int</span></em>, <em class="sig-param"><span class="n">angle</span><span class="p">:</span> <span class="n">int</span></em><span class="sig-paren">)</span><a class="headerlink" href="#compLib.Servo.Servo.set_position" title="Permalink to this definition"></a></dt>
<dd><p>Set position of servo connected to port</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
@ -173,8 +173,8 @@
</dd></dl>
<dl class="py method">
<dt id="compLIB.Servo.Servo.setup_position">
<em class="property">static </em><code class="sig-name descname">setup_position</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#compLIB.Servo.Servo.setup_position" title="Permalink to this definition"></a></dt>
<dt id="compLib.Servo.Servo.setup_position">
<em class="property">static </em><code class="sig-name descname">setup_position</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#compLib.Servo.Servo.setup_position" title="Permalink to this definition"></a></dt>
<dd><p>Set position of servos to the position used during the setup process</p>
</dd></dl>

BIN
objects.inv
View file

Binary file not shown.

2
searchindex.js
View file

@ -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}})
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}})