rosros 0.2.5
Simple unified interface to ROS1 / ROS2 Python API
Loading...
Searching...
No Matches
ros1.py File Reference

Go to the source code of this file.

Classes

class  rosros.ros1.Bag
 ROS1 bag reader and writer. More...
 
class  rosros.ros1.Mutex
 Container for local mutexes. More...
 
class  rosros.ros1.ROSLogHandler
 Logging handler that forwards logging messages to ROS1 logger. More...
 

Namespaces

namespace  rosros
 Simple unified interface to ROS1 / ROS2.
 
namespace  rosros.ros1
 ROS1 core interface.
 

Functions

 rosros.ros1.canonical (typename)
 Returns "pkg/Type" for "pkg/subdir/Type".
 
 rosros.ros1.create_client (service, cls_or_typename)
 Returns a ROS1 service client instance, for invoking a service.
 
 rosros.ros1.create_publisher (topic, cls_or_typename, latch=False, queue_size=0)
 Returns a ROS1 publisher instance.
 
 rosros.ros1.create_rate (frequency)
 Returns a ROS1 rate instance, for sleeping at a fixed rate.
 
 rosros.ros1.create_service (service, cls_or_typename, callback)
 Returns a ROS1 service server instance, for providing a service.
 
 rosros.ros1.create_subscriber (topic, cls_or_typename, callback, callback_args=None, queue_size=0, raw=False)
 Returns a ROS1 subscriber instance.
 
 rosros.ros1.create_timer (period, callback, oneshot=False, immediate=False)
 Returns a ROS1 timer instance.
 
 rosros.ros1.delete_param (name)
 Deletes parameter from the node.
 
 rosros.ros1.deserialize_message (raw, cls_or_typename)
 Returns ROS1 message or service request/response instantiated from serialized binary.
 
 rosros.ros1.destroy_entity (item)
 Closes the given publisher, subscriber, service client, or service server instance.
 
 rosros.ros1.format_param_name (name)
 Returns parameter name using "/" separator, and leading root or private sigils stripped.
 
 rosros.ros1.get_logger ()
 Returns `logging.Logger` for logging to ROS1 log handler.
 
 rosros.ros1.get_message_class (msg_or_type)
 Returns ROS1 message / service class object.
 
 rosros.ros1.get_message_definition (msg_or_type, full=True)
 Returns ROS1 message or service request/response type definition text.
 
 rosros.ros1.get_message_fields (val)
 Returns {field name: field type name} if ROS1 message or service request/response, else {}.
 
 rosros.ros1.get_message_header (val)
 Returns message `std_msgs/Header`-attribute if any, else `None`.
 
 rosros.ros1.get_message_type (msg_or_cls)
 Returns ROS1 message / service canonical type name, like "std_msgs/Header".
 
 rosros.ros1.get_message_type_hash (msg_or_type)
 Returns ROS1 message / service type MD5 hash.
 
 rosros.ros1.get_message_value (msg, name, default=...)
 Returns object attribute value, with numeric arrays converted to lists.
 
 rosros.ros1.get_namespace ()
 Returns ROS1 node namespace.
 
 rosros.ros1.get_node_name ()
 Returns ROS1 node full name with namespace.
 
 rosros.ros1.get_nodes ()
 Returns all ROS1 nodes, as `[node full name, ]`.
 
 rosros.ros1.get_param (name, default=None, autoset=True)
 Returns parameter value from current ROS1 node.
 
 rosros.ros1.get_param_names ()
 Returns the names of all current ROS1 node parameters.
 
 rosros.ros1.get_params (nested=True)
 Returns the current ROS1 node parameters, by default as nested dictionary.
 
 rosros.ros1.get_rostime ()
 Returns current ROS1 time, as `rospy.Time`.
 
 rosros.ros1.get_service_definition (srv_or_type)
 Returns ROS1 service type definition text.
 
 rosros.ros1.get_service_request_class (srv_or_type)
 Returns ROS1 service request class object.
 
 rosros.ros1.get_service_response_class (srv_or_type)
 Returns ROS1 service response class object.
 
 rosros.ros1.get_services (node=None, namespace=None, include_types=True)
 Returns all available ROS1 services, as `[(service name, [type name, ]), ]`.
 
 rosros.ros1.get_topics ()
 Returns all available ROS1 topics, as `[(topic name, [type name, ]), ]`.
 
 rosros.ros1.has_param (name)
 Returns whether the parameter exists.
 
 rosros.ros1.init_node (name, args=None, namespace=None, anonymous=False, log_level=None, enable_rosout=True)
 Initializes rospy and creates ROS1 node.
 
 rosros.ros1.init_params (defaults=None, **defaultkws)
 Declares all parameters on node from defaults dictionary.
 
 rosros.ros1.is_ros_message (val)
 Returns whether value is a ROS1 message or service request/response class or instance.
 
 rosros.ros1.is_ros_service (val)
 Returns whether value is a ROS1 service class object or instance.
 
 rosros.ros1.is_ros_time (val)
 Returns whether value is a ROS1 time/duration class or instance.
 
 rosros.ros1.make_duration (secs=0, nsecs=0)
 Returns a ROS1 duration, as rospy.Duration.
 
 rosros.ros1.make_time (secs=0, nsecs=0)
 Returns a ROS1 time, as rospy.Time.
 
 rosros.ros1.ok ()
 Returns whether ROS1 has been initialized and is not shut down.
 
 rosros.ros1.on_shutdown (callback, *args, **kwargs)
 Registers function to be called on shutdown, after node has been torn down.
 
 rosros.ros1.register_init ()
 Informs `rosros` of ROS1 having been initialized outside of `init_node()`.
 
 rosros.ros1.remap_name (name, namespace=None)
 Returns the absolute remapped topic/service name if mapping exists.
 
 rosros.ros1.resolve_name (name, namespace=None)
 Returns absolute remapped name, namespaced under current node if relative or private.
 
 rosros.ros1.scalar (typename)
 Returns scalar type from ROS message data type, like "uint8" from "uint8[100]".
 
 rosros.ros1.serialize_message (msg)
 Returns ROS1 message or service request/response as a serialized binary of `bytes()`.
 
 rosros.ros1.set_param (name, value)
 Sets a parameter on the node.
 
 rosros.ros1.shutdown (reason=None)
 Sends the shutdown signal to rospy.
 
 rosros.ros1.sleep (duration)
 Sleeps for the specified duration in ROS time.
 
 rosros.ros1.spin ()
 Spins ROS1 forever.
 
 rosros.ros1.spin_once (timeout=None)
 Waits until timeout, or forever if timeout None or negative.
 
 rosros.ros1.spin_until_future_complete (future, timeout=None)
 Spins ROS1 until future complete or timeout reached or ROS shut down.
 
 rosros.ros1.start_spin ()
 Sets ROS1 spinning forever in a background thread.
 
 rosros.ros1.to_duration (val)
 Returns value as ROS1 duration if convertible (int/float/time/datetime/decimal), else value.
 
 rosros.ros1.to_nsec (val)
 Returns value in nanoseconds if value is ROS1 time/duration, else value.
 
 rosros.ros1.to_sec (val)
 Returns value in seconds if value is ROS1 time/duration, else value.
 
 rosros.ros1.to_sec_nsec (val)
 Returns value as (seconds, nanoseconds) if value is ROS1 time/duration, else value.
 
 rosros.ros1.to_time (val)
 Returns value as ROS1 time if convertible (int/float/duration/datetime/decimal), else value.
 
 rosros.ros1.wait_for_publisher (topic, timeout=None, cls_or_typename=None)
 Blocks until topic has at least one publisher.
 
 rosros.ros1.wait_for_service (service, timeout=None, cls_or_typename=None)
 Blocks until service is available.
 
 rosros.ros1.wait_for_subscriber (topic, timeout=None, cls_or_typename=None)
 Blocks until topic has at least one subscriber.
 

Variables

 rosros.ros1.AnyMsg = rospy.AnyMsg
 `rospy.AnyMsg`
 
str rosros.ros1.FAMILY = "rospy"
 ROS Python module family, "rospy".
 
 rosros.ros1.MASTER = None
 rospy.MasterProxy instance
 
str rosros.ros1.PARAM_SEPARATOR = "/"
 Separator char between ROS1 parameter namespace parts.
 
str rosros.ros1.PRIVATE_PREFIX = "~"
 Prefix for "private" names, auto-namespaced under current namespace.
 
dict rosros.ros1.PY_LOG_LEVEL_TO_ROSPY_LEVEL
 Map rospy log level constants to Python logging level constants.
 
dict rosros.ros1.ROS_ALIAS_TYPES = {"byte": "int8", "char": "uint8"}
 Mapping between ROS type aliases and real types, like {"byte": "int8"}.
 
dict rosros.ros1.ROS_TIME_CLASSES = {rospy.Time: "time", rospy.Duration: "duration"}
 ROS1 time/duration types mapped to type names.
 
list rosros.ros1.ROS_TIME_TYPES = ["time", "duration"]
 ROS1 time/duration types.
 
 rosros.ros1.SPINNER = None
 `threading.Thread` for start_spin()