ROS2學習之旅(17)——ROS2建立介面方式拓展(介面在包內)
基於上篇簡單建立自定義訊息的文章,本文對建立介面方式進行拓展。
雖然最好的做法是是在專用介面包中宣告介面,但有時在一個包中宣告、建立和使用介面也很方便。
介面目前只能在CMake包中定義。然而,在CMake包中有Python庫和節點是可能的(使用ament_cmake_python
),所以可以在一個包中定義介面和Python節點。為了簡單起見,b本文使用CMake包和C++節點。
本問將側重於msg介面型別,但是這裡的步驟適用於所有介面型別。
1.建立功能包
在工作空間src
目錄下,建立more_interfaces
以及msg
資料夾:
ros2 pkg create --build-type ament_cmake more_interfaces mkdir more_interfaces/msg
2.建立一個msg檔案
在more_interfaces/msg
資料夾下,建立一個新檔案: AddressBook.msg
。
貼上以下程式碼來建立個人資訊:
bool FEMALE=true
bool MALE=false
string first_name
string last_name
bool gender
uint8 age
string address
該訊息分為5個部分:
- first_name: string 型別
- last_name: string 型別
- gender: bool 型別
- age: uint8型別
- address: string 型別
請注意,可以在訊息定義中為欄位設定預設值。更多ROS2介面的用法可以參考:[ROS2 interfaces](
2.1編譯msg檔案
開啟package.xml
檔案,新增:
<buildtool_depend>rosidl_default_generators</buildtool_depend> <exec_depend>rosidl_default_runtime</exec_depend> <member_of_group>rosidl_interface_packages</member_of_group>
注意:在編譯時,需要rosidl_default_generators
,而在執行時,只需要rosidl_default_runtime
。
開啟CMakeLists.txt
檔案,並新增以下程式碼:
找到從msg/srv
檔案中生成訊息程式碼的包:
find_package(rosidl_default_generators REQUIRED)
宣告要生成的訊息列表:
set(msg_files
"msg/AddressBook.msg"
)
通過手動新增.msg
檔案,可以確保CMake知道在新增其他.msg
檔案後,它何時需要重新配置專案。
生成訊息:
rosidl_generate_interfaces(${PROJECT_NAME}
${msg_files}
)
還要確保匯出訊息執行時的依賴項:
ament_export_dependencies(rosidl_default_runtime)
2.2設定多個介面
可以使用set
整潔的來列出所有的介面:
set(msg_files
"msg/Message1.msg"
"msg/Message2.msg"
# etc
)
set(srv_files
"srv/Service1.srv"
"srv/Service2.srv"
# etc
)
然後像這樣一次生成所有訊息:
rosidl_generate_interfaces(${PROJECT_NAME}
${msg_files}
${srv_files}
)
3.在同一個包裡使用介面
在 more_interfaces/src
目錄下,建立一個名為 publish_address_book.cpp
的檔案並貼上以下程式碼:
#include <chrono>
#include <memory>
#include "rclcpp/rclcpp.hpp"
#include "more_interfaces/msg/address_book.hpp"
using namespace std::chrono_literals;
class AddressBookPublisher : public rclcpp::Node
{
public:
AddressBookPublisher()
: Node("address_book_publisher")
{
address_book_publisher_ =
this->create_publisher<more_interfaces::msg::AddressBook>("address_book", 10);
auto publish_msg = [this]() -> void {
auto message = more_interfaces::msg::AddressBook();
message.first_name = "John";
message.last_name = "Doe";
message.age = 30;
message.gender = message.MALE;
message.address = "unknown";
std::cout << "Publishing Contact\nFirst:" << message.first_name <<
" Last:" << message.last_name << std::endl;
this->address_book_publisher_->publish(message);
};
timer_ = this->create_wall_timer(1s, publish_msg);
}
private:
rclcpp::Publisher<more_interfaces::msg::AddressBook>::SharedPtr address_book_publisher_;
rclcpp::TimerBase::SharedPtr timer_;
};
int main(int argc, char * argv[])
{
rclcpp::init(argc, argv);
rclcpp::spin(std::make_shared<AddressBookPublisher>());
rclcpp::shutdown();
return 0;
}
3.1程式碼解釋
#include "more_interfaces/msg/address_book.hpp"
包含建立的AddressBook.msg
。
using namespace std::chrono_literals;
class AddressBookPublisher : public rclcpp::Node
{
public:
AddressBookPublisher()
: Node("address_book_publisher")
{
address_book_publisher_ =
this->create_publisher<more_interfaces::msg::AddressBook>("address_book");
建立一個名為address_book_publisher
的釋出者。
auto publish_msg = [this]() -> void {
建立回撥以定期釋出訊息。
auto message = more_interfaces::msg::AddressBook();
建立稍後將釋出的AddressBook訊息例項。
message.first_name = "John";
message.last_name = "Doe";
message.age = 30;
message.gender = message.MALE;
message.address = "unknown";
填充AddressBook欄位。
std::cout << "Publishing Contact\nFirst:" << message.first_name <<
" Last:" << message.last_name << std::endl;
this->address_book_publisher_->publish(message);
最後定期傳送訊息。
timer_ = this->create_wall_timer(1s, publish_msg);
建立一個1秒的計時器,每秒呼叫publish_msg
函式。
3.2編譯釋出者
需要在CMakeLists.txt
中新增:
find_package(rclcpp REQUIRED)
add_executable(publish_address_book
src/publish_address_book.cpp
)
ament_target_dependencies(publish_address_book
"rclcpp"
)
install(TARGETS publish_address_book
DESTINATION lib/${PROJECT_NAME})
3.3對接介面
為了使用在同一個包中生成的訊息,需要使用以下CMake程式碼:
rosidl_target_interfaces(publish_address_book
${PROJECT_NAME} "rosidl_typesupport_cpp")
這將找到AddressBook.msg
中生成的相關c++程式碼,並且允許連結到它。
當使用的介面來自單獨構建的包時,此步驟是不必要的。這個CMake程式碼只有當你想要在同一個包中使用介面時才需要。
4.執行
返回工作空間根目錄,編譯功能包:
cd ~/dev_ws
colcon build --packages-up-to more_interfaces
然後執行:
. install/local_setup.bash
ros2 run more_interfaces publish_address_book
此時會看到釋出者轉發自定義的msg,包括在publish_address_book.cpp
中設定的值。
要確認訊息釋出在address_book
話題上,開啟另一個終端(不要忘記source),並呼叫topic echo
:
. install/setup.bash
ros2 topic echo /address_book
5.使用現有的介面定義
可以在新介面定義中使用現有介面定義。例如,假設有一個名為Contact.msg
的訊息,它屬於一個現有的名為rosidl_tutorials_msgs
的ROS 2包,假設它的定義與定製的AddressBook.msg
相同。
在這種情況下,可以定義AddressBook.msg
(一個在節點包中的介面)型別為Contact
(一個單獨包中的介面)。甚至可以定義AddressBook.msg
作為Contact
型別的陣列,如下所示:
rosidl_tutorials_msgs/Contact[] address_book
要生成此訊息,需要宣告對Contact.msg
包的依賴關係,rosidl_tutorials_msgs
,在package.xml
新增:
<build_depend>rosidl_tutorials_msgs</build_depend>
<exec_depend>rosidl_tutorials_msgs</exec_depend>
在CMakeLists.txt
中新增:
find_package(rosidl_tutorials_msgs REQUIRED)
rosidl_generate_interfaces(${PROJECT_NAME}
${msg_files}
DEPENDENCIES rosidl_tutorials_msgs
)
還需要包含Contact.msg
的標頭檔案:
#include "rosidl_tutorials_msgs/msg/contact.hpp"
可以把這個呼叫改成這樣:
auto publish_msg = [this]() -> void {
auto msg = std::make_shared<more_interfaces::msg::AddressBook>();
{
rosidl_tutorials_msgs::msg::Contact contact;
contact.first_name = "John";
contact.last_name = "Doe";
contact.age = 30;
contact.gender = contact.MALE;
contact.address = "unknown";
msg->address_book.push_back(contact);
}
{
rosidl_tutorials_msgs::msg::Contact contact;
contact.first_name = "Jane";
contact.last_name = "Doe";
contact.age = 20;
contact.gender = contact.FEMALE;
contact.address = "unknown";
msg->address_book.push_back(contact);
}
std::cout << "Publishing address book:" << std::endl;
for (auto contact : msg->address_book) {
std::cout << "First:" << contact.first_name << " Last:" << contact.last_name <<
std::endl;
}
address_book_publisher_->publish(*msg);
};
編譯和執行程式碼,將顯示按照預期定義的msg,以及上面定義的msg陣列。
6.總結
在本文中,嘗試了定義介面的不同欄位型別,然後在使用它的同一個包中構建了一個介面。還描述瞭如何使用另一個介面作為欄位型別,以及利用該特性所需的package.xml
、CMakeLists.txt
和#include
語句。
如果給您帶來幫助,希望能給點個關注,以後還會陸續更新有關機器人的內容,點個關注不迷路~歡迎大家一起交流學習。
都看到這了,點個推薦再走吧~
未經允許,禁止轉載。