luma.core 2.4.2

A component library to support SBC display drivers

luma.core | luma.docs | luma.emulator | luma.examples | luma.lcd | luma.led_matrix | luma.oled

luma.core

luma.core is a component library providing a Pillow-compatible drawing canvas for Python 3, and other functionality to support drawing primitives and text-rendering capabilities for small displays on the Raspberry Pi and other single board computers:

• scrolling/panning capability,

• terminal-style printing,

• state management,

• color/greyscale (where supported),

• dithering to monochrome,

• sprite animation,

• flexible framebuffering (depending on device capabilities)

Documentation

API documentation can be found at https://luma-core.readthedocs.io/en/latest/

Drivers

Device drivers extend luma.core to provide the correct initialization sequences for specific physical display devices/chipsets.

There are several drivers for different classes of device available:

• luma.oled

• luma.lcd

• luma.led_matrix

• luma.emulator

Emulators

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 are available in the examples directory of the luma.examples repository.

License

The MIT License (MIT)

Copyright (c) 2017-2022 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.core

Contributors

• Thijs Triemstra (@thijstriemstra)

• Christoph Handel (@fragfutter)

• @Boeeerb

• @xes

• Roger Dahl (@rogerdahl)

• Václav Šmilauer (@eudoxos)

• Claus Bjerre (@bjerrep)

• @bkntrx

• @7754359337

• @theraspydev

• @vortigont

• Maarten Los (@mlos)

• Jonathan Pereira (@jonathanrjpereira)

• Daniel Smullen (@drspangle)

• Hans Liss (@hansliss)

• Phil Howard (@gadgetoid)

• Manuel Baesler (@baslr)

• Dhrone (@dhrone)

• @jakiee3y

• Matthew Lovell (@mattblovell)

• Tiago F. Pimentel (@antropoiese)

• Maciej Sokolowski (@matemaciek)

• Jason Kingsbury (@relvacode)

• Jason Gaunt (@jasongaunt)

ChangeLog

