koalazak/rest980

koalazak

自动构建

rest980创建HTTP服务器，将dorita980的所有方法映射为REST API，用于通过HTTP请求控制iRobot Roomba 900系列（980/i7/i7+）扫地机器人。

6 次收藏下载次数: 0状态：自动构建维护者：koalazak仓库类型：镜像最近更新：4 个月前

让 AI 帮你使用轩辕镜像？ · 展开查看说明 · 点击收起说明

如果你使用 DeepSeek、元宝 AI、Copilot、ChatGPT 等 AI 工具，协助配置轩辕镜像、编写 docker pull 命令、修改 Docker Compose 镜像地址、配置镜像加速、排查镜像拉取失败、分析报错日志等问题，请先让 AI 阅读并遵守轩辕镜像的规则文档。

只需在 AI 对话中先发送下面这句话即可：

请先完整阅读并严格遵守以下文档中的全部规则与要求：

https://xuanyuan.cloud/agents.md

在未充分阅读并理解该文档前，不要生成任何命令、配置、修改建议、故障排查方案或技术回答。后续所有输出都必须严格以该文档中的规范为最高优先级执行。

查看 agents.md 用法指南与完整示范。国内用户首推元宝 AI、DeepSeek 的深度思考模式，不推荐豆包 AI；Cursor 等编辑器可在对话 @ 该链接，或加入 User Rules。若 AI 无法访问外链，可打开说明文档复制全文粘贴。文档会随站点更新，复制内容可能过期，建议定期检查。

镜像标签列表与下载命令

rest980

rest980是一个HTTP服务器，可将dorita980库的所有方法映射为REST API，从而通过HTTP请求控制iRobot Roomba 900系列（980/i7/i7+）扫地机器人。

镜像概述和主要用途

rest980旨在提供一个便捷的REST API接口，让用户能够通过HTTP请求远程控制Roomba机器人，支持本地和云两种控制方式，适用于家庭自动化、远程监控等场景。

核心功能和特性

将dorita980的方法映射为REST API，支持本地和云接口
可通过配置文件或环境变量灵活配置服务参数
支持基本认证和HTTPS加密
提供Docker镜像，便于快速部署（如在Synology等设备上运行）
支持静态文件服务和实验性实时地图功能

使用场景和适用范围

适用于需要通过HTTP协议控制iRobot Roomba 900系列（980/i7/i7+）机器人的场景，包括但不限于：

家庭自动化系统集成
远程控制机器人清洁、暂停、返回充电等操作
获取机器人状态信息（电量、清洁任务等）
自定义机器人清洁配置

详细使用方法和配置说明

固件版本要求

检查您的机器人固件版本，并在rest980配置中设置firmwareVersion参数！

配置参数

服务可通过编辑config/default.json文件或设置环境变量进行配置：

配置文件（`config/default.json`）	环境变量	描述
port	PORT	（默认：3000）HTTP服务监听端口
blid	BLID	（必填）Roomba的BLID *
password	PASSWORD	（必填）Roomba的密码 *
robotIP	ROBOT_IP	（可选）已知机器人IP时设置，可跳过发现过程加快启动
firmwareVersion	FIRMWARE_VERSION	（可选）根据固件版本设置为1或2。固件>=2时使用2（包括版本3），默认1（适用于固件1.6.6）
enableLocal	ENABLE_LOCAL	（可选）设置为'no'禁用本地API，默认'yes'
enableCloud	ENABLE_CLOUD	（可选）设置为'no'禁用云API，默认'yes'
keepAlive	KEEP_ALIVE	（可选）设置为'no'时每次请求连接/断开机器人（速度慢但释放连接供官方应用使用）
basicAuthUser	BASIC_AUTH_USER	（可选）启用基本认证，需同时设置用户和密码
basicAuthPass	BASIC_AUTH_PASS	（可选）启用基本认证，需同时设置用户和密码
sslKeyFile	SSL_KEY_FILE	（可选）HTTPS密钥文件路径，需同时设置密钥和证书 (创建自签名证书方法)
sslCertFile	SSL_CERT_FILE	（可选）HTTPS证书文件路径，需同时设置密钥和证书 (创建自签名证书方法)

