# luma.examples **Repository Path**: tigera/luma.examples ## Basic Information - **Project Name**: luma.examples - **Description**: No description available - **Primary Language**: Unknown - **License**: MIT - **Default Branch**: bugfix/env_markers - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2025-04-16 - **Last Updated**: 2025-04-16 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README `luma.core `__ **|** `luma.docs `__ **|** luma.examples **|** `luma.emulator `__ **|** `luma.lcd `__ **|** `luma.led_matrix `__ **|** `luma.oled `__ Luma.Examples ============= .. image:: https://travis-ci.org/rm-hull/luma.examples.svg?branch=master :target: https://travis-ci.org/rm-hull/luma.examples .. image:: https://img.shields.io/maintenance/yes/2017.svg?maxAge=2592000 This is the companion repo for running examples against the `luma.emulator `_, `luma.oled `_, `luma.lcd `_ and `luma.led_matrix `_ display drivers. Installation instructions ------------------------- Assuming you are using a Raspberry Pi (running Debian Jessie), follow the pre-requisites & instructions in the above repositories to wire up your display, then from a command-line:: $ sudo usermod -a -G i2c,spi,gpio pi $ sudo apt install python-dev python-pip libfreetype6-dev libjpeg-dev $ sudo apt install libsdl-dev libportmidi-dev libsdl-ttf2.0-dev libsdl-mixer1.2-dev libsdl-image1.2-dev $ sudo -H pip install --upgrade pip setuptools $ sudo apt purge python-pip Log out and in again and clone this repository:: $ git clone https://github.com/rm-hull/luma.examples.git $ cd luma.examples Finally, install the luma libraries using:: $ sudo -H pip install -e . Running the examples -------------------- After cloning the repository, enter the ``examples`` directory and try running the following examples: ===================== ================================================================ Example Description ===================== ================================================================ 3d_box.py Rotating 3D box wireframe & color dithering bounce.py Display a bouncing ball animation and frames per second carousel.py Showcase viewport and hotspot functionality chroma.py Trippy color rendering demo clock.py An analog clockface with date & time colors.py Color rendering demo crawl.py A vertical scrolling demo, which should be familiar demo.py Use misc draw commands to create a simple image font_awesome.py A meander through some awesome fonts game_of_life.py Conway's game of life grayscale.py Greyscale rendering demo invaders.py Space Invaders demo jetset_willy.py Sprite animation framework demo maze.py Maze generator perfloop.py Simple benchmarking utility to measure performance picamera_photo.py Capture photo with picamera and display it on a screen picamera_video.py Capture continuous video stream and display it on a screen pi_logo.py Display the Raspberry Pi logo (loads image as .png) runner.py Sprite animation framework demo savepoint.py Example of savepoint/restore functionality scrolling_pixelart.py Image dithering and viewport scrolling sprite_animation.py Using sprite maps for animation effects starfield.py 3D starfield simulation sys_info.py Display basic system information terminal.py Simple println capabilities tv_snow.py Example image-blitting tweet_scroll.py Using Twitter's Streaming API to display scrolling notifications video.py Display a video clip weather.py 3-day weather forecasts from the BBC welcome.py Unicode font rendering & scrolling ===================== ================================================================ By default, all the examples will asume I2C port 1, address ``0x3C`` and the ``ssd1306`` driver. If you need to use a different setting, these can be specified on the command line – each program can be invoked with a ``--help`` flag to show the options:: $ python examples/demo.py --help usage: demo.py [-h] [--config CONFIG] [--display] [--width WIDTH] [--height HEIGHT] [--rotate] [--interface] [--i2c-port I2C_PORT] [--i2c-address I2C_ADDRESS] [--spi-port SPI_PORT] [--spi-device SPI_DEVICE] [--spi-bus-speed SPI_BUS_SPEED] [--gpio-data-command GPIO_DATA_COMMAND] [--gpio-reset GPIO_RESET] [--gpio-backlight GPIO_BACKLIGHT] [--block-orientation] [--mode] [--framebuffer] [--bgr] [--h-offset H_OFFSET] [--v-offset V_OFFSET] [--backlight-active] [--transform] [--scale SCALE] [--duration DURATION] [--loop LOOP] [--max-frames MAX_FRAMES] luma.examples arguments optional arguments: -h, --help show this help message and exit General: --config CONFIG, -f CONFIG Load configuration settings from a file (default: None) --display , -d Display type, supports real devices or emulators. Allowed values are: ssd1306, ssd1322, ssd1325, ssd1331, sh1106, pcd8544, st7735, max7219, ws2812, neopixel, apa102, capture, gifanim, pygame (default: ssd1306) --width WIDTH Width of the device in pixels (default: 128) --height HEIGHT Height of the device in pixels (default: 64) --rotate , -r Rotation factor. Allowed values are: 0, 1, 2, 3 (default: 0) --interface , -i Serial interface type. Allowed values are: i2c, spi, bitbang (default: i2c) I2C: --i2c-port I2C_PORT I2C bus number (default: 1) --i2c-address I2C_ADDRESS I2C display address (default: 0x3C) SPI: --spi-port SPI_PORT SPI port number (default: 0) --spi-device SPI_DEVICE SPI device (default: 0) --spi-bus-speed SPI_BUS_SPEED SPI max bus speed (Hz) (default: 8000000) GPIO: --gpio-data-command GPIO_DATA_COMMAND GPIO pin for D/C RESET (SPI devices only) (default: 24) --gpio-reset GPIO_RESET GPIO pin for RESET (SPI devices only) (default: 25) --gpio-backlight GPIO_BACKLIGHT GPIO pin for backlight (PCD8544, ST7735 devices only) (default: 18) Misc: --block-orientation Fix 90° phase error (MAX7219 LED matrix only). Allowed values are: 0, 90, -90 (default: 0) --mode Colour mode (SSD1322, SSD1325 and emulator only). Allowed values are: 1, RGB, RGBA (default: RGB) --framebuffer Framebuffer implementation (SSD1331, SSD1322, ST7735 displays only). Allowed values are: diff_to_previous, full_frame (default: diff_to_previous) --bgr Set if LCD pixels laid out in BGR (ST7735 displays only). (default: False) --h-offset H_OFFSET Horizontal offset (in pixels) of screen to display memory (ST7735 displays only) (default: 0) --v-offset V_OFFSET Vertical offset (in pixels) of screen to display memory (ST7735 displays only) (default: 0) --backlight-active Set to "low" if LCD backlight is active low (default), else "high" otherwise (PCD8544, ST7735 displays only). Allowed values are: low, high (default: low) Emulator: --transform Scaling transform to apply (emulator only). Allowed values are: identity, led_matrix, none, scale2x, seven_segment, smoothscale (default: scale2x) --scale SCALE Scaling factor to apply (emulator only) (default: 2) --duration DURATION Animation frame duration (gifanim emulator only) (default: 0.01) --loop LOOP Repeat loop, zero=forever (gifanim emulator only) (default: 0) --max-frames MAX_FRAMES Maximum frames to record (gifanim emulator only) (default: None) .. note:: #. Substitute ``python3`` for ``python`` in the above examples if you are using python3. #. ``python-dev`` (apt-get) and ``psutil`` (pip/pip3) are required to run the ``sys_info.py`` example. See `install instructions `_ for the exact commands to use. Emulators ^^^^^^^^^ There are various display emulators available for running code against, for debugging and screen capture functionality: * The `luma.emulator.device.capture` device will persist a numbered PNG file to disk every time its ``display`` method is called. * The `luma.emulator.device.gifanim` device will record every image when its ``display`` method is called, and on program exit (or Ctrl-C), will assemble the images into an animated GIF. * The `luma.emulator.device.pygame` device uses the `pygame` library to render the displayed image to a pygame display surface. Invoke the demos with:: $ python examples/clock.py --display capture or:: $ python examples/clock.py --display pygame Documentation ------------- Full documentation with installation instructions can be found in: * https://luma-oled.readthedocs.io * https://luma-lcd.readthedocs.io * https://luma-led-matrix.readthedocs.io * https://luma-core.readthedocs.io * https://luma-emulator.readthedocs.io License ------- The MIT License (MIT) Copyright (c) 2017 Richard Hull & 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.