diff --git a/README.md b/README.md index 590f832..5ab6d8e 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,39 @@ # Balcony Weather Station -A DIY weather station on my balcony that is hooked up to [Home Assistant](https://www.home-assistant.io/). +A DIY weather station project on my balcony. The data is sent to +[Home Assistant](https://www.home-assistant.io/) to be used as part of home +automation projects. The source code started as [CircuitPython](https://circuitpython.org/) following -many of the patterns I learned in creating an [aquarium controller](https://git.sr.ht/~travisshears/sewa-reef-controller). -I have since switch to using C. +many of the patterns I learned in creating an [aquarium controller project](https://git.sr.ht/~travisshears/sewa-reef-controller). +I have since switch to using C for better performance and control. ## Capabilities -Right now the station is fairly limited measuring only temperature, humidity, -and atmospheric pressure. I have plans to expand the project to in the end measure: - -- ✅ tempature -- ✅ humidity -- ✅ atmospheric pressure -- noise levels -- wind speed -- wind direction -- rain fall -- light +- Send data to Home Assistant via MQTT +- ✅ read tempature +- ✅ read humidity +- ✅ read atmospheric pressure +- read partical matter PM1, PM2.5, and PM10 +- read noise levels +- read wind speed +- read wind direction +- read rain fall +- read light level ## Hardware +### Node1 + Sensors: -- Node1: [BME280](https://shop.pimoroni.com/products/bme280-breakout?variant=29420960677971) +- [BME280](https://shop.pimoroni.com/products/bme280-breakout?variant=29420960677971) + - reads tempature, humidity, and atmospheric pressure +- [PMS5003](https://shop.pimoroni.com/products/pms5003-particulate-matter-sensor-with-cable) + - reads partical matter PM1, PM2.5, and PM10 -MCs: -- Node1: [Raspberry Pi Pico W](https://www.raspberrypi.com/products/raspberry-pi-pico/) +MC: [Raspberry Pi Pico W](https://www.raspberrypi.com/products/raspberry-pi-pico/) -Other: -- [Weatherproof Enclosure](https://shop.pimoroni.com/products/weatherproof-cover-for-outdoor-sensors?variant=40047884468307) +Weatherproof Enclosure: [weatherproof-cover-for-outdoor-sensors](https://shop.pimoroni.com/products/weatherproof-cover-for-outdoor-sensors?variant=40047884468307) _Note: I would not recommend buying from pimoroni from EU as shipping tax is huge!_ diff --git a/pms5003.c b/pms5003.c index 5dba5d6..0a99c81 100644 --- a/pms5003.c +++ b/pms5003.c @@ -14,6 +14,7 @@ Sourcces: https://shop.pimoroni.com/products/pms5003-particulate-matter-sensor-with-cable - https://github.com/pimoroni/pms5003-python/blob/main/pms5003/__init__.py - https://github.com/vogelrh/pms5003c/tree/master + - https://github.com/raspberrypi/pico-examples/blob/master/uart/hello_uart/hello_uart.c */ void pms5003_init(pms5003_config *new_config, uart_inst_t *uart, uint8_t tx_pin,