diff --git a/README.md b/README.md index 27e4615..3fa5adf 100644 --- a/README.md +++ b/README.md @@ -169,7 +169,8 @@ $ cd micropython-nano-gui ``` As supplied, `color_setup.py` assumes a Pyboard (1.x or D) connected to an Adafruit 1.27" OLED as specified in that file. If that doesn't correspond to -your hardware, it should be edited to suit. +your hardware, it should be edited to suit. See example files in the +`setup_examples` directory. ```bash $ mpremote mount . ``` @@ -188,25 +189,36 @@ This stuff is easier than you might think. This is done using the official [mpremote utility](http://docs.micropython.org/en/latest/reference/mpremote.html) -which should be installed on the PC. +which should be installed on the PC as described above. -The easy approach is to copy everything to your hardware using `mip` +#### Networked hardware + +The easy approach is to copy the entire GUI to your hardware using `mip` ```python >>> import mip >>> mip.install("github:peterhinch/micropython-nano-gui") ``` -[rshell](https://github.com/dhylands/rshell). This consumes about 508KiB of -space on your filesystem. Substantial pruning can be done to eliminate unused -drivers, fonts, widgets and demos. +Substantial pruning can be done to eliminate unused fonts, widgets and demos. +The appropriate driver for the display hardware is 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. -Edit `color_setup.py` as discussed above. Move to the root directory of the -repo, run `rshell` and issue the following commands (note the `/sd` destination -may need to be adapted for non-pyboard targets): +After editing `color_setup.py` as discussed above it should be copied to the +target hardware with: ```bash -> cp -r drivers /sd -> cp -r gui /sd -> cp color_setup.py /sd -> repl ~ import gui.demos.aclock +$ mpremote cp color_setup.py : +``` +#### Non networked hardware + +Installation is as per networked hardware except that `mip` on the target is +replaced by `mpremote mip` on the PC: +```bash +$ mpremote mip install("github:peterhinch/micropython-nano-gui") +$ mpremote mip install("github:peterhinch/micropython-nano-gui/drivers/st7789") ``` ## 1.4 A performance boost diff --git a/drivers/epaper/package.json b/drivers/epaper/package.json index f49255c..3438a14 100644 --- a/drivers/epaper/package.json +++ b/drivers/epaper/package.json @@ -4,7 +4,7 @@ ["drivers/epaper/epaper2in7_fb.py", "github:peterhinch/micropython-nano-gui/drivers/epaper/epaper2in7_fb.py"], ["drivers/epaper/pico_epaper_42_gs.py", "github:peterhinch/micropython-nano-gui/drivers/epaper/pico_epaper_42_gs.py"], ["drivers/epaper/pico_epaper_42.py", "github:peterhinch/micropython-nano-gui/drivers/epaper/pico_epaper_42.py"], - ["drivers/boolpalette.py", "github:peterhinch/micropython-nano-gui/drivers/boolpalette.py"], + ["drivers/boolpalette.py", "github:peterhinch/micropython-nano-gui/drivers/boolpalette.py"] ], "version": "0.1" } diff --git a/drivers/ili93xx/package.json b/drivers/ili93xx/package.json index 94537d6..11d3fca 100644 --- a/drivers/ili93xx/package.json +++ b/drivers/ili93xx/package.json @@ -1,7 +1,7 @@ { "urls": [ ["drivers/ili93xx/ili9341.py", "github:peterhinch/micropython-nano-gui/drivers/ili93xx/ili9341.py"], - ["drivers/boolpalette.py", "github:peterhinch/micropython-nano-gui/drivers/boolpalette.py"], + ["drivers/boolpalette.py", "github:peterhinch/micropython-nano-gui/drivers/boolpalette.py"] ], "version": "0.1" } diff --git a/drivers/ili94xx/package.json b/drivers/ili94xx/package.json index bcc2ba0..aa72444 100644 --- a/drivers/ili94xx/package.json +++ b/drivers/ili94xx/package.json @@ -1,7 +1,7 @@ { "urls": [ ["drivers/ili94xx/ili9486.py", "github:peterhinch/micropython-nano-gui/drivers/ili94xx/ili9486.py"], - ["drivers/boolpalette.py", "github:peterhinch/micropython-nano-gui/drivers/boolpalette.py"], + ["drivers/boolpalette.py", "github:peterhinch/micropython-nano-gui/drivers/boolpalette.py"] ], "version": "0.1" } diff --git a/drivers/sh1106/package.json b/drivers/sh1106/package.json index 58c71b1..3696180 100644 --- a/drivers/sh1106/package.json +++ b/drivers/sh1106/package.json @@ -1,7 +1,7 @@ { "urls": [ ["drivers/sh1106/sh1106.py", "github:peterhinch/micropython-nano-gui/drivers/sh1106/sh1106.py"], - ["drivers/boolpalette.py", "github:peterhinch/micropython-nano-gui/drivers/boolpalette.py"], + ["drivers/boolpalette.py", "github:peterhinch/micropython-nano-gui/drivers/boolpalette.py"] ], "version": "0.1" } diff --git a/drivers/sharp/package.json b/drivers/sharp/package.json index 406d379..78c82e2 100644 --- a/drivers/sharp/package.json +++ b/drivers/sharp/package.json @@ -1,7 +1,7 @@ { "urls": [ ["drivers/sharp/sharp.py", "github:peterhinch/micropython-nano-gui/drivers/sharp/sharp.py"], - ["drivers/boolpalette.py", "github:peterhinch/micropython-nano-gui/drivers/boolpalette.py"], + ["drivers/boolpalette.py", "github:peterhinch/micropython-nano-gui/drivers/boolpalette.py"] ], "version": "0.1" } diff --git a/drivers/ssd1306/package.json b/drivers/ssd1306/package.json index bcaf883..152b06e 100644 --- a/drivers/ssd1306/package.json +++ b/drivers/ssd1306/package.json @@ -1,7 +1,7 @@ { "urls": [ ["drivers/ssd1306/ssd1306.py", "github:peterhinch/micropython-nano-gui/drivers/ssd1306/ssd1306.py"], - ["drivers/boolpalette.py", "github:peterhinch/micropython-nano-gui/drivers/boolpalette.py"], + ["drivers/boolpalette.py", "github:peterhinch/micropython-nano-gui/drivers/boolpalette.py"] ], "version": "0.1" } diff --git a/drivers/ssd1327/package.json b/drivers/ssd1327/package.json index 52b02aa..f34d861 100644 --- a/drivers/ssd1327/package.json +++ b/drivers/ssd1327/package.json @@ -1,7 +1,7 @@ { "urls": [ ["drivers/ssd1327/ssd1327.py", "github:peterhinch/micropython-nano-gui/drivers/ssd1327/ssd1327.py"], - ["drivers/boolpalette.py", "github:peterhinch/micropython-nano-gui/drivers/boolpalette.py"], + ["drivers/boolpalette.py", "github:peterhinch/micropython-nano-gui/drivers/boolpalette.py"] ], "version": "0.1" } diff --git a/drivers/ssd1331/package.json b/drivers/ssd1331/package.json index e18ca36..44b6c05 100644 --- a/drivers/ssd1331/package.json +++ b/drivers/ssd1331/package.json @@ -2,7 +2,7 @@ "urls": [ ["drivers/ssd1331/ssd1331.py", "github:peterhinch/micropython-nano-gui/drivers/ssd1331/ssd1331.py"], ["drivers/ssd1331/ssd1331_16bit.py", "github:peterhinch/micropython-nano-gui/drivers/ssd1331/ssd1331_16bit.py"], - ["drivers/boolpalette.py", "github:peterhinch/micropython-nano-gui/drivers/boolpalette.py"], + ["drivers/boolpalette.py", "github:peterhinch/micropython-nano-gui/drivers/boolpalette.py"] ], "version": "0.1" } diff --git a/drivers/ssd1351/package.json b/drivers/ssd1351/package.json index 3466510..af2e8bb 100644 --- a/drivers/ssd1351/package.json +++ b/drivers/ssd1351/package.json @@ -4,7 +4,7 @@ ["drivers/ssd1351/ssd1351_4bit.py", "github:peterhinch/micropython-nano-gui/drivers/ssd1351/ssd1351_4bit.py"], ["drivers/ssd1351/ssd1351_16bit.py", "github:peterhinch/micropython-nano-gui/drivers/ssd1351/ssd1351_16bit.py"], ["drivers/ssd1351/ssd1351_generic.py", "github:peterhinch/micropython-nano-gui/drivers/ssd1351/ssd1351_generic.py"], - ["drivers/boolpalette.py", "github:peterhinch/micropython-nano-gui/drivers/boolpalette.py"], + ["drivers/boolpalette.py", "github:peterhinch/micropython-nano-gui/drivers/boolpalette.py"] ], "version": "0.1" } diff --git a/drivers/st7735r/package.json b/drivers/st7735r/package.json index c5a355c..b00a11c 100644 --- a/drivers/st7735r/package.json +++ b/drivers/st7735r/package.json @@ -4,7 +4,7 @@ ["drivers/st7735r/st7735r_4bit.py", "github:peterhinch/micropython-nano-gui/drivers/st7735r/st7735r_4bit.py"], ["drivers/st7735r/st7735r144.py", "github:peterhinch/micropython-nano-gui/drivers/st7735r/st7735r144.py"], ["drivers/st7735r/st7735r144_4bit.py", "github:peterhinch/micropython-nano-gui/drivers/st7735r/st7735r144_4bit.py"], - ["drivers/boolpalette.py", "github:peterhinch/micropython-nano-gui/drivers/boolpalette.py"], + ["drivers/boolpalette.py", "github:peterhinch/micropython-nano-gui/drivers/boolpalette.py"] ], "version": "0.1" } diff --git a/drivers/st7789/package.json b/drivers/st7789/package.json index 2a97d10..9185dae 100644 --- a/drivers/st7789/package.json +++ b/drivers/st7789/package.json @@ -1,7 +1,7 @@ { "urls": [ ["drivers/st7789/st7789_4bit.py", "github:peterhinch/micropython-nano-gui/drivers/st7789/st7789_4bit.py"], - ["drivers/boolpalette.py", "github:peterhinch/micropython-nano-gui/drivers/boolpalette.py"], + ["drivers/boolpalette.py", "github:peterhinch/micropython-nano-gui/drivers/boolpalette.py"] ], "version": "0.1" } diff --git a/package.json b/package.json index e353eca..fb65187 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,7 @@ ["gui/demos/mono_test.py", "github:peterhinch/micropython-nano-gui/gui/demos/mono_test.py"], ["gui/demos/scale.py", "github:peterhinch/micropython-nano-gui/gui/demos/scale.py"], ["gui/demos/sharptest.py", "github:peterhinch/micropython-nano-gui/gui/demos/sharptest.py"], - ["gui/demos/tbox.py", "github:peterhinch/micropython-nano-gui/gui/demos/tbox.py"], + ["gui/demos/tbox.py", "github:peterhinch/micropython-nano-gui/gui/demos/tbox.py"] ], "version": "0.1" }