Skip to content

Latest commit

 

History

History
274 lines (189 loc) · 8.22 KB

README.md

File metadata and controls

274 lines (189 loc) · 8.22 KB
Raw

Qt6 ROS2 Template

中文 | English

目录

项目简介

Qt6 ROS2 Template 是一个基于 Qt6 构建的 ROS2 人机交互界面模板。本项目旨在为开发者提供一个快速入门的框架，方便用户在此基础上进行 ROS2 人机交互界面的开发。它融合了 Qt6 的现代化 UI 设计能力和 ROS2 的强大机器人开发生态，为机器人应用的图形界面开发提供了一个理想的起点。

本项目的开发灵感来自于早期的 ROS1 和 Qt5 项目。然而，本项目进行了重大改进：

  1. 双重编译支持：本模板不仅支持在 ROS2 环境下使用 colcon build 进行编译，还可以直接在 Qt Creator 中打开和编译，无需复杂的配置步骤。

  2. 简化开发流程：本项目实现了"开箱即用"的体验，大大简化了开发流程。

  3. 增强的灵活性：开发者可以根据自己的偏好选择使用 ROS2 工具链或 Qt Creator 进行开发，提供了更大的灵活性。

功能特性

  • 集成 Qt6 和 ROS2，提供现代化的 UI 设计和强大的机器人开发能力
  • 双重编译支持：兼容 ROS2 的 colcon build 和 Qt Creator 的构建系统
    • 可以在只有 ROS2 的环境下使用 colcon build 进行编译
    • 可以在只有 Qt6 的环境下使用 Qt Creator 编译并打开项目
    • 可以在 ROS2 和 Qt6 环境下同时使用 colcon build 或 Qt Creator 对项目进行编译
  • 无需复杂配置，可直接在 Qt Creator 中打开项目进行开发
  • 预配置的 CMakeLists.txt，简化了 Qt 和 ROS2 的集成过程
  • 包含基本的 ROS2 节点和 Qt 主窗口实现，可作为开发起点
  • 提供了 ROS2 launch 文件，方便启动和管理节点
  • 支持在 ROS2 和非 ROS 环境下编译运行，增强了项目的灵活性

系统要求

  • 操作系统：Ubuntu 22.04 LTS (Jammy Jellyfish) 或更高
  • ROS 版本：ROS2 Humble 或更高
  • Qt 版本：6.x
  • CMake 版本：3.16 或更高

安装指南

安装 ROS2

  1. 使用 Auto ROS Installer（推荐）：

    git clone https://github.com/XKHoshizora/auto-ros-installer.git
cd auto-ros-installer

    详细安装方法请查看项目主页的说明。

  2. 请按照 ROS2 的官方安装指南进行安装（以 Humble 为例）： ROS2 Humble 安装指南

安装 Qt6

推荐使用 Qt 官方安装器安装 Qt6：

  1. 下载 Qt Installer： 访问 Qt 官方下载页面，下载适用于 Linux 的在线安装程序。

  2. 授予执行权限：

    chmod +x qt-online-installer-linux-<x64/arm64>-<version>.run

  3. 运行安装程序：

    ./qt-online-installer-linux-<x64/arm64>-<version>.run

  4. 配置 Qt Creator 快捷方式： 使用以下命令创建并打开 qtcreator 文件

    sudo nano /usr/bin/qtcreator

    向 qtcreator 文件中添加以下内容：

    #!/bin/sh

export QT_HOME=/home/<user>/Qt/Tools/QtCreator/bin
$QT_HOME/qtcreator $*

  5. 为 qtcreator 文件添加可执行权限：

    sudo chmod a+x /usr/bin/

  6. 启动 Qt Creator：

    qtcreator

  7. 安装其他依赖

    如果在运行 Qt Creator 时遇到问题，请安装以下依赖：

    sudo apt install libxcb-xinerama0 libxcb-xinerama0-dev libxcb-cursor0

项目设置

创建工作空间

mkdir -p ~/qt6_ws/src
cd ~/qt6_ws/src

克隆项目

git clone https://github.com/XKHoshizora/qt6_ros2_template.git

构建项目

单独的 ROS2 环境中

在你的工作空间内执行以下命令即可编译该功能包：

cd ~/qt6_ws
colcon build --symlink-install

