mirror
/
micropython-nano-gui
kopia lustrzana https://github.com/peterhinch/micropython-nano-gui
1
0
Forkuj 0
Kod Zgłoszenia Projekty Wydania Wiki Aktywność

Improvements to docs.

pull/34/head
Peter Hinch 2022-05-10 17:32:42 +01:00
rodzic 3c8c5b2beb
commit 3bee15bd14
2 zmienionych plików z 22 dodań i 19 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

11
ASYNC.md
Wyświetl plik

@ -1,8 +1,8 @@
# nanogui: Use in asynchronous code # nanogui: Use in asynchronous code
###### [Main README](../README.md) ###### [Main README](./README.md)
###### [Driver doc](../DRIVERS.md) ###### [Driver doc](./DRIVERS.md)
## Blocking ## Blocking
@ -60,8 +60,7 @@ between devices having a `do_refresh` method and those that do not:
## Demo scripts ## Demo scripts
These require uasyncio V3. This is incorporated in daily builds and became These require MicroPython firmware V1.13 or later. The `asnano` and
available in release builds starting with MicroPython V1.13. The `asnano` and
`asnano_sync` demos assume a Pyboard. `scale.py` is portable between hosts and `asnano_sync` demos assume a Pyboard. `scale.py` is portable between hosts and
sufficiently large displays. sufficiently large displays.
@ -74,6 +73,6 @@ sufficiently large displays.
pyboard usr button is pressed. pyboard usr button is pressed.
* `scale.py` Illustrates the use of `do_refresh()` where available. * `scale.py` Illustrates the use of `do_refresh()` where available.
###### [Main README](../README.md) ###### [Main README](./README.md)
###### [Driver doc](../DRIVERS.md) ###### [Driver doc](./DRIVERS.md)

30
DRIVERS.md
Wyświetl plik

@ -1,7 +1,9 @@
# Display drivers for nano-gui # Display drivers
The nano-gui project currently supports four display technologies: OLED (color These drivers support [nano-gui](./README.md), [micro-gui](https://github.com/peterhinch/micropython-micro-gui),
and monochrome), color TFT, monochrome Sharp displays and EPD (ePaper/eInk). and [Writer and CWriter](https://github.com/peterhinch/micropython-font-to-py/blob/master/writer/WRITER.md).
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 All drivers provide a display class subclassed from the built-in
`framebuf.FrameBuffer` class. This provides three increasing levels of support: `framebuf.FrameBuffer` class. This provides three increasing levels of support:
* Graphics via the `FrameBuffer` graphics primitives. * Graphics via the `FrameBuffer` graphics primitives.
@ -10,13 +12,12 @@ All drivers provide a display class subclassed from the built-in
* Use with nano-gui and [micro-gui](https://github.com/peterhinch/micropython-micro-gui/). * Use with nano-gui and [micro-gui](https://github.com/peterhinch/micropython-micro-gui/).
It should be noted that in the interests of conserving RAM these drivers offer It should be noted that in the interests of conserving RAM these drivers offer
a bare minimum of functionality required to support the above. They assume sole a bare minimum of functionality required to support the above. Most drivers
access to the SPI or I2C bus. Applications which share the bus must do their provide some support for bus sharing.
own arbitration.
This document is written to support users of `nano-gui`, who only need to Users of the GUI and Writer classes only need to instantiate a display. Hence
instantiate a display to use the GUI. Hence only device constructors are only device constructors are documented. Other attributes are transparent to
documented. Required methods and bound variables are detailed in the user. Required methods and bound variables are detailed in
[Writing device drivers](./DRIVERS.md#7-writing-device-drivers). Low level [Writing device drivers](./DRIVERS.md#7-writing-device-drivers). Low level
access via the `Writer` and `CWriter` classes is documented access via the `Writer` and `CWriter` classes is documented
[here](https://github.com/peterhinch/micropython-font-to-py/blob/master/writer/WRITER.md). [here](https://github.com/peterhinch/micropython-font-to-py/blob/master/writer/WRITER.md).
@ -70,8 +71,11 @@ EPD's in general but makes specific reference to the 2.9" micropower demo.
# 1. Introduction # 1. Introduction
An application specifies a driver by means of `color_setup.py` located in the A nano-gui application specifies a driver by means of `color_setup.py` located
root directory of the target. This typically contains code along these lines: 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:
```python ```python
import machine import machine
import gc import gc
@ -84,7 +88,7 @@ gc.collect()
# Precaution before instantiating framebuf. The next line creates the buffer. # Precaution before instantiating framebuf. The next line creates the buffer.
ssd = SSD(spi, pcs, pdc, prst, 96) # Create a display instance ssd = SSD(spi, pcs, pdc, prst, 96) # Create a display instance
``` ```
The directory `color_setup` contains example files for various displays. These 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 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 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 to `color_setup.py` on the target's root. The section in this doc for the
@ -1185,7 +1189,7 @@ library can be extended.
#### [Device driver document.](./DRIVERS.md) #### [Device driver document.](./DRIVERS.md)
#### [nano-gui](https://github.com/peterhinch/micropython-nano-gui) #### [nano-gui](./README.md)
#### [micro-gui](https://github.com/peterhinch/micropython-micro-gui) #### [micro-gui](https://github.com/peterhinch/micropython-micro-gui)