From 6a35a711db571c7ee11223957f6210aa64fb1fc4 Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Wed, 4 Mar 2026 09:19:50 +0000 Subject: [PATCH] Add README.md --- README.en.md | 81 ++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 83 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 164 insertions(+) create mode 100644 README.en.md create mode 100644 README.md diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..8f35aee --- /dev/null +++ b/README.en.md @@ -0,0 +1,81 @@ +# Vehicle Property Panel + +A flight instrument display and control panel developed with Qt, primarily designed for drone ground stations or flight simulators to visualize flight data. + +## Project Overview + +This project implements a fully functional aircraft cockpit panel capable of real-time display and processing of various flight attitude, navigation, and status data. The panel is developed using Qt's graphical interface framework and supports mouse interaction and scroll-wheel zooming. + +## Main Features + +### Attitude Display +- **Pitch**: Displays the aircraft's nose-up/nose-down angle +- **Roll**: Displays the aircraft's left/right rolling angle +- **Yaw**: Displays the aircraft's heading angle +- Supports setting target angles and rate of change + +### Altitude and Speed +- **Altitude/Height**: Displays current flight altitude +- **Air Speed**: Displays the aircraft's speed relative to the air +- **Vertical Speed**: Displays the rate of climb or descent + +### Navigation Data +- **XTrack (Cross-track Error)**: Lateral deviation from the predefined flight path +- **WP_dist (Waypoint Distance)**: Distance to the next waypoint +- **Alt_err (Altitude Error)**: Difference between current altitude and target altitude + +### Status Information +- **GPS Data**: Global Positioning System information +- **Mode**: Current flight control mode +- **State**: Current vehicle state +- **AOA**: Angle of Attack display +- **OL**: Open-loop/Closed-loop status indicator +- **LED Status**: LED indicator display +- **HeartBeat**: Communication connection status monitoring + +## Interactive Features + +- Mouse drag to pan the view +- Mouse wheel to zoom display +- Double-click support +- Key release event handling + +## Technology Stack + +- **Qt**: Graphical user interface framework +- **C++**: Core development language +- **QPaint**: Custom drawing of flight instruments + +## Compilation and Execution + +### System Requirements +- Qt 5.x or higher +- C++11-compatible compiler +- Qt Widgets module support + +### Compilation Steps + +```bash +# Compile using qmake +qmake vehicle-property-panel.pro +make +``` + +### Running + +After compilation, execute the generated binary to launch the Vehicle Property Panel. + +## Project Structure + +``` +├── cockpit.cpp/h # Core implementation of the cockpit panel +├── key_value_item.cpp/h # Key-value display widget +├── main.cpp # Program entry point +├── mainwindow.cpp/h/ui # Main window implementation +├── style_string.h # Style definitions +└── vehicle-property-panel.pro # Qt project file +``` + +## License + +For specific licensing details, please refer to the license notices within the source code. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..ef2b18f --- /dev/null +++ b/README.md @@ -0,0 +1,83 @@ + + +# 飞行器属性面板 (Vehicle Property Panel) + +一个基于 Qt 开发的飞行器仪表显示与控制面板,主要用于无人机地面站或飞行模拟器的数据显示。 + +## 项目简介 + +本项目实现了一个功能完善的飞行器驾驶舱面板(Cockpit),能够实时显示和处理飞行器的各种姿态、导航及状态数据。面板采用 Qt 图形界面开发,支持鼠标交互和滚轮缩放。 + +## 主要功能 + +### 姿态显示 +- **俯仰角 (Pitch)**:显示飞机机头上下俯仰角度 +- **翻滚角 (Roll)**:显示飞机左右翻滚角度 +- **偏航角 (Yaw)**:显示飞机航向角 +- 支持设置目标角度和变化速度 + +### 高度与速度 +- **高度 (Altitude/Height)**:显示飞行高度 +- **空速 (Air Speed)**:显示飞机相对于空气的速度 +- **垂直速度 (Vertical Speed)**:显示上升或下降速率 + +### 导航数据 +- **侧向偏差 (XTrack)**:飞机相对于预设航线的侧向偏移量 +- **航点距离 (WP_dist)**:到下一航点的距离 +- **高度误差 (Alt_err)**:当前高度与目标高度的差值 + +### 状态信息 +- **GPS 信息**:全球定位系统数据 +- **飞行模式 (Mode)**:当前飞行控制模式 +- **飞行状态 (State)**:飞行器当前状态 +- **AOA**:攻角显示 +- **OL**:开环/闭环状态指示 +- **LED 状态**:指示灯显示 +- **心跳 (HeartBeat)**:通信连接状态监控 + +## 交互功能 + +- 鼠标拖拽移动视角 +- 鼠标滚轮缩放显示 +- 双击操作支持 +- 按键释放事件处理 + +## 技术栈 + +- **Qt**:图形界面框架 +- **C++**:核心开发语言 +- **QPaint**:自定义绘制飞行仪表 + +## 编译与运行 + +### 环境要求 +- Qt 5.x 或更高版本 +- C++11 兼容编译器 +- 支持 Qt Widgets 模块 + +### 编译步骤 + +```bash +# 使用 qmake 编译 +qmake vehicle-property-panel.pro +make +``` + +### 运行 + +编译完成后,运行生成的可执行文件即可启动飞行器属性面板。 + +## 项目结构 + +``` +├── cockpit.cpp/h # 驾驶舱面板核心实现 +├── key_value_item.cpp/h # 键值对显示控件 +├── main.cpp # 程序入口 +├── mainwindow.cpp/h/ui # 主窗口实现 +├── style_string.h # 样式定义 +└── vehicle-property-panel.pro # Qt 项目文件 +``` + +## 许可证 + +本项目具体许可证请参考源码中的相关声明。 \ No newline at end of file -- Gitee