ros2topic.api package

Module contents

class ros2topic.api.TopicMessagePrototypeCompleter(*, topic_type_key=None)

Bases: object

Callable returning a message prototype.

class ros2topic.api.TopicNameCompleter(*, include_hidden_topics_key=None)

Bases: object

Callable returning a list of topic names.

class ros2topic.api.TopicTypeCompleter(*, topic_name_key=None)

Bases: object

Callable returning an existing topic type or all message types.

ros2topic.api.add_qos_arguments(parser: ArgumentParser, subscribe_or_publish: str, default_profile_str)

ros2topic.api.get_msg_class(node, topic, blocking=False, include_hidden_topics=False)

ros2topic.api.get_topic_names_and_types(*, node, include_hidden_topics=False)

ros2topic.api.message_type_completer(**kwargs): Callable returning a list of message types.

ros2topic.api.profile_configure_short_keys(profile: rclpy.qos.QoSProfile | None = None, reliability: str | None = None, durability: str | None = None, depth: int | None = None, history: str | None = None, liveliness: str | None = None, liveliness_lease_duration_s: int | None = None) → rclpy.qos.QoSProfile: Configure a QoSProfile given a profile, and optional overrides.

ros2topic.api.qos_profile_from_short_keys(preset_profile: str, reliability: str | None = None, durability: str | None = None, depth: int | None = None, history: str | None = None, liveliness: str | None = None, liveliness_lease_duration_s: float | None = None) → rclpy.qos.QoSProfile: Construct a QoSProfile given the name of a preset, and optional overrides.