terafin/mqtt-unifi-protect-bridge

mqtt-unifi-protect-bridge 镜像文档

镜像概述

mqtt-unifi-protect-bridge 是一款用于连接 Unifi Protect 系统与 MQTT 服务的桥接工具。该镜像能够实时捕获 Unifi Protect 设备（如摄像头）产生的事件数据（如运动检测、人员识别等），并通过 MQTT 协议将事件转发至指定的 MQTT 服务器，从而实现安防事件与家庭自动化、监控系统等平台的集成。

核心功能

• Unifi Protect 集成：支持连接 Unifi Protect 系统，通过 API 获取设备事件数据
• MQTT 协议支持：将事件数据格式化为 MQTT 消息并发送至指定 MQTT 服务器
• 自定义轮询频率：可配置事件数据的轮询间隔（单位：秒），灵活控制数据更新频率
• 主题前缀自定义：支持设置 MQTT 消息的主题前缀，便于消息分类和管理
• MQTT 认证支持：可选配置 MQTT 服务器的用户名和密码认证，保障连接安全性

使用场景

• 家庭自动化：将 Unifi Protect 摄像头的运动检测事件发送至家庭自动化系统（如 Home Assistant），触发灯光、警报等联动操作
• 安防监控：集中收集多个 Unifi Protect 设备的事件数据，通过 MQTT 消息进行统一监控和记录
• 事件通知：结合 MQTT 客户端工具，实现安防事件的实时通知（如邮件、短信提醒）

使用方法

Docker Run 命令示例

bash
docker run -d \
  --name mqtt-unifi-protect-bridge \
  -e LOGGING_NAME=mqtt-unifi-protect-bridge \
  -e PROTECT_URL=https://10.0.1.2:7443 \
  -e USERNAME=your_unifi_username \
  -e PASSWORD=your_unifi_password \
  -e POLL_FREQUENCY=1 \
  -e TOPIC_PREFIX=/motion \
  -e MQTT_HOST=mqtt://mqtt.yourdomain.net \
  -e MQTT_USER=your_mqtt_username \
  -e MQTT_PASS=your_mqtt_password \
  docker.xuanyuan.run/terafin/mqtt-unifi-protect-bridge:latest

Docker Compose 配置示例

yaml
version: '3.3'
services:
  mqtt-unifi-protect-bridge:
    image: docker.xuanyuan.run/terafin/mqtt-unifi-protect-bridge:latest
    environment:
      # 日志名称（可选）
      LOGGING_NAME: mqtt-unifi-protect-bridge
      # Unifi Protect 登录 URL（必填，例如：https://10.0.1.2:7443）
      PROTECT_URL: URL_FOR_UNIFI_PROTECT_LOGIN
      # Unifi Protect 用户名（必填）
      USERNAME: YOUR_USERNAME_FOR_ABOVE_URL
      # Unifi Protect 密码（必填）
      PASSWORD: YOUR_PASSWORD_FOR_ABOVE_URL
      # 轮询频率（必填，单位：秒）
      POLL_FREQUENCY: 1
      # MQTT 主题前缀（必填，例如：/motion）
      TOPIC_PREFIX: /your_topic_prefix
      # MQTT 服务器 URL（必填，例如：mqtt://mqtt.yourdomain.net）
      MQTT_HOST: YOUR_MQTT_URL
      # MQTT 用户名（可选）
      MQTT_USER: YOUR_MQTT_USERNAME
      # MQTT 密码（可选）
      MQTT_PASS: YOUR_MQTT_PASSWORD

配置参数说明