Code Monkey home page Code Monkey logo

esp32-homie's Introduction

esp32-homie

An esp-idf component for the Homie convention.

Goals

This is alpha-level software. Pull requests are welcome! Here is where we're at:

  • Conforms to 2.0.1 of the Homie specification
  • Publishes stats for wifi signal, freeheap, and uptime
  • OTA firmware updates
  • Support for extendible nodes/stats

Philosophy

I believe a minimalist library is a better fit for the ESP-IDF ecosystem rather than a framework. I don't plan to include a captive portal, nor an inversion of program control. The scope of this library will be to manage the MQTT connection using the Homie convention, handle OTA, and little else.

Dependencies

How to use

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

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

Example

https://github.com/craftmetrics/esp32-homie-example

OTA Updates

OTA works according to the following scheme:

  1. OTA must be enabled in the config passed to homie_init (it's off by default)
  2. The initiating entity publishes a message to ./$implementation/ota/url containing a URL to the new firmware
  3. If an error is encountered, the device publishes a message to ./$implementation/ota/status
  4. If it is successful, the device reboots into the new firmware

Remote Logging

When remote logging is enabled, all calls to ESP_LOG*() are published to ./log.

To enable remote logging, send true to ./$implementation/logging. To disable, send false.

Note that the default logger uses ANSI terminal colors in its log output, you may want to set CONFIG_LOG_COLORS=n in sdkconfig to disable this.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.