Skip to content

ChristopheHD/HA_enoceanmqtt-addon

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Home Assistant enOcean addon

Home Assistant enOcean addon

Easily integrate enOcean protocol using MQTT layer

downloads

ℹ️ About the Project

This is the Home Assistant addon for HA_enoceanmqtt.
HA_enoceanmqtt allows to easily have access to EnOcean devices in Home Assistant through MQTT.

🛠 Stack Tech

Install Addon


⚙ ️Simple setup

Installation

To install this project, follow these steps:

Installation

  1. If you don't have a MQTT broker yet, click on the below button and then Install or in Home Assistant go to Settings → Add-ons → Add-on store and install the Mosquitto broker addon.

  1. Click on the below button and then Add or go back to the Add-on store, click ⋮ → Repositories, fill in
    https://github.com/ChristopheHD/HA_enoceanmqtt-addon and click Add → Close.

  1. Click on the addon and press Install and wait until the addon is installed.

Configuration

  1. Adapt the addon/enoceanmqtt.devices.sample (refer to the wiki for help) and put it to your Home Assistant /config directory. You can use the Home Assistant File Editor.
  2. Go on the Configuration tab of the addon
    • Indicate the location of this device file under the device_file entry (on HAOS, it would be /config/enoceanmqtt.devices).
    • Select the serial interface of your EnOcean transceiver in the list of detected serial ports. When using yaml configuration, the format is for example:
      enocean_port: /dev/ttyUSB0
    • Click Save at the bottom of the page
  3. Start the addon by going to Info tab and click Start

👏🏻 Contributing

We welcome contributions from the community! If you would like to contribute to this project, please follow the guidelines below.

Ways to Contribute

  • Report bugs or issues by opening a new issue on our GitHub repository.
  • Suggest new features or improvements by opening a new issue on our GitHub repository.
  • Contribute code by forking the repository, making changes, and submitting a pull request.

For more information on how to contribute, please visit Contribution Guidelines.


Built with ❤️ with Document My Project

About

Home Assistant addon for Enocean devices

Topics

Resources

License

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Languages

  • Shell 85.8%
  • Dockerfile 14.2%