elbowz / yahnc

Yet Another Homie Node Collection

YAHNC

Yet Another Homie Node Collection

Libs utility framework to build your Homie nodes

About The Project

YAHNC libs is born (and maybe will dead) as University project. It can be used as development base (ie utility/framework) on which build new sensors and/or actuator following the amazing Homie for ESP8266/ESP32 philosophy.

Getting Started

YAHNC can be used with PlatformIO.

Installation

1. Add this repository to your lib_deps in platformio.ini:

lib_deps = https://github.com/elbowz/yahnc.git#master, ...

2. include the libraries you need in your code:

#include <BME280Node.hpp>
#include <SwitchNode.hpp>
#include <BinarySensorNode.hpp>
#include <ButtonNode.hpp>

Usage

There is no documentation at this time. So you can view:

• the commented examples
• the class diagram
• and of course the src folder.

Examples

Some didactic examples to better understand how to use it:

• THUMBL-P - Temperature HUmidity Motion Buzzer Light - Pressure (full device)
• SWECS - Switch External Control & State (full device)
• BME280Node - Sensor node class for the BME280. Describe 3 different ways to aggregate multiple sensors in a node. (used in THUMBL-P)

Class Diagram

License

Distributed under the MIT License. See LICENSE for more information.

Credits

• Homie for ESP8266 / ESP32
• Homie Node Collection
• Adafruit BME280 Library
• BME280 - Heat index calculation