From 8f7396c2f0180c04126712a1db3556dde9df7e2c Mon Sep 17 00:00:00 2001 From: Peter Hinch Date: Sun, 3 Sep 2023 12:08:01 +0100 Subject: [PATCH] Docs: update driver installation details. --- DRIVERS.md | 18 ++++++++++++++++++ README.md | 3 ++- 2 files changed, 20 insertions(+), 1 deletion(-) diff --git a/DRIVERS.md b/DRIVERS.md index 20c3dce..e81e408 100644 --- a/DRIVERS.md +++ b/DRIVERS.md @@ -28,6 +28,7 @@ access via the `Writer` and `CWriter` classes is documented 1. [Introduction](./DRIVERS.md#1-introduction) 1.1 [Color handling](./DRIVERS.md#11-color-handling) + 1.2 [Installation](./DRIVERS.md#12-installation) 2. [OLED displays](./DRIVERS.md#2-oled-displays) 2.1 [Drivers for SSD1351](./DRIVERS.md#21-drivers-for-ssd1351) Color OLEDs 2.2 [Drivers for SSD1331](./DRIVERS.md#22-drivers-for-ssd1331) Small color OLEDs @@ -107,6 +108,23 @@ 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.2 Installation + +Please ensure that device firmware is up to date. On networked hardware a +display driver may be installed as follows (example is for ST7789): +```python +>>> mip.install("github:peterhinch/micropython-nano-gui/drivers/st7789") +``` +The last part of the addresss (`st7789`) is the name of the directory holding +drivers for the display in use. In some cases the directory holds more than one +driver: these will all be installed. Unused drivers may be deleted. + +On any hardware [mpremote](http://docs.micropython.org/en/latest/reference/mpremote.html#mpremote) +may be used on the PC as follows: +```bash +$ mpremote mip install "github:peterhinch/micropython-nano-gui/drivers/st7789" +``` + ## 1.1 Color handling Most color displays support colors specified as 16-bit quantities. Storing two diff --git a/README.md b/README.md index 3fa5adf..85cf128 100644 --- a/README.md +++ b/README.md @@ -187,7 +187,8 @@ This stuff is easier than you might think. ### 1.3.1 Quick install -This is done using the official +On networked hardware this is done with `mip` which is included in recent +firmware. On non-networked hardware this is done using the official [mpremote utility](http://docs.micropython.org/en/latest/reference/mpremote.html) which should be installed on the PC as described above.