添加示例文件
This commit is contained in:
18
docs/domain/README.md
Normal file
18
docs/domain/README.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# 通用规则层
|
||||
|
||||
本目录存放跨设备复用的 IoT 产品规则。这里的内容是单品 PDD 的引用来源，不针对某一款具体设备。
|
||||
|
||||
## 当前规则文档
|
||||
|
||||
- [HMI 全局交互字典](hmi-dictionary.md)
|
||||
- [设备生命周期状态](device-lifecycle.md)
|
||||
- [通用配网体验规则](networking.md)
|
||||
- [App 设备控制规则](app-device-control.md)
|
||||
- [通用异常与告警规则](alerts.md)
|
||||
|
||||
## 使用要求
|
||||
|
||||
- 每条通用规则必须有规则编号
|
||||
- 单品 PDD 只能引用通用规则，不复制规则全文
|
||||
- 修改通用规则时必须记录影响范围
|
||||
- 废弃规则应标记为已废弃，并说明替代规则
|
||||
65
docs/domain/alerts.md
Normal file
65
docs/domain/alerts.md
Normal file
@@ -0,0 +1,65 @@
|
||||
# 通用异常与告警规则
|
||||
|
||||
本文档定义 IoT 设备在异常情况下的通用产品体验。
|
||||
|
||||
## 适用范围
|
||||
|
||||
适用于需要向用户展示异常、限制操作或引导恢复的 IoT 设备。
|
||||
|
||||
## 规则列表
|
||||
|
||||
### 设备离线
|
||||
|
||||
规则编号：ALERT-DEVICE-OFFLINE
|
||||
|
||||
产品定义：设备当前无法被 App 确认在线状态，远程控制不可用或不可确认。
|
||||
|
||||
用户感知：App 展示离线状态，并提示用户检查电源、距离或网络环境。
|
||||
|
||||
触发条件：设备进入离线不可控状态。
|
||||
|
||||
例外情况：支持本地控制的设备，应在单品 PDD 中说明本体操作是否仍可使用。
|
||||
|
||||
被引用产品：
|
||||
|
||||
- [智能小夜灯 Mini PDD](../products/smart-lamp-mini/pdd.md)
|
||||
|
||||
### 控制失败
|
||||
|
||||
规则编号：ALERT-CONTROL-FAILED
|
||||
|
||||
产品定义：用户发起控制后，设备未能完成预期状态变化。
|
||||
|
||||
用户感知：App 展示控制失败，并提供可理解的原因或重试入口。
|
||||
|
||||
触发条件：设备离线、权限不足、设备受限、状态冲突或其他导致控制未生效的情况。
|
||||
|
||||
例外情况：如果控制结果无法确认，应展示处理中或状态未知，而不是直接展示成功。
|
||||
|
||||
被引用产品：
|
||||
|
||||
- [智能小夜灯 Mini PDD](../products/smart-lamp-mini/pdd.md)
|
||||
|
||||
### 设备过热保护
|
||||
|
||||
规则编号：ALERT-OVERHEAT-PROTECTION
|
||||
|
||||
产品定义：设备因温度异常进入保护状态，限制继续使用可能带来风险的能力。
|
||||
|
||||
用户感知：App 展示设备保护中，并提示用户等待设备恢复或检查使用环境。
|
||||
|
||||
触发条件：设备进入高温保护状态。
|
||||
|
||||
例外情况：不具备温度保护能力或不存在发热风险的设备不适用。
|
||||
|
||||
被引用产品：
|
||||
|
||||
- [智能小夜灯 Mini PDD](../products/smart-lamp-mini/pdd.md)
|
||||
|
||||
## 版本记录
|
||||
|
||||
| 日期 | 规则编号 | 变更 |
|
||||
| --- | --- | --- |
|
||||
| 2026-06-09 | ALERT-DEVICE-OFFLINE | 新增设备离线告警 |
|
||||
| 2026-06-09 | ALERT-CONTROL-FAILED | 新增控制失败告警 |
|
||||
| 2026-06-09 | ALERT-OVERHEAT-PROTECTION | 新增过热保护告警 |
|
||||
99
docs/domain/app-device-control.md
Normal file
99
docs/domain/app-device-control.md
Normal file
@@ -0,0 +1,99 @@
|
||||
# App 设备控制规则
|
||||
|
||||
本文档定义 App 控制 IoT 设备时的通用产品体验。
|
||||
|
||||
## 适用范围
|
||||
|
||||
适用于用户可以通过 App 查看状态、发起控制或管理权限的设备。
|
||||
|
||||
## 规则列表
|
||||
|
||||
### 控制状态一致
|
||||
|
||||
规则编号：APP-CONTROL-STATE-CONSISTENCY
|
||||
|
||||
产品定义：App 展示的设备状态应尽量与用户可感知的设备状态保持一致。
|
||||
|
||||
用户感知：用户在 App 中看到的开关、状态文案和设备真实表现不应产生明显冲突。
|
||||
|
||||
触发条件：用户进入设备详情页、发起控制、设备状态变化或收到共享设备状态变化。
|
||||
|
||||
例外情况：离线、弱网、OTA 升级或设备本地操作导致 App 尚未确认状态时，应展示过渡或不可确认状态。
|
||||
|
||||
被引用产品：
|
||||
|
||||
- [智能小夜灯 Mini PDD](../products/smart-lamp-mini/pdd.md)
|
||||
|
||||
### 控制反馈
|
||||
|
||||
规则编号：APP-CONTROL-FEEDBACK
|
||||
|
||||
产品定义：用户发起控制后，App 应给出明确反馈，避免用户不知道操作是否被接收。
|
||||
|
||||
用户感知：控制成功时，App 展示新的状态；控制失败时，App 展示失败原因或重试入口；状态未确认时，App 展示处理中。
|
||||
|
||||
触发条件：用户通过 App 操作开关、亮度、定时、场景或自动化。
|
||||
|
||||
例外情况：仅本体控制设备不适用。
|
||||
|
||||
被引用产品：
|
||||
|
||||
- [智能小夜灯 Mini PDD](../products/smart-lamp-mini/pdd.md)
|
||||
|
||||
### 离线控制限制
|
||||
|
||||
规则编号：APP-CONTROL-OFFLINE-LIMIT
|
||||
|
||||
产品定义：设备离线时，App 不应让用户误以为远程控制已经立即生效。
|
||||
|
||||
用户感知：用户可以看到设备离线，控制入口应被限制或明确提示不可用。
|
||||
|
||||
触发条件：设备处于离线不可控状态时，用户尝试控制设备。
|
||||
|
||||
例外情况：如果产品支持离线指令排队，应在单品 PDD 中明确说明用户预期和生效条件。
|
||||
|
||||
被引用产品：
|
||||
|
||||
- [智能小夜灯 Mini PDD](../products/smart-lamp-mini/pdd.md)
|
||||
|
||||
### 多入口控制覆盖
|
||||
|
||||
规则编号：APP-CONTROL-MULTI-ENTRY-SYNC
|
||||
|
||||
产品定义：当设备可由 App、本体按键、定时、场景或自动化等多个入口控制时，最新生效的控制结果应成为当前设备状态。
|
||||
|
||||
用户感知：用户在任一入口操作后，其他入口看到的状态应同步更新。
|
||||
|
||||
触发条件：多个控制入口先后改变同一设备状态。
|
||||
|
||||
例外情况：如果某一入口被权限、离线或安全策略限制，应展示对应限制原因。
|
||||
|
||||
被引用产品：
|
||||
|
||||
- [智能小夜灯 Mini PDD](../products/smart-lamp-mini/pdd.md)
|
||||
|
||||
### 权限不足
|
||||
|
||||
规则编号：APP-CONTROL-PERMISSION-DENIED
|
||||
|
||||
产品定义：用户没有控制权限时，App 不应允许其完成控制。
|
||||
|
||||
用户感知：用户看到权限限制说明，并知道需要联系设备拥有者或切换账号。
|
||||
|
||||
触发条件：共享用户、访客用户或未授权用户尝试执行受限操作。
|
||||
|
||||
例外情况：只读共享设备可展示状态，但不得提供有效控制入口。
|
||||
|
||||
被引用产品：
|
||||
|
||||
- [智能小夜灯 Mini PDD](../products/smart-lamp-mini/pdd.md)
|
||||
|
||||
## 版本记录
|
||||
|
||||
| 日期 | 规则编号 | 变更 |
|
||||
| --- | --- | --- |
|
||||
| 2026-06-09 | APP-CONTROL-STATE-CONSISTENCY | 新增状态一致规则 |
|
||||
| 2026-06-09 | APP-CONTROL-FEEDBACK | 新增控制反馈规则 |
|
||||
| 2026-06-09 | APP-CONTROL-OFFLINE-LIMIT | 新增离线控制限制规则 |
|
||||
| 2026-06-09 | APP-CONTROL-MULTI-ENTRY-SYNC | 新增多入口控制覆盖规则 |
|
||||
| 2026-06-09 | APP-CONTROL-PERMISSION-DENIED | 新增权限不足规则 |
|
||||
99
docs/domain/device-lifecycle.md
Normal file
99
docs/domain/device-lifecycle.md
Normal file
@@ -0,0 +1,99 @@
|
||||
# 设备生命周期状态
|
||||
|
||||
本文档定义 IoT 设备从出厂到日常使用中的通用产品状态。
|
||||
|
||||
## 适用范围
|
||||
|
||||
适用于需要绑定、联网、远程控制或 App 管理的 IoT 设备。
|
||||
|
||||
## 规则列表
|
||||
|
||||
### 出厂未绑定
|
||||
|
||||
规则编号：DEVICE-UNBOUND
|
||||
|
||||
产品定义：设备尚未绑定到任何用户账号。
|
||||
|
||||
用户感知：用户需要通过 App 添加设备后才能进行完整控制。
|
||||
|
||||
触发条件：新设备首次上电、用户重置设备，或设备被解除绑定后回到可绑定状态。
|
||||
|
||||
例外情况：不支持 App 绑定的设备不适用。
|
||||
|
||||
被引用产品：
|
||||
|
||||
- [智能小夜灯 Mini PDD](../products/smart-lamp-mini/pdd.md)
|
||||
|
||||
### 配网中
|
||||
|
||||
规则编号：DEVICE-PAIRING
|
||||
|
||||
产品定义：设备正在等待用户通过 App 完成添加、配网或绑定。
|
||||
|
||||
用户感知：App 展示添加流程，设备本体进入可识别的配网提示状态。
|
||||
|
||||
触发条件：设备进入配网模式，或用户在 App 中发起添加设备。
|
||||
|
||||
例外情况：仅本地控制设备不适用。
|
||||
|
||||
被引用产品：
|
||||
|
||||
- [智能小夜灯 Mini PDD](../products/smart-lamp-mini/pdd.md)
|
||||
|
||||
### 在线可控
|
||||
|
||||
规则编号：DEVICE-ONLINE-CONTROLLABLE
|
||||
|
||||
产品定义：设备已绑定且当前可以被 App 控制。
|
||||
|
||||
用户感知：用户可在 App 中查看设备状态，并发起控制操作。
|
||||
|
||||
触发条件：设备完成绑定，并处于可被用户控制的状态。
|
||||
|
||||
例外情况：设备处于 OTA 升级限制、故障保护或权限不足场景时，不应展示为完全可控。
|
||||
|
||||
被引用产品：
|
||||
|
||||
- [智能小夜灯 Mini PDD](../products/smart-lamp-mini/pdd.md)
|
||||
|
||||
### 离线不可控
|
||||
|
||||
规则编号：DEVICE-OFFLINE-UNCONTROLLABLE
|
||||
|
||||
产品定义：设备已绑定，但当前无法通过 App 完成远程控制。
|
||||
|
||||
用户感知：App 展示离线状态，不允许用户误以为控制已经生效。
|
||||
|
||||
触发条件：设备断电、网络不可用、距离过远或其他导致 App 无法确认控制结果的情况。
|
||||
|
||||
例外情况：设备本体按键仍可使用时，应在单品 PDD 中说明本地控制是否可用。
|
||||
|
||||
被引用产品：
|
||||
|
||||
- [智能小夜灯 Mini PDD](../products/smart-lamp-mini/pdd.md)
|
||||
|
||||
### OTA 升级限制
|
||||
|
||||
规则编号：DEVICE-OTA-LIMITED
|
||||
|
||||
产品定义：设备正在升级，部分或全部控制能力临时不可用。
|
||||
|
||||
用户感知：App 明确展示升级中状态，并避免用户重复操作造成误解。
|
||||
|
||||
触发条件：设备进入固件升级流程。
|
||||
|
||||
例外情况：紧急关闭、断电保护等安全相关能力可由单品 PDD 另行定义。
|
||||
|
||||
被引用产品：
|
||||
|
||||
- [智能小夜灯 Mini PDD](../products/smart-lamp-mini/pdd.md)
|
||||
|
||||
## 版本记录
|
||||
|
||||
| 日期 | 规则编号 | 变更 |
|
||||
| --- | --- | --- |
|
||||
| 2026-06-09 | DEVICE-UNBOUND | 新增出厂未绑定状态 |
|
||||
| 2026-06-09 | DEVICE-PAIRING | 新增配网中状态 |
|
||||
| 2026-06-09 | DEVICE-ONLINE-CONTROLLABLE | 新增在线可控状态 |
|
||||
| 2026-06-09 | DEVICE-OFFLINE-UNCONTROLLABLE | 新增离线不可控状态 |
|
||||
| 2026-06-09 | DEVICE-OTA-LIMITED | 新增 OTA 升级限制状态 |
|
||||
128
docs/domain/hmi-dictionary.md
Normal file
128
docs/domain/hmi-dictionary.md
Normal file
@@ -0,0 +1,128 @@
|
||||
# HMI 全局交互字典
|
||||
|
||||
本文档定义无屏 IoT 设备常用的指示灯、按键和本体反馈语言。
|
||||
|
||||
## 适用范围
|
||||
|
||||
适用于具备本体按键、指示灯或简单反馈能力的无屏设备。
|
||||
|
||||
## 规则列表
|
||||
|
||||
### 白灯常亮
|
||||
|
||||
规则编号：HMI-LIGHT-WHITE-ON
|
||||
|
||||
适用范围：具备白色照明能力的灯类设备。
|
||||
|
||||
产品定义：主灯处于开启状态。
|
||||
|
||||
用户感知：用户可以直接看到设备发光。
|
||||
|
||||
触发条件：用户通过 App、本体按键、自动化、定时或其他被授权入口打开设备。
|
||||
|
||||
例外情况：设备进入故障保护、断电、离线不可控或 OTA 升级限制状态时，主灯表现以对应规则为准。
|
||||
|
||||
被引用产品：
|
||||
|
||||
- [智能小夜灯 Mini PDD](../products/smart-lamp-mini/pdd.md)
|
||||
|
||||
### 白灯熄灭
|
||||
|
||||
规则编号：HMI-LIGHT-WHITE-OFF
|
||||
|
||||
适用范围：具备白色照明能力的灯类设备。
|
||||
|
||||
产品定义：主灯处于关闭状态。
|
||||
|
||||
用户感知：用户可以直接看到设备不发光。
|
||||
|
||||
触发条件：用户通过 App、本体按键、自动化、定时或其他被授权入口关闭设备。
|
||||
|
||||
例外情况：设备断电时不等同于用户主动关闭，App 应根据设备状态区分展示。
|
||||
|
||||
被引用产品：
|
||||
|
||||
- [智能小夜灯 Mini PDD](../products/smart-lamp-mini/pdd.md)
|
||||
|
||||
### 蓝灯慢闪
|
||||
|
||||
规则编号：HMI-LIGHT-BLUE-SLOW
|
||||
|
||||
适用范围：具备蓝色状态指示灯的无屏设备。
|
||||
|
||||
产品定义：设备正在等待配网或绑定。
|
||||
|
||||
用户感知：用户可通过 App 搜索并绑定设备。
|
||||
|
||||
触发条件：设备进入配网状态。
|
||||
|
||||
例外情况：不具备独立状态指示灯的设备，应在单品 PDD 中定义替代体验。
|
||||
|
||||
被引用产品：
|
||||
|
||||
- [智能小夜灯 Mini PDD](../products/smart-lamp-mini/pdd.md)
|
||||
|
||||
### 蓝灯急闪三次
|
||||
|
||||
规则编号：HMI-LIGHT-BLUE-FAST-3
|
||||
|
||||
适用范围：具备蓝色状态指示灯的无屏设备。
|
||||
|
||||
产品定义：设备配网或绑定失败。
|
||||
|
||||
用户感知：用户可感知当前操作未成功，需要回到 App 查看失败原因并重试。
|
||||
|
||||
触发条件：配网失败、绑定失败或用户主动取消配网。
|
||||
|
||||
例外情况：失败原因需要由 App 展示，不应仅依赖指示灯表达。
|
||||
|
||||
被引用产品：
|
||||
|
||||
- [智能小夜灯 Mini PDD](../products/smart-lamp-mini/pdd.md)
|
||||
|
||||
### 按键短按
|
||||
|
||||
规则编号：HMI-BUTTON-SHORT-PRESS
|
||||
|
||||
适用范围：具备单个本体按键的设备。
|
||||
|
||||
产品定义：用户进行一次短时按压，用于触发设备最常用的即时操作。
|
||||
|
||||
用户感知：设备应在短按后立即给出可见或可感知反馈。
|
||||
|
||||
触发条件：用户短按设备按键。
|
||||
|
||||
例外情况：设备处于配网、OTA、故障保护等限制状态时，应在单品 PDD 中说明短按是否可用。
|
||||
|
||||
被引用产品：
|
||||
|
||||
- [智能小夜灯 Mini PDD](../products/smart-lamp-mini/pdd.md)
|
||||
|
||||
### 长按五秒
|
||||
|
||||
规则编号：HMI-BUTTON-LONG-PRESS-5S
|
||||
|
||||
适用范围：具备本体按键且支持重置的设备。
|
||||
|
||||
产品定义：用户长按按键 5 秒，用于触发设备重置或进入配网准备状态。
|
||||
|
||||
用户感知：设备进入可重新绑定或重新配网的状态。
|
||||
|
||||
触发条件：用户连续按住设备按键达到 5 秒。
|
||||
|
||||
例外情况：是否清除已有绑定关系，由对应产品的绑定规则或单品 PDD 定义。
|
||||
|
||||
被引用产品：
|
||||
|
||||
- [智能小夜灯 Mini PDD](../products/smart-lamp-mini/pdd.md)
|
||||
|
||||
## 版本记录
|
||||
|
||||
| 日期 | 规则编号 | 变更 |
|
||||
| --- | --- | --- |
|
||||
| 2026-06-09 | HMI-LIGHT-WHITE-ON | 新增灯类设备主灯开启规则 |
|
||||
| 2026-06-09 | HMI-LIGHT-WHITE-OFF | 新增灯类设备主灯关闭规则 |
|
||||
| 2026-06-09 | HMI-LIGHT-BLUE-SLOW | 新增配网等待状态规则 |
|
||||
| 2026-06-09 | HMI-LIGHT-BLUE-FAST-3 | 新增配网失败反馈规则 |
|
||||
| 2026-06-09 | HMI-BUTTON-SHORT-PRESS | 新增短按规则 |
|
||||
| 2026-06-09 | HMI-BUTTON-LONG-PRESS-5S | 新增长按五秒规则 |
|
||||
82
docs/domain/networking.md
Normal file
82
docs/domain/networking.md
Normal file
@@ -0,0 +1,82 @@
|
||||
# 通用配网体验规则
|
||||
|
||||
本文档定义 App 管理型 IoT 设备的通用配网体验。
|
||||
|
||||
## 适用范围
|
||||
|
||||
适用于需要用户通过 App 添加、联网或绑定的设备。
|
||||
|
||||
## 规则列表
|
||||
|
||||
### 进入配网
|
||||
|
||||
规则编号：NET-PAIRING-ENTER
|
||||
|
||||
产品定义：设备进入等待 App 添加的状态。
|
||||
|
||||
用户感知：设备本体应给出配网提示，App 应引导用户完成添加。
|
||||
|
||||
触发条件：新设备首次上电、用户长按重置按键，或用户在 App 中重新添加设备。
|
||||
|
||||
例外情况：设备无状态灯时，应在单品 PDD 中定义替代体验。
|
||||
|
||||
被引用产品：
|
||||
|
||||
- [智能小夜灯 Mini PDD](../products/smart-lamp-mini/pdd.md)
|
||||
|
||||
### 配网成功
|
||||
|
||||
规则编号：NET-PAIRING-SUCCESS
|
||||
|
||||
产品定义：设备完成添加、绑定并进入可管理状态。
|
||||
|
||||
用户感知：App 展示添加成功，并进入设备控制页或设备列表。
|
||||
|
||||
触发条件：设备完成用户授权下的绑定流程。
|
||||
|
||||
例外情况：如果设备添加成功但暂时不可控，App 应明确展示对应状态。
|
||||
|
||||
被引用产品：
|
||||
|
||||
- [智能小夜灯 Mini PDD](../products/smart-lamp-mini/pdd.md)
|
||||
|
||||
### 配网失败
|
||||
|
||||
规则编号：NET-PAIRING-FAILED
|
||||
|
||||
产品定义：设备未能完成添加、联网或绑定。
|
||||
|
||||
用户感知：App 展示失败原因和重试入口，设备本体给出失败提示。
|
||||
|
||||
触发条件：用户取消、设备未被发现、网络不可用、授权失败或设备状态不满足添加条件。
|
||||
|
||||
例外情况：失败原因无法判断时，App 使用通用失败提示。
|
||||
|
||||
被引用产品：
|
||||
|
||||
- [智能小夜灯 Mini PDD](../products/smart-lamp-mini/pdd.md)
|
||||
|
||||
### 配网超时
|
||||
|
||||
规则编号：NET-PAIRING-TIMEOUT
|
||||
|
||||
产品定义：设备进入配网流程后，如果在规定时间内未完成绑定，系统应判定为配网超时。
|
||||
|
||||
用户感知：App 展示配网失败，并提供重新配网入口。
|
||||
|
||||
触发条件：用户发起配网后，设备未在规定时间内完成绑定。
|
||||
|
||||
例外情况：具备屏幕的设备可以在屏幕端同步展示超时提示。
|
||||
|
||||
被引用产品：
|
||||
|
||||
- [智能小夜灯 Mini PDD](../products/smart-lamp-mini/pdd.md)
|
||||
|
||||
## 版本记录
|
||||
|
||||
| 日期 | 规则编号 | 变更 |
|
||||
| --- | --- | --- |
|
||||
| 2026-06-09 | NET-PAIRING-ENTER | 新增进入配网规则 |
|
||||
| 2026-06-09 | NET-PAIRING-SUCCESS | 新增配网成功规则 |
|
||||
| 2026-06-09 | NET-PAIRING-FAILED | 新增配网失败规则 |
|
||||
| 2026-06-09 | NET-PAIRING-TIMEOUT | 新增配网超时规则 |
|
||||
Reference in New Issue
Block a user