ifm3d-ros2 overview

This documentation is formatted to be read on www.ros2.ifm3d.com.

:::{note} This release is intended to be used with the O3R camera platform ONLY. For other ifm cameras (e.g. O3D3xx and O3X1xx) please see the tagged releases 0.3.0 and 0.7.0 respectively. :::

ifm3d-ros2 is a wrapper around ifm3d enabling the usage of ifm O3R camera platform from within ROS 2 software systems.

As of version 1.2.0, ifm3d_ros2 also supports the Obstacle Detection Solution (ODS). Refer to the ODS documentation for more details on this application.

Getting Started

For hardware setup instructions, the default port configuration, and how to run the provided launch files out of the box, see the Getting Started guide.

Software Compatibility Matrix

Note: The version numbers listed above for the ifm3d API or the O3R firmware versions are the ones explicitly tested. Any other version might work but is not officially supported.

Changelog

For a complete list of changes, refer to the changelog.

Known Issues

• Cross-compilation limitations: The build_container.sh script may encounter issues when cross-compiling from AMD64 to ARM architectures. For ARM-based deployments, we recommend building directly on the target ARM platform or using ARM-compatible build environments. A fix for this issue is being developed and will be included in the next patch release.

Deprecated ifm3d-ros2 versions

The following versions are deprecated and no longer supported.

LICENSE

Please see the file called LICENSE.

\^\^\^\^\^\^\^\^\^\^\^\^\^\^\^\^\^\^\^\^\^\^\^\^\^ Changelog for package ifm3d-ros2 \^\^\^\^\^\^\^\^\^\^\^\^\^\^\^\^\^\^\^\^\^\^\^\^\^ 1.4 ===

1.4.0

• Add support for PDS operation modes and functionalities:
  • PDS node supports all three core functions: [getPallet]{.title-ref}, [getRack]{.title-ref}, and [volCheck]{.title-ref}.
  • Added/updated action and service interfaces for PDS operation, including continuous mode switching.
• Add IMU data node support:
  • Added IMU node support for publishing IMU data streams.
• Fix diagnostics severity handling to match ifm severity semantics consistently:
  • [info]{.title-ref} -> [OK]{.title-ref}, [minor]{.title-ref} -> [WARN]{.title-ref}, [major]{.title-ref}/[critical]{.title-ref} -> [ERROR]{.title-ref}.
  • Added diagnostic metadata fields to distinguish operator handling of [major]{.title-ref} vs [critical]{.title-ref} while keeping both at [ERROR]{.title-ref} level.
• Improve configuration defaults and examples:
  • Move default ODS/PDS/IMU [config_file]{.title-ref} references to [config/o3r_configs/*]{.title-ref}.
  • Add/update ODS preset-oriented example configurations.
• Improve documentation:
  • Add dedicated documentation sections for IMU and PDS nodes, including launch, parameters, and topics.
  • Extend ODS and services documentation with runtime preset switching examples.
  • Update visualization documentation with guidance for uncompressed image transport and undistortion pipeline usage.
• Add launch/runtime tooling improvements:
  • Add standalone launch support for IMU and PDS nodes.
  • Add an image undistortion launch example ([launch/examples/undistort_image.launch.py]{.title-ref}).

1.3

1.3.0

• Update for compatibility with O3R FW >= 1.20.29 and ifm3d >= 1.6.12
  • Tested with FW 1.20.29 and ifm3d API 1.6.12
  • Tested with FW 1.21.6 and ifm3d API 1.6.12
• Add support for diagnostics severity:
  • The diagnostics message level will depend on the severity of the diagnostic message.
• Add support for the extrinsic calibration correction buffer:
  • The extrinsic calibration correction buffer is published on the ["~/ods_extrinsics_calibration_correction"]{.title-ref} topic.
• Add support for the polar occupancy grid buffer:
  • The polar occupancy grid is published on the ["~/ods_polar_occupancy_grid"]{.title-ref} topic.
• Fixed an issue with the published intrinsic parameters to the [camera_info]{.title-ref} topic.
• Added an option to publish uncompressed images.
• Added publication of reflectivity and distance noise

1.2

1.2.0

• Create an ODS node to publish ODS data:
  • The launch file [ods.launch.py]{.title-ref} can be used,
  • Add two topics, ["~/ods_info"]{.title-ref} and ["~/ods_occupancy_map_ros"]{.title-ref},
  • An example launch configuration for ODS is provided [ods_default_parameters.yaml]{.title-ref} and can be used with the launch file,
  • It is expected that ODS is configured before the node is launched. Alternatively, one can use the new [config_file]{.title-ref} parameter.
• Remove the [diag_mode]{.title-ref} parameter: diagnostic is always polled periodically and published to ["/diagnostic"]{.title-ref}
• Add the [GetDiag]{.title-ref} service for polling filtered diagnostic data.
• Camera info topic:
  • Add a ["~/camera_info"]{.title-ref} topic for RGB cameras.
  • The ["~/camera_info"]{.title-ref} topic for the TOF cameras is published when the [TOF_INFO]{.title-ref} buffer is requested, instead of the [INTRINSIC]{.title-ref} buffer.
• Add a [config_file]{.title-ref} parameter. It should be formatted in JSON and will be used to configure the device when the [CONFIGURE]{.title-ref} state is triggered.

* Transforms:

• The [cloud_link]{.title-ref} was renamed to [ifm_base_link]{.title-ref}, and is used as the reference ifm calibrated coordinate system for all ifm data (RGB, 3D and ODS).
• The transforms between the [cloud_link]{.title-ref} (now [ifm_base_link]{.title-ref}), and the [mounting_link]{.title-ref} and [optical_link]{.title-ref} are fixed.
• The [mounting_link]{.title-ref} to [optical_link]{.title-ref} transform is read when the first [TOF_INFO]{.title-ref} or [RGB_INFO]{.title-ref} buffer is received, and remains constant.
• The [ifm_base_link]{.title-ref} to [mounting_link]{.title-ref}

File truncated at 100 lines see the full file