From d751985bc576feef27e547c7e073be38eb8e074d Mon Sep 17 00:00:00 2001 From: Martijn Date: Fri, 25 Oct 2024 14:07:54 +0200 Subject: [PATCH] Update README.md --- README.md | 34 +++++++++++++++++++++++++--------- 1 file changed, 25 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 62d6ca5..8b3f405 100644 --- a/README.md +++ b/README.md @@ -2,17 +2,33 @@ *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). +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 the Button+ on there [website](https://button.plus).__ this is also the place to find the original firmware, in case you want to revert back. + +To make the Button+ work with ESPHome we needed at least a list of used components and a pinout/IO-list. I spend a couple of evenings with my multimeterm, making my wife crazy with the beeps, googled and collected data sheets of the components, broke a the display of 1 BAR module and did a trail-on-error to make stuf work with ESPHome. Here in this repo you'll find the [results](./Components) of my journy. + +The ESPHome integration adds more flexebility and features, but also add some more complexity. To minimize the complexity I started this repo to collect examples and improve my work. + +> Want to help? Pull requests are welcome! + +## Usefull Links + +* Display Items: https://esphome.io/components/display/ +* Fonts: https://esphome.io/components/font#display-fonts +* Icon's and images: https://esphome.io/components/image#display-image + +## Documentation + +The documentaion of the Button+ ESPHome integration can befound in the [Docs directory](./Docs) + +## Status + +All the features, i the Buton+ has to offer should work with the [`basic_example.yaml`](./Examples/basic_example.yaml). Please reffer the ESPHome documentaion for more information on how to build your own menu or ... (?) + +The documentaion is yet to be made... Again If you want to help... Pull requests are welcome! ## TODO: