共伴协议 / 开发文档

A-B 设备交接项目模板

项目模板

把一次连接整理成别人能接着做的项目。

项目要回答四个问题

A 给出什么?桥接层如何理解?B 接收什么?怎样确认 B 真正做到了?用一条最小路径写清楚,再扩展其他设备。

  • 设备 A:名称、输入类型、获取方式和一份示例输入。
  • 桥接层:事件结构、Agent 输出结构及运行位置。
  • 设备 B:动作接口、回应方式和执行结果。
  • 验证:一条成功记录、一条失败记录和复测步骤。

建议的仓库结构

GitHub 仓库建立后,可将“上手步骤 + 两端适配器 + 可回放样例”放在同一个项目中。下面是组织建议,不是当前已有仓库。

README.md                 # 项目目标与快速开始
docs/architecture.md      # A → 桥接层 → B 的架构图
adapters/input/           # 设备 A 输入适配器
adapters/output/          # 设备 B 输出适配器
examples/                 # 一次输入与预期输出
tests/                    # 交接与失败场景

GitHub 入口

项目页已经为仓库地址预留位置。确定仓库及开源许可后,我们会把 GitHub 链接放到项目页,并在这里补上克隆、配置、运行和贡献步骤。现在可先在社区讨论设备交接方案。