docs: align product scope with LAN ABSDK access
This commit is contained in:
+50
-58
@@ -13,18 +13,20 @@
|
||||
仓库目前主要包含：
|
||||
|
||||
- 产品需求概要；
|
||||
- ABSDK 0630 接口文档；
|
||||
- AsyncTask 登录示例；
|
||||
- ABSDK 0630 接口文档与协议观测记录；
|
||||
- 正式 Android 应用工程（含提供方登录与本地体验运行时）；
|
||||
- ABSDK 防腐层、领域接口、模拟运行时和测试 Fake；
|
||||
- 清理归档后的 ABSDK Android Sample；
|
||||
- Git 和 AI 工具协作规则。
|
||||
|
||||
当前还没有正式的 Android 应用工程、自有后端、自动化测试或 CI Runner。
|
||||
当前还没有设备目录、插座温湿度、红外和情景模式的正式实现，也没有 CI Runner。
|
||||
|
||||
重要参考资料：
|
||||
|
||||
```text
|
||||
docs/requirement_spec.md
|
||||
docs/ABSDK接口部分_0630.md
|
||||
docs/protocol/absdk-0630.md
|
||||
docs/architecture.md
|
||||
docs/examples/
|
||||
samples/abox-sdk-sample/
|
||||
```
|
||||
@@ -49,42 +51,46 @@ ABox Manager 是面向 Android 手机和平板的智能家居管理应用，首
|
||||
|
||||
## 4. MVP 范围
|
||||
|
||||
### 4.1 登录
|
||||
### 4.1 ABox 登录
|
||||
|
||||
以下登录要求只适用于 ABox 提供方；本地体验不需要凭据，也不显示登录页面。
|
||||
|
||||
- 支持用户名和密码登录；
|
||||
- 支持记住用户名；
|
||||
- 支持按连接配置独立开启自动登录；
|
||||
- 支持独立开启自动登录；
|
||||
- 自动登录所需密码必须通过 Android Keystore 安全保存；
|
||||
- ABSDK Token 由 SDK 自身管理；进程重启或 Token 失效后，通过保存的凭据重新登录；
|
||||
- 退出登录时保留非敏感连接信息和用户名，清除密码与会话；
|
||||
- 切换后端提供方前必须退出当前会话。
|
||||
- 退出登录时保留用户名，清除密码与会话。
|
||||
|
||||
### 4.2 提供方模式
|
||||
|
||||
应用计划兼容三种相互独立的模式：
|
||||
应用提供两种入口，认证前必须选择其一：
|
||||
|
||||
1. **ABox 后端**：使用现有 ABSDK 0630 连接 ABox 服务；
|
||||
2. **自有兼容后端**：连接自行实现的 ABSDK 0630 协议兼容服务；
|
||||
3. **本地体验**：不连接远端服务，通过本地模拟数据体验完整应用流程。
|
||||
1. **ABox**：通过 ABSDK 0630 连接当前局域网中的智能家居网关；
|
||||
2. **本地体验**：不访问网络或 ABSDK，通过本地模拟数据直接进入完整应用流程。
|
||||
|
||||
首版不提供自有兼容后端入口，也不再规划兼容服务端。
|
||||
|
||||
约束：
|
||||
|
||||
- 任一时刻只使用一个提供方；
|
||||
- 不要求同时连接两个后端；
|
||||
- ABox 与自有后端的账号、会话和数据不互相绑定；
|
||||
- 每个连接配置拥有独立的设备、遥控器、情景和凭据空间；
|
||||
- 任一时刻只启用一个提供方；
|
||||
- 切换提供方前必须退出当前会话；
|
||||
- 每个提供方的会话、设备、遥控器、情景和凭据空间互不混用；
|
||||
- 本地体验不启动 HTTP 服务，也不调用 ABSDK。
|
||||
|
||||
### 4.3 设备目录
|
||||
|
||||
ABSDK 0630 当前没有已确认的设备列表接口，因此首版设备目录采用：
|
||||
ABSDK 0630 当前没有已确认的设备列表接口，也不提供设备目录。首版设备目录按提供方区分：
|
||||
|
||||
- ABox：由设备目录模块负责的本地持久化目录（二维码批量导入，用户手工添加、编辑和删除）；
|
||||
- 本地体验：由模拟运行时内置的模拟设备目录。
|
||||
|
||||
共同约束：
|
||||
|
||||
- 二维码批量导入；
|
||||
- 用户手工添加、编辑和删除；
|
||||
- 设备名称作为调用 ABSDK 的设备标识；
|
||||
- 设备类型首版只包含插座、温湿度和红外。
|
||||
|
||||
不得假设存在尚未确认的新版 SDK 或设备发现接口。
|
||||
不得假设存在尚未确认的新版 SDK 或远程设备发现接口。
|
||||
|
||||
### 4.4 插座
|
||||
|
||||
@@ -178,25 +184,15 @@ ABSDK 0630 当前没有已确认的设备列表接口，因此首版设备目录
|
||||
- 切换提供方前必须结束当前会话；
|
||||
- `docs/examples/` 和 `samples/abox-sdk-sample/` 只作为参考，不直接作为正式架构。
|
||||
|
||||
### 5.3 自有兼容后端
|
||||
### 5.3 模拟运行时
|
||||
|
||||
自有后端目标是兼容 ABSDK 0630 的必要服务端行为。
|
||||
本地体验由生产模块 `:runtime:simulation` 提供确定性模拟实现：
|
||||
|
||||
暂定方向：
|
||||
- 不依赖网络、ABSDK 或 Android API；
|
||||
- 内置固定的模拟设备目录和设备状态；
|
||||
- 与 ABox 共用同一套领域端口，UI 不感知差异。
|
||||
|
||||
- Kotlin 和 Ktor；
|
||||
- 旧协议只存在于兼容适配边界；
|
||||
- 内部使用类型化领域模型；
|
||||
- 密码使用强哈希保存；
|
||||
- 酒店与房间作为数据隔离边界；
|
||||
- 管理操作通过内置 CLI 完成；
|
||||
- 提供模拟设备驱动；
|
||||
- 为未来真实设备驱动预留统一接口；
|
||||
- SQLite 用于轻量部署；
|
||||
- PostgreSQL 用于较大规模部署；
|
||||
- Docker 作为标准交付方式。
|
||||
|
||||
具体协议、签名和连接方式必须先验证，不在本文档中提前固化。
|
||||
测试专用的脚本化 Fake 保留在 `:testing:fakes`，不进入生产依赖。
|
||||
|
||||
---
|
||||
|
||||
@@ -222,21 +218,20 @@ ABSDK 0630 当前没有已确认的设备列表接口，因此首版设备目录
|
||||
- 建立 Compose、Navigation、Hilt、Room 和 DataStore 基础；
|
||||
- 建立公共设计系统基础；
|
||||
- 接入和封装 ABSDK 0630；
|
||||
- 建立统一领域接口、错误模型和 Fake 实现；
|
||||
- 实现 ABox、自有兼容后端和本地体验三个入口；
|
||||
- 建立统一领域接口、错误模型和测试 Fake；
|
||||
- 实现 ABox 和本地体验两个入口，以及按活动提供方的设备操作路由；
|
||||
- 实现记住用户名、自动登录、Keystore 凭据保存和退出；
|
||||
- 处理 Token 失效与重新登录；
|
||||
- 研究 SDK 已确认行为和协议边界；
|
||||
- 建立自有兼容后端基础、测试宿主、CLI 和 Docker 基础。
|
||||
- 研究 SDK 已确认行为和协议边界。
|
||||
|
||||
主要交付：
|
||||
|
||||
```text
|
||||
工程基础
|
||||
SDK 适配层
|
||||
SDK 适配层（AbsdkBridge）
|
||||
本地体验模拟运行时
|
||||
登录与提供方选择
|
||||
公共领域接口与 Fake
|
||||
兼容后端基础
|
||||
公共领域接口与测试 Fake
|
||||
```
|
||||
|
||||
### 6.2 alZerNest：设备列表导航
|
||||
@@ -402,8 +397,7 @@ tzh：
|
||||
|
||||
退出条件：
|
||||
|
||||
- Android App 可以使用 Fake 完成主要页面导航；
|
||||
- 服务端骨架可以独立启动；
|
||||
- Android App 可以使用 Fake 或本地体验完成主要页面导航；
|
||||
- 所有人拥有可独立测试的模块。
|
||||
|
||||
### 阶段 2：完整功能实现
|
||||
@@ -412,8 +406,7 @@ tzh：
|
||||
- 完成登录和提供方隔离；
|
||||
- 完成设备目录导入和维护；
|
||||
- 完成插座、温湿度和红外；
|
||||
- 完成情景模式；
|
||||
- 完成自有兼容后端的已确认协议范围。
|
||||
- 完成情景模式。
|
||||
|
||||
退出条件：
|
||||
|
||||
@@ -423,8 +416,7 @@ tzh：
|
||||
|
||||
### 阶段 3：真实集成
|
||||
|
||||
- 连接真实 ABox 环境；
|
||||
- 连接自有兼容后端；
|
||||
- 在网关局域网内连接真实 ABox 环境；
|
||||
- 使用真实插座、温湿度和红外设备；
|
||||
- 验证 Token 失效、设备离线和错误码；
|
||||
- 验证手机和平板布局。
|
||||
@@ -432,7 +424,7 @@ tzh：
|
||||
退出条件：
|
||||
|
||||
- 三类真实硬件核心流程通过；
|
||||
- ABox 与自有后端连接行为明确；
|
||||
- ABox 局域网连接行为明确；
|
||||
- 已知限制完整记录。
|
||||
|
||||
### 阶段 4：发布验收
|
||||
@@ -459,7 +451,6 @@ tzh：
|
||||
feat/project-foundation
|
||||
feat/absdk-bridge
|
||||
feat/provider-login
|
||||
feat/compatible-server
|
||||
```
|
||||
|
||||
### alZerNest
|
||||
@@ -530,17 +521,18 @@ feat/app-integration
|
||||
|
||||
- 领域模型和执行逻辑单元测试；
|
||||
- SDK 返回和错误映射测试；
|
||||
- 提供方选择、会话协调和设备操作路由测试；
|
||||
- 模拟运行时行为测试；
|
||||
- ViewModel 状态测试；
|
||||
- Room 持久化测试；
|
||||
- Compose 核心页面测试；
|
||||
- 情景顺序执行和失败继续测试；
|
||||
- 自有兼容后端认证、存储和模拟驱动测试；
|
||||
- Docker 和 CLI 验证。
|
||||
- 情景顺序执行和失败继续测试。
|
||||
|
||||
### 11.2 手工验收
|
||||
|
||||
- 登录、自动登录和退出；
|
||||
- 三种提供方入口；
|
||||
- ABox 登录、自动登录和退出；
|
||||
- 本地体验直接进入应用；
|
||||
- 两种提供方入口；
|
||||
- 数据和凭据隔离；
|
||||
- 设备目录导入和维护；
|
||||
- 插座状态和控制；
|
||||
@@ -573,11 +565,11 @@ Runner 就绪后，再将相同命令配置为受保护 `main` 的必要检查
|
||||
- ABSDK 0630 的完整初始化流程；
|
||||
- `setHostInfo` 的正式业务含义；
|
||||
- ABox 官方部署所需参数；
|
||||
- 自有后端与原始 JAR 的最终连接方式；
|
||||
- SDK 的完整签名算法和参数规则；
|
||||
- SDK 线程安全与会话清理行为；
|
||||
- 真实测试账号、设备名称和硬件环境；
|
||||
- 自有后端连接真实设备所使用的网关协议；
|
||||
- 授权凭据下完整的 ABox 登录与设备操作冒烟验证；
|
||||
- JAR 硬编码域名与局域网网关地址之间的映射机制（详见 `docs/protocol/absdk-0630.md`）；
|
||||
- ABSDK 二进制的生产分发许可。
|
||||
|
||||
上述事项必须通过厂商资料、授权分析、实验或真实环境验证后，再更新本文档或对应技术文档。
|
||||
|
||||
Reference in New Issue
Block a user