luma.oled 3.14.0
A small library to drive an OLED device with either SSD1306, SSD1309, SSD1322, SSD1325, SSD1327, SSD1331, SSD1351, SSD1362, SH1106, SH1107 or WS0010 chipset
License: MIT
Requires Python: <4,>=3.8
Keywords: raspberry pi, rpi, oled, display, screen, rgb, monochrome, greyscale, color, ssd1306, ssd1309, ssd1322, ssd1325, ssd1327, ssd1331, ssd1351, sh1106, sh1107, ws0010, WEH001602A, WEG010016A, spi, i2c, parallel6800, pcf8574

`luma.core <https://github.com/rm-hull/luma.core>`__ **|**
`luma.docs <https://github.com/rm-hull/luma.docs>`__ **|**
`luma.emulator <https://github.com/rm-hull/luma.emulator>`__ **|**
`luma.examples <https://github.com/rm-hull/luma.examples>`__ **|**
`luma.lcd <https://github.com/rm-hull/luma.lcd>`__ **|**
`luma.led_matrix <https://github.com/rm-hull/luma.led_matrix>`__ **|**
luma.oled

luma.oled
---------
**Display drivers for SSD1306 / SSD1309 / SSD1322 / SSD1325 / SSD1327 / SSD1331 / SSD1351 / SSD1362 / SH1106 / SH1107 / WS0010**

.. image:: https://github.com/rm-hull/luma.oled/workflows/luma.oled/badge.svg?branch=master
   :target: https://github.com/rm-hull/luma.oled/actions?workflow=luma.oled

.. image:: https://coveralls.io/repos/github/rm-hull/luma.oled/badge.svg?branch=master
   :target: https://coveralls.io/github/rm-hull/luma.oled?branch=master

.. image:: https://readthedocs.org/projects/luma-oled/badge/?version=latest
   :target: http://luma-oled.readthedocs.io/en/latest/?badge=latest

.. image:: https://img.shields.io/pypi/pyversions/luma.oled.svg
   :target: https://pypi.python.org/pypi/luma.oled

.. image:: https://img.shields.io/pypi/v/luma.oled.svg
   :target: https://pypi.python.org/pypi/luma.oled

.. image:: https://img.shields.io/pypi/dm/luma.oled
   :target: https://pypi.python.org/project/luma.oled

Python 3 library interfacing OLED matrix displays with the SSD1306, SSD1309,
SSD1322, SSD1325, SSD1327, SSD1331, SSD1351, SH1106, SH1107 or WS0010 driver using
I2C/SPI/Parallel on the Raspberry Pi and other linux-based single-board
computers - it provides a `Pillow <https://pillow.readthedocs.io/>`_-compatible
drawing canvas, and other functionality to support:

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

Documentation
-------------
Full documentation with installation instructions and examples can be found on
https://luma-oled.readthedocs.io.

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

The display pictured below is a SSD1306 (128 x 64 pixels), and the board is `tiny` enough to fit
inside the RPi case.

.. image:: https://raw.githubusercontent.com/rm-hull/luma.oled/master/doc/images/mounted_display.jpg
   :alt: mounted

.. image:: https://raw.githubusercontent.com/rm-hull/luma.oled/master/doc/images/ssd1322.jpg
   :alt: ssd1322

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:: https://raw.githubusercontent.com/rm-hull/luma.oled/master/doc/images/clock_anim.gif?raw=true
   :alt: clock

.. image:: https://raw.githubusercontent.com/rm-hull/luma.oled/master/doc/images/invaders_anim.gif?raw=true
   :alt: invaders

.. image:: https://raw.githubusercontent.com/rm-hull/luma.oled/master/doc/images/crawl_anim.gif?raw=true
   :alt: crawl

Upgrade
-------
Version 2.0.0 was released on 11 January 2017: this came with a rename of the
github project from **ssd1306** to **luma.oled** to reflect the changing nature
of the codebase.

