Mirrors/grow-python
1
0
Fork 0
mirror of https://github.com/pimoroni/grow-python synced 2025-10-25 15:19:23 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Tweaks, fixes, linting and docs

Browse Source
This commit is contained in:
Phil Howard
2020-08-27 12:26:08 +01:00
parent de90e2289c
commit 3123e27939
14 changed files with 229 additions and 217 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
examples/README.md
View File

@@ -1,8 +1,35 @@
# Watering Settings
# Monitoring and/or Watering Your Plants
The `grow-monitor-and-water.py` example can monitor and, optionally, automatically water all three Grow channels.
It's configured using a settings file - `water.yml` - that looks like the following:
By default auto-watering is disabled and an alarm will sound every 1s if the `warn_level` is reached.
Run it with `python3 grow-monitor-and-water.py`.
## Monitoring
Grow can monitor the moisture level of your soil, sounding an alarm when it dries out.
Grow is configured using `settings.yml`. Your settings for monitoring only will look something like this:
```yaml
channel1:
warn_level: 0.2
icon: icons/flat-4.png
channel2:
warn_level: 0.2
channel3:
warn_level: 0.2
general:
alarm_enable: True
alarm_interval: 1.0
```
## Watering
If you've got pumps attached to Grow and want to automatically water your plants, you'll need some extra configuration options.
See [Channel Settings](#channel-settings) and [General Settings](#general-settings) for more information on what these do.
```yaml
channel1:
@@ -29,10 +56,10 @@ general:
alarm_interval: 1.0
```
By default auto-watering is disabled and an alarm will sound every 1s if the `warn_level` is reached.
## Channel Settings
Grow has three channels which are separated into the sections `channel1`, `channel2` and `channel3`, each of these sections has the following configuration options:
* `water_level` - The level at which auto-watering should be triggered (soil saturation from 0.0 to 1.0)
* `warn_level` - The level at which the alarm should be triggered (soil saturation from 0.0 to 1.0)
* `pump_speed` - The speed at which the pump should be run (from 0.0 low speed to 1.0 full speed)
@@ -42,5 +69,7 @@ By default auto-watering is disabled and an alarm will sound every 1s if the `wa
## General Settings
An additional `general` section can be used for global settings:
* `alarm_enable` - Whether to enable the alarm
* `alarm_interval` - The interval at which the alarm should beep (in seconds)