diff --git a/README.md b/README.md index 3bd3ea6..2368104 100644 --- a/README.md +++ b/README.md @@ -3,18 +3,33 @@ A python script that generates a full ESPHome config for the Button+ V2 ## Features -- Notification Service - - And toasts! -- Generate pages and all buttons and events belonging to each page +- Notification Action: `esphome._notification` + - Shows a notification, which has to be dismissed +- Toast Action: `esphome._toast` + - Shows a quick toast message which dissapears after a timeout + - Perfect for confirming actions +- Get info Action: `esphome._get_page_info` + - Shows data needed for the set_page_led action +- Set Led per page Action: `esphome._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 -### Project uses pipenv +### Project uses pipenv (Optional) run `pipenv install` to setup the project the first time. 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 +### Example run command +`python src/main.py -v 1 -b 3 -p Start Music Lights Security -c single double hold` + ## Config example The configuration (handmade) on which this generator is based, can be found in the `esphome` folder.