55 KiB

Czysty Wina Historia

Display drivers

These drivers support nano-gui, micro-gui, and Writer and CWriter. They currently support four display technologies: OLED (color and monochrome), color TFT, monochrome Sharp displays and EPD (ePaper/eInk). All drivers provide a display class subclassed from the built-in framebuf.FrameBuffer class. This provides three increasing levels of support:

Graphics via the FrameBuffer graphics primitives.
Text rendering in arbitrary fonts via Writer and Cwriter classes (see font_to_py.py).
Use with nano-gui and micro-gui.

It should be noted that in the interests of conserving RAM these drivers offer a bare minimum of functionality required to support the above. Most drivers provide some support for bus sharing.

Users of the GUI and Writer classes only need to instantiate a display. Hence only device constructors are documented. Other attributes are transparent to the user. Required methods and bound variables are detailed in Writing device drivers. Low level access via the Writer and CWriter classes is documented here.

Main README

Introduction
1.1 Color handling
OLED displays
2.1 Drivers for SSD1351 Color OLEDs
2.2 Drivers for SSD1331 Small color OLEDs
Color TFT displays
3.1 Drivers for ST7735R Small TFTs
3.2 Drivers for ILI9341 Large TFTs
3.3 Drivers for ST7789 Small high density TFTs
     3.3.1 TTGO T Display Low cost ESP32 with integrated display
     3.3.2 Waveshare Pico Res Touch
     3.3.3 Troubleshooting
Drivers for sharp displays Large low power monochrome displays
4.1 Display characteristics
     4.1.1 The VCOM bit
     4.1.2 Refresh rate
4.2 Test scripts
4.3 Device driver constructor
     4.3.1 Device driver methods
     4.3.2 The vcom arg
4.4 Application design
     4.4.1 Micropower applications
4.5 Resources
ePaper displays
5.1 Adafruit monochrome eInk Displays
     5.1.1 EPD constructor args
     5.1.2 EPD public methods
     5.1.3 EPD public bound variables
     5.1.4 FeatherWing Wiring
     5.1.5 Micropower use
5.2 Waveshare eInk Display HAT
     5.2.1 EPD constructor args
     5.2.2 EPD public methods
     5.2.3 EPD public bound variables
EPD Asynchronous support
Writing device drivers
Links

The Micropower use section is applicable to EPD's in general but makes specific reference to the 2.9" micropower demo.

Main README

1. Introduction

A nano-gui application specifies a driver by means of color_setup.py located in the root directory of the target. In micro-gui hardware_setup.py does a similar job, also specifying pins for the user controls.

A typical color_setup.py looks like this:

import machine
import gc
from drivers.ssd1351.ssd1351 import SSD1351 as SSD  # Choose device driver
pdc = machine.Pin('Y1', machine.Pin.OUT_PP, value=0)
pcs = machine.Pin('Y2', machine.Pin.OUT_PP, value=1)
prst = machine.Pin('Y3', machine.Pin.OUT_PP, value=1)
spi = machine.SPI(2, baudrate=10_000_000)  # baudrate depends on display chip
gc.collect()
# Precaution before instantiating framebuf. The next line creates the buffer.
ssd = SSD(spi, pcs, pdc, prst, 96)  # Create a display instance

The directory setup_examples contains examples for various displays. These are named by graphics chip ID followed by host, thus ssd1306_pyb.py is for an SSD1306 based display connected to a Pyboard. Files may be adapted and copied to color_setup.py on the target's root. The section in this doc for the specific display chip should be consulted for SSD constructor arguments and SPI baudrate. The more exotic displays (Sharp and ePaper) have additional features and requirements detailed below.

1.1 Color handling

Most color displays support colors specified as 16-bit quantities. Storing two bytes for every pixel results in large frame buffers. Most of the drivers reduce this to 1 byte (the default) or 4 bits per pixel, with the data being expanded at runtime when a line is displayed. This trades a large saving in RAM for a small increase in refresh time. Minimising this increase while keeping the driver cross-platform involves the use of the viper decorator.

Eight bit drivers store colors in rrrgggbb. This results in a loss of precision in specifying a color. Four bit drivers store a color as the index into a 16 bit lookup table. There is no loss of precision but only 16 distinct colors can be supported.

The choice of 16, 8 or 4 bit drivers is largely transparent: all demo scripts run in a visually identical manner under all drivers. This will apply to any application which uses the predefined colors. Differences become apparent when specifying custom colors. For detail see the main README User defined colors.

2. OLED displays

2.1 Drivers for SSD1351

This is an OLED driver. The supported displays produce excellent images with extreme contrast and bright colors. Power consumption is low.

See Adafruit 1.5" 128*128 OLED display and Adafruit 1.27" 128*96 display.

There are four versions.

ssd1351.py This is optimised for STM (e.g. Pyboard) platforms.
ssd1351_generic.py Cross-platform version. Tested on ESP32 and ESP8266.
ssd1351_16bit.py Cross-platform. Uses 16 bit RGB565 color.
ssd1351_4bit.py Cross-platform. Uses 4 bit color.

All these drivers work with the provided demo scripts.
To conserve RAM the first two use 8 bit (rrrgggbb) color. This works well with the GUI if saturated colors are used to render text and controls.

The ssd1351_generic.py and 4 bit versions use the micropython.viper decorator. If your platform does not support this, comment it out and remove the type annotations. You may be able to use the micropython.native decorator.

If the platform supports the viper emitter performance should still be good: on a Pyboard V1 the generic driver perorms a refresh of a 128*128 color display in 47ms. The STM version is faster but not by a large margin: a refresh takes 41ms. 32ms of these figures is consumed by the data transfer over the SPI interface. The 4-bit version with Viper takes 44ms.