在单独的 Qt6 环境中

  1. 打开 Qt Creator
  2. 选择 "File" > "Open File or Project"
  3. 导航到 ~/qt6_ws/src/qt6_ros_template 目录中，选择 CMakeLists.txt 文件并打开
  4. 配置并打开项目，左侧可以正常显示项目文件，即说明编译成功。若编译失败，则只会显示一个 CMakeLists.txt 文件。

在 ROS2 和 Qt6 共存的环境中

有两种编译方式：

  • 在你的工作空间内执行以下命令即可编译该功能包：

    cd ~/qt6_ws
colcon build --symlink-install

  • 通过使用 Qt Creator 打开项目进行编译，步骤如下：

    1. 打开 Qt Creator
    2. 选择 "File" > "Open File or Project"
    3. 导航到 ~/qt6_ws/src/qt6_ros_template 目录中，选择 CMakeLists.txt 文件并打开
    4. 配置并打开项目，左侧可以正常显示项目文件，即说明编译成功。若编译失败，则只会显示一个 CMakeLists.txt 文件。

运行项目

单独的 ROS 环境中

首先确保已经根据上面的步骤完成了编译。然后在工作空间下执行以下命令：

source ~/qt6_ws/install/setup.bash
ros2 launch qt6_ros2_template demo.launch.py

在单独的 Qt6 环境中

通过 Qt Creator 编译并打开项目后，点击左侧绿色的 Run 按钮，或使用 Ctrl + R 快捷键运行。

在 ROS 和 Qt6 共存的环境中

首先确保已经根据上面的步骤完成了编译。然后在工作空间下执行以下命令：

source ~/qt6_ws/devel/setup.bash
ros2 launch qt6_ros2_template demo.launch.py

或通过 Qt Creator 编译并打开项目后，点击左侧绿色的 Run 按钮，或使用 Ctrl + R 快捷键运行。

项目结构

本项目使用了标准的 CMake 构建系统，并遵循了 Qt 项目的目录结构。

qt6_ros2_template/
├── CMakeLists.txt
├── package.xml
├── include/
│   ├── qt6_ros2_template/
│   └── mainwindow.h
├── msg/
├── resources/
│   ├── images/
│   │   └── icon.png
│   └── resource.qrc
├── scripts/
├── src/
│   ├── main.cpp
│   ├── mainwindow.cpp
│   └── qt6_ros2_template_node.cpp
├── srv/
├── ui/
│   └── mainwindow.ui
└── launch/
    └── demo.launch.py

自定义和扩展

  1. 修改 src/mainwindow.cpp 和 ui/mainwindow.ui 以自定义 UI。
  2. 在 src/qt6_ros2_template_node.cpp 中添加 ROS2 功能。
  3. 更新 CMakeLists.txt 以包含新的源文件或依赖项。

常见问题

  1. 问题：编译时出现 "Qt6 not found" 错误。 解决方案：确保 Qt6 正确安装，并且 CMAKE_PREFIX_PATH 包含 Qt6 安装路径。

  2. 问题：ROS2 相关的函数未定义。 解决方案：确保已 source ROS2 的 setup 文件，并且 package.xml 中包含所有必要的依赖。

  3. 问题：在 Qt Creator 中无法找到 ROS2 头文件。 解决方案：在 Qt Creator 的项目设置中，添加 ROS2 的 include 路径（通常在 /opt/ros/humble/include）。

贡献指南

我们欢迎并感谢任何形式的贡献！如果您想为项目做出贡献，请遵循以下步骤：

  1. Fork 本仓库
  2. 创建您的特性分支 (git checkout -b feature/AmazingFeature)
  3. 提交您的更改 (git commit -m 'Add some AmazingFeature')
  4. 将您的更改推送到分支 (git push origin feature/AmazingFeature)
  5. 创建一个新的 Pull Request

版本历史

  • 0.1.0
    • 初始版本
    • 基本的 Qt6 和 ROS2 集成
    • 实现了双重编译支持（ROS2 环境和 Qt Creator）

许可证

本项目基于 MIT 许可证 - 查看 LICENSE 文件了解详情

联系方式

项目维护者：Hoshizora - [email protected]

项目链接：https://github.com/XKHoshizora/qt6_ros2_template

Star History

Star History Chart