Python examples for tf2

This package has examples for using the tf2_ros API from python. It shows how to broadcast and receive transforms between frames. The example transforms might be seen on a small two wheel robot.

Broadcasting Transforms

tf2 publishes two types of transforms: static and dynamic. Static transforms are constant, and never change once published. Dynamic transforms are frequently changing, and re-published every time the do.

Both broadcasters can be run with

ros2 launch examples_tf2_py broadcasters.launch.xml

dynamic_broadcaster.py

ros2 run examples_tf2_py dynamic_broadcaster

This is an example of a dynamic transform publisher. Transforms showing the rotation of two wheels are published frequently.

static_broadcaster.py

ros2 run examples_tf2_py static_broadcaster

This is an example of a static transform publisher. The transforms to sensors on the robot are published once at startup, and then never changed.

Receiving Transforms

Transforms are broadcast to all listeners, who then use the data. If a transform is not immediately available then users of the data may choose to wait for it.

waits_for_transform.py

ros2 run examples_tf2_py waits_for_transform

This example blocks until a transform is received. It must be run with a MultiThreadedExecutor so the TransformListener can execute callbacks for it’s subscriptions.

async_waits_for_transforms.py

ros2 run examples_tf2_py async_waits_for_transform

This example uses coroutines to wait for a transform. The coroutine is suspended without blocking the executor, so it works with a SingleThreadedExecutor.

Frame Dumper

ros2 run examples_tf2_py frame_dumper

This example periodically outputs information about all frames it is aware of.

Changelog for package examples_tf2_py

0.39.2 (2024-11-20)

• Add in test_xmllint for geometry2 python packages. (#725)
• Contributors: Chris Lalancette

0.39.1 (2024-10-15)

0.39.0 (2024-10-03)

0.38.2 (2024-07-19)

• Switch to using a context manager for the python examples. (#700) That way we can be sure to always clean up, but use less code doing so.
• Contributors: Chris Lalancette

0.38.1 (2024-07-09)

0.38.0 (2024-06-17)

0.37.1 (2024-05-29)

0.37.0 (2024-04-26)

0.36.2 (2024-04-10)

0.36.1 (2024-03-28)

0.36.0 (2024-02-07)

0.35.1 (2024-01-24)

0.35.0 (2023-12-26)

0.34.0 (2023-11-06)

0.33.2 (2023-10-04)

0.33.1 (2023-09-07)

0.33.0 (2023-08-21)

0.32.2 (2023-07-11)

0.32.1 (2023-05-11)

0.32.0 (2023-04-27)

0.31.2 (2023-04-13)

0.31.1 (2023-04-12)

0.31.0 (2023-04-11)

• Enable document generation using rosdoc2 for ament_python pkgs (#587)
• Contributors: Yadu

0.30.0 (2023-02-14)

0.29.0 (2022-11-21)

• Update maintainers (#560)
• Contributors: Audrow Nash

0.28.0 (2022-11-02)

0.27.0 (2022-09-13)

0.26.2 (2022-08-15)

0.26.1 (2022-06-24)

0.26.0 (2022-04-29)

0.25.0 (2022-04-05)

0.24.0 (2022-03-31)

0.23.0 (2022-03-28)

0.22.0 (2022-03-01)

0.21.0 (2022-01-14)

0.20.0 (2021-12-17)

• Update maintainers to Alejandro Hernandez Cordero and Chris Lalancette (#481)
• Contributors: Audrow Nash

0.19.0 (2021-10-15)

0.18.0 (2021-06-01)

• Use underscores instead of dashes in setup.cfg. (#403)
• Contributors: Chris Lalancette

0.17.1 (2021-04-06)

0.17.0 (2021-03-19)

0.16.0 (2021-01-25)

0.15.1 (2020-12-08)

0.15.0 (2020-11-02)

• Update maintainers of the ros2/geometry2 fork. (#328)
• Contributors: Chris Lalancette

0.14.1 (2020-09-21)

0.14.0 (2020-08-14)

• Add pytest.ini so local tests don't display warning (#276)
• Split tf2_ros in tf2_ros and tf2_ros_py (#210)
• Contributors: Alejandro Hernández Cordero, Chris Lalancette

0.13.4 (2020-06-03)

0.13.3 (2020-05-26)

0.13.2 (2020-05-18)

0.13.1 (2020-05-08)

0.13.0 (2020-04-30)

• more verbose test_flake8 error messages (same as ros2/launch_ros#135)
• Contributors: Dirk Thomas

0.12.4 (2019-11-19)

• Add Python examples for tf2_ros (#161)