Package rosgraph :: Module masterapi

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.

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

Functions

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

source code

Variables
	__package__ = `'rosgraph'`

Function Details

is_online(master_uri=None)

source code

Parameters:

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

Returns:

True if Master is available