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

WyzeSense 转 MQTT 网关

![PRs Welcome]([] ![GitHub License]([] ![GitHub Issues]([] ![GitHub PRs]([] ![GitHub Release]([] ![Python Validation]([]

![dockeri.co]([***]

可配置的WyzeSense转MQTT网关，适用于Home Assistant或其他使用MQTT发现机制的平台。该网关允许直接本地访问Wyze Sense产品，无需Wyze摄像头或云服务。本项目及其依赖项与Wyze Labs Inc.无任何关联。

特别感谢

• HcLX 提供的WyzeSensePy，本项目使用的核心库。
• Kevin Vincent 提供的HA-WyzeSense，为WyzeSensePy调用提供了参考代码。
• ozczecho 提供的wyze-mqtt，本项目的灵感来源。
• rmoriz 提供的multiarch-test，使Docker Hub自动构建支持多架构，包括ARM32v7（树莓派）和AMD64（Linux）。

目录

• WyzeSense 转 MQTT 网关
  • 特别感谢
  • 目录
  • 安装
    • Docker
    • Linux Systemd
  • 配置文件
    • config.yaml
    • logging.yaml
    • sensors.yaml
  • 使用方法
    • 配对传感器
    • 移除传感器
    • 重新加载传感器
    • 命令行工具
  • Home Assistant 集成
  • 测试环境

安装

Docker

这是运行网关最受测试的方法。它支持持久化，并且在硬件加密狗与配置一起迁移时便于迁移。所有步骤在Docker主机上执行，而非容器内。

1. 将Wyze Sense桥接器插入Docker主机的USB端口。确认它显示为/dev/hidraw0，如果不是，更新Docker Compose文件中的设备条目为正确路径。
2. 创建如下类似的Docker Compose文件。有关文件格式和选项的更多详情，请参见Docker Compose 文档。如果您想测试开发功能，请将镜像修改为"devel"而非"latest"。

yaml
version: "3.7"
services:
  wyzesense2mqtt:
    container_name: wyzesense2mqtt
    image: raetha/wyzesense2mqtt:latest
    hostname: wyzesense2mqtt
    restart: always
    tty: true
    stop_signal: SIGINT
    network_mode: bridge
    devices:
      - "/dev/hidraw0:/dev/hidraw0"
    volumes:
      - "/docker/wyzesense2mqtt/config:/wyzesense2mqtt/config"
      - "/docker/wyzesense2mqtt/logs:/wyzesense2mqtt/logs"
    environment:
      TZ: "America/New_York"

3. 创建本地卷挂载目录。使用与上述Docker Compose文件中选择的相同文件夹。

bash
mkdir /docker/wyzesense2mqtt/config
mkdir /docker/wyzesense2mqtt/logs

4. 创建或复制config.yaml文件到配置文件夹（见下文示例或从仓库复制）。如果未找到配置文件，脚本会自动创建默认config.yaml，但需要修改MQTT详情才能正常工作。
5. 复制logging.yaml文件到配置文件夹（见下文示例或从仓库复制）。如果不存在，脚本会自动创建默认logging.yaml。仅在需要复杂日志配置时修改此文件。
6. 如有需要，将现有传感器信息预填充到配置文件夹中的sensors.yaml文件。如果不存在，此文件会自动创建。（见下文示例或从仓库复制）
7. 启动Docker容器

bash
docker-compose up -d

8. 按照下文说明配对传感器。无需重新配对已配对的传感器，它们应在启动时自动被发现并以默认值添加到配置文件，但传感器版本可能未知。

Linux Systemd

对于不想使用Docker的用户，网关也可以作为systemd服务运行。需要Python 3.6或更高版本。根据文件系统权限，可能需要以root用户执行所有命令。

1. 将Wyze Sense桥接器插入Linux主机的USB端口。
2. 拉取仓库代码

bash
cd /tmp
git clone https://github.com/raetha/wyzesense2mqtt.git
# 如果想测试开发分支，请使用以下命令
# git clone -b devel https://github.com/raetha/wyzesense2mqtt.git

3. 创建本地应用文件夹（选择适合您的位置，示例使用/wyzesense2mqtt）

bash
mv /tmp/wyzesense2mqtt/wyzesense2mqtt /wyzesense2mqtt
rm -rf /tmp/wyzesense2mqtt
cd /wyzesense2mqtt
mkdir config
mkdir logs

4. 准备config.yaml文件。必须设置MQTT主机参数！如果未使用用户名和密码，可以留空。（见下文示例）

bash
cp samples/config.yaml config/config.yaml
vim config/config.yaml

5. 如有需要，修改logging.yaml文件（可选）

bash
cp samples/logging.yaml config/logging.yaml
vim config/logging.yaml

6. 如有需要，将现有传感器信息预填充到sensors.yaml文件。如果不存在，此文件会自动创建。（见下文示例）（可选）

bash
cp samples/sensors.yaml config/sensors.yaml
vim config/sensors.yaml

7. 安装依赖

bash
sudo pip3 install -r requirements.txt

8. 配置服务

bash
vim wyzesense2mqtt.service # 仅在不使用默认应用路径时修改
sudo cp wyzesense2mqtt.service /etc/systemd/system/
sudo systemctl daemon-reload
sudo systemctl start wyzesense2mqtt
sudo systemctl status wyzesense2mqtt
sudo systemctl enable wyzesense2mqtt # 设置开机自启

9. 按照下文说明配对传感器。无需重新配对已配对的传感器，它们应在启动时自动被发现并以默认值添加到配置文件，但传感器版本可能未知。

配置文件

网关使用位于配置目录中的三个配置文件。下文提供各文件的示例，也可从仓库获取。

config.yaml

这是主配置文件。除MQTT主机、用户名和密码外，默认值对大多数用户适用。

yaml
mqtt_host: <主机>
mqtt_port: 1883
mqtt_username: <用户>
mqtt_password: <密码>
mqtt_client_id: wyzesense2mqtt
mqtt_clean_session: false
mqtt_keepalive: 60
mqtt_qos: 2
mqtt_retain: true
self_topic_root: wyzesense2mqtt
hass_topic_root: homeassistant
hass_discovery: true
publish_sensor_name: true
usb_dongle: auto

logging.yaml

此文件包含logging.config模块的yaml字典配置。Python文档参见日志配置

yaml
version: 1
formatters:
  simple:
    format: '%(message)s'
  verbose:
    datefmt: '%Y-%m-%d %H:%M:%S'
    format: '%(asctime)s %(levelname)-8s %(name)-15s %(message)s'
handlers:
  console:
    class: logging.StreamHandler
    formatter: simple
    level: DEBUG
  file:
    backupCount: 7
    class: logging.handlers.TimedRotatingFileHandler
    encoding: utf-8
    filename: logs/wyzesense2mqtt.log
    formatter: verbose
    level: INFO
    when: midnight
root:
  handlers:
    - file
    - console
  level: DEBUG

sensors.yaml

此文件存储配对到Wyze Sense桥接器的每个传感器的基本信息。可以修改条目以设置传感器类型（class）和在Home Assistant中显示的名称。根据传感器类型，类型可自动填充为opening（门/窗传感器）、motion（运动传感器）和moisture（漏水传感器）。由于此文件可自动生成，Python可能会根据MAC是否全为数字自动添加引号。

yaml
'AAAAAAAA':
  class: door
  name: 入户门
  invert_state: false
'BBBBBBBB':
  class: window
  name: 办公室窗户
  invert_state: false
'CCCCCCCC':
  class: opening
  name: 厨房冰箱
  invert_state: false
'DDDDDDDD':
  class: motion
  name: 走廊运动传感器
  invert_state: false
'EEEEEEEE':
  class: moisture
  name: 地下室漏水传感器
  invert_state: true

使用方法

配对传感器

目前一次只能正确配对一个传感器。因此，请为每个传感器重复以下步骤。

1. 向MQTT主题“self_topic_root/scan”发布空消息，其中self_topic_root是配置文件中的值。如果未修改配置，默认MQTT主题为“wyzesense2mqtt/scan”。可通过Home Assistant或任何MQTT客户端执行此操作。
2. 使用Wyze Sense传感器附带的针工具按传感器侧面的重置按钮进行配对。按住直到红色LED闪烁。

移除传感器

1. 向MQTT主题“self_topic_root/remove”发布包含要移除MAC的消息，其中self_topic_root是配置文件中的值。如果未修改配置，默认MQTT主题为“wyzesense2mqtt/remove”。 payload应为“AABBCCDD”格式。可通过Home Assistant或任何MQTT客户端执行此操作。

重新加载传感器

如果在网关运行时修改了sensors.yaml文件，可以触发重新加载sensors.yaml文件，无需重启网关或Docker容器。

1. 向MQTT主题“self_topic_root/reload”发布空消息，其中self_topic_root是配置文件中的值。如果未修改配置，默认MQTT主题为“wyzesense2mqtt/reload”。可通过Home Assistant或任何MQTT客户端执行此操作。

命令行工具

bridge_tool_cli.py脚本可用于与桥接器交互以执行一些简单功能。确保为您的环境指定正确的设备。

bash
python3 bridge_tool_cli.py --device /dev/hidraw0

运行后将显示功能菜单：

• L - 列出已配对传感器
• P - 配对新传感器
• U - 解除配对传感器（例如“U AABBCCDD”）
• F - 修复无效传感器（移除MAC无效的传感器，常见于传感器损坏或电池电量低的情况）

Home Assistant 集成

Home Assistant只需配置为连接网关发布主题的MQTT代理。配置完成后，MQTT集成将自动为每个传感器添加设备以及状态、电池电量和信号强度的实体。默认情况下，这些实体的设备类型（device_class）为：接触传感器为“opening”，运动传感器为“motion”，漏水传感器为“moisture”。它们将以传感器类型和MAC命名，例如“Wyze Sense 接触传感器 AABBCCDD”。要将设备类型调整为“door”（门）或“window”（窗）并设置自定义名称，请更新sensors.yaml配置文件并替换默认值，然后重启WyzeSense2MQTT。有关Home Assistant支持的设备类型完整列表，请参见binary_sensor文档。

测试环境

• Debian Buster（Docker）
• Raspbian Buster（树莓派4）