Resetting app to MicroPython app, since TinyGo seems to still be maturing

2026-09-07 18:37:16 -04:00
parent b83340feb5
commit aa8ebce904
2 changed files with 215 additions and 21 deletions
@@ -1,3 +1,46 @@
-# pico-time
+# Pico Time

-Raspberry Pi Pico app to display time on a local display
+![Woodpecker CI badge](https://builds.metaunix.net/api/badges/93/status.svg)
+![shields.io version badge](https://img.shields.io/gitea/v/release/BitGoblin/pico-weather?gitea_url=https://git.metaunix.net)
+
+A [MicroPython](https://micropython.org/) app to display local time on an SSD1306 display.
+
+## Hardware
+
+The following hardware is what I used for a deployment:
+
+* Raspberry Pi Pico 2 W: https://www.amazon.com/dp/B0DRJXPPWL
+  * The **W** is VERY important, as without networking it can't reach Home Assistant!
+  * Also a Raspberry Pi Pico W *should* work too, but I haven't tested it yet
+* Elegoo SSD1306 LCD: https://www.amazon.com/dp/B0FSRQG23K
+
+Most (or all?) of these components can be swapped for equivalent components. You just need to make sure the code is compatible with whatever board you choose (not likely), and an SSD1306 display.
+
+Support for other hardware types may come in the future, but if there's a specific sensor or board you're in submit an issue or pull request!
+
+### Prototyping
+
+To help with debugging/testing deployments, I also used these components:
+
+* Elegoo 400-pin Breadboard: https://www.amazon.com/dp/B01EV640I6
+* Freenove Raspberry Pi Pico Breakout Board: https://www.amazon.com/dp/B0BFB53Y2N
+* Elegoo 20cm Jumper Cables 120 count: https://www.amazon.com/dp/B01EV70C78
+
+These are not necessary to run the app, but can be useful for testing and/or flashing several nodes.
+
+## Software Deployment
+
+### Requirements
+
+* [MicroPython](https://micropython.org/download/) - MicroPython downloads
+
+### Steps
+
+1. Flash your Raspberry Pi Pico with MicroPython.
+2. Copy `config.example.py` to `config.py` and edit the settings to match your environment.
+3. Copy `main.py` and `config.py` to the root of the filesystem on the Pico.
+4. Connect the SSD1306 display to your Pico and power on.
+
+## License
+
+This project is made available under the BSD 3-Clause license.