niryo_libraries.rosgraph

package documentation

Undocumented

Package	`impl`	Undocumented
Module	`masterapi`	Python adapter for calling ROS Master API. While it is trivial to call the Master directly using XML-RPC, this API provides a safer abstraction in the event the Master API is changed.
Module	`names`	Library for manipulating ROS Names. See U{http://ros.org/wiki/Names}.
Module	`network`	Network APIs for ROS-based systems, including IP address and ROS TCP header libraries. Because ROS-based runtimes must respect the ROS_IP and ROS_HOSTNAME environment variables, ROS-specific APIs are necessary for correctly retrieving local IP address information.
Module	`rosenv`	Undocumented
Module	`rosgraph_main`	Undocumented
Module	`roslogging`	Library for configuring python logging to standard ROS locations (e.g. ROS_LOG_DIR).
Module	`xmlrpc`	No module docstring; 2/2 functions, 4/5 classes documented

From __init__.py:

Class	`Master`	API for interacting with the ROS master. Although the Master is relatively simple to interact with using the XMLRPC API, this abstraction layer provides protection against future updates. It also provides a streamlined API with builtin return code checking and caller_id passing.
Exception	`MasterError`	Master returned an error code, which indicates an error in the arguments passed to the Master.
Exception	`MasterException`	Base class of ROS-master related errors.
Exception	`MasterFailure`	Call to Master failed. This generally indicates an internal error in the Master and that the Master may be in an inconsistent state.
Function	`get_master_uri`	Get the :envvar:`ROS_MASTER_URI` setting from the command-line args or environment, command-line args takes precedence.
Function	`is_master_online`	@param master_uri: (optional) override environment's ROS_MASTER_URI @type master_uri: str @return: True if Master is available
Function	`myargv`	Remove ROS remapping arguments from sys.argv arguments.
Constant	`ROS_HOSTNAME`	Undocumented
Constant	`ROS_IP`	Undocumented
Constant	`ROS_IPV6`	Undocumented
Constant	`ROS_MASTER_URI`	Undocumented
Constant	`ROS_NAMESPACE`	Undocumented

def 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.

Parameters
env	override environment dictionary, `dict`
argv	override `sys.argv`, `[str]`
Raises
`Unknown exception`	`ValueError` If :envvar:`ROS_MASTER_URI` value is invalidly specified

ROS_MASTER_URI: str = ¶

Undocumented

Value

'ROS_MASTER_URI'

ROS_NAMESPACE: str = ¶

Undocumented

Value

'ROS_NAMESPACE'

ROS_HOSTNAME: str = ¶

Undocumented

Value

'ROS_HOSTNAME'

ROS_IP: str = ¶

Undocumented

Value

'ROS_IP'

ROS_IPV6: str = ¶

Undocumented

Value

'ROS_IPV6'

def is_master_online(master_uri=None): ¶

@param master_uri: (optional) override environment's ROS_MASTER_URI @type master_uri: str @return: True if Master is available

def myargv(argv=None): ¶

Remove ROS remapping arguments from sys.argv arguments.

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