Update Inky Frame readme

pull/460/head
helgibbons 2022-07-22 19:17:39 +01:00
rodzic 0ad6cb9987
commit a32bbd1c63
1 zmienionych plików z 16 dodań i 2 usunięć

Wyświetl plik

@ -2,7 +2,9 @@
- [PicoGraphics](#picographics)
- [Examples](#examples)
- [Button Test](#button-test)
- [Daily Activity](#daily-activity)
- [Image Gallery](#image-gallery)
- [News](#news)
- [PlaceKitten](#placekitten)
- [Quote of the Day](#quote-of-the-day)
@ -16,21 +18,33 @@ You can draw on Inky Frame using our tiny PicoGraphics display library.
## Examples
The examples need `network_manager.py` and `WIFI_CONFIG.py` from the `common` directory to be saved to your Pico W. Open up `WIFI_CONFIG.py` in Thonny to add your wifi details (and save it when you're done).
The wireless examples need `network_manager.py` and `WIFI_CONFIG.py` from the `common` directory to be saved to your Pico W. Open up `WIFI_CONFIG.py` in Thonny to add your wifi details (and save it when you're done).
You'll also need to install the `micropython-urllib.urequest` library using Thonny's 'Tools' > 'Manage Packages' or `common/lib/urllib` which contains a compiled `.mpy` version that uses less RAM. You should place this directory in `lib` on your Pico W.
Finally for examples loading images, you'll need `sdcard.mpy` from `common/lib`. You should place this file in `lib` on your Pico W.
- [micropython/examples/common](../common)
### Button Test
[button_test.py](button_test.py)
This example shows you a simple, non-interrupt way of reading Inky Frame's buttons with a loop that checks to see if buttons are pressed.
### Daily Activity
[inky_frame_daily_activity.py](inky_frame_daily_activity.py)
Generate a random activity from Bored API.
### Image Gallery
[/image_gallery](/image_gallery)
This photo frame example displays local images on Inky Frame and lets you switch between them with the buttons. Use `image_gallery.py` if your images are stored on your Pico, or `image_gallery_sd.py` if the images are on your SD card.
### News
[inky_frame_news.py](inky_frame_news.py)
Display headlines from BBC news.
Display headlines from BBC News.
### PlaceKitten
[inky_frame_placekitten.py](inky_frame_placekitten.py)