Update documentation
This commit is contained in:
parent
d555d55b2c
commit
f7a7dd37ed
13 changed files with 60 additions and 60 deletions
|
@ -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> → 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> → 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> → 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> → 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> → 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> → 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> → 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> → 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> → 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> → 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>
|
||||
|
|
Reference in a new issue