ros-perception / ros-perception/image_common

[ROS 2] documentation

Open
#359 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
153
Forks
253
Avg merge
5m
Merged PRs (30d)
1

Description

Is there a place with documentation for ROS 2? The usage in https://wiki.ros.org/image_transport seems wrong. I get:

$ ros2 run image_transport republish compressed raw --ros-args -r in/compressed:=/camera/camera/color/image_raw/compressed -r out:=/camera/camera/color/image_raw
[WARN] [1749460456.256789054] [rcl]: Found remap rule 'in:=/camera/camera/color/image_raw/compressed'. This syntax is deprecated. Use '--ros-args --remap in:=/camera/camera/color/image_raw/compressed' instead.
[WARN] [1749460456.256805555] [rcl]: Found remap rule 'out:=/camera/camera/color/image_raw'. This syntax is deprecated. Use '--ros-args --remap out:=/camera/camera/color/image_raw' instead.
[INFO] [1749460456.268222763] [image_republisher]: The 'in_transport' parameter is set to: raw
[INFO] [1749460456.268272237] [image_republisher]: The 'out_transport' parameter is set to: 

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the ROS 2 usage on the linked wiki.ros.org/image_transport page and compare it with the reported ros2 run image_transport republish command and its remap warnings. Done means the documentation gives a working ROS 2 command and the example no longer relies on the deprecated syntax.

Written by the indexing model from the issue text.

Assessment

Domain
cli, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.