Code Monkey home page Code Monkey logo

arduino-home-assistant's Introduction

Arduino Home Assistant integration

ArduinoHA allows to integrate an Arduino/ESP based device with Home Assistant using MQTT. The library is designed to use as little resources (RAM/flash) as possible. Initially it was optimized to work on Arduino Uno with Ethernet Shield, but I successfully use it on ESP8266/ESP8255 boards in my projects.

Features

  • MQTT discovery (device is added to the Home Assistant panel automatically)
  • MQTT Last Will and Testament
  • Support for custom MQTT messages (publishing and subscribing)
  • Auto reconnect with MQTT broker
  • Reporting availability (online/offline states) of a device

Supported HA types

  • Binary sensors
  • Covers
  • Fans
  • Device triggers
  • Switches
  • Sensors
  • Tag scanner
  • HVACs (side note: HVACs requires more flash size than other HA types. It's not suitable for Arduino Nano/Uno)

Examples

Tested boards

  • Arduino Uno
  • Arduino Mega
  • NodeMCU
  • ESP-01
  • Generic ESP8266/ESP8255
  • Arduino Nano 33 IoT (SAMD)

Tested devices

  • Controllino Maxi (standard/pure/automation/power)
  • Controllino Mega (standard/pure)
  • Sonoff Dual R2
  • Sonoff Basic
  • Sonoff Mini
  • Tuya Wi-Fi switch module
  • Tuya Wi-Fi curtain module

Tested Arduino Shields

  • Arduino Ethernet Shield (WizNet W5100)

Roadmap

  • FAQ + Home Assistant setup instructions
  • Documentation of the library
  • Unit tests
  • Reduce flash memory usage
  • Add support for HA lights

Unsupported features

The library doesn't support all features of the MQTT integration. If you need support for a new feature please open a new issue in the repository.

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License v3.0 as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/gpl.html

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.