Skip to content

Latest commit

 

History

History
61 lines (37 loc) · 3.38 KB

README.md

File metadata and controls

61 lines (37 loc) · 3.38 KB

Home Assistant Overlay for enoceanmqtt

This is a Home Assistant overlay for enoceanmqtt.
It allows to easily have access to EnOcean devices in Home Assistant through MQTT.
It is based on MQTT discovery from the Home Assistant MQTT integration.

Diagram



EnOceanMQTT is the core of HA_enoceanmqtt. It manages the EnOcean protocol through the USB300 dongle thanks to the Python EnOcean library.

The Python EnOcean library is based on an EEP.xml file which contains the definition of the supported EnOcean EEPs.
As for EnOceanMQTT, it needs a configuration file in which are indicated among other things the MQTT parameters as well as the EnOcean devices to manage.
The Home Assistant overlay is in charge of creating automatically and managing MQTT devices in Home Assistant. It maps an EnOcean device to one or more MQTT devices in HA thanks to a mapping file.

Standalone Installation

HA_enoceanmqtt can be installed as a standard python application on a Linux system.

Install Supervised



See Standalone installation for more details.

Docker Installation

HA_enoceanmqtt is also available as a docker image.

Install Docker



This installation will mainly suits users of Home Assistant container.
See Docker Installation for more details.

Home Assistant Addon Installation

HA_enoceanmqtt can also be installed as a Home Assistant addon.

Install Addon



This installation suits all Home Assistant installations with Supervisor.
See Home Assistant Addon Installation for more details.

Usage

Refer to Usage for more details.

Supported Devices

Refer to Supported devices for a list of supported devices.

For devices not yet supported, only the RSSI sensor is created in Home Assistant.

Note: If your device is not supported yet, please feel free to ask me for adding your device through the discussion panel. Or feel free to add it to mapping.yaml and make a pull request (see Contributing for more details).

Additional Information

The Wiki page is filled with useful information.
A discussion panel is also available. Do not hesitate to read it and use it.
You can also take a closer look at the work in progress on this page.