Skip to content

Commit

Permalink
Added ParamsParser to RgbdSensor_nws_ros2
Browse files Browse the repository at this point in the history
Signed-off-by: Ettore Landini <[email protected]>
  • Loading branch information
elandini84 committed Sep 2, 2024
1 parent 502cc7c commit 7bd138a
Show file tree
Hide file tree
Showing 6 changed files with 315 additions and 56 deletions.
3 changes: 3 additions & 0 deletions src/devices/rgbdSensor_nws_ros2/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,14 @@ yarp_prepare_plugin(rgbdSensor_nws_ros2

if(NOT SKIP_rgbdSensor_nws_ros2)
yarp_add_plugin(yarp_rgbdSensor_nws_ros2)
generateDeviceParamsParser(RgbdSensor_nws_ros2 rgbdSensor_nws_ros2)

target_sources(yarp_rgbdSensor_nws_ros2
PRIVATE
RgbdSensor_nws_ros2.cpp
RgbdSensor_nws_ros2.h
RgbdSensor_nws_ros2_ParamsParser.h
RgbdSensor_nws_ros2_ParamsParser.cpp
)
target_sources(yarp_rgbdSensor_nws_ros2 PRIVATE $<TARGET_OBJECTS:Ros2Utils>)

Expand Down
51 changes: 4 additions & 47 deletions src/devices/rgbdSensor_nws_ros2/RgbdSensor_nws_ros2.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -103,68 +103,25 @@ bool RgbdSensor_nws_ros2::open(yarp::os::Searchable &config)

bool RgbdSensor_nws_ros2::fromConfig(yarp::os::Searchable &config)
{
if (!config.check("period", "refresh period of the broadcasted values in ms")) {
yCDebug(RGBDSENSOR_NWS_ROS2) << "Using default 'period' parameter of " << DEFAULT_THREAD_PERIOD << "s";
} else {
setPeriod(config.find("period").asFloat64());
}

// node_name check
if (!config.check("node_name")) {
yCError(RGBDSENSOR_NWS_ROS2) << "missing node_name parameter";
return false;
}
m_node_name = config.find("node_name").asString();
parseParams(config);
if(m_node_name[0] == '/'){
yCError(RGBDSENSOR_NWS_ROS2) << "node_name cannot begin with an initial /";
return false;
}
// FIXME node_name is not currently used.
yCWarning(RGBDSENSOR_NWS_ROS2, "FIXME: node_name is not currently used!");

// depth topic base name check
if (!config.check("depth_topic_name")) {
yCError(RGBDSENSOR_NWS_ROS2) << "missing depth_topic_name parameter";
return false;
}
m_depth_topic_name = config.find("depth_topic_name").asString();
if(m_depth_topic_name[0] != '/'){
yCError(RGBDSENSOR_NWS_ROS2) << "depth_topic_name must begin with an initial /";
return false;
}
m_depth_info_topic_name = m_depth_topic_name.substr(0, m_depth_topic_name.rfind('/')) + "/camera_info";

// color topic base name check
if (!config.check("color_topic_name")) {
yCError(RGBDSENSOR_NWS_ROS2) << "missing color_topic_name parameter";
return false;
}
m_color_topic_name = config.find("color_topic_name").asString();
if(m_color_topic_name[0] != '/'){
yCError(RGBDSENSOR_NWS_ROS2) << "color_topic_name must begin with an initial /";
return false;
}
m_color_info_topic_name = m_color_topic_name.substr(0, m_color_topic_name.rfind('/')) + "/camera_info";

// depth_frame_id check
if (!config.check("depth_frame_id")) {
yCError(RGBDSENSOR_NWS_ROS2) << "missing depth_frame_id parameter";
return false;
}
m_depth_frame_id = config.find("depth_frame_id").asString();

// color_frame_id check
if (!config.check("color_frame_id")) {
yCError(RGBDSENSOR_NWS_ROS2) << "missing color_frame_id parameter";
return false;
}
m_color_frame_id = config.find("color_frame_id").asString();


if (config.check("forceInfoSync"))
{
forceInfoSync = config.find("forceInfoSync").asBool();
}
m_forceInfoSync = m_force_info_synch == 1;

return true;
}
Expand Down Expand Up @@ -417,7 +374,7 @@ bool RgbdSensor_nws_ros2::writeData()

sensor_msgs::msg::CameraInfo camInfoC;
if (setCamInfo(camInfoC, m_color_frame_id, colorStamp, COLOR_SENSOR)) {
if(forceInfoSync) {
if(m_forceInfoSync) {
camInfoC.header.stamp = rColorImage.header.stamp;
}
rosPublisher_colorCaminfo->publish(camInfoC);
Expand All @@ -444,7 +401,7 @@ bool RgbdSensor_nws_ros2::writeData()

sensor_msgs::msg::CameraInfo camInfoD;
if (setCamInfo(camInfoD, m_depth_frame_id, depthStamp, DEPTH_SENSOR)) {
if(forceInfoSync) {
if(m_forceInfoSync) {
camInfoD.header.stamp = rDepthImage.header.stamp;
}
rosPublisher_depthCaminfo->publish(camInfoD);
Expand Down
14 changes: 5 additions & 9 deletions src/devices/rgbdSensor_nws_ros2/RgbdSensor_nws_ros2.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
#include <sensor_msgs/msg/image.hpp>
#include <sensor_msgs/msg/camera_info.hpp>

#include "RgbdSensor_nws_ros2_ParamsParser.h"

#include <mutex>

/**
Expand All @@ -31,7 +33,8 @@
class RgbdSensor_nws_ros2 :
public yarp::dev::DeviceDriver,
public yarp::dev::WrapperSingle,
public yarp::os::PeriodicThread
public yarp::os::PeriodicThread,
RgbdSensor_nws_ros2_ParamsParser
{
public:
RgbdSensor_nws_ros2();
Expand Down Expand Up @@ -77,19 +80,12 @@ class RgbdSensor_nws_ros2 :
rclcpp::Publisher<sensor_msgs::msg::CameraInfo>::SharedPtr rosPublisher_colorCaminfo;
rclcpp::Publisher<sensor_msgs::msg::CameraInfo>::SharedPtr rosPublisher_depthCaminfo;

std::string m_node_name;

std::string m_depth_topic_name;
std::string m_depth_info_topic_name;
std::string m_depth_frame_id;

std::string m_color_topic_name;
std::string m_color_info_topic_name;
std::string m_color_frame_id;

yarp::dev::IRGBDSensor* sensor_p {nullptr};
yarp::dev::IFrameGrabberControls* fgCtrl {nullptr};
bool forceInfoSync {true};
bool m_forceInfoSync {true};

bool writeData();
bool setCamInfo(sensor_msgs::msg::CameraInfo& cameraInfo,
Expand Down
209 changes: 209 additions & 0 deletions src/devices/rgbdSensor_nws_ros2/RgbdSensor_nws_ros2_ParamsParser.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,209 @@
/*
* SPDX-FileCopyrightText: 2023-2023 Istituto Italiano di Tecnologia (IIT)
* SPDX-License-Identifier: LGPL-2.1-or-later
*/


// Generated by yarpDeviceParamParserGenerator (1.0)
// This is an automatically generated file. Please do not edit it.
// It will be re-generated if the cmake flag ALLOW_DEVICE_PARAM_PARSER_GERNERATION is ON.

// Generated on: Mon Sep 2 10:47:31 2024


#include "RgbdSensor_nws_ros2_ParamsParser.h"
#include <yarp/os/LogStream.h>
#include <yarp/os/Value.h>

namespace {
YARP_LOG_COMPONENT(RgbdSensor_nws_ros2ParamsCOMPONENT, "yarp.device.RgbdSensor_nws_ros2")
}


RgbdSensor_nws_ros2_ParamsParser::RgbdSensor_nws_ros2_ParamsParser()
{
}


std::vector<std::string> RgbdSensor_nws_ros2_ParamsParser::getListOfParams() const
{
std::vector<std::string> params;
params.push_back("period");
params.push_back("node_name");
params.push_back("color_topic_name");
params.push_back("depth_topic_name");
params.push_back("force_info_synch");
params.push_back("depth_frame_id");
params.push_back("color_frame_id");
return params;
}


bool RgbdSensor_nws_ros2_ParamsParser::parseParams(const yarp::os::Searchable & config)
{
//Check for --help option
if (config.check("help"))
{
yCInfo(RgbdSensor_nws_ros2ParamsCOMPONENT) << getDocumentationOfDeviceParams();
}

std::string config_string = config.toString();
yarp::os::Property prop_check(config_string.c_str());
//Parser of parameter period
{
if (config.check("period"))
{
m_period = config.find("period").asFloat64();
yCInfo(RgbdSensor_nws_ros2ParamsCOMPONENT) << "Parameter 'period' using value:" << m_period;
}
else
{
yCInfo(RgbdSensor_nws_ros2ParamsCOMPONENT) << "Parameter 'period' using DEFAULT value:" << m_period;
}
prop_check.unput("period");
}

//Parser of parameter node_name
{
if (config.check("node_name"))
{
m_node_name = config.find("node_name").asString();
yCInfo(RgbdSensor_nws_ros2ParamsCOMPONENT) << "Parameter 'node_name' using value:" << m_node_name;
}
else
{
yCError(RgbdSensor_nws_ros2ParamsCOMPONENT) << "Mandatory parameter 'node_name' not found!";
yCError(RgbdSensor_nws_ros2ParamsCOMPONENT) << "Description of the parameter: name of the ros2 node";
return false;
}
prop_check.unput("node_name");
}

//Parser of parameter color_topic_name
{
if (config.check("color_topic_name"))
{
m_color_topic_name = config.find("color_topic_name").asString();
yCInfo(RgbdSensor_nws_ros2ParamsCOMPONENT) << "Parameter 'color_topic_name' using value:" << m_color_topic_name;
}
else
{
yCError(RgbdSensor_nws_ros2ParamsCOMPONENT) << "Mandatory parameter 'color_topic_name' not found!";
yCError(RgbdSensor_nws_ros2ParamsCOMPONENT) << "Description of the parameter: ros rgb topic (it's also the base name for the rgb camera_info topic)";
return false;
}
prop_check.unput("color_topic_name");
}

//Parser of parameter depth_topic_name
{
if (config.check("depth_topic_name"))
{
m_depth_topic_name = config.find("depth_topic_name").asString();
yCInfo(RgbdSensor_nws_ros2ParamsCOMPONENT) << "Parameter 'depth_topic_name' using value:" << m_depth_topic_name;
}
else
{
yCError(RgbdSensor_nws_ros2ParamsCOMPONENT) << "Mandatory parameter 'depth_topic_name' not found!";
yCError(RgbdSensor_nws_ros2ParamsCOMPONENT) << "Description of the parameter: ros depth topic (it's also the base name for the depth camera_info topic)";
return false;
}
prop_check.unput("depth_topic_name");
}

//Parser of parameter force_info_synch
{
if (config.check("force_info_synch"))
{
m_force_info_synch = config.find("force_info_synch").asInt64();
yCInfo(RgbdSensor_nws_ros2ParamsCOMPONENT) << "Parameter 'force_info_synch' using value:" << m_force_info_synch;
}
else
{
yCInfo(RgbdSensor_nws_ros2ParamsCOMPONENT) << "Parameter 'force_info_synch' using DEFAULT value:" << m_force_info_synch;
}
prop_check.unput("force_info_synch");
}

//Parser of parameter depth_frame_id
{
if (config.check("depth_frame_id"))
{
m_depth_frame_id = config.find("depth_frame_id").asString();
yCInfo(RgbdSensor_nws_ros2ParamsCOMPONENT) << "Parameter 'depth_frame_id' using value:" << m_depth_frame_id;
}
else
{
yCError(RgbdSensor_nws_ros2ParamsCOMPONENT) << "Mandatory parameter 'depth_frame_id' not found!";
yCError(RgbdSensor_nws_ros2ParamsCOMPONENT) << "Description of the parameter: The depth image frame";
return false;
}
prop_check.unput("depth_frame_id");
}

//Parser of parameter color_frame_id
{
if (config.check("color_frame_id"))
{
m_color_frame_id = config.find("color_frame_id").asString();
yCInfo(RgbdSensor_nws_ros2ParamsCOMPONENT) << "Parameter 'color_frame_id' using value:" << m_color_frame_id;
}
else
{
yCError(RgbdSensor_nws_ros2ParamsCOMPONENT) << "Mandatory parameter 'color_frame_id' not found!";
yCError(RgbdSensor_nws_ros2ParamsCOMPONENT) << "Description of the parameter: The color image frame";
return false;
}
prop_check.unput("color_frame_id");
}

/*
//This code check if the user set some parameter which are not check by the parser
//If the parser is set in strict mode, this will generate an error
if (prop_check.size() > 0)
{
bool extra_params_found = false;
for (auto it=prop_check.begin(); it!=prop_check.end(); it++)
{
if (m_parser_is_strict)
{
yCError(RgbdSensor_nws_ros2ParamsCOMPONENT) << "User asking for parameter: "<<it->name <<" which is unknown to this parser!";
extra_params_found = true;
}
else
{
yCWarning(RgbdSensor_nws_ros2ParamsCOMPONENT) << "User asking for parameter: "<< it->name <<" which is unknown to this parser!";
}
}
if (m_parser_is_strict && extra_params_found)
{
return false;
}
}
*/
return true;
}


std::string RgbdSensor_nws_ros2_ParamsParser::getDocumentationOfDeviceParams() const
{
std::string doc;
doc = doc + std::string("\n=============================================\n");
doc = doc + std::string("This is the help for device: RgbdSensor_nws_ros2\n");
doc = doc + std::string("\n");
doc = doc + std::string("This is the list of the parameters accepted by the device:\n");
doc = doc + std::string("'period': refresh period of the broadcasted values in s\n");
doc = doc + std::string("'node_name': name of the ros2 node\n");
doc = doc + std::string("'color_topic_name': ros rgb topic (it's also the base name for the rgb camera_info topic)\n");
doc = doc + std::string("'depth_topic_name': ros depth topic (it's also the base name for the depth camera_info topic)\n");
doc = doc + std::string("'force_info_synch': if 1, it forces synching images time stamp with and cameras time stamp\n");
doc = doc + std::string("'depth_frame_id': The depth image frame\n");
doc = doc + std::string("'color_frame_id': The color image frame\n");
doc = doc + std::string("\n");
doc = doc + std::string("Here are some examples of invocation command with yarpdev, with all params:\n");
doc = doc + " yarpdev --device rgbdSensor_nws_ros2 --period 0.02 --node_name <mandatory_value> --color_topic_name <mandatory_value> --depth_topic_name <mandatory_value> --force_info_synch 0 --depth_frame_id <mandatory_value> --color_frame_id <mandatory_value>\n";
doc = doc + std::string("Using only mandatory params:\n");
doc = doc + " yarpdev --device rgbdSensor_nws_ros2 --node_name <mandatory_value> --color_topic_name <mandatory_value> --depth_topic_name <mandatory_value> --depth_frame_id <mandatory_value> --color_frame_id <mandatory_value>\n";
doc = doc + std::string("=============================================\n\n"); return doc;
}
Loading

0 comments on commit 7bd138a

Please sign in to comment.