If the viper and native decorators are unsupported a screen redraw takes 272ms (on Pyboard 1.0) which is visibly slow.

The ssd1351_16bit version on a 128x128 display requires 32KiB for the frame buffer; this means it is only usable on platforms with plenty of RAM. Testing was done on a Pyboard D SF2W. With the GUI this version offers no benefit, but it delivers major advantages in applications such as rendering images.

For further information see the GUI README User defined colors.

This driver was tested on Adafruit 1.5 and 1.27 inch displays.

The color_setup.py file should initialise the SPI bus with a baudrate of 20_000_000. Args polarity, phase, bits, firstbit are defaults. Hard or soft SPI may be used but hard may be faster.

SSD1351 Constructor args:

spi An SPI bus instance.
pincs An initialised output pin. Initial value should be 1.
pindc An initialised output pin. Initial value should be 0.
pinrs An initialised output pin. Initial value should be 1.
height=128 Display dimensions in pixels. Height must be 96 or 128.
width=128
init_spi=False This optional arg enables flexible options in configuring the SPI bus. The default assumes exclusive access to the bus with color_setup.py initialising it. Those settings will be left in place. If a callback function is passed, it will be called prior to each SPI bus write: this is for shared bus applications. The callback will receive a single arg being the SPI bus instance. In normal use it will be a one-liner or lambda initialising the bus. A minimal example is this function:

def spi_init(spi):
    spi.init(baudrate=20_000_000)  # Data sheet: should support 20MHz

Despite the datasheet I failed to get this baudrate to work even on a PCB.

A "gotcha" in the datasheet

For anyone seeking to understand or modify the code, the datasheet para 8.3.2 is confusing. They use the colors red, green and blue to represent colors C, B and A. With the setup used in these drivers, C is blue and A is red. The 16 bit color streams sent to the display are:
s[x] 1st byte sent b7 b6 b5 b4 b3 g7 g6 g5
s[x + 1] 2nd byte sent g4 g3 g2 r7 r6 r5 r4 r3

2.2 Drivers for SSD1331

This is an OLED driver for small displays. The supported display produces excellent images with extreme contrast and bright colors. Power consumption is low.

See Adafruit 0.96" OLED display. Most of the demos assume a larger screen and will fail. The color96.py demo is written for this display.

There are two versions. Both are cross-platform.

ssd1331.py Uses 8 bit rrrgggbb color.
ssd1331_16bit.py Uses 16 bit RGB565 color.

The ssd1331_16bit version requires 12KiB of RAM for the frame buffer, while the standard version needs only 6KiB. For the GUI the standard version works well because text and controls are normally drawn with a limited range of colors, most of which are saturated.

The 16 bit version provides greatly improved results when rendering images.

The color_setup.py file should initialise the SPI bus with a baudrate of 6_666_000. Args polarity, phase, bits, firstbit are defaults. Hard or soft SPI may be used but hard may be faster.

SSD1331 Constructor args:

spi An SPI bus instance.
pincs An initialised output pin. Initial value should be 1.
pindc An initialised output pin. Initial value should be 0.
pinrs An initialised output pin. Initial value should be 1.
height=64 Display dimensions in pixels.
width=96
init_spi=False This optional arg enables flexible options in configuring the SPI bus. The default assumes exclusive access to the bus with color_setup.py initialising it. Those settings will be left in place. If a callback function is passed, it will be called prior to each SPI bus write: this is for shared bus applications. The callback will receive a single arg being the SPI bus instance. In normal use it will be a one-liner or lambda initialising the bus. A minimal example is this function:

def spi_init(spi):
    spi.init(baudrate=6_666_000)  # Data sheet: max is 150ns

3. Color TFT displays

3.1 Drivers for ST7735R

This chip is for small TFT displays. Four drivers are provided. All are cross-platform but assume micropython.viper capability. They use 8-bit or 4-bit color to minimise the RAM used by the frame buffer.

Drivers for Adafruit 1.8" display.

st7735r.py 8-bit color.
st7735r_4bit.py 4-bit color for further RAM reduction.

For Adafruit 1.44" display.

st7735r144.py 8-bit color.
st7735r144_4bit 4 bit color.

Users of other ST7735R based displays should beware: there are many variants with differing setup requirements. This driver has four different initialisation routines for various display versions. The supported Adafruit displays differ in their initialisation settings, hence the need for different drivers for the two display types. If your Chinese display doesn't work with my drivers you are on your own: I can't support hardware I don't possess.

The color_setup.py file should initialise the SPI bus with a baudrate of 12_000_000. Args polarity, phase, bits, firstbit are defaults. Hard or soft SPI may be used but hard may be faster.

ST7735R Constructor args 1.8" display:

spi An initialised SPI bus instance. The device can support clock rates of upto 15MHz.
cs An initialised output pin. Initial value should be 1.
dc An initialised output pin. Initial value should be 0.
rst An initialised output pin. Initial value should be 1.
height=128 Display dimensions in pixels. For portrait mode exchange height and width values.
width=160
usd=False Upside down: set True to invert display.
init_spi=False This optional arg enables flexible options in configuring the SPI bus. See below.

ST7735R144 Constructor args 1.44" display:

spi An initialised SPI bus instance. The device can support clock rates of upto 15MHz.
cs An initialised output pin. Initial value should be 1.
dc An initialised output pin. Initial value should be 0.
rst An initialised output pin. Initial value should be 1.
height=128 Display dimensions in pixels.
width=128
rotation=0 Pass 0, 90, 180 or 270 to rotate the display.
init_spi=False This optional arg enables flexible options in configuring the SPI bus. See below.