有关获取BLID和密码的更多信息和说明，请参见https://github.com/koalazak/dorita980

Docker部署

拉取Docker镜像

bash
docker pull docker.xuanyuan.run/koalazak/rest980

运行Docker容器

bash
docker run -e BLID=myuser -e PASSWORD=mypass -e ROBOT_IP=myrobotIP docker.xuanyuan.run/koalazak/rest980

本地构建Docker镜像

可通过项目中的https://github.com/koalazak/rest980/blob/master/Dockerfile%E6%9C%AC%E5%9C%B0%E6%9E%84%E5%BB%BA%EF%BC%9A

bash
docker build . -t koalazak/rest980

API使用说明

服务启动后，可通过端口3000访问API，主要包含local（本地）和cloud（云）两个端点，分别对应dorita980的本地和云方法。

错误响应

HTTP状态码500，响应格式：

json
{"message":"人类可读消息","error":{}}

本地API（local）

操作接口（Actions）

所有清洁操作通过/api/local/action/[action]端点，使用GET方法（无查询参数）：

可用操作：

start（开始清洁）
stop（停止）
pause（暂停）
dock（返回充电）
resume（恢复）
cleanRoom（指定房间清洁）

示例：开始清洁

http
GET http://192.168.1.110:3000/api/local/action/start

成功响应：

json
{"ok":null,"id":23}

示例：指定房间清洁

部分Roomba型号（如s9、i7）支持房间特定清洁，需通过POST方法发送参数：

sh
curl -X POST http://192.168.1.110:3000/api/local/action/cleanRoom -H 'Content-Type: application/json' -d '{"ordered": 0, "pmap_id": "123456", "regions": [{"region_id":"5", "region_name":"Hallway","region_type":"hallway"}], "user_pmapv_id": "987654"}'

信息接口（Info）

所有信息通过/api/local/info/[record]端点，使用GET方法（无查询参数）：

可用记录：

mission（任务状态）
wireless（无线信息）
lastwireless（最近无线信息）
sys（系统信息）
sku（型号信息）
state（状态，仅固件2支持）

示例：获取当前任务变量

http
GET http://192.168.1.110:3000/api/local/info/mission

成功响应：

json
{ "ok":
   { "flags": 0,
     "cycle": "none",
     "phase": "charge",
     "pos": { "theta": 179, "point": {"x": 102, "y": -13} },
     "batPct": 99,
     "expireM": 0,
     "rechrgM": 0,
     "error": 0,
     "notReady": 0,
     "mssnM": 0,
     "sqft": 0 },
  "id": 2 }

配置接口（Configurations）

所有配置通过/api/local/config/[configName]端点，GET方法获取配置，POST方法设置配置：

可用配置名称：

ptime（仅固件1支持GET）
bbrun（仅GET）
cloud（仅GET）
langs（仅GET，通过preferences设置语言）
week
time（固件1支持POST和GET，固件2仅支持GET）
preferences
carpetBoost/auto（仅POST，通过preferences获取当前配置）
carpetBoost/performance（仅POST）
carpetBoost/eco（仅POST）
edgeClean/on（仅POST）
edgeClean/off（仅POST）
cleaningPasses/auto（仅POST）
cleaningPasses/one（仅POST）
cleaningPasses/two（仅POST）
alwaysFinish/on（仅POST）
alwaysFinish/off（仅POST）

示例：获取固件1的偏好设置

http
GET http://192.168.1.110:3000/api/local/config/preferences

成功响应：

json
{ "ok":
   { "flags": 1024,
     "lang": 2,
     "timezone": "America/Buenos_Aires",
     "name": "myRobotName",
     "cleaningPreferences": {
        "carpetBoost": "auto",
        "edgeClean": true,
        "cleaningPasses": "1",
        "alwaysFinish": true 
      }
    },
 "id": 2 }

示例：设置清洁次数为两次

http
POST http://192.168.1.110:3000/api/local/config/cleaningPasses/two

请求体：

json
{}

成功响应：

json
{"ok":null,"id":293}

云API（cloud，仅固件1.6.x支持）

所有信息接口使用GET方法（无查询参数）：

/api/cloud/info/status
/api/cloud/info/history
/api/cloud/info/missionHistory

