Olink 文档

主题

快速开始 ​

使用 Docker Compose 部署 ​

  1. 创建 docker-compose.yml 文件

    在您的部署目录中创建 docker-compose.yml 文件，内容如下：

yaml
services:
   olink:
     image: registry.cn-zhangjiakou.aliyuncs.com/hperfect/olink:latest
     network_mode: host
     container_name: olink
     privileged: false
     volumes:
       # 冒号左边请修改为你想保存配置的路径
       - ./data:/data   
     environment:
       - PUID=0
       - RUST_BACKTRACE=1
       - PGID=0
       - UMASK=000
       #监听端口
       - APP__server__listen=0.0.0.0:5512
       - APP__server__data_path=/data
     restart: always

  1. 启动服务

    在包含 docker-compose.yml 文件的目录中执行以下命令：

    bash
    docker-compose up -d

  2. 验证服务状态

    执行以下命令检查服务是否正常运行：

    bash
    docker-compose ps

    您应该看到 olink 服务处于 Up 状态。

  3. 访问控制台

    服务启动后，您可以通过浏览器访问 http://<服务器IP>:5512 打开 Olink Web 控制台。

前提条件 ​

  • 已按上述步骤部署并启动 Olink 服务端。
  • 必须有米家中枢网关

界面分区 ​

Web 控制台左侧为主导航，对应三个功能区：

  1. 米家 — 网关列表、添加网关、米家房间管理、映射管理。
  2. HomeKit — 桥接器列表、添加/编辑桥接器、各桥下的配件与配置。
  3. 接入设备 — 已纳入 Olink 模型的设备总览，按区域筛选与查看详情。

右上角一般提供账号或调试相关能力（以您构建的前端版本为准）。

推荐首次流程 ​

流程: 同步米家设备->接入Olink->映射到homekit

  1. 在 米家 页添加网关并完成授权（按界面引导打开授权链接或使用回调地址完成登录）。
  2. 对网关执行 加载设备（或等价操作），拉取家庭、房间与 MIoT 设备列表。
  3. 在 映射管理 中确认或补全「米家侧实体 → Olink 设备」的映射（部分流程支持半自动；复杂设备可能需要手动对齐）。
  4. 切换到 HomeKit，添加桥接器并记下配对码（PIN）与端口；类别为「桥接器」时可在同一桥下挂载多个配件。
  5. 在配件列表中 从接入设备添加 或 手写配置，必要时用内置编辑器修改 TOML 并做配置校验。
  6. 打开 iOS「家庭」App，添加配件，扫描或手动输入桥接器 PIN，将桥或单个配件加入家庭。
  7. 在 接入设备 页检查设备是否出现在预期区域，必要时使用 区域管理 整理分区。

更细的字段说明与异常处理见 米家网关与映射、HomeKit 桥接与配件 与 常见问题。