The init_spi constructor arg

The False default assumes exclusive access to the bus. It is initialised by color_setup.py and those settings are left in place. If a callback function is passed, it will be called prior to each SPI bus write. This is for shared bus applications. The callback will receive a single arg being the SPI bus instance. In normal use it will be a one-liner or lambda initialising the bus. A minimal example is this function which caters for the case where another program may have changed the baudrate:

def spi_init(spi):
    spi.init(baudrate=12_000_000)  # Data sheet: max is 12MHz

3.2 Drivers for ILI9341

Adafruit make several displays using this chip, for example this 3.2 inch unit.

The color_setup.py file should initialise the SPI bus with a baudrate of 10_000_000. Args polarity, phase, bits, firstbit are defaults. Hard or soft SPI may be used but hard may be faster. See note on overclocking below.

ILI9341 Constructor args:

spi An initialised SPI bus instance. The device can support clock rates of upto 10MHz.
cs An initialised output pin. Initial value should be 1.
dc An initialised output pin. Initial value should be 0.
rst An initialised output pin. Initial value should be 1.
height=240 Display dimensions in pixels. For portrait mode exchange height and width values.
width=320
usd=False Upside down: set True to invert display.
init_spi=False This optional arg enables flexible options in configuring the SPI bus. The default assumes exclusive access to the bus. In this normal case, color_setup.py initialises it and the settings will be left in place. If the bus is shared with devices which require different settings, a callback function should be passed. It will be called prior to each SPI bus write. The callback will receive a single arg being the SPI bus instance. It will typically be a one-liner or lambda initialising the bus. A minimal example is this function:

def spi_init(spi):
    spi.init(baudrate=10_000_000)

The ILI9341 class uses 4-bit color to conserve RAM. Even with this adaptation the buffer size is 37.5KiB. See Color handling for details of the implications of 4-bit color. On a Pyboard 1.1 the scale.py demo ran with 34.5K free with no modules frozen, and with 47K free with gui and contents frozen.

The driver uses the micropython.viper decorator. If your platform does not support this, comment it out and remove the type annotations. You may be able to use the micropython.native decorator.

Use with uasyncio

A full refresh blocks for ~200ms. If this is acceptable, no special precautions are required. However this period may be unacceptable for some uasyncio applications. The driver provides an asynchronous do_refresh(split=4) method. If this is run the display will be refreshed, but will periodically yield to the scheduler enabling other tasks to run. This is documented here.

Another option to reduce blocking is overclocking the SPI bus.

Overclocking SPI

The ILI9341 datasheet section 19.3.4 specifies a minimum clock cycle time of 100ns for write cycles. It seems that every man and his dog overclocks this, even the normally conservative Adafruit use 24MHz and rdagger uses 40MHz. I have successfully run my display at 40MHz. My engineering training makes me baulk at exceeding datasheet limits but the choice is yours. I raised this isse. The response may be of interest.

3.3 Drivers for ST7789

These displays tend to be physically small with a high pixel density. The chip supports up to 240x320 displays. The Adafruit units tested are 240x240. To keep the buffer size down, the driver uses 4-bit color with dynamic conversion to 16 bit RGB565 at runtime. This uses a lookup table (LUT) enabling user defined colors. The resultant buffer size for the Adafruit displays is 28800 bytes. See Color handling for the implications of 4-bit color.

Tested display: Adafruit 1.3 inch. The Adafruit 1.54 inch has identical resolution and uses the same CircuitPython driver so can be expected to work.

The driver also supports the TTGO T-Display. This is an inexpensive ESP32 with a 135x240 color TFT display. See setup_examples/st7789_ttgo.py.

Also, in landscape mode only, the Waveshare Pico LCD 1.14 inch. This has a hardware quirk, copy setup_examples/st7789_pico_lcd_114.py to your setup file.

The color_setup.py file should initialise the SPI bus with a baudrate of 30_000_000. Args polarity, phase, bits, firstbit are defaults. Hard or soft SPI may be used but hard may be faster. 30MHz is a conservative value: see below. An example file for the Pi Pico is in color_setup/st7789_pico.py.

ST7789 Constructor args:

spi An initialised SPI bus instance. The chip supports clock rates of upto 62.5MHz (datasheet table 6). I have tested 60MHz. High speeds are sensitive to electrical issues such as lead lengths, PCB layout and grounding.
cs An initialised output pin. Initial value should be 1.
dc An initialised output pin. Initial value should be 0.
rst An initialised output pin. Initial value should be 1.
height=240 Display dimensions in pixels. For portrait mode exchange height and width values: this ensures that nano-gui gets the correct aspect ratio.
width=240
disp_mode=LANDSCAPE This arg enables portrait mode and other configurations. See below.
init_spi=False For shared SPI bus applications. See note below.
display=GENERIC The display arg is an opaque type defining the display hardware. Current options (exported by the driver) are GENERIC for Adafruit displays and TDISPLAY for the TTGO board.

Constants exported by the driver

The color_setup.py file should invoke the driver as follows:

from drivers.st7789.st7789_4bit import *
SSD = ST7789

The following constants are available:
Orientation (values for disp_mode):
LANDSCAPE Normal display, text is parallel to long axis.
PORTRAIT Text is parallel to short axis.
USD Upside down rendering.
REFLECT Mirror image rendering.

Display types (values for display):
GENERIC For Adafruit displays.
TDISPLAY For the TTGO T-Display and Waveshare Pico LCD.

init_spi

