Cleanup documentation, examples and repo

This commit is contained in:
2026-05-11 18:22:24 +02:00
parent 018555268a
commit 5936fbf9ae
9 changed files with 160 additions and 603 deletions
Binary file not shown.

After

Width:  |  Height:  |  Size: 446 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.2 MiB

-7
View File
@@ -1,7 +0,0 @@
# ESPHome Button+ Integration
*work in progress*
## Introduction
TODO
+14 -1
View File
@@ -1,7 +1,7 @@
# Getting Started
In order to get started with a 3 bar module, you should
1. Make sure you have [ESPHome](https://esphome.io) installed
2. Copy the file [3pages_TotalExample.yml](/examples/3pages_TotalExample.yml) to the root of the repository
2. Copy the file [3BAR_1Display.yml](/Examples/3BAR_1Display.yml) to the root of the repository
3. Create a file secrets.yaml and add the following
```
wifi_ssid: "YOUR_SSID"
@@ -12,3 +12,16 @@ wifi_password: "YOUR_PASSWORD"
7. Connect the B+ to your computer
8. Open a compatible browser such as Chrome and visit https://web.esphome.io
9. Load the downloaded file to your device and enjoy
# Generating different events / pages
If you want a different number of pages, and you want the matching events, you can generate a new [3bar_1display_events.yaml](/package/3bar_1display_events.yaml) file using python.
The python file is called [generate_events.py](/generate/generate_events.py). The top of the file has three configuration options:
```python
NR_OF_PAGES = 3
INCLUDE_DISPLAY_EXTRA = True # Enable Double, Triple, Hold for main display buttons
LED_CONFIRMATION = True # Flash LED on press
```
Set these to your preferred config before running. Then run `python generate_events.py`. Copy the output file to the package folder, and use that package in your main config. Make sure the number of pages in your main config and the generated file are the same.