ArduinoHA documentation

ArduinoHA allows to integrate an Arduino/ESP based device with Home Assistant using MQTT. The library is designed to use as low resources (RAM/flash) as possible. Initially, it was optimized to work on Arduino Uno with Ethernet Shield, but I successfully use it on ESP8266/ESP8255 boards in my projects.

Features

• Two-way communication (state reporting and command execution)

• MQTT discovery (device is added to the Home Assistant panel automatically)

• MQTT Last Will and Testament

• Support for custom MQTT messages (publishing and subscribing)

• Auto reconnect with MQTT broker

• Reporting availability (online/offline states) of a device

• Doxygen documentation

• Covered by unit tests (AUnit + EpoxyDuino + AUniter)

Docs

• Getting started
  • Prerequisites
  • Installation
    • Arduino IDE
    • makeEspArduino
  • Compatible Hardware
  • Examples
• Library
  • Introduction
    • Arduino Boilerplate
    • ESP32/ESP8266 Boilerplate
  • Device configuration
    • Unique ID
    • Device properties
  • Availability reporting
    • Shared availability
    • MQTT LWT
    • Device type’s availability
  • Connection parameters
  • Discovery
    • Topics prefix
  • Device types (entities)
    • Identifiers
    • Limitations
    • Supported device types
  • MQTT security
  • MQTT advanced features
    • Callbacks
    • Subscriptions
    • Publishing a message
  • Compiler macros
    • Debug mode
    • Code optimization
• API reference
  • Core API
    • HADevice class
    • HAMqtt class
  • Device types API
    • HABaseDeviceType class
    • HABinarySensor class
    • HAButton class
    • HACamera class
    • HACover class
    • HADeviceTracker class
    • HADeviceTrigger class
    • HAFan class
    • HAHVAC class
    • HALight class
    • HALock class
    • HANumber class
    • HAScene class
    • HASelect class
    • HASensor class
    • HASensorNumber class
    • HASwitch class
    • HATagScanner class
  • Utils API
    • HANumeric class
    • HASerializer class
    • HASerializerArray class
    • HAUtils class
• Sponsor