mxcory/arduino-home-assistant
1
0
Fork 0
mirror of https://github.com/mrcory/arduino-home-assistant.git synced 2026-08-02 15:24:26 -04:00
Code Issues Packages Projects Releases Wiki Activity
45 Commits 3 Branches 6 Tags
a4e50b7d048373d1254fef2e3e48f5e9a5fd51fc
T
Clone
Open with VS Code Open with VSCodium Open with Intellij IDEA
Download ZIP Download TAR.GZ Download BUNDLE
Dawid ChyrzyńskiandGitHub a4e50b7d04 Release 1.3.0 (#36) 
* Add support for HVAC (#15)

* remove HASwitch::triggerCallback method

* fix typo in docs

* HASwitch: simplify callback #define

* work in progress: HVAC

* replace local mqtt instances with singleton

* device types optimization

* cleanup

* finished aux heating and away mode

* wip: HVAC

* finished HVAC implementation

* HVAC implementation

* add ifdefs for all HA components

* wip: optimization

* update readme

* update examples

* remove unused constructor from HAMqtt

* update HAUtils

* remove mqtt from constructors, fix compilation warnings

* finished HVAC

* add HVAC example, add changelog

* update changelog, add documentation

* Add support for icons in HASwitch and HASensor (#16)

* add support for icon in HASwitch

* add support for icon in HASensor

* update changelog

* add support for setting retain flag in HASwitch

* Add support for text payload in HASensor (#17)

* refactored HASensor

* update changelog

* fix sensor example

* Add support for fans (HAFan) (#18)

* finished basic implementation of the HAFan

* add retain method to DeviceTypeSerializer

* finished HAFan implementation

* update HAHVAC

* device types cleanup

* add HAFan example

* update changelog

* update readme

* update fan example

* optimization, add support for ActionFeature in HVAC

* Add support for MQTT LWT (#19)

* add support for hostname in HAMqtt

* add support for LWT and shared availability

* minor fixes

* added advanced availability example

* update examples

* update changelog

* cleanup & bug fix

* bump up version

* minor improvements and fixes

* update readme

* add HAMqtt::onMessage method

* Add support for covers (#28)

* add HACovers

* add cover example, update implementation

* disable debug

* update mqtt-events example

* Add support for setting different prefix for non-discovery topics (#29)

* add support for data prefix

* cleanup

* update comments and logs

* update multi-state-button example

* rename rexample from mqtt-events to mqtt-advanced

* update changelog

* update links in changelog

* Home Assistant 2021.4.5 - MQTT upgrade (#33)

* updae HAFan implementation

* change lib version

* update changelog

* fix setSpeed method

* update HAFan example

* Separate uniqueId from name (#34)

* rename name to uniqueId

* remove legacy labels

* update examples

* rename isMyTopic to compareTopics

* update changelog, rename name to uniqueId

* Implement onBeforeStateChanged callback in HASwitch (#35)

* add low latency mode to HASwitch

* add onBeforeStateChanged callback to HASwitch

* update readme

* rename DEPRECATED macro

* update advanced MQTT example
2021-04-17 20:03:32 +02:00
examples
Release 1.3.0 (#36)
2021-04-17 20:03:32 +02:00
src
Release 1.3.0 (#36)
2021-04-17 20:03:32 +02:00
CHANGELOG.md
Release 1.3.0 (#36)
2021-04-17 20:03:32 +02:00
library.properties
Release 1.3.0 (#36)
2021-04-17 20:03:32 +02:00
README.md
Release 1.3.0 (#36)
2021-04-17 20:03:32 +02:00

README.md

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

Reference in New Issue View Git Blame Copy Permalink
S
Description
ArduinoHA allows to integrate an Arduino/ESP based device with Home Assistant using MQTT.
Readme
2.8 MiB
Languages
C++ 99.1%
C 0.9%