| name | foc-desktop-development |
| description | Assist in developing an industrial-grade PySide6 QML based FOC motor control desktop tool. Focus on motor command control and real-time telemetry visualization. OTA is not included in this phase. |
FOC Desktop Development Skill (Phase 1)（FOC 桌面开发目标，第 1 阶段）
Project Positioning（项目定位）
This project is an industrial FOC motor tuning and monitoring platform.
It is NOT:
- a serial debugging assistant
- a demo GUI
- a protocol playground
It IS:
- a structured control console
- a deterministic telemetry visualizer
- an embedded-system-grade desktop frontend
Code Search Rule
AI must never search or analyze the deployment/ directory. It contains compiled artifacts, not source code.
Comment Language Preservation Rule（注释语言保留规则）
AI must NEVER change the language of existing comments or docstrings.
- If a comment is written in Chinese（中文）, it must remain in Chinese after any edit.
- If a comment is written in English, it must remain in English after any edit.
- This rule applies to ALL files:
.py, .qml, .md, and any other file in this project.
- When modifying a file, only touch the lines that are necessary for the task. Do NOT rewrite, reformat, or translate untouched lines.
Translating Chinese comments to English (or vice versa) is a strict violation of this rule, even if the surrounding code is being changed.
Code Comment Requirement（代码注释要求）
When AI writes or modifies code, it MUST add Chinese comments（中文注释） at key locations to help the developer quickly understand the code.
Required comment locations:
- Class definition: briefly describe the class's responsibility（简述类职责）
- Function / method definition: describe what it does, key parameters, and return value（描述功能、关键参数、返回值）
- Non-trivial logic: complex conditionals, state machines, bit operations, protocol parsing, etc.（复杂条件、状态机、位操作、协议解析等）
- Signal / Slot connections: explain what triggers the signal and what the slot does（说明信号触发条件与槽的作用）
- Important constants or magic numbers: explain their meaning（说明含义）
Rules:
- All new comments written by AI must be in Chinese（中文）.
- Keep comments concise — one or two sentences, not paragraphs.
- Do NOT add comments on trivial or self-explanatory lines (e.g.
i += 1).
Primary Objectives (Phase 1)（主要目标，第 1 阶段）
The system must support:
- Sending structured motor control commands（发送结构化电机控制命令）
- UI -> BackendFacade -> Service -> Transport
- UI must never access transport directly.
- Receiving and decoding FOC telemetry frames（接收并解码 FOC 遥测帧）
- Real-time UI visualization of motor state（电机状态的实时 UI 可视化）
- Deterministic fault state handling（确定性的故障状态处理）
OTA upgrade is NOT included in this phase.（本阶段不包含 OTA 升级）
Encoding Rule（编码规则）
All files in this project MUST use UTF-8 encoding.
Applies to:
- Python source files (
.py)
- QML files (
.qml)
- Markdown documentation (
.md)
- JSON configuration files (
.json)
Forbidden encodings:
All AI-generated files must be UTF-8 encoded.
All text in source code and documentation must be UTF-8 compatible.
Current Project Architecture（当前项目架构）
All outputs must strictly integrate into:
core/
command/
protocol/
transport/
service/
ui/
QMLFiles/
Architecture Overview（架构概览）
| Layer | Responsibility |
|---|
| UI | User interaction, visualization only |
| BackendFacade | System coordinator, exposes API to UI, connects backend modules |
| Service | Business logic, frame dispatch, state management |
| Transport | Byte transport only, serial communication |
| Protocol | Pure functions, frame encode/decode |
No new top-level directories allowed.（不允许新增顶级目录）
Windows Packaging（Windows 发布）
- Do not perform compilation unless the user asks you to.（除非用户要求，否则不要执行编译）
- Use the repository-root
build_windows.ps1 script for Windows .exe packaging.（在项目根目录，使用PowerShell终端执行'./build_windows.ps1'就能编译.exe应用程序）
- Treat
build_windows.ps1 as the single source of truth for packaging flags, runtime file collection, and output layout.
- Deliver the whole
deployment/foc_studio/ directory to Windows users.
- Do not distribute only the
.exe file.
- Do not distribute intermediate build directories such as
deployment/main.build/ or deployment/main.dist/.
Rules & Constraints（规则与约束）
All backend components must follow the architecture rules defined below.
Violating these constraints will break the system design.
- Communication Model - Signal/Slot rules, threading, ownership model（信号槽规则、线程规则、所有权模型）
- Layer Contracts - Protocol, Transport, Service constraints and data processing strategy（各层约束与数据处理策略）
Reference（参考资料）
