Metadata-Version: 2.1
Name: potnanny
Version: 0.4.3
Summary: Potnanny grow room automation controller.
Home-page: https://github.com/potnanny/application
Author: J Leary
Author-email: potnanny@gmail.com
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: greenlet
Requires-Dist: bleak
Requires-Dist: aio-databases[aiosqlite]
Requires-Dist: peewee-aio
Requires-Dist: quart
Requires-Dist: quart-auth
Requires-Dist: quart-wtforms
Requires-Dist: pyyaml
Requires-Dist: gpiozero
Requires-Dist: marshmallow
Requires-Dist: pyyaml
Requires-Dist: python-daemon
Requires-Dist: markupsafe

# Potnanny
*"Plant care when you're not there!"*

Potnanny turns your Raspberry Pi into powerful grow-room automation system
using inexpensive, off-the-shelf Bluetooth sensors, power outlets, and other devices.

## Description
Potnanny provides a simple dashboard for monitoring your grow environment.

<img src="/docs/screenshots/dashboard.png" width="400">

Clicking on any of the dashboard values will show graph trends.

<img src="/docs/screenshots/graph.png" width="400">

## Smart Controls
Beyond basic monitoring, Potnanny also makes it possible to configure Schedules and Measurment Controls of the bluetooth power outlets.

A Measurement Control is like saying "When the humidity reading of a sensor is over 65%, turn the dehumidifier outlet on".

Potnanny's Measurement Controls:
- Turn simple devices (humidifiers, fans, etc) into *smart* devices.
- Saves energy. Turning fans and dehumidifiers on only when actually needed reduces energy consumption.
- Automate your irrigation, ventilation, and temperature controls to maintain the ideal growing environment.

## Reliable
Potnanny does not rely on WiFi or cloud-connectivity. So even if your home internet goes down, Potnanny will continue working to maintain your environment. Once your Potnanny system is configured the way you want, it is very much a *set it and forget it* system. It is not fancy. It just does what you want.

## Supported Bluetooth Devices
This list includes only hygrometers, soil sensors, and power outlets that we have tested and found to have good stable communication.

- Govee H5080 Bluetooth Outlet
- Govee H5082 Bluetooth Dual Outlet
- Smartbot PLUS Bluetooth Hygrometer
- Smartbot Bluetooth Hygrometer
- Xiaomi Mi Bluetooth Soil Sensor
- Xiaomi Mi MJHT Bluetooth Hygrometer

We are constantly looking out for new bluetooth devices that would be useful to home growers, and writing new plugins. So this list will grow in the future.

## Expandable Plugin System
All communication to bluetooth and GPIO devices is based on plugins.
You are free to write and install your own plugins, in order to communicate with new devices.
See the Plugin Documentation for more.

## Hardware Requirements
Potnanny was written specifically targeting the low-priced Raspberry Pi Zero W.

<img src="/docs/screenshots/rpizerow.png" width="300">

But it will work on most models with integrated WiFi and Bluetooth.
- Raspberry Pi Zero W
- Raspberry Pi Zero W2
- Raspberry Pi 3 B+
- Raspberry Pi 4

## OS Requirements
32-bit Raspberry Pi OS "Bookworm" (Debian 12.0) is the minimum recommended OS.
64-bit versions will not work on the original Raspberry Pi Zero W

## Python Requirements
Python 3.11 is the minimum requirement (included with Raspberry Pi OS Bookworm version)

## Installation
```
pip install potnanny
```

## Startup
```
potnanny start
```

## Login
Using a web browser, connect to "https://potnanny.local"
The initial login/password is set to "admin/potnanny!". Please secure your system and reset the password as soon as you log in for the first time.
