Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/homieiot/homie-esp8266
💡 ESP8266 framework for Homie, a lightweight MQTT convention for the IoT
https://github.com/homieiot/homie-esp8266
arduino esp8266 framework home-automation homie iot mqtt
Last synced: 3 days ago
JSON representation
💡 ESP8266 framework for Homie, a lightweight MQTT convention for the IoT
- Host: GitHub
- URL: https://github.com/homieiot/homie-esp8266
- Owner: homieiot
- License: mit
- Created: 2015-12-13T14:22:17.000Z (about 9 years ago)
- Default Branch: develop
- Last Pushed: 2023-07-24T07:32:15.000Z (over 1 year ago)
- Last Synced: 2025-01-11T11:14:49.843Z (10 days ago)
- Topics: arduino, esp8266, framework, home-automation, homie, iot, mqtt
- Language: HTML
- Homepage: http://homieiot.github.io/homie-esp8266
- Size: 2.06 MB
- Stars: 1,364
- Watchers: 110
- Forks: 308
- Open Issues: 87
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://circleci.com/gh/homieiot/homie-esp8266) [](https://github.com/homieiot/homie-esp8266/releases) [](https://gitter.im/homie-iot/ESP8266) [](https://platformio.org/lib/show/555/Homie)
# Homie for ESP8266 / ESP32
An Arduino for ESP8266 / ESP32 implementation of [Homie](https://github.com/homieiot/convention), an MQTT convention for the IoT.
This branch of Homie for ESP8266 implements [Homie 3.0.1](https://github.com/homieiot/convention/releases/tag/v3.0.1) and adds support for ESP32.
[](https://homieiot.github.io/)
## Download
The Git repository contains the development version of Homie for ESP8266.
Stable releases are available [on the releases page](https://github.com/homieiot/homie-esp8266/releases).
## Using with PlatformIO
[PlatformIO](http://platformio.org) 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](http://platformio.org/platformio-ide)
2. Create new project using "PlatformIO Home > New Project"
3. Open [Project Configuration File `platformio.ini`](http://docs.platformio.org/page/projectconf.html)
### Stable version
4. Add "Homie" to project using `platformio.ini` and [lib_deps](http://docs.platformio.org/page/projectconf/section_env_library.html#lib-deps) option:
```ini
[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
4. Update dev/platform to staging version:
- [Instruction for Espressif 8266](http://docs.platformio.org/en/latest/platforms/espressif8266.html#using-arduino-framework-with-staging-version)
5. 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.
6. Add development version of "Homie" to project using `platformio.ini` and [lib_deps](http://docs.platformio.org/page/projectconf/section_env_library.html#lib-deps) option:
```ini
[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
```
-----
Happy coding with PlatformIO!
## Features
* Automatic connection/reconnection to Wi-Fi/MQTT
* [JSON configuration file](https://homieiot.github.io/homie-esp8266/docs/stable/configuration/json-configuration-file) to configure the device
* [Cute HTTP API / Web UI / App](https://homieiot.github.io/homie-esp8266/docs/stable/configuration/http-json-api) to remotely send the configuration to the device and get information about it
* [Custom settings](https://homieiot.github.io/homie-esp8266/docs/stable/advanced-usage/custom-settings)
* [OTA over MQTT](https://homieiot.github.io/homie-esp8266/docs/stable/others/ota-configuration-updates)
* [Magic bytes](https://homieiot.github.io/homie-esp8266/docs/stable/advanced-usage/magic-bytes)
* Available in the [PlatformIO registry](http://platformio.org/#!/lib/show/555/Homie)
* Pretty [straightforward sketches](./examples), a simple light for example: (**TODO**: adapt to V3)
```c++
#include
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:
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=JSGTYJPMNRC74)