Version	Description	Date
2.4.2	Add support for spi-mode in cmdline	2024/01/30
2.4.1	Adjust type check	2023/09/01
2.4.0	Drop support for Python 3.6 Switch to implicit namespace package configuration Add support for variable-width GPIO ports on FT23xx chips Use time.perf_counter_ns() to avoid loss of precision Remove cmdline.make_serial (deprecated since 1.17.1) Pillow 9.2.0 or newer is required now	2022/10/16
2.3.2	Only import smbus2 if no bus is provided	2021/09/25
2.3.1	Add Github publish action	2021/03/08
2.3.0	Cleanup only GPIO pins used rather than all	2021/03/08
2.2.0	Linux framebuffer: Support BGR, RGBA & BGRA colorspace displays	2020/12/11
2.1.0	Linux framebuffer pseudo-device uses diff-to-previous algorithm	2020/11/30
2.0.2	Change order of namepaces cmdline, so SSD1306 is default	2020/11/26
2.0.1	Fix to allow cmdline args to dynamically create a full_frame() instance	2020/11/06
2.0.0	Improved diff_to_previous framebuffer performance Add Linux framebuffer pseudo-device Allow a wider range of SPI bus speeds	2020/11/02
1.17.3	Drop support for Python 3.5, only 3.6 or newer is supported now Add missing cmdline interfaces: “noop” & “gpio_cs_spi” Legacy proportional font wrapper raises user-friendly error message when character is not in the font table	2020/10/24
1.17.2	Remove SPI cs_high capability (causing SystemException in latest version of spidev on 5.4 kernel line)	2020/10/11
1.17.1	Add cmdline opt: “pcf8574” and “bitbang_6800” interfaces	2020/09/26
1.17.0	Added –inverse option for ST7735 to cmdline opt Allow SPI interface to define reset duration Change bitmap_font to be compatible with Pillow < 7.0	2020/09/25
1.16.2	Added new parallel interface module Renamed parallel class to bitbang_6800; moved to parallel module	2020/09/20
1.16.1	Fix bug in bitmap_font: glyph_index now computed correctly	2020/08/29
1.16.0	Embedded font parallel device (for upcoming HD44780, Winstar character devices)	2020/08/27
1.15.0	Parallel bus and I²C backpack support	2020/08/10
1.14.1	Pin spidev at v3.4 or lower; v3.5 seems to cause SystemException running on latest linux kernel Fix bug in snapshot: should always redraw on startup	2020/07/26
1.14.0	Drop support for Python 2.7, only 3.5 or newer is supported now Add support for SPI mode (clock polarity and phase)	2020/04/07
1.13.0	Add support for using any GPIO pin as a CS pin for SPI	2020/01/12
1.12.0	Rework namespace support for subprojects	2019/06/15
1.11.0	Support luma.lcd.aux (if present)	2019/06/02
1.10.1	Fix [Error 22] emitted from within I2C serial adapter when used with SSD1327 device	2019/05/25
1.10.0	Allow viewport pseudo-display to dither when rendering to device with lower-fidelity color mode	2019/05/23
1.9.0	Improve I2C render speed by not chunking into 32-byte blocks Add support for bridging FTDI to I2C/SPI	2019/05/10
1.8.3	Improve command line help output Split API docs into separate pages	2019/01/07
1.8.2	Fix type hint for SPI’s cs_high parameter	2018/11/05
1.8.1	Mutable string now works over unicode (for both py2/3)	2018/09/18
1.8.0	Namespace packaging fix Correct implementation of pkgutil style namespace Support for Python 3.7 Docstring updates	2018/09/04
1.7.2	Fix upside-down SEG7_FONT	2018/03/29
1.7.1	Support unicode in terminal class	2018/03/22
1.7.0	Add persist flag on device	2018/03/21
1.6.0	Add --spi-transfer-size=... flag in cmdline args	2018/02/21
1.5.0	Add SEG7_FONT: Compact 7x3 font for LED Matrix	2018/02/06
1.4.0	Add --spi-cs-high=... flag in cmdline args	2018/01/29
1.3.0	Add --gpio-mode=... flag in cmdline args	2018/01/02
1.2.1	Use extras_require in setup.py for Linux dependencies	2017/11/26
1.2.0	Added get_library_version & get_library_for_display_type	2017/11/23
1.1.1	Version number available as luma.core.__version__ now	2017/11/23
1.1.0	Added image composition classes	2017/10/28
1.0.3	Explicitly state ‘UTF-8’ encoding in setup when reading files	2017/10/18
1.0.2	Fix conditional install on wheel	2017/09/15
1.0.1	Don’t install RPi.GPIO & spidev if setup running on OSX	2017/09/04
1.0.0	Stable release (remove all deprecated methods & parameters)	2017/07/29
0.9.5	Remove assert in terminal to allow extended characters to be printed (note: this only works for Python3 presently)	2017/07/06
0.9.4	Add tolerant class for legacy font handling non-ASCII chars Add CP437 chars to fonts.py	2017/07/01
0.9.3	LCD_FONT: lowercase cyrillic chars added, minor corrections in uppercase chars	2017/06/25
0.9.2	Add background= option to luma.core.render.canvas Add TCA9548A I2C multiplex scanner (contrib) Display I2C address in hex when error occurs	2017/06/19
0.9.1	Add cmdline block orientation of 180	2017/05/01
0.9.0	Add word-wrap capability to luma.core.virtual.terminal Bug fix to luma.core.virtual.terminal when scrolling	2017/04/22
0.8.1	Propagate segment_mapper through other virtual devices	2017/04/14
0.8.0	Migrate seven-segment wrapper from luma.led_matrix	2017/04/14
0.7.5	Allow alternative RPi.GPIO implementations	2017/04/09
0.7.4	Reduce size of space character in legacy proportional font	2017/04/09
0.7.3	Cmdline args now supports backlight active high/low	2017/04/07
0.7.2	Add --h-offset=N and --v-offset=N params to cmdline args	2017/04/07
0.7.1	Improve formatting in command line options	2017/04/06
0.7.0	Add software-based bitbang SPI implementation Cmdline args parsing Use monotonic clock	2017/03/27
0.6.2	Move GPIO.setmode() to point when referenced Use regex prefix in ANSI color parser (fixes deprecation warning)	2017/03/19
0.6.1	Deprecate spi params Fix resource leak in spritesheet	2017/03/13
0.6.0	Terminal supports ANSI Color escape codes Catch & rethrow IOErrors	2017/03/13
0.5.4	Rework decorators	2017/03/08
0.5.3	Catch & rethrow all RPi.GPIO RuntimeExceptions	2017/03/08
0.5.2	Raise error.UnsupportedPlatform if RPi.GPIO is not available Bug fix to luma.core.virtual.terminal to handle multiple \n	2017/03/08
0.5.1	Bug fix: legacy.show_message regression	2017/03/05
0.5.0	BREAKING CHANGES: Rework framework_regulator class Documentation updates	2017/03/05
0.4.4	Bug fix: legacy.show_message off-by-one bug	2017/03/02
0.4.3	Restrict exported Python symbols from luma.core.serial	2017/03/02
0.4.2	Optional alignment of framebuffer bounding_box to word-boundaries	2017/02/28
0.4.1	Refactor framebuffer interface	2017/02/27
0.4.0	Add spritesheet and framerate_regulator functionality Add full-frame and diff-to-previous framebuffer implementations Remove unnecessary travis/tox dependencies	2017/02/27
0.3.2	Bug fix: legacy.show_message wrong device height Add Cyrillic chars to legacy font Make pytest-runner a conditional requirement	2017/02/24
0.3.1	Imported legacy font handling from rm-hull/luma.led_matrix	2017/02/19
0.2.0	Fix bug in seven_segment transform (display correct char) Moved emulator code to rm-hull/luma.emulator github repo	2017/02/17
0.1.15	Require at least Pillow 4.0.0 Configurable transfer_size on SPI writes Documentation updates	2017/02/11
0.1.14	Use a more flexible no-op implementation Use spidev’s writebytes() rather than xfer2() Dont write GIF animation if nothing was displayed Attempt to optimize palette when saving GIF animations	2017/02/03
0.1.13	Fix bug in setup script	2017/01/23
0.1.12	Assert valid SPI bus speed Don’t report errors in shutdown Don’t package as zip-safe Add 7-segment LED emulation transformer	2017/01/21
0.1.11	Rejig packaging to include emulator assets	2017/01/20
0.1.3	Reset SPI device on initialization Add LED matrix emulation transformer	2017/01/19
0.1.2	Namespace packaging	2017/01/10
0.1.0	Split out core functionality from rm-hull/ssd1306	2017/01/10