cornerbit/hiksink

HikSink 镜像文档

镜像概述

HikSink 是一款轻量级工具，用于将海康威视（Hikvision）摄像头和NVR（网络视频录像机）产生的各类事件（如移动侦测、越线检测、设备篡改、非法登录等）实时流式传输至MQTT服务器，以便家庭自动化软件（如Home Assistant）消费和处理这些事件，实现智能化监控与自动化联动。

核心功能与特性

• 简易摄像头认证：支持海康威视设备默认采用的摘要认证（digest authentication），无需降低设备安全设置即可完成认证。
• 全事件类型支持：具备自动学习能力，可识别并处理HikSink尚未预设的事件类型，确保全面覆盖设备产生的各类事件。
• Home Assistant集成：兼容Home Assistant的MQTT发现协议，可自动在Home Assistant中创建实体，并提供单个摄像头的离线状态通知功能。
• 故障强化机制：当与摄像头的连接因网络问题或异常中断时，系统会自动尝试重新建立连接，保障事件传输的连续性。
• 低资源占用：采用Rust语言开发，内存占用低于20MB，CPU消耗低，可在树莓派等低配置设备上稳定运行。

使用场景与适用范围

• 家庭自动化系统：将海康威视摄像头事件集成到Home Assistant等平台，实现基于摄像头事件的自动化场景（如移动侦测时触发灯光开启、发送通知等）。
• 小型监控环境：适用于家庭、办公室等小型场所，为监控设备提供事件集中管理与转发能力。
• 低功耗设备部署：可在树莓派、NAS等资源受限设备上部署，作为轻量级事件转发服务运行。

使用方法与配置说明

环境变量配置

HikSink通过环境变量进行配置，主要参数如下：

Docker Run 部署示例

bash
docker run -d \
  --name hik-sink \
  -e MQTT_BROKER="tcp://192.168.1.100:1883" \
  -e MQTT_USERNAME="mqtt_user" \
  -e MQTT_PASSWORD="mqtt_pass" \
  -e CAMERA_CONFIG="front_door:192.168.1.200:admin:camera_pass,back_yard:192.168.1.201:admin:camera_pass" \
  -e HOME_ASSISTANT_DISCOVERY="true" \
  -e LOG_LEVEL="info" \
  --restart unless-stopped \
  cornerbit/hiksink:latest

Docker Compose 部署示例

yaml
version: '3'
services:
  hik-sink:
    image: cornerbit/hiksink:latest
    container_name: hik-sink
    environment:
      - MQTT_BROKER=tcp://192.168.1.100:1883
      - MQTT_USERNAME=mqtt_user
      - MQTT_PASSWORD=mqtt_pass
      - CAMERA_CONFIG=front_door:192.168.1.200:admin:camera_pass,back_yard:192.168.1.201:admin:camera_pass
      - HOME_ASSISTANT_DISCOVERY=true
      - LOG_LEVEL=info
    restart: unless-stopped