From df3218938321d720bd7c369519c18da0134760cb Mon Sep 17 00:00:00 2001 From: Aljaz Ogrin Date: Fri, 30 Aug 2024 20:49:44 +0200 Subject: [PATCH] Added authors and HA details into Readme. --- EleksTubeHAX_pio/README.md | 3 --- README.md | 10 ++++++++++ 2 files changed, 10 insertions(+), 3 deletions(-) delete mode 100644 EleksTubeHAX_pio/README.md diff --git a/EleksTubeHAX_pio/README.md b/EleksTubeHAX_pio/README.md deleted file mode 100644 index c53d627..0000000 --- a/EleksTubeHAX_pio/README.md +++ /dev/null @@ -1,3 +0,0 @@ -Things that are special in PlatformIO -and must be taken care of: -- (currently none) \ No newline at end of file diff --git a/README.md b/README.md index c0cac7d..a3bfe49 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,15 @@ Firmware supports and was tested on different clock versions. Note that "EleksTu - Supported effect's speed change for backlight - All options are discoverable via Home Assistant MQTT +Detailed description: +Interaction with Home Assistant occurs according to the MQTT integration documentation: +https://www.home-assistant.io/integrations/light.mqtt/ +https://www.home-assistant.io/integrations/switch.mqtt/ +https://www.home-assistant.io/integrations/number.mqtt/ +https://www.home-assistant.io/integrations/mqtt/#mqtt-discovery +It is preferable (but not mandatory) to use MQTT Discovery (#define MQTT_HOME_ASSISTANT_DISCOVERY), in which case the device and all entities will be found by the MQTT integration without user intervention. Otherwise, all settings will need to be done manually. +#define MQTT_CLIENT is used as a unique device name (i.e. it should be different if you have several IPS clocks) and is the "root" part of the topic for all entities that will be interacted with via MQTT. Further analysis is easier to perform using, for example, "MQTT Explorer", a common add-on for users who prefer manual configuration. + # How to use this firmware If you just want to use new firmware without setting up all the tools and libraries and everything, navigate to folder `\pre-built-firmware\` and modify `_ESP32 write flash.cmd` to upload selected version to your clock. If you want more features, continue reading below. @@ -171,6 +180,7 @@ Hardware pinout and notes are in the document `Hardware pinout.xlsx` - Mark Smith, aka Smitty ... @SmittyHalibut on GitHub, Twitter, and YouTube. - Aljaz Ogrin, aka aly-fly ... @aly-fly on GitHub and Instagram - Misc code snips either commited by or copied from: @icebreaker-ch, @meddle99, @OggyP, @bitrot-alpha +- Home Assistant support by @victorvuelma and @gamba69 - in future (on to-do list) also from: @RedNax67, @wfdudley, @judge2005 *Happy hacking!*