Introduction
============
luma.oled provides a Python3 interface to `OLED matrix displays
<https://github.com/rm-hull/luma.oled/wiki/Usage-&-Benchmarking>`_ with the
SSD1305, SSD1306, SSD1309, SSD1315, SSD1316, SSD1322, SSD1325, SSD1327, SSD1331, SSD1351, SSD1362, SH1106,
SH1107, CH1115 or WS0010 controllers to connect with Raspberry Pi and other Linux-based
single-board computers (SBC).  It provides a Pillow-compatible drawing canvas,
and other functionality to support:

* scrolling/panning capability,
* terminal-style printing,
* state management,
* color/greyscale (where supported),
* dithering to monochrome

The SSD1306 display pictured below is 128 x 64 pixels, and the board is `tiny`,
and will fit neatly inside the RPi case.

.. image:: images/mounted_display.jpg
   :alt: mounted

.. image:: images/ssd1322.jpg
   :alt: ssd1322

.. seealso::
   Further technical information for the specific implemented devices can be found
   in the following datasheets:

   - :download:`SSD1305 <tech-spec/SSD1305.pdf>`
   - :download:`SSD1306 <tech-spec/SSD1306.pdf>`
   - :download:`SSD1309 <tech-spec/SSD1309.pdf>`
   - :download:`SSD1315 <tech-spec/SSD1315.pdf>`
   - :download:`SSD1316 <tech-spec/SSD1316.pdf>`
   - :download:`SSD1322 <tech-spec/SSD1322.pdf>`
   - :download:`SSD1325 <tech-spec/SSD1325.pdf>`
   - :download:`SSD1327 <tech-spec/SSD1327.pdf>`
   - :download:`SSD1331 <tech-spec/SSD1331.pdf>`
   - :download:`SSD1351 <tech-spec/SSD1351.pdf>`
   - :download:`SSD1362 <tech-spec/SSD1362.pdf>`
   - :download:`SH1106 <tech-spec/SH1106.pdf>`
   - :download:`WS0010 <tech-spec/WS0010.pdf>`
   - :download:`WEH001602 <tech-spec/WEH001602.pdf>`

   Benchmarks for tested devices can be found in the
   `wiki <https://github.com/rm-hull/luma.oled/wiki/Usage-&-Benchmarking>`_.

Examples and Emulators
----------------------
As well as display drivers for various physical OLED devices there are
emulators that run in real-time (with pygame_) and others that can take
screenshots, or assemble animated GIFs, as per the examples below (source code
for these is available in the `luma.examples <https://github.com/rm-hull/luma.examples>`_
git repository:

.. image:: images/clock_anim.gif
   :alt: clock

.. image:: images/invaders_anim.gif
   :alt: invaders

.. image:: images/crawl_anim.gif
   :alt: crawl


.. _Pillow: https://pillow.readthedocs.io
.. _pygame: https://www.pygame.org