Skip to content

Commit

Permalink
Add first draft of instructions (#11)
Browse files Browse the repository at this point in the history
  • Loading branch information
chl33 authored Oct 2, 2024
1 parent 1009735 commit c77359b
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ secrets*.ini
secrets*.yaml
.dir-locals.el
*.old
/box/plant1337.3mf
*.3mf
/KiCAD/Plant1337-backups/
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,3 +58,7 @@ This project is built using my C++ framework for ESP devices.
- [og3](https://github.com/chl33/og3) My application framework.
- [og3x-oled](https://github.com/chl33/og3x-oled) Support for the OLED screen I use with this project
- [og3x-shtc3](https://github.com/chl33/og3x-shtc3) Support for the SHTC3 temperature/humidty sensor used by this project.

## Setup

Please see the [instructions](instructions.md).
24 changes: 24 additions & 0 deletions instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Instructions

First, hang the EBox on the reservoir and position the plant and reservoir where you want them and in a place where you can power the device with the USB cable.

Then, for each plant to be watered:

1. Put a pump in the reservoir insert.
2. Connect a soil moisture sensor and pump to the EBox. The connectors should be in a vertical line under 1, 2, 3, or 4 on the EBox. The soil moisture sensor uses a 3-conductor wire with JST connectors.
3. Run a tube from the pump, through the hole in the insert, and then to the soil in the pot.
4. Cut the tube to the right length, and either:
- Push the end through the hole in the moisture sensor cap to position it for watering the soil, or
- Insert the end of the tube into a soil spike and then insert the soil spike into the soil.
5. Power the EBox with the USB micro cable.
6. Look for the name of the device, and connect your phone or computer to a WiFi network with that name.
7. Open a web browser to http://192.168.4.1, and accept the non-encrypted connection.
8. Use the web interface to configure the device to connect to your home's WiFi network.
9. Look for the IP address of the device on its screen to open its web interface again. If mDNS works in your home, you might be able to connect to it as "http://{device-name}.local" where "{device-name}" is replaced with the name of your device.
9. If you have an MQTT broker in your house, use the web interface to configure the connection to the broker. If you are running Home Assistant and it works with your MQTT broker, the device will automatically show up in Home Assistant.
10. In the device web interface, select the plant to be configured. Select the minimum and maximum soil moisture levels you want, and select the number of seconds you want the pump to run at each iteration of watering. Try 1 second for a small pot and 3 seconds for a medium-sized pot.
11. Enable watering, and enable reservoir water detection.
12. Fill the reservoir with water.
13. Monitor the plant-watering and tweak settings so it works the way you want it to.
14. You get bonus points for setting up Grafana and creating a dashboard to show how well the watering is working.
15. You can even more bonus points for using Home Assistant to send you a phone alert you when the reservoir is out of water.

0 comments on commit c77359b

Please sign in to comment.