search

JeffLabonte / garden-gateway

Gateway that controls multiple sensors and devices to automate your home gardening
GNU General Public License v3.0
1 stars 1 forks source link

Documentation #1

Open JeffLabonte opened 2 years ago

JeffLabonte commented 2 years ago

Documentation is cruelly missing!

LuluNwenyi commented 2 years ago

Hi @JeffLabonte, I would love to work on some documentation for this project. Probably starting with the basics (readme and contributing guidelines). However, I'd need to know more about this project.

JeffLabonte commented 2 years ago

@LuluNwenyi Thank you for your interest in my project.

I want to document how I built my setup to make this repository reproducible by someone else.

JeffLabonte commented 2 years ago

@LuluNwenyi

Sorry, I got really busy in the past months. If you are still interested to contribute to this project you are more than welcome to do so.

This project is for the gateway that will take care of a garden. So I have multiple sensors that I will integrate to a RPI 4 ( I am planning in the future to support other boards if requested). At the moment, I have a relay power bar (I left a link to Amazon in the README.md) that turns on and off a growth lamp in my plant room. I bought a water pump and a few other components to be able to turn off and on the water pump to water my vegetables. I have a water detector that I still need to integrate so I can detect water in the plate under my plant’s pot. The water detector will be the trigger for the water pump to know when to water. If there is water in the plate, the water pump is turned off, if there is no water in the plate, then the water is turned on.

Overall, as you can read, this project is about growing food with as little effort as possible. I want to make it available to everyone so I will add plans and documentation on how to build those devices. Perhaps I will make videos in the future!

Let me know if you have any questions!

LuluNwenyi commented 2 years ago

Hi @JeffLabonte, yes I'd love to still work on this. I'd try to read up a bit and let you know where i'd start from. I'd also like to know what kind of documentation you think we should prepare.

JeffLabonte commented 2 years ago

What I can see right now is the contribution guidelines. It will be to respect each other and keep your mind open, open a PR from your fork and ask for review by me (for now). I want to put in place a Wiki with how to setup your RPI for those that are not familiar with the process. We can add links to other documentation on how to setup yourself. I wanted a section to give tutorial on how to plug your sensors, where to buy them, and what configurations are required to make it work.

I will keep thinking about what other kind of documentation that might be useful and would have value to prepare! Thank you! 😄