kennyboy55/buttonplus-esphome-generator
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add some more info to README

Browse Source
This commit is contained in:
kennyboy55
2026-05-19 13:30:11 +02:00
parent 9be0b12085
commit 38d10934c8
1 changed files with 19 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+19 -4
View File
@@ -3,18 +3,33 @@
A python script that generates a full ESPHome config for the Button+ V2 A python script that generates a full ESPHome config for the Button+ V2
## Features ## Features
- Notification Service - Notification Action: `esphome.<name>_notification`
- And toasts! - Shows a notification, which has to be dismissed
- Generate pages and all buttons and events belonging to each page - Toast Action: `esphome.<name>_toast`
- Shows a quick toast message which dissapears after a timeout
- Perfect for confirming actions
- Get info Action: `esphome.<name>_get_page_info`
- Shows data needed for the set_page_led action
- Set Led per page Action: `esphome.<name>_set_page_led`
- Allows you to set the LED for a specific page
- So that you don't need to keep track of which page is active when setting a LED
- Generates pages and all buttons and events belonging to each page
- Breathe and Blink effect for all LEDs
- more to come..
## Setup ## Setup
### Project uses pipenv ### Project uses pipenv (Optional)
run `pipenv install` to setup the project the first time. run `pipenv install` to setup the project the first time.
run `pipenv shell` after that to open the virtual environment. run `pipenv shell` after that to open the virtual environment.
## Run script
You can then use `python src/main.py --help` to run the generator You can then use `python src/main.py --help` to run the generator
### Example run command
`python src/main.py -v 1 -b 3 -p Start Music Lights Security -c single double hold`
## Config example ## Config example
The configuration (handmade) on which this generator is based, can be found in the `esphome` folder. The configuration (handmade) on which this generator is based, can be found in the `esphome` folder.