💡 ESP8266 framework for Homie, a lightweight MQTT convention for the IoT
HTML C++ Python Other
Clone or download

README.md

homie-esp8266 banner

Homie for ESP8266

Build Status Latest Release Gitter

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

Currently Homie for ESP8266 implements Homie 2.0.1

Note for v1.x users

The old configurator is not available online anymore. You can download it here.

Download

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

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).

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

Stable version

  1. Add "Homie" to project using platformio.ini and lib_deps option:
[env:myboard]
platform = espressif8266
board = ...
framework = arduino
lib_deps = Homie

Development version

  1. Update dev/platform to staging version:
  2. Add development version of "Homie" to project using platformio.ini and lib_deps option:
[env:myboard]
platform = ...
board = ...
framework = arduino

; the latest development branch
lib_deps = https://github.com/marvinroger/homie-esp8266.git

; or tagged version
lib_deps = https://github.com/marvinroger/homie-esp8266.git#v2.0.0-beta.2

Happy coding with PlatformIO!

Features

#include <Homie.h>

const int PIN_RELAY = 5;

HomieNode lightNode("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").settable(lightOnHandler);

  Homie.setup();
}

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

Requirements, installation and usage

The project is documented on http://marvinroger.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. 😉

Donate button