Docs: update driver installation details.

pull/61/head
Peter Hinch 2023-09-03 12:08:01 +01:00
rodzic 5eafeed7f7
commit 8f7396c2f0
2 zmienionych plików z 20 dodań i 1 usunięć

Wyświetl plik

@ -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

Wyświetl plik

@ -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.