Some core functionality has been moved out to another git repository,
`luma.core <https://github.com/rm-hull/luma.core>`_: this has enabled
another project to have a facelift: **pcd8544** has now been reborn as
`luma.lcd <https://github.com/rm-hull/luma.lcd>`_: the same API can now be
used across both projects. Likewise **max7219** has been renamed to
`luma.led_matrix <https://github.com/rm-hull/luma.led_matrix>`_ so
it can also take advantage of the common API.

The consequence is that any existing code that uses the old **ssd1306** package
will need to be updated. The changes should be limited to altering import
statements only, and are described in the
`upgrade documentation <https://luma-oled.readthedocs.io/en/latest/upgrade.html>`_.

License
-------
The MIT License (MIT)

Copyright (c) 2014-2023 Richard Hull and contributors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Contributing
------------

Pull requests (code changes / documentation / typos / feature requests / setup)
are gladly accepted. If you are intending to introduce some large-scale
changes, please get in touch first to make sure we're on the same page: try to
include a docstring for any new method or class, and keep method bodies small,
readable and PEP8-compliant. Add tests and strive to keep the code coverage
levels high.

GitHub
^^^^^^
The source code is available to clone at: https://github.com/rm-hull/luma.oled

Contributors
^^^^^^^^^^^^
* Thijs Triemstra (@thijstriemstra)
* Christoph Handel (@fragfutter)
* Boeeerb (@Boeeerb)
* xes (@xes)
* Roger Dahl (@rogerdahl)
* Václav Šmilauer (@eudoxos)
* Claus Bjerre (@bjerrep)
* Vx Displays LLC (@VxGeeks)
* Christopher Arndt (@SpotlightKid)
* Sascha Walther (@leragequit)
* Marcus Kellerman (@sharkusk)
* Phil Howard (@gadgetoid)
* @wjgeorge
* Doug Burrell (@doug-burrell)
* Xavier Carcelle (@xcarcelle)
* Dhrone (@dhrone)
* George Harker (@georgeharker)
* @Pako2
* Graeme Smecher (@gsmecher)
* Romit Raj (@QuicksandDesignStudio)

ChangeLog
---------

