update docs [bot]
This commit is contained in:
github-actions
@@ -57,16 +57,8 @@
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#module-inkycal.display.display">Display</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#inkycal.display.display.Display"><code class="docutils literal notranslate"><span class="pre">Display</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#inkycal.display.display.Display.calibrate"><code class="docutils literal notranslate"><span class="pre">Display.calibrate()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#inkycal.display.display.Display.get_display_names"><code class="docutils literal notranslate"><span class="pre">Display.get_display_names()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#inkycal.display.display.Display.get_display_size"><code class="docutils literal notranslate"><span class="pre">Display.get_display_size()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#inkycal.display.display.Display.render"><code class="docutils literal notranslate"><span class="pre">Display.render()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#module-inkycal.display.Display">Display</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#modules">Modules</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#module-inkycal.custom.functions">Custom functions</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#inkycal.custom.functions.auto_fontsize"><code class="docutils literal notranslate"><span class="pre">auto_fontsize()</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#inkycal.custom.functions.draw_border"><code class="docutils literal notranslate"><span class="pre">draw_border()</span></code></a></li>
|
||||
@@ -191,14 +183,9 @@ checks if the images could be generated correctly.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-inkycal.display.display">
|
||||
<span id="display"></span><h1>Display<a class="headerlink" href="#module-inkycal.display.display" title="Link to this heading"></a></h1>
|
||||
<p>Inkycal ePaper driving functions
|
||||
Copyright by aceisace</p>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="inkycal.display.display.Display">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">inkycal.display.display.</span></span><span class="sig-name descname"><span class="pre">Display</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">epaper_model</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#inkycal.display.display.Display" title="Link to this definition"></a></dt>
|
||||
<dd><p>Display class for inkycal</p>
|
||||
<section id="module-inkycal.display.Display">
|
||||
<span id="display"></span><h1>Display<a class="headerlink" href="#module-inkycal.display.Display" title="Link to this heading"></a></h1>
|
||||
<p>Display class for inkycal</p>
|
||||
<p>Creates an instance of the driver for the selected E-Paper model and allows
|
||||
rendering images and calibrating the E-Paper display</p>
|
||||
<dl class="simple">
|
||||
@@ -207,102 +194,25 @@ rendering images and calibrating the E-Paper display</p>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="inkycal.display.display.Display.calibrate">
|
||||
<span class="sig-name descname"><span class="pre">calibrate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cycles</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">3</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#inkycal.display.display.Display.calibrate" title="Link to this definition"></a></dt>
|
||||
<dd><p>Calibrates the display to retain crisp colours</p>
|
||||
<p>Flushes the selected display several times with it’s supported colours,
|
||||
removing any previous effects of ghosting.</p>
|
||||
<dl class="simple">
|
||||
<dt>Args:</dt><dd><ul class="simple">
|
||||
<li><p>cycles: -> int. The number of times to flush the display with it’s
|
||||
supported colours.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</section>
|
||||
<section id="modules">
|
||||
<h1>Modules<a class="headerlink" href="#modules" title="Link to this heading"></a></h1>
|
||||
<p>Agenda
|
||||
.. automodule:: inkycal.modules.inkycal_agenda.Agenda</p>
|
||||
<blockquote>
|
||||
<div><dl class="field-list simple">
|
||||
<dt class="field-odd">members<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<p>It’s recommended to calibrate the display after every 6 display updates
|
||||
for best results. For black-white only displays, calibration is less
|
||||
critical, but not calibrating regularly results in grey-ish text.</p>
|
||||
<p>Please note that calibration takes a while to complete. 3 cycles may
|
||||
take 10 minutes on black-white E-Papers while it takes 20 minutes on coloured
|
||||
E-Paper displays.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="inkycal.display.display.Display.get_display_names">
|
||||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_display_names</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span></span></span><a class="headerlink" href="#inkycal.display.display.Display.get_display_names" title="Link to this definition"></a></dt>
|
||||
<dd><p>Prints all supported E-Paper models.</p>
|
||||
<p>Fetches all filenames in driver folder and prints them on the console.</p>
|
||||
<dl class="simple">
|
||||
<dt>Returns:</dt><dd><p>Printed version of all supported Displays.</p>
|
||||
</dd>
|
||||
</div></blockquote>
|
||||
<p>Calendar
|
||||
.. automodule:: inkycal.modules.inkycal_calendar.Calendar</p>
|
||||
<blockquote>
|
||||
<div><dl class="field-list simple">
|
||||
<dt class="field-odd">members<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p></p></dd>
|
||||
</dl>
|
||||
<p>Use one of the models to intilialize the Display class in order to gain
|
||||
access to the E-Paper.</p>
|
||||
<p>You can use this function directly without creating the Display class:</p>
|
||||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">Display</span><span class="o">.</span><span class="n">get_display_names</span><span class="p">()</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="inkycal.display.display.Display.get_display_size">
|
||||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_display_size</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model_name)</span> <span class="pre">-></span> <span class="pre">(<class</span> <span class="pre">'int'></span></span></em>, <em class="sig-param"><span class="n"><span class="pre"><class</span> <span class="pre">'int'></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#inkycal.display.display.Display.get_display_size" title="Link to this definition"></a></dt>
|
||||
<dd><p>Returns the size of the display as a tuple -> (width, height)</p>
|
||||
<p>Looks inside “drivers” folder for the given model name, then returns it’s
|
||||
size.</p>
|
||||
<dl class="simple">
|
||||
<dt>Args:</dt><dd><ul class="simple">
|
||||
<li><p>model_name: str -> The name of the E-Paper display to get it’s size.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>(width, height) ->tuple, showing the size of the display</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>You can use this function directly without creating the Display class:</p>
|
||||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">Display</span><span class="o">.</span><span class="n">get_display_size</span><span class="p">(</span><span class="s1">'model_name'</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="inkycal.display.display.Display.render">
|
||||
<span class="sig-name descname"><span class="pre">render</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">im_black:</span> <span class="pre"><module</span> <span class="pre">'PIL.Image'</span> <span class="pre">from</span> <span class="pre">'/home/runner/work/Inkycal/Inkycal/venv/lib/python3.11/site-packages/PIL/Image.py'></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">im_colour:</span> <span class="pre"><module</span> <span class="pre">'PIL.Image'</span> <span class="pre">from</span> <span class="pre">'/home/runner/work/Inkycal/Inkycal/venv/lib/python3.11/site-packages/PIL/Image.py'></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#inkycal.display.display.Display.render" title="Link to this definition"></a></dt>
|
||||
<dd><p>Renders an image on the selected E-Paper display.</p>
|
||||
<p>Initlializes the E-Paper display, sends image data and executes command
|
||||
to update the display.</p>
|
||||
<dl class="simple">
|
||||
<dt>Args:</dt><dd><ul class="simple">
|
||||
<li><p>im_black: The image for the black-pixels. Anything in this image that is
|
||||
black is rendered as black on the display. This is required and ideally
|
||||
should be a black-white image.</p></li>
|
||||
<li><p>im_colour: For E-Paper displays supporting colour, a separate image,
|
||||
ideally black-white is required for the coloured pixels. Anything that is
|
||||
black in this image will show up as either red/yellow.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>Rendering an image for black-white E-Paper displays:</p>
|
||||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">sample_image</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">'path/to/file.png'</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">display</span> <span class="o">=</span> <span class="n">Display</span><span class="p">(</span><span class="s1">'my_black_white_display'</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">display</span><span class="o">.</span><span class="n">render</span><span class="p">(</span><span class="n">sample_image</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Rendering black-white on coloured E-Paper displays:
|
||||
>>> sample_image = Image.open(‘path/to/file.png’)
|
||||
>>> display = Display(‘my_coloured_display’)
|
||||
>>> display.render(sample_image, sample_image)</p>
|
||||
<p>Rendering coloured image where 2 images are available:</p>
|
||||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">black_image</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">'path/to/file.png'</span><span class="p">)</span> <span class="c1"># black pixels</span>
|
||||
<span class="gp">>>> </span><span class="n">colour_image</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">'path/to/file.png'</span><span class="p">)</span> <span class="c1"># coloured pixels</span>
|
||||
<span class="gp">>>> </span><span class="n">display</span> <span class="o">=</span> <span class="n">Display</span><span class="p">(</span><span class="s1">'my_coloured_display'</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">display</span><span class="o">.</span><span class="n">render</span><span class="p">(</span><span class="n">black_image</span><span class="p">,</span> <span class="n">colour_image</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div></blockquote>
|
||||
</section>
|
||||
<section id="module-inkycal.custom.functions">
|
||||
<span id="custom-functions"></span><h1>Custom functions<a class="headerlink" href="#module-inkycal.custom.functions" title="Link to this heading"></a></h1>
|
||||
|
||||
Reference in New Issue
Block a user