PTT/CONFIG_QUICK_REFERENCE.md

175 lines
4.6 KiB
Markdown
Raw Permalink Normal View History

2026-01-24 13:43:45 +08:00
# 配置编辑器 - 快速参考
## ⚡ 快速开始
### 打开编辑器的 3 种方式
| 方式 | 操作 |
|------|------|
| 🎯 **快捷键** | 按 `Ctrl+,` |
| 📋 **菜单** | 工具 → 编辑配置文件 |
| 💻 **脚本** | `python edit_config.py` |
---
## 🎮 操作指南
### 展开/折叠节点
- **展开**: 点击节点左侧的 ▶ 箭头
- **全部展开**: 树形编辑器加载时自动展开
- **折叠**: 再次点击箭头
### 编辑值
1. **点击**右列的值
2. **输入**新值(编辑器类型自动选择)
3. **确认**:按 Enter 或点击其他位置
### 编辑器类型
```
值类型 编辑器类型 示例
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
true/false ☐ 复选框 ☑
15200 🔢 整数框 (-2M ~ 2M) 115200
1.5 🔢 浮点框 (精度 6位) 1.0
"text" 📝 文本框 "torizon"
```
### 保存配置
1. 修改完成后
2. 点击 **保存** 按钮
3. 系统自动创建备份 (`.bak`)
---
## 📝 常用配置修改
### 修改串口波特率
```
serial → default_baudrate (默认: 115200)
```
### 修改 SSH 用户名
```
ssh → default_username (默认: "torizon")
```
### 修改网络配置
```
network → eth0/eth1 → ip/netmask/gateway
```
### 修改测试项超时
```
test_items → [0] → timeout (默认: 30秒)
```
---
## ⚠️ 注意事项
| ⚠️ 注意 | 说明 |
|-------|------|
| **类型匹配** | 修改时保持原有数据类型 |
| **格式正确** | JSON 格式必须正确,否则无法保存 |
| **备份文件** | 保存时自动备份为 `*.json.bak` |
| **权限检查** | 确保对配置文件有读写权限 |
| **重启应用** | 某些配置修改需要重启生效 |
---
## 🔄 撤销/恢复
### 撤销修改
1. 点击 **重新加载** 按钮
2. 确认放弃修改
3. 配置恢复到保存时的状态
### 恢复备份
```bash
# 如果配置被破坏,可以从备份恢复
cp config/config.json.bak config/config.json
```
---
## 🐛 常见问题
### Q: 修改后无法保存?
**A:** 检查 JSON 格式是否正确(特别是逗号、引号)
### Q: 编辑器无法打开?
**A:**
1. 确保配置文件存在
2. 检查文件权限
3. 查看应用日志
### Q: 修改后配置未生效?
**A:**
1. 确认已保存
2. 重启应用程序
3. 检查配置项名称
### Q: 如何恢复误改的配置?
**A:** 从 `.bak` 备份文件恢复即可
---
## 📂 配置文件位置
```
production_test_tool/
├── config/
│ ├── config.json ← 主配置
│ ├── config.json.bak ← 自动备份
│ ├── test_items.json ← 测试项配置
│ └── test_items.json.bak ← 自动备份
```
---
## 🎨 界面说明
```
┌──────────────────────────────────────┐
│ 配置编辑器 - config.json │
├──────────────────────────────────────┤
│ 编辑文件: /path/to/config.json │
├──────────────────────────────────────┤
│ 键 │ 值 │
├────────────────────────┼──────────────┤
│ ▼ application │ │
│ ├─ name │ "采集..." │
│ ├─ version │ "1.0.0" │
│ └─ language │ "zh_CN" │
│ ▼ serial │ │
│ ├─ default_baudrate │ 115200 │
│ └─ auto_detect_ports│ true │
├──────────────────────────────────────┤
│ [重新加载] [保存] [取消] │
└──────────────────────────────────────┘
```
---
## 🔗 快捷键总结
| 快捷键 | 功能 |
|-------|------|
| `Ctrl+,` | 打开配置编辑器 |
| `Enter` | 确认编辑 |
| `Esc` | 取消编辑 |
---
## 📞 获取帮助
- 📖 详细指南: [CONFIG_EDITOR_GUIDE.md](CONFIG_EDITOR_GUIDE.md)
- 🔧 技术文档: [CONFIG_EDITOR_COMPLETE.md](CONFIG_EDITOR_COMPLETE.md)
- 📋 完成报告: [FEATURE_COMPLETE_REPORT.md](FEATURE_COMPLETE_REPORT.md)
- 💻 源代码: [src/ui/config_editor.py](src/ui/config_editor.py)
---
**版本**: 1.0.0 | **状态**: ✅ 生产就绪