flopon/enocean-mqtt

EnOcean转MQTT转发器

镜像概述和主要用途

EnOcean转MQTT转发器是一个Python模块，用于从EnOcean接口（如USB设备）接收消息，并将选定的消息发布到MQTT broker。同时支持配置响应传入的EnOcean消息，响应内容通过MQTT请求定义。该模块基于https://github.com/kipe/enocean%E5%BA%93%E6%9E%84%E5%BB%BA%E3%80%82

核心功能和特性

• 消息转发：接收EnOcean接口消息并发布到MQTT broker
• 消息响应：可配置对传入EnOcean消息的响应，响应内容通过MQTT请求定义
• 多接口支持：兼容USB EnOcean接口和EnOcean Raspberry Pi Hat
• 灵活配置：支持多配置文件合并，可分离敏感配置与设备配置
• 多部署方式：支持作为系统服务（systemd）或Docker容器运行

使用场景和适用范围

• 智能家居系统中EnOcean设备与MQTT生态的集成
• 工业自动化场景下EnOcean传感器数据的MQTT转发
• 需要将EnOcean无线设备数据接入MQTT协议的物联网项目
• 构建EnOcean设备与其他系统（如Home Assistant）的通信桥梁

详细使用方法和配置说明

安装与部署

直接安装（非Docker方式）

通过PyPI安装：

bash
pip install enocean-mqtt

或从GitHub安装最新版本：

bash
# 下载仓库
git clone https://github.com/volschin/enocean-mqtt.git
cd enocean-mqtt
# 安装
python setup.py develop

作为Docker容器运行

1. 挂载配置目录和EnOcean USB设备
2. 在/config目录中配置enoceanmqtt.conf文件

Docker运行示例：

bash
sudo docker run --name="enoceanmqtt" \
  --device=/dev/enocean \  # EnOcean设备路径
  -v /local/path/to/config:/config \  # 本地配置目录映射
  volschin/enocean-mqtt:latest

作为系统服务运行

1. 复制服务文件：

bash
cp enoceanmqtt.service /etc/systemd/system/

2. 启用并启动服务：

bash
systemctl enable enoceanmqtt
systemctl start enoceanmqtt

设备配置

EnOcean接口持久化设备名称

为避免USB设备名称变动（如/dev/ttyUSB0变为/dev/ttyUSB1），可创建udev规则：

1. 创建规则文件：

bash
nano /etc/udev/rules.d/99-usb.rules

2. 添加内容（以EnOcean USB 300 DB为例）：

ini
SUBSYSTEM=="tty", ATTRS{product}=="EnOcean USB 300 DB", SYMLINK+="enocean"

3. 重启后设备将固定为/dev/enocean

与EnOcean Raspberry Pi Hat配合使用

1. 设置enocean_port = /dev/ttyAMA0
2. 启用串口并禁用Linux串口控制台（通过raspi-config）
3. 对于Raspberry Pi 3，添加以下行到/boot/config.txt以禁用蓝牙冲突：

ini
dtoverlay=disable-bt

配置文件说明

配置文件位置与合并顺序

配置文件按以下顺序合并（后文件覆盖前文件值）：

1. /etc/enoceanmqtt.conf
2. Docker环境中：/enoceanmqtt-default.conf
3. 命令行参数指定的配置文件

关键配置项

• enocean_port：EnOcean接口设备路径（如/dev/enocean或/dev/ttyAMA0）
• mqtt_broker：MQTT broker地址
• sensors：传感器配置部分，定义要监控的设备（包含rorg、func、type等参数）

配置示例

参考提供的enoceanmqtt.conf.sample文件，主要配置项包括：

ini
[mqtt]
broker = 192.168.1.100
port = 1883
username = mqtt_user
password = mqtt_password

[enocean]
port = /dev/enocean

[sensor.heating]
rorg = 0xA5
func = 0x20
type = 0x01
ignore = 0
default_data = {"SP": 50}
answer = 0

消息处理

读取EnOcean消息

• 配置的传感器接收EnOcean消息后，将按rorg、func、type解码
• 解码内容发布到MQTT主题
• 若要忽略特定设备，可在配置中设置ignore = 1

发送EnOcean消息

1. 通过MQTT请求设置消息数据：向设备主题前缀/req的子主题发布数据
   • 示例：向enocean/heating/req/SP发布80，设置加热执行器的设定值为80%
2. 发送消息：向设备的req/send主题发布消息触发发送

响应EnOcean消息

1. 在设备配置中设置answer = 1
2. 通过default_data配置默认响应数据
3. 通过MQTT请求（/req前缀主题）自定义响应数据
4. 收到EnOcean消息时自动发送配置的响应