Merge branch 'init-readme'

This commit is contained in:
Travis Shears 2023-08-10 10:19:07 +02:00
commit b4d6e97b46
Signed by: travisshears
GPG key ID: D4C2E4DFAB8BABF8
3 changed files with 59 additions and 0 deletions

2
.gitignore vendored
View file

@ -1 +1,3 @@
CIRCUITPY/settings.toml
.DS_Store
.vscode/

19
LICENSE.md Normal file
View file

@ -0,0 +1,19 @@
ANTI-CAPITALIST SOFTWARE LICENSE (v 1.4)
Copyright © 2022 Travis Shears
This is anti-capitalist software, released for free use by individuals and organizations that do not operate by capitalist principles.
Permission is hereby granted, free of charge, to any person or organization (the "User") obtaining a copy of this software and associated documentation files (the "Software"), to use, copy, modify, merge, distribute, and/or sell copies of the Software, subject to the following conditions:
1. The above copyright notice and this permission notice shall be included in all copies or modified versions of the Software.
2. The User is one of the following:
- An individual person, laboring for themselves
- A non-profit organization
- An educational institution
- An organization that seeks shared profit for all of its members, and allows non-members to set the cost of their labor
3. If the User is an organization with owners, then all owners are workers and all workers are owners with equal equity and/or equal vote.
4. If the User is an organization, then the User is not law enforcement or military, or working for or under either.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT EXPRESS OR IMPLIED WARRANTY OF ANY KIND, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

38
README.md Normal file
View file

@ -0,0 +1,38 @@
# Balcony Weather Station
A DIY weather station on my balcony that is hooked up to [Home Assistant](https://www.home-assistant.io/).
The code is [CircuitPython](https://circuitpython.org/). It follows many of the patterns I learned in creating an [aquarium controller](https://git.sr.ht/~travisshears/sewa-reef-controller).
## Capabilities
Right now the station is fairly limited measuring only temperature, humidity,
and atmospheric pressure. I have plans to expand the project to also measure
noise levels, and wind.
## Hardware
Sensors:
- [BME280](https://shop.pimoroni.com/products/bme280-breakout?variant=29420960677971)
MCs:
- [Raspberry Pi Pico](https://www.raspberrypi.com/products/raspberry-pi-pico/)
- [Adafruit Airlift](https://www.adafruit.com/product/4201)
Other:
- [Weatherproof Enclosure](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!_
## Images
Circuit board:
![project circuit board](https://travisshears.com/image-service/images/sourcehut/balcony-weather-station/circuit.jpg)
Home Assistant screen shot:
![home assistant screen shot](https://travisshears.com/image-service/images/sourcehut/balcony-weather-station/home_assistant.jpg)
Case:
![project weather proof case](https://travisshears.com/image-service/images/sourcehut/balcony-weather-station/case.jpg)
Power box:
![power case](https://travisshears.com/image-service/images/sourcehut/balcony-weather-station/power.jpg)