Skip to content

Commit

Permalink
deploy: 85fe6a5
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisib committed Jan 10, 2025
1 parent eb797c7 commit a59baea
Show file tree
Hide file tree
Showing 4 changed files with 3 additions and 39 deletions.
30 changes: 0 additions & 30 deletions generated/europi.html
Original file line number Diff line number Diff line change
Expand Up @@ -309,36 +309,6 @@

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="europi.Display">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">europi.</span></span><span class="sig-name descname"><span class="pre">Display</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#europi.Display" title="Permalink to this definition"></a></dt>
<dd><p>A class for drawing graphics and text to the OLED.</p>
<p>The OLED Display works by collecting all the applied commands and only
updates the physical display when <code class="docutils literal notranslate"><span class="pre">oled.show()</span></code> is called. This allows
you to perform more complicated graphics without slowing your program, or
to perform the calculations for other functions, but only update the
display every few steps to prevent lag.</p>
<p>To clear the display, simply fill the display with the colour black by using <code class="docutils literal notranslate"><span class="pre">oled.fill(0)</span></code></p>
<p>More explanations and tips about the the display can be found in the oled_tips file
<a class="reference external" href="https://github.com/Allen-Synthesis/EuroPi/blob/main/software/oled_tips.md">oled_tips.md</a></p>
<dl class="py method">
<dt class="sig sig-object py" id="europi.Display.centre_text">
<span class="sig-name descname"><span class="pre">centre_text</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">clear_first</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auto_show</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#europi.Display.centre_text" title="Permalink to this definition"></a></dt>
<dd><p>Display one or more lines of text centred both horizontally and vertically.</p>
<p>&#64;param text The text to display
&#64;param clear_first If true, the screen buffer is cleared before rendering the text
&#64;param auto_show If true, oled.show() is called after rendering the text. If false, you must call oled.show() yourself</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="europi.Display.rotate">
<span class="sig-name descname"><span class="pre">rotate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rotate</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#europi.Display.rotate" title="Permalink to this definition"></a></dt>
<dd><p>Flip the screen from its default orientation</p>
<p>&#64;param rotate True or False, indicating whether we want to flip the screen from its default orientation</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="europi.Knob">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">europi.</span></span><span class="sig-name descname"><span class="pre">Knob</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pin</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deadzone</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.01</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#europi.Knob" title="Permalink to this definition"></a></dt>
Expand Down
10 changes: 2 additions & 8 deletions genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -127,8 +127,6 @@ <h2 id="B">B</h2>
<h2 id="C">C</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="generated/europi.html#europi.Display.centre_text">centre_text() (europi.Display method)</a>
</li>
<li><a href="generated/europi.html#europi.AnalogueInput.choice">choice() (europi.AnalogueInput method)</a>

<ul>
Expand Down Expand Up @@ -185,14 +183,12 @@ <h2 id="D">D</h2>
<li><a href="generated/configuration.html#configuration.ConfigFile.delete_config">delete_config() (configuration.ConfigFile static method)</a>
</li>
<li><a href="generated/europi.html#europi.DigitalInput">DigitalInput (class in europi)</a>
</li>
<li><a href="generated/europi.html#europi.DigitalReader">DigitalReader (class in europi)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="generated/experimental.knobs.html#experimental.knobs.DisabledKnob">DisabledKnob (class in experimental.knobs)</a>
<li><a href="generated/europi.html#europi.DigitalReader">DigitalReader (class in europi)</a>
</li>
<li><a href="generated/europi.html#europi.Display">Display (class in europi)</a>
<li><a href="generated/experimental.knobs.html#experimental.knobs.DisabledKnob">DisabledKnob (class in experimental.knobs)</a>
</li>
<li><a href="generated/europi_script.html#europi_script.EuroPiScript.display_name">display_name() (europi_script.EuroPiScript class method)</a>
</li>
Expand Down Expand Up @@ -448,8 +444,6 @@ <h2 id="R">R</h2>
</li>
</ul></li>
<li><a href="generated/europi.html#europi.reset_state">reset_state() (in module europi)</a>
</li>
<li><a href="generated/europi.html#europi.Display.rotate">rotate() (europi.Display method)</a>
</li>
</ul></td>
</tr></table>
Expand Down
Binary file modified objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit a59baea

Please sign in to comment.