Skip to main content

A component library to support SBC display drivers

Project description

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

Luma.Core

https://travis-ci.org/rm-hull/luma.core.svg?branch=master https://coveralls.io/repos/github/rm-hull/luma.core/badge.svg?branch=master https://requires.io/github/rm-hull/luma.core/requirements.svg?branch=master https://img.shields.io/pypi/pyversions/luma.core.svg https://img.shields.io/pypi/v/luma.core.svg https://img.shields.io/maintenance/yes/2018.svg?maxAge=2592000

luma.core is a component library providing a Pillow-compatible drawing canvas, 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)

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:

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.

clock invaders crawl

License

The MIT License (MIT)

Copyright (c) 2017-18 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)

ChangeLog

Version

Description

Date

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

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

luma.core-1.6.0.tar.gz (56.0 kB view hashes)

Uploaded Source

Built Distribution

luma.core-1.6.0-py2.py3-none-any.whl (52.9 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page