Skip to content

Commit

Permalink
Added authors and HA details into Readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
aly-fly committed Aug 30, 2024
1 parent 8afb027 commit df32189
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
3 changes: 0 additions & 3 deletions EleksTubeHAX_pio/README.md

This file was deleted.

10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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!*
Expand Down

0 comments on commit df32189

Please sign in to comment.