Updated documentation

This commit is contained in:
Martijn
2024-12-27 19:59:31 +01:00
parent 8f460f5cb9
commit 11a0ef1ff0
3 changed files with 32 additions and 3 deletions
+30 -2
View File
@@ -2,6 +2,34 @@
*work in progress*
## Introduction
## Initial firmware load
TODO
### Required
- Button+ Base Module
- 1x Button+ Main Display
- 1x Button+ BAR module
- USB-C cable
- ESPHome installed on Home-Assistant
- [Getting started guide by @balk77](./GettingStarted.md)
- [Official ESPhome guide](https://esphome.io/guides/getting_started_hassio.html)
- Chrome/Edge or a [WebSerial compatible Browser](https://webserial.io/)
### Steps
1. Go to ESPHome in Home Assistant.
2. Click on the bottom right on "Add Device"
3. Click "Continue"
4. Give the device a name you can remember (e.g. "Button+ Kitchen") and click "Next"
5. Click "Skip This Step"
6. Select the "ESP32-S3"
7. Click "Skip"
8. On the ESPHome main screen find the device you've just created, on the device card click "Edit"
9. Find in the links below the initial script for your setup. Copy
- [1 BAR 1 Display](../Examples/1BAR_1Display_Basic.yaml)
- [2 BAR 1 Display](../Examples/2BAR_1Display_Basic.yaml)
- [3 BAR 1 Display](../Examples/3BAR_1Display_Basic.yaml)
10. Klik rechts boven in op "Save" en vervolgens op "Install"
11. Kies "Plug into this computer" en volg de instructies. Als je Firefox gebruikt kun je ook "Manual Download" kiezen en de image met ESP tool laden
Na de initiële upload met USB kun je de Button+ met de Wireless optie laden.
@@ -1,4 +1,5 @@
# 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
+1 -1
View File
@@ -42,6 +42,6 @@ The documentaion is yet to be made... Again If you want to help... Pull requests
- [x] figure out how to control them individually. [> maybe with Light Partition](https://esphome.io/components/light/partition)
- [x] find correct [type](https://esphome.io/components/light/neopixelbus.html#configuration-variables)
- [x] Temperature sensor STS35
- [ ] Make a basic [package](https://esphome.io/components/packages.html) so there is less initial code to be copied.
- [x] Make a basic [package](https://esphome.io/components/packages.html) so there is less initial code to be copied.
- [ ] Documentation
- [ ] More examples