This optional arg enables flexible options in configuring the SPI bus. The default assumes exclusive access to the bus. In this normal case, color_setup.py initialises it and the settings will be left in place. If the bus is shared with devices which require different settings, a callback function should be passed. It will be called prior to each SPI bus write. The callback will receive a single arg being the SPI bus instance. It will typically be a one-liner or lambda initialising the bus. A minimal example is this function:

def spi_init(spi):
    spi.init(baudrate=30_000_000)

Display mode

This is provided mainly to support asymmetrical displays. It also enables the Adafruit display image to be rotated. Any of the orientation constants listed above may be applied, and multiple options may be combined using the bitwise-or | operator.

When choosing LANDSCAPE or PORTRAIT mode it is essential that height and width constructor args match the mode.

The following example color_setup.py is for Pi Pico and produces an upside down portrait display.

from drivers.st7789.st7789_4bit import *
SSD = ST7789

pdc = Pin(13, Pin.OUT, value=0)  # Arbitrary pins
pcs = Pin(14, Pin.OUT, value=1)
prst = Pin(15, Pin.OUT, value=1)

gc.collect()  # Precaution before instantiating framebuf
spi = SPI(1, 30_000_000, sck=Pin(10), mosi=Pin(11), miso=Pin(8))
ssd = SSD(spi, dc=pdc, cs=pcs, rst=prst, disp_mode=PORTRAIT | USD)

Use with uasyncio

Running the SPI bus at 60MHz a refresh blocks for 83ms (tested on a Pi Pico at standard clock frequency). If the blocking period is acceptable, no special precautions are required. This period may be unacceptable for some uasyncio applications. Some may use lower SPI baudrates either for electrical reasons or where the host cannot support high speeds, and some platforms may run Python code at a different speed.

The driver provides an asynchronous do_refresh(split=4) method. If this is run the display will be refreshed, but will periodically yield to the scheduler enabling other tasks to run. This is documented here.

The amount of data for SPI transfer for a 240x240 display is
240x240x16 = 921.6K bits
At a 60MHz baudrate this equates to
240x240x16/6e7=15.36ms
This suggests that about 80% of the latency results from the Python code. An option may be to overclock.

3.3.1 TTGO T Display

Thanks to Ihor Nehrutsa who wrote much of the setup file for this device.

This is an ESP32 based device with an integrated 1.14" 135x240 pixel display based on ST7789.

It is supported by color_setup/st7789_ttgo.py. Copy to /pyboard/color_setup.py on the device. It produces a landscape mode display with the top left hand corner adjacent to pin 36.

Commented-out code offers portrait mode.

URL's. More in st7789_ttgo.py
TTGO Product page
Ihor Nehrutsa's PR
Another MicroPython driver
Factory test (C)

3.3.2 Waveshare Pico Res Touch

This is a "plug and play" 2.8" color TFT for nano-gui and the Pi Pico. Users of micro-gui will need to find a way to connect pushbuttons, either using stacking headers on the Pico or soldering wires to its pads. The color_setup.py file is as follows. Note the commented-out options and the Lewis Caroll nature of the landscape/portrait constructor args. See setup_examples/ws_pico_res_touch.py.

import gc
from machine import Pin, SPI
from drivers.st7789.st7789_4bit import *
SSD = ST7789

pdc = Pin(8, Pin.OUT, value=0)
pcs = Pin(9, Pin.OUT, value=1)
prst = Pin(15, Pin.OUT, value=1)
pbl = Pin(13, Pin.OUT, value=1)

gc.collect()  # Precaution before instantiating framebuf
spi = SPI(1, 33_000_000, sck=Pin(10), mosi=Pin(11), miso=Pin(12))

# Define the display
# For portrait mode:
# ssd = SSD(spi, height=320, width=240, dc=pdc, cs=pcs, rst=prst)
# For landscape mode:
ssd = SSD(spi, height=240, width=320, disp_mode=PORTRAIT, dc=pdc, cs=pcs, rst=prst)

# Optional use of SD card.
from sdcard import SDCard
import os
sd = SDCard(spi, Pin(22, Pin.OUT), 33_000_000)
vfs = os.VfsFat(sd)
os.mount(vfs, "/fc")

The ST7789 is specified for baudrates upto 62.5MHz, however the maximum the Pico can produce is 31.25MHz. The display uses a nonstandard pin for MISO. This was proven to work by testing the SD card. This requires the official SD card driver which may be found in the MicroPython source tree in drivers/sdcard/sdcard.py. I am not an expert on SD cards. Mine worked fine at 31.25MHz but this may or may not be universally true.

3.3.3 Troubleshooting

If your display shows garbage, check the following (I have seen both):

SPI baudrate too high for your physical layout.
height and width not matching the choice of LANDSCAPE or PORTRAIT display mode.

4. Drivers for sharp displays

These displays have characteristics which mean that they are best suited to micropower applications. Inevitably this means that deployment is more involved than the other supported units. This doc provides some background information on their use.

These monochrome SPI displays exist in three variants from Adafruit.

I have tested on the first of these. However the Adfruit driver supports all of these and I would expect this one also to do so.

4.1. Display characteristics

These displays have extremely low current consumption: I measured ~90μA on the 2.7" board when in use. Refresh is fast, visually excellent and can run at up to 20Hz. This contrasts with ePaper (eInk) displays where refresh is slow (seconds) and visually intrusive; an alternative fast mode overcomes this, but at the expense of ghosting.

On the other hand the power consumption of ePaper can be zero (you can switch them off and the display is retained). If you power down a Sharp display the image is retained, but only for a few seconds. In a Pyboard context 90μA is low in comparison to stop mode and battery powered applications should be easily realised.

