Skip to content

Commit

Permalink
deploy: c07f894
Browse files Browse the repository at this point in the history
  • Loading branch information
@joaoantoniocardoso
joaoantoniocardoso committed Mar 1, 2024
1 parent 18caa47 commit 56ad847
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 25 deletions.
6 changes: 2 additions & 4 deletions python/genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -221,10 +221,6 @@ <h2 id="M">M</h2>

<h2 id="P">P</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#bluerobotics_navigator.pwm_enable">pwm_enable() (in module bluerobotics_navigator)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#bluerobotics_navigator.PwmChannel">PwmChannel (class in bluerobotics_navigator)</a>
</li>
Expand Down Expand Up @@ -273,6 +269,8 @@ <h2 id="S">S</h2>
<li><a href="index.html#bluerobotics_navigator.set_pwm_channels_value">set_pwm_channels_value() (in module bluerobotics_navigator)</a>
</li>
<li><a href="index.html#bluerobotics_navigator.set_pwm_channels_values">set_pwm_channels_values() (in module bluerobotics_navigator)</a>
</li>
<li><a href="index.html#bluerobotics_navigator.set_pwm_enable">set_pwm_enable() (in module bluerobotics_navigator)</a>
</li>
<li><a href="index.html#bluerobotics_navigator.set_pwm_freq_hz">set_pwm_freq_hz() (in module bluerobotics_navigator)</a>
</li>
Expand Down
40 changes: 20 additions & 20 deletions python/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,6 @@
</li>
<li><a class="reference internal" href="#bluerobotics_navigator.get_led"><code class="docutils literal notranslate"><span class="pre">get_led()</span></code></a></li>
<li><a class="reference internal" href="#bluerobotics_navigator.init"><code class="docutils literal notranslate"><span class="pre">init()</span></code></a></li>
<li><a class="reference internal" href="#bluerobotics_navigator.pwm_enable"><code class="docutils literal notranslate"><span class="pre">pwm_enable()</span></code></a></li>
<li><a class="reference internal" href="#bluerobotics_navigator.read_accel"><code class="docutils literal notranslate"><span class="pre">read_accel()</span></code></a></li>
<li><a class="reference internal" href="#bluerobotics_navigator.read_adc"><code class="docutils literal notranslate"><span class="pre">read_adc()</span></code></a></li>
<li><a class="reference internal" href="#bluerobotics_navigator.read_adc_all"><code class="docutils literal notranslate"><span class="pre">read_adc_all()</span></code></a></li>
Expand All @@ -111,6 +110,7 @@
<li><a class="reference internal" href="#bluerobotics_navigator.set_pwm_channel_value"><code class="docutils literal notranslate"><span class="pre">set_pwm_channel_value()</span></code></a></li>
<li><a class="reference internal" href="#bluerobotics_navigator.set_pwm_channels_value"><code class="docutils literal notranslate"><span class="pre">set_pwm_channels_value()</span></code></a></li>
<li><a class="reference internal" href="#bluerobotics_navigator.set_pwm_channels_values"><code class="docutils literal notranslate"><span class="pre">set_pwm_channels_values()</span></code></a></li>
<li><a class="reference internal" href="#bluerobotics_navigator.set_pwm_enable"><code class="docutils literal notranslate"><span class="pre">set_pwm_enable()</span></code></a></li>
<li><a class="reference internal" href="#bluerobotics_navigator.set_pwm_freq_hz"><code class="docutils literal notranslate"><span class="pre">set_pwm_freq_hz()</span></code></a></li>
<li><a class="reference internal" href="#bluerobotics_navigator.set_pwm_freq_prescale"><code class="docutils literal notranslate"><span class="pre">set_pwm_freq_prescale()</span></code></a></li>
</ul>
Expand Down Expand Up @@ -373,22 +373,6 @@ <h1>BlueRobotics’s Navigator Library<a class="headerlink" href="#bluerobotics-
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="bluerobotics_navigator.pwm_enable">
<span class="sig-prename descclassname"><span class="pre">bluerobotics_navigator.</span></span><span class="sig-name descname"><span class="pre">pwm_enable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">state</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bluerobotics_navigator.pwm_enable" title="Link to this definition"></a></dt>
<dd><p>Enables or disables the PWM chip (PCA9685), using the firmware and OE_pin.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>state</strong> (<em>bool</em>) – The desired PWM chip state. <cite>True</cite> -&gt; ON, <cite>False</cite> -&gt; OFF.</p>
</dd>
</dl>
<p class="rubric">Examples</p>
<p>Please check <a class="reference internal" href="#bluerobotics_navigator.set_pwm_channel_value" title="bluerobotics_navigator.set_pwm_channel_value"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_pwm_channel_value()</span></code></a></p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">navigator</span><span class="o">.</span><span class="n">pwm_enable</span><span class="p">(</span><span class="kc">True</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="bluerobotics_navigator.read_accel">
<span class="sig-prename descclassname"><span class="pre">bluerobotics_navigator.</span></span><span class="sig-name descname"><span class="pre">read_accel</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bluerobotics_navigator.read_accel" title="Link to this definition"></a></dt>
Expand Down Expand Up @@ -698,7 +682,7 @@ <h1>BlueRobotics’s Navigator Library<a class="headerlink" href="#bluerobotics-
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">navigator</span><span class="o">.</span><span class="n">set_pwm_channel_value</span><span class="p">(</span><span class="n">PwmChannel</span><span class="o">.</span><span class="n">Ch1</span><span class="p">,</span> <span class="mi">2000</span><span class="p">)</span>
</pre></div>
</div>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">navigator</span><span class="o">.</span><span class="n">pwm_enable</span><span class="p">(</span><span class="kc">True</span><span class="p">)</span>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">navigator</span><span class="o">.</span><span class="n">set_pwm_enable</span><span class="p">(</span><span class="kc">True</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
Expand Down Expand Up @@ -742,6 +726,22 @@ <h1>BlueRobotics’s Navigator Library<a class="headerlink" href="#bluerobotics-
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="bluerobotics_navigator.set_pwm_enable">
<span class="sig-prename descclassname"><span class="pre">bluerobotics_navigator.</span></span><span class="sig-name descname"><span class="pre">set_pwm_enable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">state</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bluerobotics_navigator.set_pwm_enable" title="Link to this definition"></a></dt>
<dd><p>Enables or disables the PWM chip (PCA9685), using the firmware and OE_pin.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>state</strong> (<em>bool</em>) – The desired PWM chip state. <cite>True</cite> -&gt; ON, <cite>False</cite> -&gt; OFF.</p>
</dd>
</dl>
<p class="rubric">Examples</p>
<p>Please check <a class="reference internal" href="#bluerobotics_navigator.set_pwm_channel_value" title="bluerobotics_navigator.set_pwm_channel_value"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_pwm_channel_value()</span></code></a></p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">navigator</span><span class="o">.</span><span class="n">set_pwm_enable</span><span class="p">(</span><span class="kc">True</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="bluerobotics_navigator.set_pwm_freq_hz">
<span class="sig-prename descclassname"><span class="pre">bluerobotics_navigator.</span></span><span class="sig-name descname"><span class="pre">set_pwm_freq_hz</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">freq</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bluerobotics_navigator.set_pwm_freq_hz" title="Link to this definition"></a></dt>
Expand All @@ -767,7 +767,7 @@ <h1>BlueRobotics’s Navigator Library<a class="headerlink" href="#bluerobotics-
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">navigator</span><span class="o">.</span><span class="n">set_pwm_channel_value</span><span class="p">(</span><span class="n">PwmChannel</span><span class="o">.</span><span class="n">Ch1</span><span class="p">,</span> <span class="mi">2000</span><span class="p">)</span>
</pre></div>
</div>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">navigator</span><span class="o">.</span><span class="n">pwm_enable</span><span class="p">(</span><span class="kc">True</span><span class="p">)</span>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">navigator</span><span class="o">.</span><span class="n">set_pwm_enable</span><span class="p">(</span><span class="kc">True</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
Expand Down Expand Up @@ -805,7 +805,7 @@ <h1>BlueRobotics’s Navigator Library<a class="headerlink" href="#bluerobotics-
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">navigator</span><span class="o">.</span><span class="n">set_pwm_channel_value</span><span class="p">(</span><span class="n">PwmChannel</span><span class="o">.</span><span class="n">Ch1</span><span class="p">,</span> <span class="mi">2000</span><span class="p">)</span>
</pre></div>
</div>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">navigator</span><span class="o">.</span><span class="n">pwm_enable</span><span class="p">(</span><span class="kc">True</span><span class="p">)</span>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">navigator</span><span class="o">.</span><span class="n">set_pwm_enable</span><span class="p">(</span><span class="kc">True</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
Expand Down
Binary file modified python/objects.inv
View file
Binary file not shown.
Loading

0 comments on commit 56ad847

Please sign in to comment.