https://github.com/matthieuvw/enocean2mqtt

EnOcean to MQTT Gateway
https://github.com/matthieuvw/enocean2mqtt

enocean mqtt

Last synced: 27 days ago
JSON representation

EnOcean to MQTT Gateway

• Host: GitHub
• URL: https://github.com/matthieuvw/enocean2mqtt
• Owner: matthieuvw
• License: gpl-3.0
• Created: 2021-03-04T22:12:02.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-03-07T00:19:22.000Z (over 3 years ago)
• Last Synced: 2024-09-29T21:01:27.213Z (about 1 month ago)
• Topics: enocean, mqtt
• Language: Python
• Homepage:
• Size: 27.3 KB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# enocean2mqtt

* publish EnOcean received packets to MQTT

* Send commands to EnOcean equipments via MQTT

It is based on [Python EnOcean](https://github.com/kipe/enocean) and [Eclipse Paho™ MQTT Python Client](https://github.com/eclipse/paho.mqtt.python).

## Install

```

pip install encoean2mqtt --user

```

For Linux systems pip install lib to `~/.local/lib` and executable to `~/.local/bin` (check with `python -m site`).

## Configure

Get inspired by [enocean2mqtt-sample.yaml](https://github.com/matthieuvw/enocean2mqtt/blob/main/resources/enocean2mqtt-sample.yaml) and/or read [configuration documentation on GitHub](https://github.com/matthieuvw/enocean2mqtt/blob/main/doc/configuration.md)

## Run manually

```

# Minimal

~/.local/bin/enocean2mqtt --config /your/path/enocean2mqtt.yaml

# All args

~/.local/bin/enocean2mqtt --config /your/path/enocean2mqtt.yaml --verbose --log-file /your/path/enocean2mqtt.log

```

## Run as a systemd service

> Sample made for Raspbian 10 and `pi` user

* copy file [enocean2mqtt.service](https://github.com/matthieuvw/enocean2mqtt/blob/main/resources/enocean2mqtt.service) to `/etc/systemd/system/enocean2mqtt.service`

* customize with your user and configuration file path

* `sudo chown root:root /etc/systemd/system/enocean2mqtt.service`

* `sudo chmod 644 /etc/systemd/system/enocean2mqtt.service`

* `sudo systemctl daemon-reload`

* `sudo systemctl enable enocean2mqtt`

* `sudo systemctl start enocean2mqtt`

Check status : `sudo systemctl status enocean2mqtt`  

See logs : `journalctl -f -u enocean2mqtt`