The 2.7" display has excellent resolution and can display fine lines and small fonts. In other respects the display quality is not as good as ePaper. For good contrast best results are achieved if the viewing angle and the direction of the light source are positioned to achieve reflection.

4.1.1 The VCOM bit

The significance of this is somewhat glossed-over in the Adafruit docs, and a study of the datasheet is confusing in the absence of prior knowledge of LCD technology.

The signals applied to an LCD display should have no DC component. This is because DC can cause gradual electrolysis and deterioration of of the liquid crystal material. Display driver hardware typically has an oscillator driving exclusive-or gates such that antiphase signals are applied for ON pixels, and in-phase for OFF pixels. The oscillator typically drives a D-type flip-flop to ensure an accurate 1:1 mark space ratio and hence zero DC component.

These displays offer two ways of achieving this, in the device driver or using an external 1:1 mark space logic signal. The bit controlling this is known as VCOM and the external pins supporting it are EXTMODE and EXTCOMIN. EXTMODE determines whether a hardware input is used (Vcc) or software control is required (Gnd). It is pulled low.

The driver supports software control, in that VCOM is complemented each time the display is refreshed. The Adafruit driver also does this.

Sofware control implies that, in long running applications, the display should regularly be refreshed. The datasheet incicates that the maximum rate is 20Hz, but a 1Hz rate is sufficient.

If hardware control is to be used, EXTMODE should be linked to Vcc and a 1:1 logic signal applied to EXTCOMIN. A frequency range of 0.5-10Hz is specified, and the datasheet also specifies "EXTCOMIN frequency should be made lower than frame frequency".

In my opinion the easiest way to deal with this is usually to use software control, ensuring that the driver's show method is called at regular intervals of at least 1Hz.

4.1.2 Refresh rate

The datasheet specifies a minimum refresh rate of 1Hz.

4.2. Test scripts

sharptest.py Basic functionality test.
clocktest.py Digital and analog clock display.
clock_batt.py As above but designed for low power operation. Pyboard specific.

Tests assume that nanogui is installed as per the instructions. sharptest should not be run for long periods as it does not regularly refresh the display. It tests writer.py and some framebuffer graphics primitives. clocktest demostrates use with nanogui.

The clock_batt.py demo needs upower.py from micropython-micropower.

Testing was done on a Pyboard D SF6W: frozen bytecode was not required. I suspect a Pyboard 1.x would require it to prevent memory errors. Fonts in particular benefit from freezing as their RAM usage is radically reduced.

4.3. Device driver constructor

Positional args:

spi An SPI bus instance. The constructor initialises this to the baudrate and bit order required by the hardware.
pincs A Pin instance. The caller should initialise this as an output with value 0 (unusually the hardware CS line is active high).
height=240 Dimensions in pixels. Defaults are for 2.7" display.
width=400
vcom=False Accept the default unless using pyb.standby. See 4.3.2.

4.3.1 Device driver methods

show No args. Transfers the framebuffer contents to the device, updating the display.
update Toggles the VCOM bit without transferring the framebuffer. This is a power saving method for cases where the application calls show at a rate of < 1Hz. In such cases update should be called at a 1Hz rate.

4.3.2 The vcom arg

It purpose is to support micropower applications which use pyb.standby. Wakeup from standby is similar to a reboot in that program execution starts from scratch. In the case where the board wakes up, writes to the display, and returns to standby, the VCOM bit would never change. In this case the application should store a bool in peristent storage, toggling it on each restart, and pass that to the constructor.

Persistent storage exists in the RTC registers and backup RAM. See micopython-micropower for details of how to acces these resources.

4.4. Application design

In all cases the frame buffer is located on the target hardware. In the case of the 2.7 inch display this is 400*240//8 = 12000 bytes in size. This should be instantiated as soon as possible in the application to ensure that sufficient contiguous RAM is available.

4.4.1 Micropower applications

These comments largely assume a Pyboard host. The application should import upower from micropython-micropower. This turns the USB interface off if not in use to conserve power. It also provides an lpdelay function to implement a delay using pyb.stop() to conserve power.

In tests the clock_batt demo consumed 700μA between updates. A full refresh every 30s consumed about 48mA for 128ms. These figures correspond to a mean current consumption of 904μA implying about 46 days operation per AH of battery capacity. LiPo cells of 2AH capacity are widely available offering a theoretical runtime of 92 days between charges.

Lower currents might be achieved using standby but I have major doubts. This is because it is necessary to toggle the VCOM bit at a minimum of 1Hz. Waking from standby uses significan amounts of power as the modules are compiled. Even if frozen bytecode is used, there is still significant power usage importing modules and instantiating classes; this usage is not incurred in the loop in the demo.

4.5. Resources

Schematic for 2.7" unit

Datasheet 2.7"

Datasheet 1.3"

5. ePaper displays

Known as ePaper or eInk, electrophoretic (EPD) displays are usually monochrome. Some support a few levels of grey or a very small range of colors. They have long refresh times (many seconds). The principal benefit that they consume zero current except while being refreshed: it is possible to switch off power completely with the device retaining the image indefinitely. Present day EPD units perform the slow refresh autonomously - the process makes no demands on the CPU enabling user code to continue to run.

The drivers are compatible with uasyncio. One approach is to use synchronous methods only and the standard demos (some of which use uasyncio) may be run. However copying the framebuffer to the device blocks for some time - 250ms or more - which may be problematic for applications which need to respond to external events. A specific asynchronous mode provides support for reducing blocking time. See EPD Asynchronous support.

5.1 Adafruit monochrome eInk Displays

The driver supports two Adafruit 2.9 inch 296*128 pixel units. A flexible display interfaced via their interface breakout.

