Files
CPY_DevAdmin/scanner_service/drawio_usage_guide.md
T

102 lines
4.0 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.
# Draw.io 使用指南:绘制UML状态图并保存本地
## 一、进入绘制界面
1. 打开 [draw.io](https://app.diagrams.net/)
2. 选择「Create New Diagram」(创建新图表)
3. 选择存储位置:点击「Device」(设备)→ 暂时不保存
4. 选择模板:点击「Blank Diagram」(空白图表)→ 点击「Create」
## 二、绘制UML状态图
### 1. 启用UML状态图工具
在左侧工具栏找到并点击「More Shapes」(更多形状):
- 展开「Software」(软件)→ 勾选「UML」
- 特别勾选「UML State Machine」(UML状态机)
- 点击「Apply」(应用)
### 2. 绘制基本元素
#### 初始状态
- 从左侧「UML State Machine」工具栏拖拽「Initial State」(实心圆)到画布
#### 普通状态
- 拖拽「State」(圆角矩形)到画布
- 双击状态框输入状态名称(如:`scanner1_scanning`)
- 右键点击状态 → 「Edit Style」(编辑样式)可修改颜色、边框等
#### 状态转换
- 从左侧工具栏拖拽「Transition」(带箭头的线)到画布
- 连接两个状态(起点状态 → 终点状态)
- 双击箭头输入触发事件(如:`scanner1_complete`)
#### 终止状态
- 从左侧工具栏拖拽「Final State」(同心圆)到画布(如果需要)
### 3. 高级设置
#### 转换条件
- 右键点击转换箭头 → 「Edit」(编辑)→ 「Add Condition」(添加条件)
- 输入条件(如:`if position == upper_limit`)
#### 状态动作
- 双击状态 → 进入编辑模式
- 输入格式:`状态名称\n/进入动作\n退出动作`
- 示例:`scanner1_scanning\n/on_scanner1_scanning_start()\non_scanner1_scanning_stop()`
#### 并行区域(可选)
- 使用「Composite State」(复合状态)创建嵌套区域
- 用于表示并发执行的状态
## 三、保存到本地
### 1. 保存为.drawio格式(可编辑)
- 点击顶部菜单栏「File」(文件)→ 「Save As」(另存为)
- 选择「Device」(设备)
- 选择保存位置(推荐保存到 `motor_service` 目录)
- 输入文件名(如:`scanner_state_machine.drawio`)
- 点击「Save」(保存)
### 2. 导出为图片格式(用于查看)
- 点击顶部菜单栏「File」(文件)→ 「Export As」(导出为)→ 「PNG」
- 设置图片参数:
- 「Include a border」(包含边框):可选
- 「Zoom」(缩放):100%
- 「Transparent Background」(透明背景):可选
- 点击「Export」(导出)
- 选择保存位置和文件名(如:`scanner_state_machine.png`)
- 点击「Save」(保存)
### 3. 导出为PDF格式(用于文档)
- 点击顶部菜单栏「File」(文件)→ 「Export As」(导出为)→ 「PDF」
- 设置PDF参数后点击「Export」(导出)
## 四、绘制示例(扫描器状态图)
按照之前的设计指南,绘制以下状态:
- 初始状态
- `all_stopped`
- `scanner1_scanning`
- `scanner1_waiting`
- `scanner2_scanning`
- `scanner2_waiting`
并添加以下转换:
- 初始状态 → `all_stopped`
- `all_stopped` → `scanner1_scanning`(触发:`start_scanner1`)
- `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`)
- 所有状态 → `all_stopped`(触发:`stop_all` 或 `emer_stop_all`)
## 五、注意事项
1. 定期保存:绘制过程中可按 Ctrl+S(Windows)或 Command+S(Mac)快速保存
2. 命名规范:使用有意义的状态名称和事件名称
3. 布局清晰:使用「Arrange」(排列)菜单调整状态布局
4. 颜色区分:使用不同颜色表示不同类型的状态(如:运行状态用绿色,停止状态用红色)
绘制完成后,将 `.drawio` 文件保存到 `motor_service` 目录,然后告诉我,我将根据您的状态图实现代码。