Package Summary
Tags | No category tags. |
Version | 1.1.0 |
License | Apache License 2.0 |
Build type | AMENT_CMAKE |
Use | RECOMMENDED |
Repository Summary
Checkout URI | https://github.com/autowarefoundation/autoware_utils.git |
VCS Type | git |
VCS Version | main |
Last Updated | 2025-03-07 |
Dev Status | DEVELOPED |
CI status | No Continuous Integration |
Released | RELEASED |
Tags | No category tags. |
Contributing |
Help Wanted (0)
Good First Issues (0) Pull Requests to Review (0) |
Package Description
The autoware_utils_debug package
Additional Links
No additional links.
Maintainers
- Jian Kang
- Ryohsuke Mitsudome
- Esteve Fernandez
- Yutaka Kondo
- Takagi, Isamu
Authors
No additional authors.
autoware_utils_debug
Overview
The autoware_utils library is a comprehensive toolkit designed to facilitate the development of autonomous driving applications. This package provides essential utilities for debug. It is extensively used in the Autoware project to handle common tasks such as publishing debug data and measuring time.
Design
-
debug_publisher.hpp
: A helper class for publishing debug messages with timestamps. -
debug_traits.hpp
: Traits for identifying debug message types. -
processing_time_publisher.hpp
: Publishes processing times as diagnostic messages. -
published_time_publisher.hpp
: Tracks and publishes the time when messages are published. -
time_keeper.hpp
: Tracks and reports the processing time of various functions.
Example Code Snippets
Handling Debug Message Types with debug_traits.hpp
#include <autoware_utils_debug/debug_publisher.hpp>
#include <autoware_utils_debug/debug_traits.hpp>
#include <rclcpp/rclcpp.hpp>
int main(int argc, char * argv[]) {
rclcpp::init(argc, argv);
auto node = rclcpp::Node::make_shared("debug_node");
// Initialize DebugPublisher
autoware_utils_debug::DebugPublisher debug_pub(node, "/debug");
// Publish a debug message with custom type
float debug_data = 42.0;
debug_pub.publish<autoware_internal_debug_msgs::msg::Float32Stamped>("example", debug_data);
rclcpp::shutdown();
return 0;
}
Logging Processing Times with ProcessingTimePublisher
#include <autoware_utils_debug/processing_time_publisher.hpp>
#include <rclcpp/rclcpp.hpp>
#include <map>
int main(int argc, char * argv[]) {
rclcpp::init(argc, argv);
auto node = rclcpp::Node::make_shared("processing_time_node");
// Initialize ProcessingTimePublisher
autoware_utils_debug::ProcessingTimePublisher processing_time_pub(node.get(), "~/debug/processing_time_ms");
// Simulate some processing times
std::map<std::string, double> processing_times = {
{"node1", 0.1}, {"node2", 0.2}, {"node3", 0.3}
};
// Publish processing times
processing_time_pub.publish(processing_times);
rclcpp::shutdown();
return 0;
}
CHANGELOG
No CHANGELOG found.
Wiki Tutorials
This package does not provide any links to tutorials in it's rosindex metadata.
You can check on the ROS Wiki Tutorials page for the package.
Package Dependencies
Deps | Name |
---|---|
ament_cmake_auto | |
autoware_cmake | |
ament_cmake_ros | |
ament_lint_auto | |
autoware_lint_common | |
autoware_internal_debug_msgs | |
autoware_internal_msgs | |
autoware_utils_system | |
diagnostic_msgs | |
rclcpp |
System Dependencies
No direct system dependencies.
Dependant Packages
Name | Deps |
---|---|
autoware_utils |
Launch files
No launch files found
Messages
No message files found.
Services
No service files found
Plugins
No plugins found.
Recent questions tagged autoware_utils_debug at Robotics Stack Exchange
No version for distro jazzy. Known supported distros are highlighted in the buttons above.
Package Summary
Tags | No category tags. |
Version | 1.1.0 |
License | Apache License 2.0 |
Build type | AMENT_CMAKE |
Use | RECOMMENDED |
Repository Summary
Checkout URI | https://github.com/autowarefoundation/autoware_utils.git |
VCS Type | git |
VCS Version | main |
Last Updated | 2025-03-07 |
Dev Status | DEVELOPED |
CI status | No Continuous Integration |
Released | RELEASED |
Tags | No category tags. |
Contributing |
Help Wanted (0)
Good First Issues (0) Pull Requests to Review (0) |
Package Description
The autoware_utils_debug package
Additional Links
No additional links.
Maintainers
- Jian Kang
- Ryohsuke Mitsudome
- Esteve Fernandez
- Yutaka Kondo
- Takagi, Isamu
Authors
No additional authors.
autoware_utils_debug
Overview
The autoware_utils library is a comprehensive toolkit designed to facilitate the development of autonomous driving applications. This package provides essential utilities for debug. It is extensively used in the Autoware project to handle common tasks such as publishing debug data and measuring time.
Design
-
debug_publisher.hpp
: A helper class for publishing debug messages with timestamps. -
debug_traits.hpp
: Traits for identifying debug message types. -
processing_time_publisher.hpp
: Publishes processing times as diagnostic messages. -
published_time_publisher.hpp
: Tracks and publishes the time when messages are published. -
time_keeper.hpp
: Tracks and reports the processing time of various functions.
Example Code Snippets
Handling Debug Message Types with debug_traits.hpp
#include <autoware_utils_debug/debug_publisher.hpp>
#include <autoware_utils_debug/debug_traits.hpp>
#include <rclcpp/rclcpp.hpp>
int main(int argc, char * argv[]) {
rclcpp::init(argc, argv);
auto node = rclcpp::Node::make_shared("debug_node");
// Initialize DebugPublisher
autoware_utils_debug::DebugPublisher debug_pub(node, "/debug");
// Publish a debug message with custom type
float debug_data = 42.0;
debug_pub.publish<autoware_internal_debug_msgs::msg::Float32Stamped>("example", debug_data);
rclcpp::shutdown();
return 0;
}
Logging Processing Times with ProcessingTimePublisher
#include <autoware_utils_debug/processing_time_publisher.hpp>
#include <rclcpp/rclcpp.hpp>
#include <map>
int main(int argc, char * argv[]) {
rclcpp::init(argc, argv);
auto node = rclcpp::Node::make_shared("processing_time_node");
// Initialize ProcessingTimePublisher
autoware_utils_debug::ProcessingTimePublisher processing_time_pub(node.get(), "~/debug/processing_time_ms");
// Simulate some processing times
std::map<std::string, double> processing_times = {
{"node1", 0.1}, {"node2", 0.2}, {"node3", 0.3}
};
// Publish processing times
processing_time_pub.publish(processing_times);
rclcpp::shutdown();
return 0;
}
CHANGELOG
No CHANGELOG found.
Wiki Tutorials
This package does not provide any links to tutorials in it's rosindex metadata.
You can check on the ROS Wiki Tutorials page for the package.
Package Dependencies
Deps | Name |
---|---|
ament_cmake_auto | |
autoware_cmake | |
ament_cmake_ros | |
ament_lint_auto | |
autoware_lint_common | |
autoware_internal_debug_msgs | |
autoware_internal_msgs | |
autoware_utils_system | |
diagnostic_msgs | |
rclcpp |
System Dependencies
No direct system dependencies.
Dependant Packages
Name | Deps |
---|---|
autoware_utils |
Launch files
No launch files found
Messages
No message files found.
Services
No service files found
Plugins
No plugins found.
Recent questions tagged autoware_utils_debug at Robotics Stack Exchange
No version for distro noetic. Known supported distros are highlighted in the buttons above.
No version for distro ardent. Known supported distros are highlighted in the buttons above.
No version for distro bouncy. Known supported distros are highlighted in the buttons above.
No version for distro crystal. Known supported distros are highlighted in the buttons above.
No version for distro eloquent. Known supported distros are highlighted in the buttons above.
No version for distro dashing. Known supported distros are highlighted in the buttons above.
No version for distro galactic. Known supported distros are highlighted in the buttons above.
No version for distro foxy. Known supported distros are highlighted in the buttons above.
No version for distro iron. Known supported distros are highlighted in the buttons above.
No version for distro lunar. Known supported distros are highlighted in the buttons above.
No version for distro jade. Known supported distros are highlighted in the buttons above.
No version for distro indigo. Known supported distros are highlighted in the buttons above.
No version for distro hydro. Known supported distros are highlighted in the buttons above.
No version for distro kinetic. Known supported distros are highlighted in the buttons above.
No version for distro melodic. Known supported distros are highlighted in the buttons above.