From af084ea33f14935a9200b837e5edd6036cab9154 Mon Sep 17 00:00:00 2001 From: Gregory Ballantine Date: Mon, 7 Sep 2026 01:21:24 -0400 Subject: [PATCH] Updating README with information about the hardware used --- README.md | 28 ++++++++++++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ae7b56e..f9b30ff 100644 --- a/README.md +++ b/README.md @@ -7,11 +7,35 @@ Raspberry Pi Pico app to read BME280 sensor data and send it to Home Assistant. Made in Go with [TinyGo](https://tinygo.org/). -## Requirements +## 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 +* Waveshare Bosch BME280 sensor: https://www.amazon.com/dp/B07Q47DFXS +* 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), is a genuine BME280 sensor, 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 + +## Software Deployment + +### Requirements * [TinyGo](https://tinygo.org/getting-started/install/) - TinyGo installation guide -## Deployment +### Steps 1. Clone this git repository `git clone https://git.metaunix.net/gballan/pico-weather`. 2. Copy `config.go.example` to `config.go` and modify the values to match your environment.