所有操作接口使用GET方法（无查询参数）：

/api/cloud/action/clean
/api/cloud/action/quick
/api/cloud/action/spot
/api/cloud/action/dock
/api/cloud/action/start
/api/cloud/action/stop
/api/cloud/action/pause
/api/cloud/action/resume
/api/cloud/action/wake
/api/cloud/action/reset
/api/cloud/action/find
/api/cloud/action/wipe
/api/cloud/action/sleep
/api/cloud/action/off
/api/cloud/action/fbeep

示例：开始清洁

http
GET http://192.168.1.110:3000/api/cloud/action/clean

成功响应：

json
{"status":"OK","method":"multipleFieldSet"}

静态文件服务

可将图片或文件添加到public/文件夹，服务将提供静态文件访问。

实验性实时地图

通过浏览器访问http://serverIP:3000/map，可体验实验性实时地图功能。

!实时地图

视频演示：使用dorita980库的iRobot Roomba 980清洁地图

镜像拉取方式

您可以使用以下命令拉取该镜像。请将 <标签> 替换为具体的标签版本。如需查看所有可用标签版本，请访问标签列表页面。

轩辕镜像加速拉取命令点我查看更多 rest980 镜像标签

docker pull docker.xuanyuan.run/koalazak/rest980:<标签>

使用方法：

DockerHub 原生拉取命令

docker pull koalazak/rest980:<标签>

轩辕镜像配置手册

按平台快速找到配置文档

一键安装

一键安装 Docker

Linux Docker 一键安装

AI

用 AI 使用轩辕镜像

agents.md · AI 对话 · 提示词

Docker

登录仓库拉取

登录认证 · 私有仓库

专属域名拉取

免登录 · 高速拉取

Linux

Docker 镜像配置

Windows / Mac

Docker Desktop 配置

MacOS OrbStack

OrbStack 容器

Apple Container

macOS 原生容器

Docker Compose

Compose 项目配置

NAS

群晖

Synology 配置

飞牛

fnOS 镜像配置

绿联

绿联 NAS

威联通

QNAP 配置

极空间

极空间 NAS

Unraid

Unraid NAS

企业仓库

其他仓库

ghcr · Quay · nvcr

Harbor 镜像源

Proxy Repository 对接

Portainer 镜像源

Registries 配置

Nexus 镜像源

Docker Proxy 缓存

开发工具

Dev Containers

VS Code 开发容器

Podman

Podman 配置指南

Singularity / Apptainer

HPC 科学计算容器

Kubernetes

K8s Containerd

Kubernetes · Containerd

K3s

轻量级集群

面板 / 网络

爱快路由

iKuai 镜像加速

宝塔面板

一键配置镜像源

需要其他帮助？请查看我们的常见问题Docker 镜像访问常见问题解答或提交工单

镜像拉取常见问题

功能

版本功能对比

功能对比 · 版本选择

支持的镜像仓库

Docker Hub · GCR · GHCR

新手拉取配置

docker search 限制

专属域名 · Hub 搜索

不支持 push

仅支持 pull · 不支持

拉取速度原因

带宽 · 缓存 · 冷热镜像

错误码

402 与流量用尽

402 · 流量包 · 充值

401 认证失败

401 · docker login

manifest unknown

标签错误 · 镜像不存在

410 Gone 排查

410 · Docker 升级

429 限流

免费版 · 专业版 · 企业版 · 请求频率

其他报错

DNS 超时

DNS 解析 · 网络超时

TLS 证书失败

no matching manifest（架构）

账号

失败是否计费

manifest · blob · 计费

申请开发票（企业 / 个人）

企业 · 个人 · 工单

修改登录密码

网站 · 仓库 · 重置

注销账户

工单 · 数据 · 注销

原理

mirrors 不生效

daemon.json · 重启

去掉域名前缀

docker tag · 重命名

指定架构拉取

ARM64 · AMD64 · 多架构

latest 与「最新」

digest · 版本号 · 标签

查看全部问题→

用户好评

来自真实用户的反馈，见证轩辕镜像的优质服务

oldzhang

运维工程师

Linux服务器

"Docker访问体验非常流畅，大镜像也能快速完成下载。"