27 lines
1.4 KiB
Markdown
27 lines
1.4 KiB
Markdown
# 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 [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"
|
|
wifi_password: "YOUR_PASSWORD"
|
|
```
|
|
5. modify the yml file to your liking (optional)
|
|
6. Compile (Install, manual download) and download in modern format
|
|
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. |