Docs: update driver installation details.

pull/61/head
Peter Hinch 2023-09-03 12:23:21 +01:00
rodzic 5e2dfb681f
commit 521c7b553d
1 zmienionych plików z 17 dodań i 17 usunięć

Wyświetl plik

@ -108,23 +108,6 @@ specific display chip should be consulted for SSD constructor arguments and SPI
baudrate. The more exotic displays (Sharp and ePaper) have additional features baudrate. The more exotic displays (Sharp and ePaper) have additional features
and requirements detailed below. 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 ## 1.1 Color handling
Most color displays support colors specified as 16-bit quantities. Storing two Most color displays support colors specified as 16-bit quantities. Storing two
@ -145,6 +128,23 @@ application which uses the predefined colors. Differences become apparent when
specifying custom colors. For detail see the main README specifying custom colors. For detail see the main README
[User defined colors](./README.md#311-user-defined-colors). [User defined colors](./README.md#311-user-defined-colors).
## 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"
```
###### [Contents](./DRIVERS.md#contents) ###### [Contents](./DRIVERS.md#contents)
# 2. OLED displays # 2. OLED displays