An alternative is the Adafruit 2.9" eInk FeatherWing with wiring details listed below.

In my testing there are differences between these alternatives. The FeatherWing shows a black border around the display. The reason for this is unclear. In development I encountered instances where the image on the flexible display gradually degraded after the system was powered down. The white background becomes speckled over a period of a few minutes. I'm unsure of the reason for this. The epd29_lowpower demo did not exhibit this.

The interface breakout for the flexible display has an ENA pin which enables the display to be powered down. This facilitates micropower applications: the host shuts down the display before itself going into deep sleep.

The driver is cross platform and supports landscape or portrait mode. To keep the buffer size down (to 4736 bytes) there is no greyscale support. It should be noted that the Adafruit site cautions against refreshing the flexible displays more frequently than every 180s. This warning does not appear on the FeatherWing pages. No reason for the warning is given and it is unclear if this is an absolute limit or an average rate.

Wiring

The interface schematic is here. The drawing title is confusing but I believe this is the correct schematic.

The following assumes a Pyboard host. Pyboard pin numbers are based on hardware SPI 2 and an arbitrary choice of GPIO. All may be changed and soft SPI may be used.

Pyb	Breakout
Vin	Vin (1)
Gnd	Gnd (3)
Y8	MOSI (6)
Y6	SCK (4)
Y4	BUSY (11)
Y3	RST (10)
Y2	CS (7)
Y1	DC (8)

In normal use the ENA pin (12) may be left unconnected. For micropower use, see below.

5.1.1 EPD constructor args

spi An initialised SPI bus instance. The device can support clock rates of upto 10MHz.
cs An initialised output pin. Initial value should be 1.
dc An initialised output pin. Initial value should be 0.
rst An initialised output pin. Initial value should be 1.
busy An initialised input pin.
landscape=True By default the long axis is horizontal.
asyn=False Setting this True invokes an asynchronous mode. See EPD Asynchronous support.

5.1.2 EPD public methods

Synchronous methods

init No args. Issues a hardware reset and initialises the hardware. This is called by the constructor. It needs to explicitly be called to exit from a deep sleep.
sleep No args. Puts the display into deep sleep. If called while a refresh is in progress it will block until the refresh is complete. sleep should be called before a power down to avoid leaving the display in an abnormal state.
ready No args. After issuing a refresh the device will become busy for a period: ready status should be checked before issuing refresh.
wait_until_ready No args. Pause until the device is ready.

Asynchronous methods

updated Asynchronous. No args. Pause until the framebuffer has been copied to the display.
wait Asynchronous. No args. Pause until the display refresh is complete.

5.1.3 EPD public bound variables

height Integer. Height in pixels. Treat as read-only.
width Integer. Width in pixels. Treat as read-only.
demo_mode=False Boolean. If set True after instantiating, refresh() will block until display update is complete, and then for a further two seconds to enable viewing. This enables generic nanogui demos to be run on an EPD.

5.1.4 FeatherWing wiring

The pinout is listed here. The busy line is brought out to a labelled pad on the PCB. It can be linked to an unused pin on the interface connectors.

These are the connections required to run the test scripts on a Pyboard. Viwed on the underside of the board with the SD card at the top. Each connector has pairs of pins which are linked together.

Pin	Pyb	Pin	Pyb	Notes
RST	Y3			Should be open drain (see below).
3V	3.3V
.
Gnd	Gnd
.		.
.		.
.		.
.		.
.		.
.		.
SCK	Y6	DC	Y1
MOSI	Y8	ECS	Y2
.		.
.		.
.		.
BUSY	Y4	.		Linked with wire to BUSY pad.

The FeatherWing has a reset button which shorts the RST line to Gnd. To avoid risk of damage to the microcontroller pin if the button is pressed, the pin should be configured as open drain.

5.1.5 Micropower use

Developers of micropower applications will need to familiarise themselves with the power saving features of their board. Information may be found in micropython-micropower. Some information is generic, but the code is Pyboard specific. Pyboard users should copy upower.py to the filesystem root. Further power savings may be achieved by precompiling or freezing code as this avoids the energy used by the compiler (on each wakeup). Users of other platforms will need to know how to enter and exit from deep sleep.

I developed this using the breakout board linked to Wbus DIP28 adaptor and a Pyboard D, powered from a LiPo cell. A Pyboard 1.1 could be used identically. The test script epd29_lowpower.py requires upower.py as described above. This simplifies access to the Pyboard RTC's alarms which can wake the board from deep sleep. Wakeup from certain pins is also possible.

To power down the breakout the ENA pin must be pulled to 0v. Some microcontrollers can ensure that a GPIO pin is able to sink current when the chip goes into deep sleep. In other cases the pin becomes high impedance. The following ensures that a high impedance pin will cause ENA to be pulled low. The N channel MOSFET must have a low threshold voltage.

An alternative, slightly less efficient approach, is to pull down ENA with a 2.2KΩ resistor and link it to a GPIO pin. The breakout has a 100KΩ resistor to Vin. The 2.2KΩ resistor causes the breakout and display to assume the power off state if the GPIO pin is high impedance.

The test script epd29_lowpower.py assumes pin Y5 linked to the breakout enable. I used the 2.2KΩ resistor pull down. The code comments clarify the mode of operation. The demo wakes every 30s. Real applications would do it much less frequently with attendant power savings.

Users of other EPD's may want to develop other means of powering down the EPD. A p-channel MOSFET could be considered as described here.

Measurements

In use I measured 58μA between wakeups. The Pyboard accounts for about 6μA. 33μA will be used by the 100KΩ pullup on the breakout's power enable line. I haven't attempted to figure out where the other 19μA is going.

