From 759c71eea4c51015e1e915b31c10c4dfe4fc6c5e Mon Sep 17 00:00:00 2001 From: Martijn Date: Thu, 24 Oct 2024 10:27:06 +0200 Subject: [PATCH] Improved readme --- README.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 41f22e5..bb03640 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,24 @@ # ESPhome_ButtonPlus -For now, the diplays and the buttons are working. See the examples folder for the first example. Please reffer the ESPHome documentaion for more information on how to build your own menu or ... (?) +__ESPHome documentation and examples to make ESPHome working on the Button+__ + +## Status + +For now, the diplays, the neopixel LED's and the buttons are working. See the examples folder for the first example. Please reffer the ESPHome documentaion for more information on how to build your own menu or ... (?) > https://esphome.io/components/display/ > https://esphome.io/components/font#display-fonts Want to help? Pull requests are welcome! +## Button+ + +The Button+ is a modular control panel designed to work with MQTT. It has a "Main display" and "BAR modules" where the position and amount can be changed according your needs. You can order it on there [website](https://button.plus). + ## TODO: -- [ ] Neonleds - - [ ] figure out how to control them individually. [> maybe with Light Partition](https://esphome.io/components/light/partition) - - [ ] find correct [type](https://esphome.io/components/light/neopixelbus.html#configuration-variables) +- [x] Neonleds + - [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) +- [ ] Temperature sensor STS35 - [ ] Documentation - [ ] More examples