micro-ROS Agent 项目使用指南

2024-08-26 13:47:05作者：羿妍玫Ivan

1. 项目的目录结构及介绍

micro-ROS Agent 项目的目录结构如下：

micro-ROS-Agent/
├── agent
│   ├── CMakeLists.txt
│   ├── include
│   │   └── micro_ros_agent
│   │       └── agent.h
│   ├── src
│   │   ├── agent.cpp
│   │   └── main.cpp
├── CMakeLists.txt
├── package.xml
└── README.md

目录结构介绍

agent: 包含 micro-ROS Agent 的主要代码文件。
- CMakeLists.txt: 用于构建项目的 CMake 配置文件。
- include/micro_ros_agent: 包含头文件的目录。
  - agent.h: micro-ROS Agent 的头文件。
- src: 包含源代码文件的目录。
  - agent.cpp: micro-ROS Agent 的主要实现文件。
  - main.cpp: 程序的入口文件。
CMakeLists.txt: 顶层的 CMake 配置文件。
package.xml: ROS 2 包的描述文件。
README.md: 项目的说明文档。

2. 项目的启动文件介绍

项目的启动文件是 agent/src/main.cpp。这个文件包含了程序的入口点，负责初始化和启动 micro-ROS Agent。

main.cpp 文件内容概览

#include <micro_ros_agent/agent.h>

int main(int argc, char** argv) {
    // 初始化 ROS 2
    rclcpp::init(argc, argv);

    // 创建 micro-ROS Agent 节点
    auto node = std::make_shared<micro_ros_agent::Agent>();

    // 运行节点
    rclcpp::spin(node);

    // 关闭 ROS 2
    rclcpp::shutdown();
    return 0;
}

主要功能

初始化 ROS 2: 使用 rclcpp::init 函数初始化 ROS 2 环境。
创建 micro-ROS Agent 节点: 创建一个 Agent 类的实例。
运行节点: 使用 rclcpp::spin 函数运行节点，使其开始处理消息。
关闭 ROS 2: 使用 rclcpp::shutdown 函数关闭 ROS 2 环境。

3. 项目的配置文件介绍

项目的配置文件主要是 CMakeLists.txt 和 package.xml。

CMakeLists.txt

CMakeLists.txt 文件位于项目的根目录和 agent 目录下，分别用于顶层构建和子目录构建。

顶层 CMakeLists.txt 内容概览

cmake_minimum_required(VERSION 3.5)
project(micro_ros_agent)

find_package(ament_cmake REQUIRED)
find_package(rclcpp REQUIRED)
find_package(micro_ros_common REQUIRED)

add_subdirectory(agent)

ament_package()

agent 目录下的 CMakeLists.txt 内容概览

cmake_minimum_required(VERSION 3.5)
project(micro_ros_agent_core)

find_package(ament_cmake REQUIRED)
find_package(rclcpp REQUIRED)
find_package(micro_ros_common REQUIRED)

add_executable(micro_ros_agent src/main.cpp src/agent.cpp)

target_include_directories(micro_ros_agent PRIVATE include)

ament_target_dependencies(micro_ros_agent rclcpp micro_ros_common)

install(TARGETS micro_ros_agent
  DESTINATION lib/${PROJECT_NAME})

ament_package()

package.xml

package.xml 文件位于项目的根目录，用于描述 ROS 2 包的依赖和元数据。

package.xml 内容概览

<?xml version="1.0"?>
<package format="2">
  <name>micro_ros_agent</name>
  <version>0.0.1</version>
  <description>micro-ROS Agent</description>
  <maintainer email="example@example.com">Your Name</maintainer>
  <license>Apache License