krambox/buderus2mqtt

mqtt-km200

镜像概述和主要用途

buderus2mqtt是KM200 Buderus互联网网关与MQTT之间的网关，采用mqtt-smarthome主题和负载格式，实现设备数据与MQTT智能家居系统的集成。通过该镜像，用户可将KM200设备的测量数据（如温度、运行时间、功率等）传输至MQTT broker，并支持自定义测量点配置。

核心功能和特性

• 协议转换：实现KM200设备数据与MQTT协议的双向转换
• 自定义测量点：通过配置文件定义需要监控的设备数据点
• 环境变量配置：支持通过环境变量设置MQTT地址、KM200 IP、AES密钥等关键参数
• 扫描工具：提供scan.js工具，可扫描KM200设备的可用测量点
• Docker化部署：支持通过Docker容器快速部署，简化安装流程

使用场景和适用范围

适用于使用KM200 Buderus互联网网关的用户，需要将壁挂炉、热水器等设备的运行数据接入MQTT智能家居系统，实现设备监控、数据记录、自动化控制等场景。例如：家庭能源管理、远程设备状态监控、智能家居联动控制。

详细使用方法和配置说明

安装方式

推荐通过Docker Hub安装。需准备配置文件（存储测量点）和环境变量文件（配置连接参数）。

Docker运行命令

bash
docker run --env-file ./km200.env -v <本地数据目录（含config.yml）>:/data --name buderus2mqtt -d krambox/buderus2mqtt

环境变量配置

环境变量文件（km200.env）需包含以下参数：

KM200_url=mqtt://<MQTT主机IP>  # MQTT broker地址
KM200_config=/data/config.yml  # 配置文件路径（容器内路径）
KM200_passcode=<AES密钥>       # 通过AES密钥生成工具获取
KM200_km200=<KM200 IP>         # KM200设备的IP地址

AES密钥获取

需通过KM200 web网关的AES密钥生成工具获取：[***]

测量点配置文件（config.yml）

配置文件用于定义需要监控的测量点，示例如下：

yaml
measurements:
  - url: '/system/sensors/temperatures/chimney'                # 烟囱温度
  - url: '/system/sensors/temperatures/outdoor_t1'             # 室外温度
  - url: '/system/sensors/temperatures/supply_t1_setpoint'     # 供水温度设定值
  - url: '/heatSources/actualSupplyTemperature'                # 实际供水温度
  - url: '/heatingCircuits/hc1/temperatureLevels/day'          # 供暖回路1白天温度
  - url: '/heatingCircuits/hc1/temperatureLevels/night'        # 供暖回路1夜间温度
  - url: '/heatingCircuits/hc1/roomtemperature'                # 供暖回路1室温
  - url: '/heatingCircuits/hc1/temperatureRoomSetpoint'        # 供暖回路1室温设定值
  - url: '/dhwCircuits/dhw1/actualTemp'                        # 生活热水实际温度
  - url: '/dhwCircuits/dhw1/setTemperature'                     # 生活热水设定温度
  - url: '/system/appliance/workingTime/centralHeating'        # 中央供暖运行时间
  - url: '/system/appliance/workingTime/secondBurner'          # 第二燃烧器运行时间
  - url: '/system/appliance/workingTime/totalSystem'           # 系统总运行时间
  - url: '/dhwCircuits/dhw1/workingTime'                       # 生活热水运行时间
  - url: '/system/appliance/numberOfStarts'                    # 启动次数
  - url: '/system/appliance/fanSpeed'                           # 风扇转速
  - url: '/system/appliance/flameCurrent'                      # 火焰电流
  - url: '/system/appliance/actualPower'                       # 实际功率
  - url: '/system/appliance/powerSetpoint'                     # 功率设定值
  - url: '/dhwCircuits/dhw1/waterFlow'                         # 热水流量

扫描可用测量点

使用scan.js工具可扫描KM200设备的可用测量点，命令如下：

bash
./scan.js -p <AES密钥> -k <KM200 IP> gb135.txt

本地Docker构建与运行

构建镜像

bash
docker build -t km200 .

运行容器

bash
docker run --env-file ./km200.env -v <本地数据目录（含config.yml）>:/data -it km200

本地开发与直接运行

通过命令行参数直接运行km200mqtt.js，使用-h选项查看帮助：

bash
./km200mqtt.js -url mqtt://<MQTT主机IP> \
    -config ./config.yml \
    -passcode <AES密钥> \
    -km200 <KM200 IP>