I measured power consumption for a hypothetical application which wakes once per hour, refreshes the screen, and goes back to sleep. In summary it uses 0.74AH per year. This suggests it could run for ~3 years on a set of alkaline AA cells (capacity 2.5AH).

Of the total, the 58μA sleep current accounts for 0.5AH, and the wakeup current 0.24AH. Of the wakeup current, 28% is used for physical display refresh and a further 39% during SPI transfer to the display. The remaining 33% is used by boot (3%), initialisation of the device (2.8%), and initialisation of nano-gui (27%). This is based on study of the current waveform in conjunction with guessing what is going on in each phase of operation.

The measurements used frozen bytecode on a Pyboard D SF6W. No SD card was fitted. Code was epd29_lowpower.py with the red LED code removed.

The fact that nearly 70% of the energy is used in standby suggests improvements. If the EPD subsystem were turned off by a p-channel MOSFET, current consumption could be reduced to the 6μA figure of the Pyboard, an order of magnitude improvement.

5.2 Waveshare eInk Display HAT

This 2.7" 176*274 display is designed for the Raspberry Pi and is detailed here.

I bought two of these units from different sources. Both have hardware issues discussed here. I have failed to achieve consistent behaviour. Units behave perfectly one day and fail the next. I published this driver on the assumption that I was twice sold dubious Chinese clones and that genuine ones would be reliable.

The driver is cross-platform.

Wiring

This shows the Raspberry Pi connector looking at the underside of the board with the bulk of the board to the right. Only the top portion of the 40-way connector is shown, with connections to a Pyboard to match waveshare_setup.py.

Connections may be adapted for other MicroPython targets. The board may be powered from 5V or 3.3V: there is a regulator on board.

Pyb		L	R		Pyb
Vin	VIN	2	1
		4	3
		6	5
		8	7
		10	9	GND	Gnd
		12	11	RST	Y3
		14	13
		16	15
Y4	BUSY	18	17
		20	19	MOSI	Y8
Y1	DC	22	21
Y2	CS	24	23	SCLK	Y6

Pins 26-40 unused and omitted.

5.2.1 EPD constructor args

spi An initialised SPI bus instance. The device can support clock rates of upto 2MHz.
cs An initialised output pin. Initial value should be 1.
dc An initialised output pin. Initial value should be 0.
rst An initialised output pin. Initial value should be 1.
busy An initialised input pin.
landscape=False By default the long axis is vertical.
asyn=False

5.2.2 EPD public methods

Synchronous methods

init No args. Issues a hardware reset and initialises the hardware. This is called by the constructor. It needs to explicitly be called to exit from a deep sleep.
sleep No args. Puts the display into deep sleep. If called while a refresh is in progress it will block until the refresh is complete. sleep should be called before a power down to avoid leaving the display in an abnormal state.
ready No args. After issuing a refresh the device will become busy for a period: ready status should be checked before issuing refresh.
wait_until_ready No args. Pause until the device is ready.

Asynchronous methods

updated Asynchronous. No args. Pause until the framebuffer has been copied to the display.
wait Asynchronous. No args. Pause until the display refresh is complete.

5.2.3 EPD public bound variables

height Integer. Height in pixels. Treat as read-only.
width Integer. Width in pixels. Treat as read-only.
demo_mode=False Boolean. If set True after instantiating, refresh() will block until display update is complete, and then for a further two seconds to enable viewing. This enables generic nanogui demos to be run on an EPD.

6. EPD Asynchronous support

Normally when GUI code issues

refresh(ssd)  # 250ms or longer depending on platform

display data is copied to the device and a physical refresh is initiated. The code blocks while copying data to the display before returning. Subsequent physical refresh is performed by the display hardware taking several seconds. While physical refresh is nonblocking, the initial blocking period is too long for many uasyncio applications.

If an EPD is instantiated with asyn=True the process of copying the data to the device is performed by a task which periodically yields to the scheduler. By default blocking is limited to around 30ms.

A .updated() method lets user code pause after issuing refresh(). The pause lasts until the framebuf has been entirely copied to the hardware. The application is then free to alter the framebuf contents.

It is invalid to issue .refresh() until the physical display refresh is complete; if this is attempted a RuntimeError will occur. The most efficient way to ensure that this cannot occur is to await the .wait() method prior to a refresh. This method will pause until any physical update is complete.

The following illustrates the kind of approach which may be used:

    while True:
        # Before refresh, ensure that a previous refresh is complete
        await ssd.wait()
        refresh(ssd)  # Immediate return. Creates a task to copy content to EPD.
        # Wait until the framebuf content has been passed to EPD.
        await ssd.updated()
        # Trigger an event which allows other tasks to update the
        # framebuffer in background
        evt.set()
        evt.clear()
        # The 2.9 inch display should not be updated too frequently
        await asyncio.sleep(180)

7. Writing device drivers

Device drivers capable of supporting nanogui can be extremely simple: see drivers/sharp/sharp.py for a minimal example. It should be noted that the supplied device drivers are designed purely to support nanogui. To conserve RAM they provide no functionality beyond the transfer of an external frame buffer to the device. This transfer typically takes a few tens of milliseconds. While visually instant, this period constitutes latency between an event occurring and a consequent display update. This may be unacceptable in applications such as games. In such cases the FrameBuffer approach is inappropriate. Many driver chips support graphics primitives in hardware; drivers using these capabilities will be faster than those provided here and may often be found using a forum search.

For a driver to support nanogui it must be subclassed from framebuf.FrameBuffer and provide height and width bound variables being the display size in pixels. This, and a show method, are all that is required for monochrome drivers. Generality can be extended by providing this static method:

    @staticmethod
    def rgb(r, g, b):
        return int(((r | g | b) & 0x80) > 0)

