# HomeAssistantEntities [![Test](https://github.com/Johboh/HomeAssistantEntities/actions/workflows/test.yaml/badge.svg)](https://github.com/Johboh/HomeAssistantEntities/actions/workflows/test.yaml) [![GitHub release](https://img.shields.io/github/release/Johboh/HomeAssistantEntities.svg)](https://github.com/Johboh/HomeAssistantEntities/releases) Arduino/ESP-IDF library for providing sensors and actuators to Home Assistant using MQTT. Home Assistant has a well defined way of defining sensors and actuators using MQTT. This library register a device with one or mulitple sensors and provide a way to publish new values for them, as well as listen for commands from Home Assistant. ### Currently supported sensors - Atmospheric Preassure (hPa) - Brightness (%) - Door (open/closed) - Humidity (%) - Json (raw "json"-sensor) - Lock (locked/unlocked) - Motion (detected/not detected) - Number - Sound (detected/not detected) - String (raw "String"-sensor) - Temperature (°C/°F) - Voltage (mV/V) - Weight (g/kg) ### Currently supported actuators (and sensors) - Curtain (open/opening, close/closing, position) - Event - Light (brightness, rgb, effect) - Select - Switch (on/off) ### Installation #### Platform I/O: Add the following to `libs_deps`: ``` Johboh/HomeAssistantEntities ``` #### ESP-IDF: In your existing `idf_component.yml` or in a new `idf_component.yml` next to your main component: ``` dependencies: johboh/HomeAssistantEntities ``` ### Examples See Examples for [sensors](examples/Sensors/Sensors.ino) as well as [actuators](examples/Actuators/Actuators.ino). ### Functionallity verified on the following platforms and frameworks - ESP32 (tested with platform I/O [espressif32@6.4.0](https://github.com/platformio/platform-espressif32) / [arduino-esp32@2.0.11](https://github.com/espressif/arduino-esp32) / [ESP-IDF@5.1.1](https://github.com/espressif/esp-idf) on ESP32-S2 and ESP32-C3) - ESP8266 (tested with platform I/O [espressif8266@4.2.1](https://github.com/platformio/platform-espressif8266) / [ardunio-core@3.1.2](https://github.com/esp8266/Arduino)) Newer version most probably work too, but they have not been verified. ### Dependencies - https://github.com/Johboh/MQTTRemote @^2.0.2 - _Note_: If you don't want to depend on [MQTTRemote](https://github.com/Johboh/MQTTRemote), you can copy the [IMQTTRemote](https://github.com/Johboh/MQTTRemote/blob/main/src/IMQTTRemote.h) interface from the MQTTRemote repo and implement/adapt/forward to your own MQTT implementation. This library only depend on the [IMQTTRemote](https://github.com/Johboh/MQTTRemote/blob/main/src/IMQTTRemote.h) interface. - https://github.com/bblanchon/ArduinoJson @^6.20.0 - Needs C++17 for `std::optional`. - For platform I/O in `platformio.ini`: ```C++ build_unflags=-std=gnu++11 # "Disable" C++11 build_flags=-std=gnu++17 # "Enable" C++17 ```
idf.py add-dependency "johboh/homeassistantentities^6.0.1"