sgupta99/mqtt-bridge-smartthings

MQTT Bridge to SmartThings (MBS) 镜像说明

镜像概述

该镜像是基于St. John Johnson开发的smartthings-mqtt-broker项目的更新版本，旨在作为SmartThings与MQTT broker之间的桥梁，实现两者之间的设备状态同步和命令交互。它针对Tasmota设备进行了优化，同时保持与旧版本的向后兼容性。

核心功能

• 支持外部YAML配置文件（devices.yml）自定义SmartThings设备属性/命令与MQTT主题/payload的映射关系。
• 单个设备可订阅和发布多个MQTT主题，并支持MQTT通配符。
• 简化的日志和配置管理：日志和状态数据分别存储在Log和Data目录中。
• 所有依赖项已更新至最新版本。
• 针对Tasmota设备的特殊支持：定期更新设备的SSID、RSSI等状态信息。
• 保持与旧版本的向后兼容性，原有用户可无缝迁移。

使用场景

• 家庭自动化系统中，将SmartThings设备（如开关、传感器）与MQTT-based系统（如Home Assistant）集成。
• 自定义Tasmota设备与SmartThings之间的交互逻辑，实现更灵活的控制。
• 对SmartThings设备的状态变化进行MQTT消息转发，或通过MQTT命令控制SmartThings设备。

配置说明

该桥梁使用两个YAML配置文件，需放置在config目录下（可通过CONFIG_DIR环境变量指定路径）：

config.yml

主要配置MQTT连接信息和服务端口等：

yaml
---
port: 8080
loglevel: "info"
deviceconfig: true
mqtt:
    host: mqtt://localhost
    preface: smartthings
    # 可选配置：username、password、retain等

devices.yml

定义SmartThings设备与MQTT主题的映射关系，示例如下：

yaml
---
Living Room Light:
  attribute: switch
  subscribe:
    smartthings/stat/sonoff-1/POWER:
      command:
        'OFF': 'off'
        'ON': 'on'
  publish:
    switch:
      topic: smartthings/cmnd/sonoff-1/POWER
      command:
        'off': 'OFF'
        'on': 'ON'
  retain: 'false'

Docker部署示例

基本运行命令

bash
docker run -d \
  -p 8080:8080 \
  -v /path/to/your/config:/config \
  --name mqtt-bridge-smartthings \
  sgupta99/mqtt-bridge-smartthings

自定义配置目录

若需指定非默认的配置目录，可设置CONFIG_DIR环境变量：

bash
docker run -d \
  -p 8080:8080 \
  -v /my/custom/config:/my/custom/config \
  -e CONFIG_DIR=/my/custom/config \
  --name mqtt-bridge-smartthings \
  sgupta99/mqtt-bridge-smartthings