mirror of
https://github.com/pimoroni/grow-python
synced 2025-10-25 15:19:23 +00:00
Prep for v0.0.1
This commit is contained in:
63
library/README.md
Normal file
63
library/README.md
Normal file
@@ -0,0 +1,63 @@
|
||||
# Grow HAT Mini
|
||||
|
||||
Designed as a tiny valet for your plants, Grow HAT mini will monitor the soil moiture for up to 3 plants, water them with tiny pumps, and show you their health on its small but informative screen. Learn more - https://shop.pimoroni.com/products/grow
|
||||
|
||||
[](https://travis-ci.com/pimoroni/grow-python)
|
||||
[](https://coveralls.io/github/pimoroni/grow-python?branch=master)
|
||||
[](https://pypi.python.org/pypi/growhat)
|
||||
[](https://pypi.python.org/pypi/growhat)
|
||||
|
||||
# Installing
|
||||
|
||||
You're best using the "One-line" install method.
|
||||
|
||||
## One-line (Installs from GitHub)
|
||||
|
||||
```
|
||||
curl -sSL https://get.pimoroni.com/grow | bash
|
||||
```
|
||||
|
||||
**Note** report issues with one-line installer here: https://github.com/pimoroni/get
|
||||
|
||||
## Or... Install and configure dependencies from GitHub:
|
||||
|
||||
* `git clone https://github.com/pimoroni/grow-python`
|
||||
* `cd grow-python`
|
||||
* `sudo ./install.sh`
|
||||
|
||||
**Note** Raspbian Lite users may first need to install git: `sudo apt install git`
|
||||
|
||||
## Or... Install from PyPi and configure manually:
|
||||
|
||||
* Install dependencies:
|
||||
|
||||
```
|
||||
sudo apt install python3-setuptools python3-pip python3-yaml python3-smbus python3-pil python3-spidev python3-rpi.gpio
|
||||
```
|
||||
|
||||
* Run `sudo pip3 install growhat`
|
||||
|
||||
**Note** this wont perform any of the required configuration changes on your Pi, you may additionally need to:
|
||||
|
||||
* Enable i2c: `sudo raspi-config nonint do_i2c 0`
|
||||
* Enable SPI: `sudo raspi-config nonint do_spi 0`
|
||||
* Add the following to `/boot/config.txt`: `dtoverlay=spi0-cs,cs0_pin=14`
|
||||
|
||||
## Monitoring
|
||||
|
||||
You should read the following to get up and running with our monitoring script:
|
||||
|
||||
* [Using and configuring monitor.py](examples/README.md)
|
||||
* [Setting up monitor.py as a service](service/README.md)
|
||||
|
||||
## Help & Support
|
||||
|
||||
* GPIO Pinout - https://pinout.xyz/pinout/grow_hat_mini
|
||||
* Support forums - http://forums.pimoroni.com/c/support
|
||||
* Discord - https://discord.gg/hr93ByC
|
||||
|
||||
# Changelog
|
||||
0.0.1
|
||||
-----
|
||||
|
||||
* Initial Release
|
||||
Reference in New Issue
Block a user