[OpenClaw 文档]参考--RPC 与 API

.ocdoc h2 { margin-top:2em; padding-bottom:.3em; border-bottom:2px solid #FF5A36; color:#FF5A36; }
.ocdoc h3 { margin-top:1.5em; color:#333; }
.ocdoc pre { background:#1e1e2e; color:#cdd6f4; padding:16px; border-radius:8px; overflow-x:auto; font-size:14px; line-height:1.6; }
.ocdoc code { font-family:'JetBrains Mono','Fira Code',Consolas,monospace; }
.ocdoc pre code { background:none; padding:0; color:inherit; }
.ocdoc :not(pre)>code { background:#f0f0f0; padding:2px 6px; border-radius:3px; font-size:.9em; color:#d63384; }
.ocdoc table { border-collapse:collapse; margin:1em 0; }
.ocdoc th,.ocdoc td { border:1px solid #ddd; padding:8px 12px; }
.ocdoc th { background:#f5f5f5; }
.ocdoc blockquote { border-left:4px solid #FF5A36; padding:.5em 1em; background:#fff7f4; color:#555; margin:1em 0; }
.ocdoc .page-sep { margin:2.5em 0; border:none; border-top:1px dashed #ccc; }
.ocdoc .page-title { color:#444; font-size:1.3em; margin-top:1em; padding:.4em .6em; background:#fafafa; border-left:4px solid #FF5A36; }
.ocdoc .src-link { font-size:.85em; color:#888; margin-top:2em; padding-top:1em; border-top:1px solid #e0e0e0; }
.ocdoc .toc-box { background:#f8f9fa; padding:1em 1.5em; border-radius:6px; margin:1em 0; }

[OpenClaw 文档]参考--RPC 与 API

本文档汇总了 OpenClaw 官方文档站 参考 > RPC 与 API 子模块下的全部 2 篇内容,源自 docs.openclaw.ai/zh-CN

📑 本文目录(2 篇)

  1. RPC 适配器
  2. 设备型号数据库

📄 RPC 适配器

原文:https://docs.openclaw.ai/zh-CN/reference/rpc

OpenClaw 通过 JSON-RPC 集成外部 CLI。目前使用两种模式。

模式 A:HTTP 守护进程(signal-cli)

  • signal-cli 作为守护进程运行,通过 HTTP 提供 JSON-RPC。
  • 事件流是 SSE(/api/v1/events)。
  • 健康探针:/api/v1/check
  • channels.signal.autoStart=true 时,OpenClaw 拥有生命周期管理。

请参阅 Signal 了解设置和端点。

模式 B:标准输入/输出子进程(imsg)

  • OpenClaw 为 iMessageimsg rpc 作为子进程启动。
  • JSON-RPC 通过 stdin/stdout 按行分隔传输(每行一个 JSON 对象)。
  • 不需要 TCP 端口,也不需要守护进程。

使用的核心方法:

  • watch.subscribe → 通知(method: "message"
  • watch.unsubscribe
  • send
  • chats.list(探针/诊断)

请参阅 iMessage 了解旧版设置和寻址(推荐使用 chat_id)。

适配器指南

  • Gateway 网关拥有该进程(启动/停止绑定到提供商生命周期)。
  • 保持 RPC 客户端有韧性:超时、退出时重启。
  • 优先使用稳定 ID(例如 chat_id),而不是显示字符串。

相关


📄 设备型号数据库

原文:https://docs.openclaw.ai/zh-CN/reference/device-models

macOS 配套应用会在 Instances UI 中显示友好的 Apple 设备型号名称,方法是将 Apple 型号标识符(例如 iPad16,6Mac16,6)映射为人类可读的名称。

该映射以 JSON 形式内置在以下位置:

  • apps/macos/Sources/OpenClaw/Resources/DeviceModels/

数据来源

我们当前从以下 MIT 许可仓库内置该映射:

  • kyle-seongwoo-jun/apple-device-identifiers

为了保持构建的确定性,这些 JSON 文件被固定到特定的上游提交(记录在 apps/macos/Sources/OpenClaw/Resources/DeviceModels/NOTICE.md 中)。

更新数据库

  1. 选择你要固定的上游提交(一个用于 iOS,一个用于 macOS)。
  2. 更新 apps/macos/Sources/OpenClaw/Resources/DeviceModels/NOTICE.md 中的提交哈希。
  3. 重新下载这些 JSON 文件,并固定到这些提交:
IOS_COMMIT="<commit sha for ios-device-identifiers.json>"
MAC_COMMIT="<commit sha for mac-device-identifiers.json>"

curl -fsSL "https://raw.githubusercontent.com/kyle-seongwoo-jun/apple-device-identifiers/${IOS_COMMIT}/ios-device-identifiers.json" \
  -o apps/macos/Sources/OpenClaw/Resources/DeviceModels/ios-device-identifiers.json

curl -fsSL "https://raw.githubusercontent.com/kyle-seongwoo-jun/apple-device-identifiers/${MAC_COMMIT}/mac-device-identifiers.json" \
  -o apps/macos/Sources/OpenClaw/Resources/DeviceModels/mac-device-identifiers.json
  1. 确保 apps/macos/Sources/OpenClaw/Resources/DeviceModels/LICENSE.apple-device-identifiers.txt 仍与上游一致(如果上游许可证变更,请替换它)。
  2. 验证 macOS 应用能够干净构建(无警告):
swift build --package-path apps/macos

相关内容

上一篇 [OpenClaw 文档]参考--CLI 命令
下一篇 [OpenClaw 文档]参考--模板