doradx / luma.examples Goto Github PK

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

This is the companion repo for running examples against the luma.emulator, luma.oled, luma.lcd and luma.led_matrix display drivers.

Assuming you are using a Raspberry Pi (running Debian Jessie or newer), 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 build-essential
$ sudo apt install libsdl-dev libportmidi-dev libsdl-ttf2.0-dev libsdl-mixer1.2-dev libsdl-image1.2-dev

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 .

After cloning the repository, enter the examples directory and try running one of the following examples listed below. For example:

cd examples
python 3d_box.py

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 DISPLAY] [--width WIDTH] [--height HEIGHT]
               [--rotate ROTATION] [--interface INTERFACE] [--i2c-port I2C_PORT]
               [--i2c-address I2C_ADDRESS] [--spi-port SPI_PORT] [--spi-device SPI_DEVICE]
               [--spi-bus-speed SPI_BUS_SPEED] [--spi-cs-high SPI_CS_HIGH]
               [--spi-transfer-size SPI_TRANSFER_SIZE] [--ftdi-device FTDI_DEVICE] [--gpio GPIO]
               [--gpio-mode GPIO_MODE] [--gpio-data-command GPIO_DATA_COMMAND]
               [--gpio-reset GPIO_RESET] [--gpio-backlight GPIO_BACKLIGHT]
               [--gpio-reset-hold-time GPIO_RESET_HOLD_TIME]
               [--gpio-reset-release-time GPIO_RESET_RELEASE_TIME] [--block-orientation ORIENTATION]
               [--mode MODE] [--framebuffer FRAMEBUFFER] [--bgr] [--inverse] [--h-offset H_OFFSET]
               [--v-offset V_OFFSET] [--backlight-active VALUE] [--transform 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 DISPLAY, -d DISPLAY
                         Display type, supports real devices or emulators. Allowed values are:
                         ssd1306, ssd1309, ssd1322, ssd1362, ssd1322_nhd, ssd1325, ssd1327, ssd1331,
                         ssd1351, sh1106, ws0010, winstar_weh, pcd8544, st7735, ht1621, uc1701x,
                         st7567, ili9341, hd44780, max7219, ws2812, neopixel, neosegment, apa102,
                         unicornhathd, capture, gifanim, pygame, asciiart, asciiblock (default:
                         ssd1306)
   --width WIDTH         Width of the device in pixels (default: 128)
   --height HEIGHT       Height of the device in pixels (default: 64)
   --rotate ROTATION, -r ROTATION
                         Rotation factor. Allowed values are: 0, 1, 2, 3 (default: 0)
   --interface INTERFACE, -i INTERFACE
                         Serial interface type. Allowed values are: i2c, spi, bitbang, ftdi_spi,
                         ftdi_i2c, pcf8574 (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)
   --spi-cs-high SPI_CS_HIGH
                         SPI chip select is high (default: False)
   --spi-transfer-size SPI_TRANSFER_SIZE
                         SPI bus max transfer unit (bytes) (default: 4096)

 FTDI:
   --ftdi-device FTDI_DEVICE
                         FTDI device (default: ftdi://::/1)

 GPIO:
   --gpio GPIO           Alternative RPi.GPIO compatible implementation (SPI devices only) (default:
                         None)
   --gpio-mode GPIO_MODE
                         Alternative pin mapping mode (SPI devices only) (default: None)
   --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)
   --gpio-reset-hold-time GPIO_RESET_HOLD_TIME
                         Duration to hold reset line active on startup (seconds) (SPI devices only)
                         (default: 0)
   --gpio-reset-release-time GPIO_RESET_RELEASE_TIME
                         Duration to pause for after reset line was made active on startup (seconds)
                         (SPI devices only) (default: 0)

 Misc:
   --block-orientation ORIENTATION
                         Fix 90° phase error (MAX7219 LED matrix only). Allowed values are: 0, 90,
                         -90, 180 (default: 0)
   --mode MODE           Colour mode (SSD1322, SSD1325 and emulator only). Allowed values are: 1, RGB,
                         RGBA (default: RGB)
   --framebuffer 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)
   --inverse             Set if LCD has swapped black and white (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 VALUE
                         Set to "low" if LCD backlight is active low, else "high" otherwise (PCD8544,
                         ST7735 displays only). Allowed values are: low, high (default: low)

 Emulator:
   --transform 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)

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

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

The MIT License (MIT)

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