This ensures compatibility with code written for color displays by converting RGB values to a single bit.

For color display drivers some boilerplate code is required for rendering monochrome objects such as glyphs:

from drivers.boolpalette import BoolPalette
# In the constructor:
        mode = framebuf.GS8  # Whatever mode the driver uses
        self.palette = BoolPalette(mode)
        super().__init__(buf, self.width, self.height, mode)

Refresh must be handled by a show method taking no arguments; when called, the contents of the buffer underlying the FrameBuffer must be copied to the hardware.

For color drivers, to conserve RAM it is suggested that 8-bit color is used for the FrameBuffer. If the hardware does not support this, conversion to the supported color space needs to be done "on the fly" as per the SSD1351 driver. This uses framebuf.GS8 to stand in for 8 bit color in rrrgggbb format. To maximise update speed consider using native, viper or assembler for the conversion, typically to RGB565 format.

An alternative is to design for 4-bit color which halves the size of the framebuffer. This means using GS4_HMSB mode. The class must include the class variable lut:

class MY_DRIVER(framebuf.FrameBuffer):
    lut = bytearray(32)

This is a lookup table (LUT) mapping a 4-bit index onto a 16-bit color value acceptable to the hardware. The "on the fly" converter unpacks the values in the frame buffer and uses them as indices into the lut bytearray. See the various supplied 4-bit drivers.

Color drivers should have a static method converting rgb(255, 255, 255) to a form acceptable to the driver. For 8-bit rrrgggbb this can be:

    @staticmethod
    def rgb(r, g, b):
        return (r & 0xe0) | ((g >> 3) & 0x1c) | (b >> 6)

This should be amended if the hardware uses a different 8-bit format. If the hardware expects a 16 bit value, the "on the fly" converter will map the 8-bit value to 16 bits. In the case of 4-bit drivers the LUT is 16 bits in size, and .rgb is called only when populating the LUT. In this case .rgb returns a 16 bit value in a format compatible with the hardware and the byte order of the "on the fly" conversion code.

The convention I use is that the LS byte from .rgb() is transmitted first. So long as .rgb() and the "on the fly" converter match, this is arbitrary.

The Writer (monochrome) or CWriter (color) classes and the nanogui module should then work automatically.

For color displays the following provides a substantial performance boost when rendering text.

from drivers.boolpalette import BoolPalette

and, in __init__.py:

        mode = framebuf.GS4_HMSB  # The format to be used by the driver
        self.palette = BoolPalette(mode)
        gc.collect()
        buf = bytearray(self.height * self.width // 2)  # Computation must match the format
        super().__init__(buf, self.width, self.height, mode)

Assuming firmware dated after 26th Aug 2021, a fast C blit will be used to render glyphs instead of Python code.

The following script is useful for testing color display drivers after configuring color_setup.py. It draws squares at the extreme corners of the display and a corner to corner diagonal. The nature of this image makes faultfinding much simpler than viewing a garbled GUI screen.

from color_setup import ssd  # Create a display instance
from gui.core.colors import RED, BLUE, GREEN
from gui.core.nanogui import refresh
refresh(ssd, True)  # Initialise and clear display.
# Uncomment for ePaper displays
# ssd.wait_until_ready()
ssd.fill(0)
ssd.line(0, 0, ssd.width - 1, ssd.height - 1, GREEN)  # Green diagonal corner-to-corner
ssd.rect(0, 0, 15, 15, RED)  # Red square at top left
ssd.rect(ssd.width -15, ssd.height -15, 15, 15, BLUE)  # Blue square at bottom right
ssd.show()

If this produces correct output the GUI's can be expected to work.

Authors of device drivers are encouraged to raise an issue or PR so that the library can be extended.

55 KiB Czysty Wina Historia

Display drivers

Contents

1. Introduction

1.1 Color handling

2. OLED displays

2.1 Drivers for SSD1351

SSD1351 Constructor args:

A "gotcha" in the datasheet

2.2 Drivers for SSD1331

SSD1331 Constructor args:

3. Color TFT displays

3.1 Drivers for ST7735R

ST7735R Constructor args 1.8" display:

ST7735R144 Constructor args 1.44" display:

The init_spi constructor arg

3.2 Drivers for ILI9341

ILI9341 Constructor args:

Use with uasyncio

Overclocking SPI

3.3 Drivers for ST7789

ST7789 Constructor args:

Constants exported by the driver

init_spi

Display mode

Use with uasyncio

3.3.1 TTGO T Display

3.3.2 Waveshare Pico Res Touch

3.3.3 Troubleshooting

4. Drivers for sharp displays

4.1. Display characteristics

4.1.1 The VCOM bit

4.1.2 Refresh rate

4.2. Test scripts

4.3. Device driver constructor

4.3.1 Device driver methods

4.3.2 The vcom arg

4.4. Application design

4.4.1 Micropower applications

4.5. Resources

5. ePaper displays

5.1 Adafruit monochrome eInk Displays

Wiring

5.1.1 EPD constructor args

5.1.2 EPD public methods

Synchronous methods

Asynchronous methods

5.1.3 EPD public bound variables

5.1.4 FeatherWing wiring

5.1.5 Micropower use

Measurements

5.2 Waveshare eInk Display HAT

Wiring

5.2.1 EPD constructor args

5.2.2 EPD public methods

Synchronous methods

Asynchronous methods

5.2.3 EPD public bound variables

6. EPD Asynchronous support

7. Writing device drivers

8. Links

55 KiB

Czysty Wina Historia