Update documentation

This commit is contained in:
Konstantin Lampalzer 2022-01-28 19:51:27 +01:00
parent 16a3609f9f
commit ccb72b1108
4 changed files with 17 additions and 1 deletions

View file

@ -363,7 +363,11 @@
</li>
</ul></li>
<li><a href="lib/Encoder.html#compLib.Encoder.Encoder.read_all">read_all() (compLib.Encoder.Encoder static method)</a>
<ul>
<li><a href="lib/IRSensor.html#compLib.IRSensor.IRSensor.read_all">(compLib.IRSensor.IRSensor static method)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="lib/Encoder.html#compLib.Encoder.Encoder.read_all_raw">read_all_raw() (compLib.Encoder.Encoder static method)</a>

View file

@ -194,6 +194,18 @@
</dl>
</dd></dl>
<dl class="py method">
<dt id="compLib.IRSensor.IRSensor.read_all">
<em class="property">static </em><code class="sig-name descname">read_all</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#compLib.IRSensor.IRSensor.read_all" title="Permalink to this definition"></a></dt>
<dd><p>Read all IR sensors at once.
This is faster than read as it only uses one SPI call for all sensors!</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Tuple of all current ir sensors</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="compLib.IRSensor.IRSensor.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">sensor</span><span class="p">:</span> <span class="n">int</span></em>, <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.IRSensor.IRSensor.set" title="Permalink to this definition"></a></dt>

Binary file not shown.

File diff suppressed because one or more lines are too long