Files
CPY_DevAdmin/scanner_service/state_machine_design_guide.md
T

165 lines
4.8 KiB
Markdown
Executable File
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 状态机设计指南
## 一、状态图绘制指南
### 1. 状态图包含要素
为了确保状态图能准确转换为代码,请包含以下要素:
| 要素 | 说明 | 示例 |
|------|------|------|
| **状态名称** | 清晰描述系统状态 | `scanner1_scanning` |
| **状态转换** | 状态间的变化路径 | `scanner1_scanning → scanner1_waiting` |
| **触发事件** | 导致转换的信号 | `scanner1_complete` |
| **转换条件** | 转换发生的条件 | `if position == upper_limit` |
| **执行动作** | 转换时执行的操作 | `on_scanner1_scanning_start()` |
| **初始状态** | 系统初始状态 | `all_stopped` |
### 2. 状态图绘制工具推荐
- **在线工具**:
- [draw.io](https://app.diagrams.net/) - 免费、功能强大
- [Lucidchart](https://www.lucidchart.com/) - 专业UML绘图
- [PlantUML](https://plantuml.com/state-diagram) - 文本描述生成图形
- **本地工具**:
- Microsoft Visio
- StarUML
- Visual Studio Code 插件 (如 PlantUML)
### 3. 绘制示例(PlantUML语法)
```plantuml
@startuml
skinparam state {
StartColor red
EndColor silver
BackgroundColor beige
BorderColor gray
FontName Helvetica
}
[*] --> all_stopped
state all_stopped {
}
state scanner1_scanning {
}
state scanner1_waiting {
}
state scanner2_scanning {
}
state scanner2_waiting {
}
all_stopped --> scanner1_scanning : start_scanner1
transition all_stopped --> scanner2_scanning : start_scanner2
scanner1_scanning --> scanner1_waiting : scanner1_complete
scanner2_scanning --> scanner2_waiting : scanner2_complete
scanner1_waiting --> scanner2_scanning : start_scanner2
scanner2_waiting --> scanner1_scanning : start_scanner1
scanner1_scanning --> all_stopped : stop_all
scanner1_waiting --> all_stopped : stop_all
scanner2_scanning --> all_stopped : stop_all
scanner2_waiting --> all_stopped : stop_all
@enduml
```
## 二、代码实现对应关系
### 1. 状态映射
| 状态图要素 | 代码实现 |
|------------|----------|
| 状态 | `self.states = ['state1', 'state2', ...]` |
| 转换 | `self.transitions = [{'trigger': 'event', 'source': 'from_state', 'dest': 'to_state'}]` |
| 初始状态 | `Machine(initial='initial_state')` |
| 动作 | `self.on_enter_state_name(action_function)` |
### 2. 事件处理
```python
# 状态转换定义
self.transitions = [
{'trigger': 'start_scanner1', 'source': 'all_stopped', 'dest': 'scanner1_scanning'},
{'trigger': 'scanner1_complete', 'source': 'scanner1_scanning', 'dest': 'scanner1_waiting'},
# 更多转换...
]
# 状态进入动作
self.on_enter_scanner1_scanning(self.on_scanner1_scanning_start)
# 动作实现
def on_scanner1_scanning_start(self):
"""1号扫描开始时的回调"""
self.start_scanning(self.ID_MT1)
```
## 三、交付要求
请提供:
1. **状态图文件**:支持格式包括 PNG、JPG、SVG 或 PlantUML 文本
2. **状态说明文档**:
- 每个状态的含义
- 每个事件的触发条件
- 每个动作的具体功能
3. **特殊需求说明**:
- 超时处理
- 错误恢复机制
- 并发控制要求
## 四、示例状态图与代码对应
### 状态图
```
[*] → all_stopped
all_stopped → scanner1_scanning : start_scanner1
scanner1_scanning → scanner1_waiting : scanner1_complete
scanner1_waiting → scanner2_scanning : start_scanner2
scanner2_scanning → scanner2_waiting : scanner2_complete
scanner2_waiting → scanner1_scanning : start_scanner1
```
### 对应代码
```python
from transitions import Machine
class MotorManager:
def __init__(self):
# 定义状态
self.states = ['all_stopped', 'scanner1_scanning', 'scanner1_waiting', 'scanner2_scanning', 'scanner2_waiting']
# 定义转换
self.transitions = [
{'trigger': 'start_scanner1', 'source': ['all_stopped', 'scanner2_waiting'], 'dest': 'scanner1_scanning'},
{'trigger': 'scanner1_complete', 'source': 'scanner1_scanning', 'dest': 'scanner1_waiting'},
{'trigger': 'start_scanner2', 'source': ['all_stopped', 'scanner1_waiting'], 'dest': 'scanner2_scanning'},
{'trigger': 'scanner2_complete', 'source': 'scanner2_scanning', 'dest': 'scanner2_waiting'},
]
# 初始化状态机
self.machine = Machine(model=self, states=self.states, transitions=self.transitions, initial='all_stopped')
# 添加回调
self.on_enter_scanner1_scanning(self.on_scanner1_scanning_start)
self.on_enter_scanner2_scanning(self.on_scanner2_scanning_start)
def on_scanner1_scanning_start(self):
print("1号扫描器开始扫描")
def on_scanner2_scanning_start(self):
print("2号扫描器开始扫描")
```
---
请完成状态图绘制后,将文件保存到 `y:\CPY\CPY_AdminPlatform_V3.5\motor_service\` 目录下,然后告知我开始实现代码。