+------------+---------------------------------------------------------------------+------------+
| Version    | Description                                                         | Date       |
+============+=====================================================================+============+
| **3.14.0** | * Drop support for Python 3.7                                       | 2024/10/26 |
+------------+---------------------------------------------------------------------+------------+
| **3.13.0** | * Add support for 128x128 SH1107                                    | 2023/08/12 |
+------------+---------------------------------------------------------------------+------------+
| **3.12.0** | * Fix 96x16 OLED panel offset                                       | 2023/03/19 |
+------------+---------------------------------------------------------------------+------------+
| **3.11.0** | * Add support for SH1107 greyscale OLED                             | 2023/01/26 |
+------------+---------------------------------------------------------------------+------------+
| **3.10.0** | * Fix SSD1322 NHD initialization and encode each pixel as 4bit+4bit | 2022/11/14 |
|            |   identical nibbles                                                 |            |
+------------+---------------------------------------------------------------------+------------+
| **3.9.0**  | * Use native namespace package configuration                        | 2022/10/19 |
|            | * Drop support for Python 3.6                                       |            |
+------------+---------------------------------------------------------------------+------------+
| **3.8.1**  | * Fix mutable default parameter bug when using multiple displays    | 2020/11/15 |
+------------+---------------------------------------------------------------------+------------+
| **3.8.0**  | * Improved diff_to_previous framebuffer performance                 | 2020/11/06 |
+------------+---------------------------------------------------------------------+------------+
| **3.7.0**  | * Drop support for Python 3.5, only 3.6 or newer is supported now   | 2020/10/25 |
|            | * Add support for SSD1351 128x96 display                            |            |
|            | * Pin luma.core to 1.x.y line only, in anticipation of performance  |            |
|            |   improvements in upcoming major release                            |            |
+------------+---------------------------------------------------------------------+------------+
| **3.6.0**  | * Add support for Winstar OLED displays                             | 2020/09/24 |
+------------+---------------------------------------------------------------------+------------+
| **3.5.0**  | * Drop support for Python 2.7, only 3.5 or newer is supported now   | 2020/07/04 |
+------------+---------------------------------------------------------------------+------------+
| **3.4.0**  | * Add support for SSD1362 256x64 Greyscale OLED                     | 2020/01/19 |
+------------+---------------------------------------------------------------------+------------+
| **3.3.0**  | * Namespace fix                                                     | 2019/06/19 |
+------------+---------------------------------------------------------------------+------------+
| **3.2.1**  | * Fix bug where SSD1325 ``framebuffer=diff_to_prev`` didn't set     | 2019/04/30 |
|            |   column address properly, resulting in garbled output              |            |
+------------+---------------------------------------------------------------------+------------+
| **3.2.0**  | * Add support for 128x64 OLED (Newhaven SSD1322_NHD))               | 2019/04/17 |
+------------+---------------------------------------------------------------------+------------+
| **3.1.1**  | * Fix bug where SSD1327 ``framebuffer=diff_to_prev`` didn't set     | 2019/03/30 |
|            |   column address properly, resulting in garbled output              |            |
|            | * Minor API documentation improvements                              |            |
+------------+---------------------------------------------------------------------+------------+
| **3.1.0**  | * Add support for 128x64 monochrome OLED (SSD1309)                  | 2018/12/21 |
+------------+---------------------------------------------------------------------+------------+
| **3.0.1**  | * Fix bug where SSD1325/1327 didn't handle ``framebuffer`` properly | 2018/12/21 |
+------------+---------------------------------------------------------------------+------------+
| **3.0.0**  | * **BREAKING** Fix SSD1351 init sequence didn't set RGB/BGR color   | 2018/12/02 |
|            |   order properly. Users of this device should verify proper color   |            |
|            |   rendering and add ``bgr=True`` if blue/red color components       |            |
|            |   appear to be reversed                                             |            |
|            | * Device consolidation - greyscale and colour SSD13xx devices now   |            |
|            |   share common base classes.                                        |            |
+------------+---------------------------------------------------------------------+------------+
| **2.5.1**  | * Fix bug where SSD1331/1351 didn't render green accurately         | 2018/09/14 |
+------------+---------------------------------------------------------------------+------------+
| **2.5.0**  | * Add support form 128x128 Monochrome OLED (SH1106) (by @Gadgetoid) | 2018/09/07 |
|            | * Dependency and documentation updates                              |            |
|            | * Minor packaging changes                                           |            |
+------------+---------------------------------------------------------------------+------------+
| **2.4.1**  | * Fix bug where SSD1327 init sequence exceeds serial command size   | 2018/05/28 |
+------------+---------------------------------------------------------------------+------------+
| **2.4.0**  | * Support for 128x128 4-bit OLED (SSD1327)                          | 2018/04/18 |
+------------+---------------------------------------------------------------------+------------+
| **2.3.2**  | * Support for 96x96 color OLED (SSD1351)                            | 2018/03/03 |
+------------+---------------------------------------------------------------------+------------+
| **2.3.1**  | * Changed version number to inside ``luma/oled/__init__.py``        | 2017/11/23 |
+------------+---------------------------------------------------------------------+------------+
| **2.3.0**  | * Support for 128x128 color OLED (SSD1351)                          | 2017/10/30 |
+------------+---------------------------------------------------------------------+------------+
| **2.2.12** | * Explicitly state 'UTF-8' encoding in setup when reading files     | 2017/10/18 |
+------------+---------------------------------------------------------------------+------------+
| **2.2.11** | * Update dependencies                                               | 2017/09/19 |
|            | * Additional troubleshooting documentation                          |            |
+------------+---------------------------------------------------------------------+------------+
| **2.2.10** | * Add support for 128x32 mode for SH1106                            | 2017/05/01 |
+------------+---------------------------------------------------------------------+------------+
| **2.2.9**  | * luma.core 0.9.0 or newer is required now                          | 2017/04/22 |
|            | * Documentation amends                                              |            |
+------------+---------------------------------------------------------------------+------------+
| **2.2.8**  | * SSD1331 & SSD1322 framebuffer & API docstrings                    | 2017/04/13 |
+------------+---------------------------------------------------------------------+------------+
| **2.2.7**  | * Add support for 64x32 SSD1306 OLED                                | 2017/04/12 |
+------------+---------------------------------------------------------------------+------------+
| **2.2.6**  | * Add support for 64x48 SSD1306 OLED                                | 2017/03/30 |
+------------+---------------------------------------------------------------------+------------+
| **2.2.5**  | * Restrict exported Python symbols from ``luma.oled.device``        | 2017/03/02 |
+------------+---------------------------------------------------------------------+------------+
| **2.2.4**  | * Tweaked SSD1325 init settings & replaced constants                | 2017/02/17 |
|            | * Update dependencies                                               |            |
+------------+---------------------------------------------------------------------+------------+
| **2.2.3**  | * Monochrome rendering on SSD1322 & SSD1325                         | 2017/02/14 |
+------------+---------------------------------------------------------------------+------------+
| **2.2.2**  | * SSD1325 performance improvements (perfloop: 25.50 --> 34.31 FPS)  | 2017/02/02 |
|            | * SSD1331 performance improvements (perfloop: 34.64 --> 51.89 FPS)  |            |
+------------+---------------------------------------------------------------------+------------+
| **2.2.1**  | * Support for 256x64 4-bit greyscale OLED (SSD1322)                 | 2017/01/29 |
|            | * Improved API documentation (shows inherited members)              |            |
+------------+---------------------------------------------------------------------+------------+
| **2.1.0**  | * Simplify/optimize SSD1306 display logic                           | 2017/01/22 |
+------------+---------------------------------------------------------------------+------------+
| **2.0.1**  | * Moved examples to separate git repo                               | 2017/01/15 |
|            | * Add notes about breaking changes                                  |            |
+------------+---------------------------------------------------------------------+------------+
| **2.0.0**  | * Package rename to ``luma.oled`` (**Note:** Breaking changes)      | 2017/01/11 |
+------------+---------------------------------------------------------------------+------------+
| **1.5.0**  | * Performance improvements for SH1106 driver (2x frame rate!)       | 2017/01/09 |
|            | * Support for 4-bit greyscale OLED (SSD1325)                        |            |
|            | * Landscape/portrait orientation with rotate=N parameter            |            |
+------------+---------------------------------------------------------------------+------------+
| **1.4.0**  | * Add savepoint/restore functionality                               | 2016/12/23 |
|            | * Add terminal functionality                                        |            |
|            | * Canvas image dithering                                            |            |
|            | * Additional & improved examples                                    |            |
|            | * Load config settings from file (for examples)                     |            |
|            | * Universal wheel distribution                                      |            |
|            | * Improved/simplified error reporting                               |            |
|            | * Documentation updates                                             |            |
+------------+---------------------------------------------------------------------+------------+
| **1.3.1**  | * Add ability to adjust brightness of screen                        | 2016/12/11 |
|            | * Fix for wrong value NORMALDISPLAY for SSD1331 device              |            |
+------------+---------------------------------------------------------------------+------------+
| **1.3.0**  | * Support for 16-bit color OLED (SSD1331)                           | 2016/12/11 |
|            | * Viewport/scrolling support                                        |            |
|            | * Remove pygame as an install dependency in setup                   |            |
|            | * Ensure SH1106 device collapses color images to monochrome         |            |
|            | * Fix for emulated devices: do not need cleanup                     |            |
|            | * Fix to allow gifanim emulator to process 1-bit images             |            |
|            | * Establish a single threadpool for all virtual viewports           |            |
|            | * Fix issue preventing multiple threads from running concurrently   |            |
|            | * Documentation updates                                             |            |
+------------+---------------------------------------------------------------------+------------+
| **1.2.0**  | * Add support for 128x32, 96x16 OLED screens (SSD1306 chipset only) | 2016/12/08 |
|            | * Fix boundary condition error when supplying max-frames to gifanim |            |
|            | * Bit pattern calc rework when conveting color -> monochrome        |            |
|            | * Approx 20% performance improvement in ``display`` method          |            |
+------------+---------------------------------------------------------------------+------------+
| **1.1.0**  | * Add animated-GIF emulator                                         | 2016/12/05 |
|            | * Add color-mode flag to emulator                                   |            |
|            | * Fix regression in SPI interface                                   |            |
|            | * Rename emulator transform option 'scale' to 'identity'            |            |
+------------+---------------------------------------------------------------------+------------+
| **1.0.0**  | * Add HQX scaling to capture and pygame emulators                   | 2016/12/03 |
|            | * SPI support (**NOTE:** contains breaking changes)                 |            |
|            | * Improve benchmarking examples                                     |            |
|            | * Fix resource leakage & noops on emulated devices                  |            |
|            | * Additional tests                                                  |            |
+------------+---------------------------------------------------------------------+------------+
| **0.3.5**  | * Pygame-based device emulator & screen capture device emulator     | 2016/11/30 |
|            | * Add bouncing balls demo, clock & Space Invaders examples          |            |
|            | * Auto cleanup on exit                                              |            |
|            | * Add ``bounding_box`` attribute to devices                         |            |
|            | * Demote buffer & pages attributes to "internal use" only           |            |
|            | * Replaced SH1106 data sheet with version that is not "preliminary" |            |
|            | * Add font attribution                                              |            |
|            | * Tests for SSD1306 & SSH1106 devices                               |            |
|            | * Add code coverage & upload to coveralls.io                        |            |
|            | * flake8 code compliance                                            |            |
|            | * Documentation updates                                             |            |
+------------+---------------------------------------------------------------------+------------+
| **0.3.4**  | * Performance improvements - render speeds ~2x faster               | 2016/11/15 |
|            | * Documentation updates                                             |            |
+------------+---------------------------------------------------------------------+------------+
| **0.3.3**  | * Add PyPi badge                                                    | 2016/11/15 |
|            | * Use smbus2                                                        |            |
+------------+---------------------------------------------------------------------+------------+
| **0.3.2**  | * Fix bug in maze example (integer division on python 3)            | 2016/11/13 |
|            | * Use latest pip                                                    |            |
|            | * Add tox & travis config (+ badge)                                 |            |
|            | * Add RTFD config                                                   |            |
|            | * Documentation updates                                             |            |
+------------+---------------------------------------------------------------------+------------+
| **0.3.1**  | * Adjust requirements (remove smbus)                                | 2016/11/13 |
|            | * Default RTFD theme                                                |            |
|            | * Documentation updates                                             |            |
+------------+---------------------------------------------------------------------+------------+
| **0.3.0**  | * Allow SMBus implementation to be supplied                         | 2016/11/13 |
|            | * Add show, hide and clear methods                                  |            |
|            | * Catch & rethrow ``IOError`` exceptions                            |            |
|            | * Fix error in 'hello world' example                                |            |
|            | * Cleanup imports                                                   |            |
|            | * Allow setting width/height                                        |            |
|            | * Documentation updates                                             |            |
+------------+---------------------------------------------------------------------+------------+
| **0.2.0**  | * Add Python 3 support                                              | 2016/09/06 |
|            | * Add options to demos                                              |            |
|            | * Micro-optimizations                                               |            |
|            | * Remove unused optional arg                                        |            |
|            | * Fix bug in rendering image data                                   |            |
|            | * Added more examples                                               |            |
|            | * Add setup file                                                    |            |
|            | * Support SH1106                                                    |            |
|            | * Documentation updates                                             |            |
+------------+---------------------------------------------------------------------+------------+