refactor(sensing/image_transport_decompressor): rework parameters (#6746

) * add param, schema file, update readme Signed-off-by: oguzkaganozt <[email protected]> * style(pre-commit): autofix --------- Signed-off-by: oguzkaganozt <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Kenzo Lobos Tsunekawa <[email protected]> Co-authored-by: Yoshi Ri <[email protected]>
autowarefoundation · Jun 10, 2024 · 9fd6d55 · 9fd6d55
1 parent f7ac46f
commit 9fd6d55
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 1 deletion.
diff --git a/sensing/image_transport_decompressor/README.md b/sensing/image_transport_decompressor/README.md
@@ -22,6 +22,8 @@ The `image_transport_decompressor` is a node that decompresses images.
 
 ## Parameters
 
+{{ json_to_markdown("sensing/image_transport_decompressor/schema/image_transport_decompressor.schema.json") }}
+
 ## Assumptions / Known limits
 
 ## (Optional) Error detection and handling

diff --git a/sensing/image_transport_decompressor/config/image_transport_decompressor.param.yaml b/sensing/image_transport_decompressor/config/image_transport_decompressor.param.yaml
@@ -0,0 +1,3 @@
+/**:
+  ros__parameters:
+    encoding: default
diff --git a/sensing/image_transport_decompressor/launch/image_transport_decompressor.launch.xml b/sensing/image_transport_decompressor/launch/image_transport_decompressor.launch.xml
@@ -1,9 +1,11 @@
 <launch>
   <arg name="input_topic_name" default="/input/compressed_image"/>
   <arg name="output_topic_name" default="/output/raw_image"/>
+  <arg name="param_file" default="$(find-pkg-share image_transport_decompressor)/config/image_transport_decompressor.param.yaml"/>
 
   <node pkg="image_transport_decompressor" exec="image_transport_decompressor_node" name="$(anon image_transport_decompressor_node)">
     <remap from="~/input/compressed_image" to="$(var input_topic_name)"/>
     <remap from="~/output/raw_image" to="$(var output_topic_name)"/>
+    <param from="$(var param_file)" allow_substs="true"/>
   </node>
 </launch>
diff --git a/sensing/image_transport_decompressor/schema/image_transport_decompressor.schema.json b/sensing/image_transport_decompressor/schema/image_transport_decompressor.schema.json
@@ -0,0 +1,30 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Parameters for Image Transport Decompressor",
+  "type": "object",
+  "definitions": {
+    "image_transport_decompressor": {
+      "type": "object",
+      "properties": {
+        "encoding": {
+          "type": "string",
+          "description": "The image encoding to use for the decompressed image",
+          "default": "default"
+        }
+      },
+      "required": ["encoding"]
+    }
+  },
+  "properties": {
+    "/**": {
+      "type": "object",
+      "properties": {
+        "ros__parameters": {
+          "$ref": "#/definitions/image_transport_decompressor"
+        }
+      },
+      "required": ["ros__parameters"]
+    }
+  },
+  "required": ["/**"]
+}
diff --git a/sensing/image_transport_decompressor/src/image_transport_decompressor.cpp b/sensing/image_transport_decompressor/src/image_transport_decompressor.cpp
@@ -69,7 +69,7 @@ namespace image_preprocessor
 {
 ImageTransportDecompressor::ImageTransportDecompressor(const rclcpp::NodeOptions & node_options)
 : rclcpp::Node("image_transport_decompressor", node_options),
-  encoding_(declare_parameter("encoding", "default"))
+  encoding_(declare_parameter<std::string>("encoding"))
 {
   compressed_image_sub_ = create_subscription<sensor_msgs::msg::CompressedImage>(
     "~/input/compressed_image", rclcpp::SensorDataQoS(),