|
| | calculate_definition_hash (typename, msgdef, extradefs=()) |
| |
| | canonical (typename, unbounded=False) |
| |
| | create_publisher (topic, cls_or_typename, queue_size) |
| |
| | create_subscriber (topic, cls_or_typename, handler, queue_size) |
| |
| | deserialize_message (msg, cls_or_typename) |
| |
| | dict_to_message (dct, msg) |
| |
| | filter_fields (fieldmap, top=(), include=(), exclude=()) |
| |
| | format_message_value (msg, name, value) |
| |
| | get_alias_type (typename) |
| |
| | get_message_class (typename) |
| |
| | get_message_definition (msg_or_type) |
| |
| | get_message_fields (val) |
| |
| | get_message_type (msg_or_cls) |
| |
| | get_message_type_hash (msg_or_type) |
| |
| | get_message_value (msg, name, typename=None, default=Ellipsis) |
| |
| | get_ros_time_category (msg_or_type) |
| |
| | get_rostime (fallback=False) |
| |
| | get_topic_types () |
| |
| | get_type_alias (typename) |
| |
| | init_node (name=None) |
| |
| | is_ros_message (val, ignore_time=False) |
| |
| | is_ros_time (val) |
| |
| | iter_message_fields (msg, messages_only=False, flat=False, scalars=(), include=(), exclude=(), top=()) |
| |
| | make_bag_time (stamp, bag) |
| |
| | make_duration (secs=0, nsecs=0) |
| |
| | make_full_typename (typename, category="msg") |
| |
| | make_live_time (stamp) |
| |
| | make_message_hash (msg, include=(), exclude=()) |
| |
| | make_time (secs=0, nsecs=0) |
| |
| | message_to_dict (msg, replace=None) |
| |
| | parse_definition_fields (typename, typedef) |
| |
| | parse_definition_subtypes (typedef, nesting=False) |
| |
| | scalar (typename) |
| |
| | serialize_message (msg) |
| |
| | set_message_value (obj, name, value) |
| |
| | shutdown_node () |
| |
| | time_message (val, to_message=True, clock_type=None) |
| |
| | to_datetime (val) |
| |
| | to_decimal (val) |
| |
| | to_duration (val) |
| |
| | to_nsec (val) |
| |
| | to_sec (val) |
| |
| | to_sec_nsec (val) |
| |
| | to_time (val) |
| |
| | validate (live=False) |
| |
|
| tuple | BAG_EXTENSIONS = () |
| | Bagfile extensions to seek, including leading dot, populated after init.
|
| |
| str | NODE_NAME = "grepros" |
| | Node base name for connecting to ROS (will be anonymized).
|
| |
| | realapi = None |
| | Module grepros.ros1 or grepros.ros2.
|
| |
| | ROS1 = None |
| | Flag denoting ROS1 environment, populated on validate()
|
| |
| | ROS2 = None |
| | Flag denoting ROS2 environment, populated on validate()
|
| |
| dict | ROS_ALIAS_TYPES = {} |
| | Mapping between type aliases and real types, like {"byte": "int8"} in ROS1.
|
| |
| dict | ROS_BUILTIN_CTORS |
| | Python constructors for ROS built-in types, as {ROS name: type class}.
|
| |
| list | ROS_BUILTIN_TYPES = ROS_NUMERIC_TYPES + ROS_STRING_TYPES |
| | All built-in basic types in ROS.
|
| |
| list | ROS_COMMON_TYPES = [] |
| | All built-in basic types plus time types in ROS, populated after init.
|
| |
| | ROS_FAMILY = None |
| | ROS Python module family, "rospy" or "rclpy", populated on validate()
|
| |
| list | ROS_NUMERIC_TYPES |
| | All built-in numeric types in ROS.
|
| |
| list | ROS_STRING_TYPES = ["string", "wstring"] |
| | All built-in string types in ROS.
|
| |
| dict | ROS_TIME_CLASSES = {} |
| | ROS1 time/duration types mapped to type names, populated after init.
|
| |
| list | ROS_TIME_TYPES = [] |
| | ROS time/duration types, populated after init.
|
| |
| | ROS_VERSION = None |
| | ROS version from environment, populated on validate() as integer.
|
| |
| tuple | SKIP_EXTENSIONS = () |
| | Bagfile extensions to skip, including leading dot, populated after init.
|
| |
ROS interface, shared facade for ROS1 and ROS2.
------------------------------------------------------------------------------
This file is part of grepros - grep for ROS1 bag files and live topics.
Released under the BSD License.
@author Erki Suurjaak
@created 01.11.2021
@modified 13.02.2026
------------------------------------------------------------------------------
| canonical |
( |
|
typename, |
|
|
|
unbounded = False |
|
) |
| |
Returns "pkg/Type" for "pkg/subdir/Type", standardizes various ROS2 formats.
Converts ROS2 DDS types like "octet" to "byte", and "sequence<uint8, 100>" to "uint8[100]".
@param unbounded drop constraints like array bounds, and string bounds in ROS2,
e.g. returning "uint8[]" for "uint8[10]"
Definition at line 664 of file api.py.
| filter_fields |
( |
|
fieldmap, |
|
|
|
top = (), |
|
|
|
include = (), |
|
|
|
exclude = () |
|
) |
| |
Returns fieldmap filtered by include and exclude patterns.
@param fieldmap {field name: field type name}
@param top parent path as (rootattr, ..)
@param include [((nested, path), re.Pattern())] to require in parent path
@param exclude [((nested, path), re.Pattern())] to reject in parent path
Definition at line 691 of file api.py.
| iter_message_fields |
( |
|
msg, |
|
|
|
messages_only = False, |
|
|
|
flat = False, |
|
|
|
scalars = (), |
|
|
|
include = (), |
|
|
|
exclude = (), |
|
|
|
top = () |
|
) |
| |
Yields ((nested, path), value, typename) from ROS message.
@param messages_only whether to yield only values that are ROS messages themselves
or lists of ROS messages, else will yield scalar and scalar list values
@param flat recurse into lists of nested messages, ignored if `messages_only`
@param scalars sequence of ROS types to consider as scalars, like ("time", duration")
@param include [((nested, path), re.Pattern())] to require in field path, if any
@param exclude [((nested, path), re.Pattern())] to reject in field path, if any
@param top internal recursion helper
Definition at line 832 of file api.py.
| make_message_hash |
( |
|
msg, |
|
|
|
include = (), |
|
|
|
exclude = () |
|
) |
| |
Returns hashcode for ROS message, as a hex digest.
@param include message fields to include if not all, as [((nested, path), re.Pattern())]
@param exclude message fields to exclude, as [((nested, path), re.Pattern())]
Definition at line 945 of file api.py.
| parse_definition_fields |
( |
|
typename, |
|
|
|
typedef |
|
) |
| |
Returns field names and type names from a message definition text.
Does not recurse into subtypes.
@param typename ROS message type name, like "my_pkg/MyCls"
@param typedef ROS message definition, like "Header header\nbool a\nMyCls2 b"
@return ordered {field name: type name},
like {"header": "std_msgs/Header", "a": "bool", "b": "my_pkg/MyCls2"}
Definition at line 1028 of file api.py.
1.9.8