Package rosgraph

Submodules

rosgraph.impl
- rosgraph.impl.graph
rosgraph.masterapi: Python adapter for calling ROS Master API.
rosgraph.names: Library for manipulating ROS Names.
rosgraph.network: Network APIs for ROS-based systems, including IP address and ROS TCP header libraries.
rosgraph.rosenv
rosgraph.rosgraph_main
rosgraph.roslogging: Library for configuring python logging to standard ROS locations (e.g.
rosgraph.xmlrpc

Classes
	Master API for interacting with the ROS master.
	MasterError Master returned an error code, which indicates an error in the arguments passed to the Master.
	MasterException Base class of ROS-master related errors.
	MasterFailure Call to Master failed.

Functions

get_master_uri(env=None, argv=None)
Get the :envvar:`ROS_MASTER_URI` setting from the command-line args or environment, command-line args takes precedence.

source code

is_master_online(master_uri=None)
Returns: True if Master is available

source code

myargv(argv=None)
Remove ROS remapping arguments from sys.argv arguments.

source code

Variables
	ROS_HOSTNAME = `'ROS_HOSTNAME'`
	ROS_IP = `'ROS_IP'`
	ROS_IPV6 = `'ROS_IPV6'`
	ROS_MASTER_URI = `'ROS_MASTER_URI'`
	ROS_NAMESPACE = `'ROS_NAMESPACE'`

Function Details

get_master_uri(env=None, argv=None)

source code


Get the :envvar:`ROS_MASTER_URI` setting from the command-line args or
environment, command-line args takes precedence.

:param env: override environment dictionary, ``dict``
:param argv: override ``sys.argv``, ``[str]``
:raises: :exc:`ValueError` If :envvar:`ROS_MASTER_URI` value is invalidly
  specified

is_master_online(master_uri=None)

source code

Parameters:

master_uri (str) - (optional) override environment's ROS_MASTER_URI

Returns:

True if Master is available

myargv(argv=None)

source code

Remove ROS remapping arguments from sys.argv arguments.

:returns: copy of sys.argv with ROS remapping arguments removed, ``[str]``