Awesome

*** THIS IS THE DEVELOPMENT BRANCH FOR Version 3.x.y ***

See https://github.com/homieiot/homie-esp8266 for current 2.0.y releases

Homie for ESP8266 / ESP32

An Arduino for ESP8266 / ESP32 implementation of Homie, an MQTT convention for the IoT.

This branch of Homie for ESP8266 implements Homie 3.0.1 and adds support for ESP32.

Download

The Git repository contains the development version of Homie for ESP8266. Stable releases are available on the releases page.

Note that there is no release of the 3.x.y branch yet. Please use the git repository if you are interested in latest development.

Using with PlatformIO

PlatformIO is an open source ecosystem for IoT development with cross platform build system, library manager and full support for Espressif ESP8266 development. It works on the popular host OS: Mac OS X, Windows, Linux 32/64, Linux ARM (like Raspberry Pi, BeagleBone, CubieBoard).

Install PlatformIO IDE
Create new project using "PlatformIO Home > New Project"
Open Project Configuration File platformio.ini

Stable version

Add "Homie" to project using platformio.ini and lib_deps option:

[env:myboard]
platform = espressif8266
board = ...
framework = arduino
build_flags = -D PIO_FRAMEWORK_ARDUINO_LWIP2_LOW_MEMORY
lib_deps = Homie

Add the PIO_FRAMEWORK_ARDUINO_LWIP2_LOW_MEMORY build flag to ensure reliable OTA updates.

Development version

Update dev/platform to staging version:
- Instruction for Espressif 8266
Before editing platformio.ini as shown below, you must install "git" if you don't already have it. For Windows, just go to http://git-scm.com/download/win and the download will start automatically. Note, this is only a requirement for the development versions.
Add development version of "Homie" to project using platformio.ini and lib_deps option:

[env:myboard]
platform = ...
board = ...
framework = arduino
build_flags = -D PIO_FRAMEWORK_ARDUINO_LWIP2_LOW_MEMORY

; the latest development branch (convention V3.0.x) 
lib_deps = https://github.com/homieiot/homie-esp8266.git#develop-v3

Happy coding with PlatformIO!

Features

Automatic connection/reconnection to Wi-Fi/MQTT
JSON configuration file to configure the device
Cute HTTP API / Web UI / App to remotely send the configuration to the device and get information about it
Custom settings
OTA over MQTT
Magic bytes
Available in the PlatformIO registry Please note that this is the latest release from V2 branch - see above how to use latest v3 version with platformio.
Pretty straightforward sketches, a simple light for example: (TODO: adapt to V3)

#include <Homie.h>

const int PIN_RELAY = 5;

HomieNode lightNode("light", "Light", "switch");

bool lightOnHandler(const HomieRange& range, const String& value) {
  if (value != "true" && value != "false") return false;

  bool on = (value == "true");
  digitalWrite(PIN_RELAY, on ? HIGH : LOW);
  lightNode.setProperty("on").send(value);
  Homie.getLogger() << "Light is " << (on ? "on" : "off") << endl;

  return true;
}

void setup() {
  Serial.begin(115200);
  Serial << endl << endl;
  pinMode(PIN_RELAY, OUTPUT);
  digitalWrite(PIN_RELAY, LOW);

  Homie_setFirmware("awesome-relay", "1.0.0");

  lightNode.advertise("on", "On", "boolean").settable(lightOnHandler);

  Homie.setup();
}

void loop() {
  Homie.loop();
}

Requirements, installation and usage

The project is documented on https://homieiot.github.io/homie-esp8266/ with a Getting started guide and every piece of information you will need.

Donate

I am a student and maintaining Homie for ESP8266 takes time. I am not in need and I will continue to maintain this project as much as I can even without donations. Consider this as a way to tip the project if you like it. :wink: