plant-badger/README.md

31 lines
776 B
Markdown
Raw Normal View History

2023-03-10 20:39:58 +01:00
# Plant Badger
Application for Pimoroni Badger 2040 W. Connects to Home Assistant to fetch
a plant's status and displays it on the Badger.
2023-03-10 12:18:34 +01:00
## Install dependencies
If you only manage this project from a shell, then you only need these dependencies.
```shell
pip install -r requirements.txt
```
When running with PyCharm, instead use `requirements-pycharm.txt`:
```shell
pip install -r requirements-pycharm.txt
```
This will install dependencies required by PyCharm to run its MicroPython tools.
2023-03-10 14:17:30 +01:00
## Invoke tasks
2023-03-10 12:18:34 +01:00
```shell
2023-03-10 14:17:30 +01:00
invoke --list
# Start by getting your board id
inv list
# Then wipe the board
inv wipe <board_id>
# Then run the initial setup
inv initial-setup <board_id>
# After that, just update the code when changes are made locally
inv update-code <board_id>
2023-03-10 12:18:34 +01:00
```