To setup create a virtualenv, install the requirements, and run setup.py
virtualenv .venv
source .venv/bin/activate
pip install -U -r requirements.txt
python setup.py develop
Cross subsystem configurations are done in the main configuration file.
Option | Description | Required | Default |
---|---|---|---|
AWS | |||
access_key | AWS Access Key | YES | None |
secret_key | AWS Secret Key | YES | None |
Logging | |||
config_file | Path to logging config | YES | None |
The subsystems configuration is simply to enable or disable the different subsystems. Available subsystems are:
Each subsystem will have an enabled
flag that is either true
or false
Control the rPi camera.
Option | Description | Required | Default |
---|---|---|---|
directory | Local path to save files | YES | None |
remote | |||
type | remote system type | YES | None |
target | location on remote system | YES | None |
resolution | |||
x | horizontal resolution | YES | None |
y | vertical resolution | YES | None |
Control relays for irrigation systems
Option | Description | Required | Default |
---|---|---|---|
units | |||
name | user defined name | NO | None |
pin | GPIO pin | YES | None |
enabled | Is unit enabled? | NO | true |
runs | |||
start_time | Time of day for run | YES | None |
run_time | Length of run in seconds | YES | None |
zones | Zones included in run | YES | None |
Read environmental sensors
Option | Description | Required | Default |
---|---|---|---|
units | |||
name | user defined long name | NO | None |
pin | GPIO pin | YES | None |
enabled | Is sensor enabled? | NO | true |
type | Sensor model | YES | None |
Collect local weather data
WIP
Control HVAC system
WIP
Save various data to local or remote systems
WIP
Timelapsed is used for taking timelapse pictures...surprise, surprise. It offers a number of configuration options as listed below.
Timelapsed is configured through the camera configuration file linked above. All configuration options are under the timelapse
section.
Option | Description | Required | Default |
---|---|---|---|
enabled | Is timelapse enabled? | NO | true |
frequency | Picture interval(seconds) | NO | false |
prefix | Filename prefix | NO | None |
delete | Delete local file | NO | false |
hours | Hours of operation | NO | all |
Irrigationd controls sprinklers and other irrigation systems according to the configuration as defined in irrigation.yaml
Irrigationd is configured through the irrigation configuration file linked above.
The Bawt command line interface allows you to manually invoke the various subsystems.
root@mark-i:/home/pi/bawt# bawt --help
Usage: bawt [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
camera
file
hvac
irrigation
sensor
weather
The irrigation CLI is used to manually manipulate the irrigation subsystem.
root@mark-i:/home/pi/bawt# bawt irrigation --help
Usage: bawt irrigation [OPTIONS] ZONE
Options:
--state TEXT turn it on yo
--runtime TEXT Time of the run
--help Show this message and exit.
Manually take pictures.
root@mark-i:/home/pi/bawt# bawt irrigation --help
Usage: bawt irrigation [OPTIONS] ZONE
Options:
--state TEXT turn it on yo
--runtime TEXT Time of the run
--help Show this message and exit.
(.venv)root@mark-i:/home/pi/bawt# bawt camera --help
Usage: bawt camera [OPTIONS]
Options:
--name TEXT Name prefix for file
--target TEXT bucket name
--help Show this message and exit.