Skip to content

Latest commit

 

History

History
112 lines (73 loc) · 3.85 KB

README.md

File metadata and controls

112 lines (73 loc) · 3.85 KB
Raw

esp-homie

An ESP-IDF component for the Homie convention.

Build Status

Feature

  • Conforms to 4.x of the Homie specification
  • Publishes stats for wifi signal, freeheap, and uptime
  • OTA firmware updates
  • Reboot by MQTT command topic
  • Logging over MQTT
  • Support for extendable nodes
  • Support both ESP32 and ESP8266

Supported SDKs and versions

SDK name Version
ESP-IDF 3.x or newer
ESP8266 RTOS SDK master with the latest esp-mqtt

How to use

Clone this component to ESP-IDF project (as submodule):

git submodule add https://github.com/craftmetrics/esp-homie.git components/esp-homie

Example

Examples are under examples directory.

Required variables in sdkconfig

Some non-default variables must be set in sdkconfig.

For esp-idf version 4.x, or master, see sdkconfig.defaults and sdkconfig.defaults.esp32.

For esp-idf version 3.x, see sdkconfig.defaults.esp32_v3.

For ESP8266 RTOS SDK, see sdkconfig.defaults.esp8266.

OTA Updates

The OTA routine is based on native_ota_example without logic change.

Note that sdkconfig should have necessary variables set, such as CONFIG_PARTITION_TABLE_TWO_OTA in esp-idf 4.x, etc). For more details, see Over The Air Updates (OTA).

For more details, see examples/system/ota in your branch of esp-idf at https://github.com/espressif/esp-idf/.

esp-idf version 3.x

  • Download a firmware at the location specified in http_config
  • If the version of the firmware is different from the version of the running firmware, start the OTA

esp-idf version 4.x

  • Download a firmware at the location specified in http_config
  • If the running firmware version is older than the new firmware, start the OTA.

Firmware version can be set in version.txt at the root directory of your project. See "App version" section in "Miscellaneous System APIs".

Accepted version string must be in the form of Semantic Versioning 2.0.0.

ESP8266 RTOS SDK

  • Download a firmware at the location specified in http_config
  • Start the OTA

KNOWN BUGS

Command topics, such as ota and reboot, are not properly rendered in PAPER UI of OpenHAB2 version 2.5.0~M6-1.

Although ESP-IDF 3.x is supported, the example is not tested in the testing environment.

When the SDK is ESP8266 RTOS SDK, logging over MQTT is not supported.

When the SDK is ESP8266 RTOS SDK, esp-mqtt must be used instead of bundled one in the SDK because the bundled version is broken.

License

All code is licensed under MIT license except:

The library includes the following third-party libraries:

  • semver.c (MIT license, Copyright (c) Tomás Aparicio)