allangood/rtlamr2mqtt Docker 镜像 - 轩辕镜像 | Docker 镜像高效稳定拉取服务

RTLAMR2MQTT

RTLAMR2MQTT是一个Docker容器项目，旨在将RTLAMR获取的仪表读数发送到MQTT代理，主要用于与Home Assistant等智能家居系统集成，实现仪表数据的监控与管理。

最新更新

2021-09-13:

• 新增配置参数：verbosity（日志级别）
• 环境变量DEBUG重命名为LISTEN_ONLY，避免混淆
• 改进错误处理和输出（仍在开发中）

以监听所有仪表模式运行容器

若未知仪表ID或监听协议，可运行容器的LISTEN_ONLY模式以监听所有内容。此模式下不读取配置文件，仅在屏幕打印所有仪表读数！

bash
docker run --rm -ti -e LISTEN_ONLY=yes -e RTL_MSGTYPE="scm+" --device=/dev/bus/usb:/dev/bus/usb allangood/rtlamr2mqtt

Home Assistant工具

!Home Assistant工具截图

Home Assistant配置

utility_meter配置：

yaml
utility_meter:
  hourly_water:
    source: sensor.<meter_name>
    cycle: hourly
  daily_water:
    source: sensor.<meter_name>
    cycle: daily
  monthly_water:
    source: sensor.<meter_name>
    cycle: monthly

若配置中设置了ha_autodiscovery: false，需手动添加传感器：

手动传感器配置示例（基于下文配置的水表）：

yaml
sensor:
  - platform: mqtt
    name: "我的公用事业仪表"
    state_topic: rtlamr/meter_water/state
    unit_of_measurement: "\u33A5"

需将meter_water替换为配置文件中设置的仪表名称。

配置文件示例

yaml
# （可选部分）
general:
  # 成功读取每个仪表后休眠的秒数，设为0（默认）禁用
  sleep_for: 300
  # 日志级别，可选debug或info
  verbosity: debug

# （必填部分）
# MQTT配置
mqtt:
  # MQTT主机名或IP地址
  host: 192.168.1.1
  # MQTT用户名（如使用认证），不使用可移除
  user: mqtt
  # MQTT密码（如使用认证），不使用可移除
  password: my very strong password
  # 是否启用Home Assistant自动发现
  ha_autodiscovery: true
  # Home Assistant自动发现主题
  ha_autodiscovery_topic: homeassistant

# （可选部分）
# 自定义参数，无需自定义可省略
# ***请勿在此添加-msgtype、-filterid或-protocol参数***
custom_parameters:
  # rtl_tcp文档：https://osmocom.org/projects/rtl-sdr/wiki/Rtl-sdr
  rtltcp: "-s 2048000"
  # rtlamr文档：https://github.com/bemasher/rtlamr/wiki/Configuration
  rtlamr: "-unique=true -symbollength=32"

# （必填部分）
# 仪表定义
meters:
    # 仪表ID
  - id: 7823010
    # 协议
    protocol: scm+
    # 在Home Assistant/Node Red中显示的名称
    name: meter_water
    # 数值格式
    format: "#####.###"
    # Home Assistant使用的计量单位
    unit_of_measurement: "\u33A5"
    # Home Assistant使用的图标
    icon: mdi:gauge
  - id: 6567984
    protocol: scm
    name: meter_hydro
    unit_of_measurement: kWh

Docker Compose配置

yaml
version: "3"
services:
  rtlamr:
    container_name: rtlamr2mqtt
    image: allangood/rtlamr2mqtt
    restart: unless-stopped
    devices:
      - /dev/bus/usb
    volumes:
      - /etc/rtlamr2mqtt.yaml:/etc/rtlamr2mqtt.yaml:ro

鸣谢

• [***]
• [***]===SHORT_DESC=== 将RTLAMR的仪表读数发送到MQTT代理的Docker容器，适用于与Home Assistant集成。

===FULL_DESC===

RTLAMR2MQTT

RTLAMR2MQTT是一个Docker容器项目，旨在将RTLAMR获取的仪表读数发送到MQTT代理，主要用于与Home Assistant集成，实现仪表数据的监控与管理。

最新更新

2021-09-13:

• 新增配置参数：verbosity（日志级别）
• 环境变量DEBUG重命名为LISTEN_ONLY，避免混淆
• 改进错误处理和输出（仍在开发中）

LISTEN ALL METERS模式运行方法

若未知仪表ID或监听协议，可运行容器的LISTEN_ONLY模式以监听所有内容。
此模式下，rtlamr2mqtt不会读取配置文件，仅在屏幕打印所有仪表读数！

bash
docker run --rm -ti -e LISTEN_ONLY=yes -e RTL_MSGTYPE="scm+" --device=/dev/bus/usb:/dev/bus/usb allangood/rtlamr2mqtt

Home Assistant工具

!Home Assistant工具截图

Home Assistant配置

utility_meter配置：

yaml
utility_meter:
  hourly_water:
    source: sensor.<meter_name>
    cycle: hourly
  daily_water:
    source: sensor.<meter_name>
    cycle: daily
  monthly_water:
    source: sensor.<meter_name>
    cycle: monthly

若配置中设置了ha_autodiscovery: false，需手动添加传感器：

手动传感器配置示例（基于下文配置的水表）：

yaml
sensor:
  - platform: mqtt
    name: "我的公用事业仪表"
    state_topic: rtlamr/meter_water/state
    unit_of_measurement: "\u33A5"

需将meter_water替换为配置文件中设置的仪表名称。

配置文件示例

yaml
# （可选部分）
general:
  # 成功读取每个仪表后休眠的秒数，设为0（默认）禁用
  sleep_for: 300
  # 日志级别，可选debug或info
  verbosity: debug

# （必填部分）
# MQTT配置
mqtt:
  # MQTT主机名或IP地址
  host: 192.168.1.1
  # MQTT用户名（如使用认证），不使用可移除
  user: mqtt
  # MQTT密码（如使用认证），不使用可移除
  password: my very strong password
  # 是否启用Home Assistant自动发现
  ha_autodiscovery: true
  # Home Assistant自动发现主题
  ha_autodiscovery_topic: homeassistant

# （可选部分）
# 自定义参数，无需自定义可省略
# ***请勿在此添加-msgtype、-filterid或-protocol参数***
custom_parameters:
  # rtl_tcp文档：https://osmocom.org/projects/rtl-sdr/wiki/Rtl-sdr
  rtltcp: "-s 2048000"
  # rtlamr文档：https://github.com/bemasher/rtlamr/wiki/Configuration
  rtlamr: "-unique=true -symbollength=32"

# （必填部分）
# 仪表定义
meters:
    # 仪表ID
  - id: 7823010
    # 协议
    protocol: scm+
    # 在Home Assistant/Node Red中显示的名称
    name: meter_water
    # 数值格式
    format: "#####.###"
    # Home Assistant使用的计量单位
    unit_of_measurement: "\u33A5"
    # Home Assistant使用的图标
    icon: mdi:gauge
  - id: 6567984
    protocol: scm
    name: meter_hydro
    unit_of_measurement: kWh

Docker Compose配置

yaml
version: "3"
services:
  rtlamr:
    container_name: rtlamr2mqtt
    image: allangood/rtlamr2mqtt
    restart: unless-stopped
    devices:
      - /dev/bus/usb
    volumes:
      - /etc/rtlamr2mqtt.yaml:/etc/rtlamr2mqtt.yaml:ro

鸣谢

• [***]
• [***]