Common Methods — Module

This module offers common methods to find ROS_MASTER_URI, resolve URI to find a resource or create a regular expression pattern.

fkie_master_discovery.common.create_pattern(param, data, has_interface, default=[], mastername='')

Create and compile the regular expression for given parameter. The data is taken from data. If the data was read from the interface file, then you have to set the has_interface to True. If has_interface is False, the data will be ignored and the parameter will be read from ROS parameter server. If resulting value is an empty list, \b (http://docs.python.org/2/library/re.html) will be added to the pattern as EMPTY_PATTERN.

Parameters:

• param (str) – parameter name
• data (dict) – The dictionary, which can contain the parameter name and value. The data will be ignored, if has_interface is False.
• has_interface (bool) – True, if valid data is available.
• default (list) – Default value will be added to the data

Returns:

the compiled regular expression

Return type:

The result of re.compile()

fkie_master_discovery.common.gen_pattern(filter_list, name, print_info=True, mastername=None)

fkie_master_discovery.common.get_hostname(url)

Extracts the hostname from given url.

Parameters:url (str) – the url to parse Returns:the hostname or None, if the url is None or invalid Return type:str See:http://docs.python.org/library/urlparse.html

fkie_master_discovery.common.get_port(url)

Extracts the port from given url.

Parameters:url (str) – the url to parse Returns:the port or None, if the url is None or invalid Return type:int See:http://docs.python.org/library/urlparse.html

fkie_master_discovery.common.get_ros_param(name, default)

fkie_master_discovery.common.is_empty_pattern(re_object)

Returns the value of EMPTY_PATTERN.

fkie_master_discovery.common.masteruri_from_master(from_env_on_error=False)

Requests the ROS master URI from the ROS master through the RPC interface and returns it. The ‘materuri’ attribute will be set to the requested value.

Returns:ROS master URI Return type:str or None

fkie_master_discovery.common.masteruri_from_ros()

Returns the master URI depending on ROS distribution API.

Returns:ROS master URI Return type:str See:rosgraph.rosenv.get_master_uri() (fuerte) See:roslib.rosenv.get_master_uri() (prior)

fkie_master_discovery.common.read_interface(interface_file)

Reads the given file. You can use fkie_master_discovery.common.resolve_url() to resolve an URL to a file.

Parameters:interface_file (str) – the file containing the interface. Raises:ValueError – on error while read interface Returns:directory with content of the given file

fkie_master_discovery.common.resolve_url(interface_url, pwd='.')

The supported URL begins with file:///, package:// or pkg://. The package URL will be resolved to a valid file path. If the file is in a subdirectory, you can replace the subdirectory by ///.

E.g.: package://fkie_master_discovery///master_discovery.launch

Raises:ValueError – on invalid URL or not existent file Returns:the file path

fkie_master_discovery.common.subdomain(hostname)

Returns:the name with first subdomain

Filter Interface — Module

This module offers a Filter class to filter out nodes, topics or services from MasterInfo.

class fkie_master_discovery.filter_interface.FilterInterface

Bases: object

The class represents a filter used by sync node to filter nodes, topics or services. The filter is based on regular expressions. The filter object can be converted to a tuple of strings and then passed to the XML-RPC method to get a filtered ROS master state. After creation of the filter object you must call fkie_master_discovery.filter_interface.FilterInterface.load() or fkie_master_discovery.filter_interface.FilterInterface.from_list(). Otherwise the object is invalid and the test methods return always False.

do_not_sync(name)

static from_list(l=None)

Reads the tuple of

(sync_remote_nodes,
ignore_nodes, sync_nodes,
ignore_topics, sync_topics,
ignore_services, sync_services,
ignore_type,
ignore_publishers, ignore_subscribers,
do_not_sync)`

with types (bool, str, str, str, str, str, str, str, str)

and creates the FilterInterface object.

Returns:FilterInterface object or None on failure

is_ignored_node(node)

Searches the given node in ignore_nodes and sync_nodes lists.

Parameters:node (str) – the name of the node to test. Returns:True, if the node was found in the ignore_nodes list or the sync_nodes is not empty. Note:If the filter object is not initialized by load() or from_list() the returned value is False

is_ignored_publisher(node, topic, topictype)

Searches first in the ignore_publishers ignore list Then in ignore lists ignore_type, ignore_nodes and ignore_topics. Finally in sync_nodes or sync_topics.

Parameters:

• node (str) – the name of the node published or subscribed the topic.
• topic (str) – the name of the topic to test.
• topictype (str) – the type of the topic. (e.g. the synchronization of bond/Status terminate the nodelets)

Returns:

True, if the values are found in ignore_type, ignore_nodes or ignore_topics. If sync_nodes or sync_topics is empty True will be returned, too.

Note:

If the filter object is not initialized by load() or from_list() the returned value is False

is_ignored_service(node, service)

Searches firstly in ignore lists ignore_nodes and ignore_services. Then in sync_nodes or sync_services.

Parameters:

• node (str) – the name of the node provided the service.
• topic (str) – the name of the service to test.

Returns:

True, if the values are found in ignore_nodes or ignore_services. If sync_nodes or sync_services is empty True will be returned, too.

Note:

If the filter object is not initialized by load() or from_list() the returned value is False

is_ignored_subscriber(node, topic, topictype)

Searches first in the ignore_subscribers ignore list Then in ignore lists ignore_type, ignore_nodes and ignore_topics. Finally in sync_nodes or sync_topics.

Parameters:

• node (str) – the name of the node published or subscribed the topic.
• topic (str) – the name of the topic to test.
• topictype (str) – the type of the topic. (e.g. the synchronization of bond/Status terminate the nodelets)

Returns:

True, if the values are found in ignore_type, ignore_nodes or ignore_topics. If sync_nodes or sync_topics is empty True will be returned, too.

Note:

If the filter object is not initialized by load() or from_list() the returned value is False

is_ignored_topic(node, topic, topictype)

NOTE: This function is deprecated. Please use is_ignored_subscriber and is_ignored_publisher instead

Searches firstly in ignore lists ignore_type, ignore_nodes and ignore_topics. Then in sync_nodes or sync_topics.

Parameters:

• node (str) – the name of the node published or subscribed the topic.
• topic (str) – the name of the topic to test.
• topictype (str) – the type of the topic. (e.g. the synchronization of bond/Status terminate the nodelets)

Returns:

True, if the values are found in ignore_type, ignore_nodes or ignore_topics. If sync_nodes or sync_topics is empty True will be returned, too.

Note:

If the filter object is not initialized by load() or from_list() the returned value is False

load(mastername='', ignore_nodes=[], sync_nodes=[], ignore_topics=[], sync_topics=[], ignore_srv=[], sync_srv=[], ignore_type=[], ignore_publishers=[], ignore_subscribers=[], do_not_sync=[])

Reads the parameter and creates the pattern using fkie_master_discovery.common.create_pattern()

read_do_not_sync()

set_hide_pattern(re_hide_nodes=re.compile('\x08', re.IGNORECASE), re_hide_topics=re.compile('\x08', re.IGNORECASE), re_hide_services=re.compile('\x08', re.IGNORECASE))

sync_remote_nodes()

Returns the value stored in sync_remote_nodes parameter.

to_list()

Returns:the tuple of the all filter patterns.

(sync_remote_nodes,
ignore_nodes, sync_nodes,
ignore_topics, sync_topics,
ignore_services, sync_services,
ignore_type,
ignore_publishers, ignore_subscribers,
do_not_sync)

Return type:(bool, str, str, str, str, str, str, str, str, str, str)

update_sync_topics_pattern(topics=[])

Updates the sync topics pattern.

Parameters:topics (list of strings) – the list of topics to sync.

Interface Finder — Module

This module offers methods to find the interface of the running master_discovery node.

fkie_master_discovery.interface_finder.get_changes_topic(masteruri, wait=True, check_host=True)

Search in publishers of ROS master for a topic with type fkie_master_discovery.msg.MasterState and returns his name, if it runs on the local host. Returns empty list if no topic was found and wait is False.

Parameters:

• masteruri (str) – the URI of the ROS master
• wait (bool) – check every second for the topic
• check_host (bool) – check for eqaul hostname of topic provider and master uri.

Returns:

the list with names of the topics of type fkie_master_discovery.msg.MasterState

Return type:

list of strings

fkie_master_discovery.interface_finder.get_listmaster_service(masteruri, wait=True, check_host=True)

Search in services of ROS master for a service with name ending by list_masters and returns his name, if it runs on the local host. Returns empty list if no service was found and wait is False.

Parameters:

• masteruri (str) – the URI of the ROS master
• wait (boo) – check every second for the service
• check_host (bool) – check for eqaul hostname of topic provider and master uri.

Returns:

the list with names of the services ending with list_masters

Return type:

list of strings

fkie_master_discovery.interface_finder.get_refresh_service(masteruri, wait=True, check_host=True)

Search in services of ROS master for a service with name ending by refresh and returns his name, if it runs on the local host. Returns empty list if no service was found and wait is False.

Parameters:

• masteruri (str) – the URI of the ROS master
• wait (boo) – check every second for the service
• check_host (bool) – check for eqaul hostname of topic provider and master uri.

Returns:

the list with names of the services ending with refresh

Return type:

list of strings

fkie_master_discovery.interface_finder.get_stats_topic(masteruri, wait=True, check_host=True)

Search in publishers of ROS master for a topic with type LinkStatesStamped and returns his name, if it runs on the local host. Returns empty list if no topic was found and wait is False.

Parameters:

• masteruri (str) – the URI of the ROS master
• wait (bool) – check every second for the topic
• check_host (bool) – check for eqaul hostname of topic provider and master uri.

Returns:

the list of names of the topic with type fkie_master_discovery.msg.LinkStatesStamped

Return type:

list of strings

Master Discovery — Module

class fkie_master_discovery.master_discovery.DiscoveredMaster(monitoruri, is_local=False, heartbeat_rate=1.0, timestamp=0.0, timestamp_local=0.0, callback_master_state=None)

Bases: object

The class stores all information about the remote ROS master and the all received heartbeat messages of the remote node. On first contact a theaded connection to remote discoverer will be established to get additional information about the ROS master.

Parameters:

• monitoruri (str) – The URI of the remote RPC server, which moniter the ROS master
• heartbeat_rate (float (Default: 1.`)) – The remote rate, which is used to send the heartbeat messages.
• timestamp (float (Default: 0)) – The timestamp of the state of the remoter ROS master
• timestamp_local (float (Default: 0)) – The timestamp of the state of the remoter ROS master, without the changes maked while a synchronization.
• callback_master_state – the callback method to publish the changes of the ROS masters

ERR_RESOLVE_NAME = 1

ERR_SOCKET = 2

MIN_HZ_FOR_QUALILTY = 0.3

add_heartbeat(timestamp, timestamp_local, rate)

Adds a new heartbeat measurement. If it is a new timestamp a ROS message about the change of this ROS master will be published into ROS network.

Parameters:

• timestamp (float) – The new timestamp of the ROS master state
• timestamp_local (float (Default: 0)) – The timestamp of the state of the remoter ROS master, without the changes maked while a synchronization.
• rate (float) – The remote rate, which is used to send the heartbeat messages. If the rate is zero the heartbeat is ignored.

Returns:

True on changes

Return type:

bool

add_request(timestamp)

Stores the count of requests. This count is used to determine offline state of remote master.

Parameters:timestamp (float) – time the request is sent.

errors

Copies the errors and returns as dictionary. :return: a dictionry of error type (ERR_*) and a message

finish()

get_quality(interval=5, offline_after=1.4)

Calculates the link quality to this master.

remove_heartbeats(timestamp)

Removes all heartbeat measurements, which are older as the given timestamp.

Parameters:timestamp (float) – heartbeats older this timestamp will be removed. Returns:the count of removed heartbeats Return type:int

requests_count()

set_offline()

Sets this master to offline and publish the new state to the ROS network.

class fkie_master_discovery.master_discovery.Discoverer(mcast_port, mcast_group, monitor_port, rpc_addr='')

Bases: object

The class to publish the current state of the ROS master.

Discovering is done by heartbeats:

Each master discovery node sends to a multicast group periodically messages with current state. If the frequency is less than 0.3 the detected changes on ROS master are published immediately. The current state is described by timestamp of last change. The frequency of heartbeats can be changed by ~heartbeat_hz parameter.

If heartbeats are disabled (~heartbeat_hz is zero) each master discovery node sends on start three notification messages and requests.

If for a host no more heartbeat are received while ACTIVE_REQUEST_AFTER (60 sec) a request to this host will be sent as an unicast message. After five unanswered requests the host state will be changed to offline. After REMOVE_AFTER (300 sec) the host will be removed.

Parameters:

• mcast_port (int) – The port used to publish and receive the multicast messages.
• mcast_group (str) – The IPv4 or IPv6 multicast group used for discovering over nodes.
• monitor_port (int) – The port of the RPC Server, used to get more information about the ROS master.

ACTIVE_REQUEST_AFTER = 60

send an update request, if after this time no heartbeats are received [sec] (Default: 60 sec).

CHANGE_NOTIFICATION_COUNT = 3

After the ROS master was changed the new state will be sent for CHANGE_NOTIFICATION_COUNT times (Default: 3 sec). The new state will be sent with ROSMASTER_HZ and only if HEARTBEAT_HZ is zero.

HEARTBEAT_FMT = 'cBBiiHii'

packet format description, see: http://docs.python.org/library/struct.html

HEARTBEAT_HZ = 0.02

the send rate of the heartbeat packets in hz. Zero disables the heartbeats. (Default: 0.02 Hz) Only values between 0.1 and 25.5 are used to detemine the link quality.

INIT_NOTIFICATION_COUNT = 3

the count of heartbeats and update request to send at the start (Default: 3 sec). It will be send with 1Hz. Only used if HEARTBEAT_HZ is zero.

MEASUREMENT_INTERVALS = 5

the count of intervals (1 sec) used for a quality calculation. If HEARTBEAT_HZ is smaller then 1, MEASUREMENT_INTERVALS will be divided by HEARTBEAT_HZ value. (Default: 5 sec are used to determine the link qaulity)

NETPACKET_SIZE = 68

OFFLINE_AFTER_REQUEST_COUNT = 5

After this unanswered count of requests for update the remote master is set to offline state (Default: 5 sec). The requests are send after ACTIVE_REQUEST_AFTER with ROSMASTER_HZ.

REMOVE_AFTER = 300

remove an offline host after this time in [sec] (Default: 300 sec).

ROSMASTER_HZ = 1

the test rate of ROS master state in Hz (Default: 1 Hz).

TIMEOUT_FACTOR = 10

the timeout is defined by calculated measurement duration multiplied by TIMEOUT_FAKTOR.

VERSION = 2

the version of the packet format described by HEARTBEAT_FMT

Version 1:‘cBBiiH’

one character 'R'
unsigned char: version of the heartbeat message
unsigned char: rate of the heartbeat message in HZ*10. Maximal rate: 25.5 Hz -> value 255
int: secs of the ROS Master state
int: nsecs of the ROS Master state
unsigned short: the port number of the RPC Server of the remote ROS-Core monitor

Version 2:‘cBBiiHii’

``Version 1``
int: secs of the ROS Master state (only local changes). Changes while sync will be ignored.
int: nsecs of the ROS Master state (only local changes). Changes while sync will be ignored.

Version 3:‘cBBiiHii’

``Version 2``
if the timestamp of ROS Master state is zero, the reply as unicast
message will be send to the sender.

checkROSMaster_loop()

The method test periodically the state of the ROS master. The new state will be published as heartbeat messages. fkie_master_discovery.master_monitor.MasterMonitor.checkState()

finish()

Callback called on exit of the ros node and publish the empty list of ROSMasters.

classmethod msg2masterState(msg, address)

Returns:parses the heartbeat message and return a tuple of version and values corresponding with current version of message. fkie_master_discovery.master_discovery.Discoverer.HEARTBEAT_FMT Raise:Exception on invalid message Return type:(unsigned char, tuple corresponding to fkie_master_discovery.master_discovery.Discoverer.HEARTBEAT_FMT)

on_shutdown(*arg)

publish_masterstate(master_state)

Publishes the given state to the ROS network. This method is thread safe.

Parameters:master_state – the master state to publish

publish_stats(stats)

Publishes the link quality states to the ROS network.This method is thread safe.

Parameters:stats – the link quality states to publish

recv_udp_msg(msg, address, via)

This method handles the received udp messages.

rosservice_list_masters(req)

Callback for the ROS service to get the current list of the known ROS masters.

rosservice_refresh(req)

Callback for the ROS service to send an active unicast and multicast request to each known master discovery.

send_heartbeat(timer=True)

Sends current state as heartbeat messages to defined multicast group. If the Discoverer.HEARTBEAT_HZ is greather then zero a timer will be started to send heartbeat messages periodically. This message will also send on start of the discoverer.

start()

timed_stats_calculation()

This method will be called by a timer and has two jobs:

1. set the masters offline, if no heartbeat messages are received a long time
2. calculate the quality of known links

update_master_errors()

Master Monitor — Module

exception fkie_master_discovery.master_monitor.MasterConnectionException

Bases: Exception

The exception class to handle the connection problems with ROS Master.

class fkie_master_discovery.master_monitor.MasterMonitor(rpcport=11611, do_retry=True, ipv6=False, rpc_addr='')

Bases: object

This class provides methods to get the state from the ROS master using his RPC API and test for changes. Furthermore an XML-RPC server will be created to offer the complete current state of the ROS master by one method call.

Parameters:

• rpcport (int) – the port number for the XML-RPC server
• do_retry (bool) – retry to create XML-RPC server

See:

fkie_master_discovery.master_monitor.MasterMonitor.getCurrentState(), respectively fkie_master_discovery.master_monitor.MasterMonitor.updateState()

RPC Methods:

fkie_master_discovery.master_monitor.MasterMonitor.getListedMasterInfo() or fkie_master_discovery.master_monitor.MasterMonitor.getMasterContacts() as RPC: masterInfo() and masterContacts()

INTERVAL_UPDATE_LAUNCH_URIS = 15.0

MAX_PING_SEC = 10.0

The time to update the node URI, ID or service URI (Default: 10.0)

checkState(clear_cache=False)

Gets the state from the ROS master and compares it to the stored state.

Parameters:clear_cache (bool (Default: False)) – The URI of nodes and services will be cached to reduce the load. If remote hosted nodes or services was restarted, the cache must be cleared! The local nodes will be updated periodically after fkie_master_discovery.master_monitor.MasterMonitor.MAX_PING_SEC. Returns:True if the ROS master state is changed Return type:bool

getCurrentState()

Returns:The current ROS Master State Return type:fkie_master_discovery.master_info.MasterInfo or None

getCurrentTime()

The RPC method called by XML-RPC server to request the current host time.

Returns:(ROS master URI, current time) Return type:(str, float)

getListedMasterInfo()

Returns:a extended ROS Master State. Return type:fkie_master_discovery.master_info.MasterInfo.listedState() for result type

getListedMasterInfoFiltered(filter_list)

Returns:a extended filtered ROS Master State. Return type:fkie_master_discovery.master_info.MasterInfo.listedState() for result type

getMasterContacts()

The RPC method called by XML-RPC server to request the master contact information.

Returns:(timestamp of the ROS master state, ROS master URI, master name, name of this service, URI of this RPC server) Return type:(str, str, str, str, str)

getMasterErrors()

The RPC method called by XML-RPC server to request the occured network errors.

Returns:(ROS master URI, list with errors) Return type:(str, [str])

getMastername()

Returns the name of the master. If no name is set, the hostname of the ROS master URI will be extracted.

Returns:the name of the ROS master Return type:str or None

getMasteruri()

Requests the ROS master URI from the ROS master through the RPC interface and returns it.

Returns:ROS master URI Return type:str or None

getTopicsMd5sum(topic_types)

Returns:a list with topic type and current md5sum.

• topic types is of the form

  [ (topic1, md5sum1) ... ]

Return type:list

getUser()

The RPC method called by XML-RPC server to request the user name used to launch the master_discovery.

Returns:(ROS master URI, user name) Return type:(str, str)

is_running()

reset()

Sets the master state to None.

rpcport = None

the port number of the RPC server

setTime(timestamp)

The RPC method called by XML-RPC server to set new host time. :param timestamp: UNIX timestamp :type timestamp: float :return: (ROS master URI, current time) :rtype: (str, float)

shutdown()

Shutdown the RPC Server.

updateState(clear_cache=False)

Gets state from the ROS Master through his RPC interface.

Parameters:clear_cache (bool (Default: False)) – The URI of nodes and services will be cached to reduce the load. If remote hosted nodes or services was restarted, the cache must be cleared! The local nodes will be updated periodically after fkie_master_discovery.master_monitor.MasterMonitor.MAX_PING_SEC. Return type:fkie_master_discovery.master_info.MasterInfo Raise:MasterConnectionException, if not complete information was get from the ROS master.

updateSyncInfo()

This method can be called to update the origin ROS master URI of the nodes and services in new master_state. This is only need, if a synchronization is running. The synchronization service will be detect automatically by searching for the service ending with get_sync_info. The method will be called by fkie_master_discovery.master_monitor.MasterMonitor.checkState().

update_master_errors(error_list)

class fkie_master_discovery.master_monitor.RPCThreading(addr, requestHandler=<class 'xmlrpc.server.SimpleXMLRPCRequestHandler'>, logRequests=True, allow_none=False, encoding=None, bind_and_activate=True)

Bases: socketserver.ThreadingMixIn, xmlrpc.server.SimpleXMLRPCServer

daemon_threads = True

class fkie_master_discovery.master_monitor.RPCThreadingV6(addr, requestHandler=<class 'xmlrpc.server.SimpleXMLRPCRequestHandler'>, logRequests=True, allow_none=False, encoding=None, bind_and_activate=True)

Bases: socketserver.ThreadingMixIn, xmlrpc.server.SimpleXMLRPCServer

address_family = 10

daemon_threads = True

Master Info — Module

class fkie_master_discovery.master_info.MasterInfo(masteruri, mastername=None)

Bases: object

The MasterInfo class stores informations about a ROS master. Not thread safe!

Parameters:

• masteruri (str) – The URI of the corresponding master
• mastername (str or None (Default: None)) – The name of the ROS master. If no one is given, it will be extracted from the masteruri.

check_ts = None

the last time, when the state of the ROS master retrieved

static from_list(l)

Creates a new instance of the MasterInfo from given list.

Parameters:l (list) – the list returned by fkie_master_discovery.master_info.MasterInfo.listedState() Returns:the new instance of the MasterInfo filled from list. Return type:fkie_master_discovery.master_info.MasterInfo

getNode(name)

Parameters:name (str) – the name of the node Returns:the instance of the fkie_master_discovery.master_info.NodeInfo with given name Return type:fkie_master_discovery.master_info.NodeInfo or None

getNodeEndsWith(suffix)

Returns the node, which name ends with given suffix. On more then one node, only the fist found will be returned.

Parameters:suffix (str) – the end of the name Returns:the instance of the fkie_master_discovery.master_info.NodeInfo with with given suffix Return type:fkie_master_discovery.master_info.NodeInfo or None

getService(name)

Returns the service with given name.

Parameters:name (str) – the name of the service Returns:the instance of the fkie_master_discovery.master_info.ServiceInfo with given name Return type:fkie_master_discovery.master_info.ServiceInfo or None

getTopic(name)

Returns the topics with given name.

Parameters:name (str) – the name of the topic Returns:the instance of the fkie_master_discovery.master_info.TopicInfo with given name. Return type:fkie_master_discovery.master_info.TopicInfo or None

has_local_changes(other)

Compares the master state with other master state. The timestamp will not be compared.

Parameters:other (fkie_master_discovery.master_info.MasterInfo) – the another MasterInfo instance. Returns:a tupel with two boolean values (all equal, only local equal) Return type:(bool, bool)

listedState(filter_interface=None)

Returns a extended ROS Master State.

Parameters:filter_interface (FilterInterface) – The filter used to filter the nodes, topics or serivces out. Returns:complete ROS Master State as

(stamp, stamp_local, masteruri, name, publishers, subscribers, services, topicTypes, nodes, serviceProvider)

• publishers is of the form

  [ [topic1, [topic1Publisher1...topic1PublisherN]] ... ]

• subscribers is of the form

  [ [topic1, [topic1Subscriber1...topic1SubscriberN]] ... ]

• services is of the form

  [ [service1, [service1Provider1...service1ProviderN]] ... ]

• topicTypes is a list of

  [ [topicName1, topicType1], ... ]

• nodes is a list of (the pid of remote Nodes will not be resolved)

  [nodename, XML-RPC URI, origin ROS_MASTER_URI, pid, {local, remote}]

• serviceProvider is a list of (the type, serviceClass and args of remote Services will not be resolved)

  [service, XML-RPC URI, origin ROS_MASTER_URI, type, {local, remote}]

Return type:(float, float, str, str, [ [str,[str] ] ], [ [str,[str] ] ], [ [str,[str] ] ], [ [str,str] ], [ [str,str,str,int,str] ], [ [str,str,str,str,str] ])

mastername

Returns:the name of the ROS master. In most cases the ROS master name is the name of the host, where the ROS master running. Although it can differ. Return type:str

masteruri

Returns:the URI of the ROS master. Return type:str

node_names

Returns:the list with node names Return type:list of strings

node_uris

Returns:the list with node URI’s. Return type:list of strings

nodes

Returns:the dictionary with node names and corresponding instances of NodeInfo. Return type:dict of (str : fkie_master_discovery.master_info.NodeInfo)

service_names

Returns:the list with service names. Return type:list of strings

service_uris

Returns:the list with service URI’s. Return type:list of strings

services

Returns:the dictionary with service names and corresponding ServiceInfo instances. Return type:dict of (str : fkie_master_discovery.master_info.ServiceInfo)

timestamp

Returns:The timestamp when this MasterInfo was first time filled with the information. See fkie_master_discovery.master_info.MasterInfo.check_ts() to get the time, when the information was compared with the data of ROS Master. Return type:float

timestamp_local

Returns:The timestamp when this MasterInfo was first time filled with the information. See fkie_master_discovery.master_info.MasterInfo.check_ts() to get the time, when the information was compared with the data of ROS Master. This timestamp is only updated, not synchronized nodes, topics or services are changed. Return type:float

topic_names

Returns:the list with topic names. Return type:list of strings

topics

Returns:the dictionary with topic names and corresponding TopicInfo instances. Return type:dict of (str : fkie_master_discovery.master_info.TopicInfo)

updateInfo(other)

Updates the information about nodes, topics and services. If the other masterinfo is from the same ROS Master all informations are copied. If other contains the info from remote ROS Master, only the informations for synchronized nodes, topics or services are copied. :param other: the new master information object :type other: MasterInfo :return: The tuple of sets with added, changed and removed nodes, topics and services :rtype: (nodes_added, nodes_changed, nodes_removed, topics_added, topics_changed, topics_removed, services_added, services_changed, services_removed)

class fkie_master_discovery.master_info.NodeInfo(name, masteruri)

Bases: object

The NodeInfo class stores informations about a ROS node.

Parameters:

• name (str) – the name of the node
• masteruri (str) – the URI of the ROS master, where the node is registered. This masteruri will be used to determine, whether the ROS master and the node are running on the same machine.

copy(new_masteruri=None)

Creates a copy of this object and returns it.

Parameters:new_masteruri – the masteruri of the new masterinfo Return type:fkie_master_discovery.master_info.NodeInfo

isLocal

Returns:True if the node and the ROS master are running on the same machine. Return type:bool

isLocalMaster

Returns:True if the node is registered on the local machine. Return type:bool

static local_(masteruri, org_masteruri, uri)

Test the node whether it’s run on the same machineas the ROS master and masteruri and org_masteruri are equal.

Parameters:

• masteruri (str) – The URI of the ROS master currently tested.
• org_masteruri (str) – The URI of the ROS master, where the node was originally registered.
• uri (str) – The URI of the node.

Return type:

bool

masteruri

Returns:the URI of the ROS master where the node is registered. Return type:str

name

Returns:the name of the node. Return type:str

pid = None

the process id of the node. Invalid id has a None value

publishedTopics

Returns:the list of all published topics by this node. Return type:list of strings

services

Returns:the list of all services provided by this node. Return type:list of strings

subscribedTopics

Returns:the list of all subscribed topics by this node. Return type:list of strings

uri

Returns:the URI of the RPC API of the node. Return type:str

class fkie_master_discovery.master_info.ServiceInfo(name, masteruri)

Bases: object

The ServiceInfo class stores informations about a ROS service.

Parameters:

• name (str) – the name of the service
• masteruri (str) – the URI of the ROS master, where the service is registered. This masteruri will be used to determine, whether the ROS master and the service are running on the same machine.

copy(new_masteruri=None)

Creates a copy of this object and returns it.

Parameters:new_masteruri – the masteruri of the new masterinfo Return type:fkie_master_discovery.master_info.NodeInfo

get_service_class(allow_get_type=False)

Get the service class using the type of the service. NOTE: this method is from rosservice and changed to avoid a probe call to the service.

Parameters:allow_get_type (bool) – allow to connect to service and get the type if the type is not valid (in case of other host) Returns:service class Return type:ServiceDefinition: service class Raise:ROSServiceException, if service class cannot be retrieved

isLocal

Returns:True, if this service and the master are on the same machine. This will be determine on setting the uri-parameter. Return type:bool

isLocalMaster

Returns:True if the service is registered on the local machine. Return type:bool

masteruri

Returns:the URI of the ROS master of the service Return type:str

name

Returns:the name of the service. Return type:str

serviceProvider

Returns:the list of the node names, which provide this service. Return type:list of strings

type = None

the type of the service. (Default: None)

uri

Returns:the URI of the RPC API of the service Return type:str

class fkie_master_discovery.master_info.TopicInfo(name)

Bases: object

The TopicInfo class stores informations about a ROS topic.

Parameters:name (str) – the name of the topic

copy()

Creates a copy this object and returns it.

Return type:fkie_master_discovery.master_info.TopicInfo

name

Returns:the name of the topic. Return type:str

publisherNodes

Returns:the list with node names witch are publishing to this topic. Return type:list of strings

subscriberNodes

Returns:the list with node names witch are subscribed to this topic. Return type:list of strings

type = None

the type of the topic. (Default: None)

udp — Module

class fkie_master_discovery.udp.DiscoverSocket(port, mgroup, ttl=20, send_mcast=True, listen_mcast=True)

Bases: socket.socket

The DiscoverSocket class enables the send and receive UDP messages to a multicast group and unicast address. The unicast socket is only created if ‘send_mcast’ and ‘listen_mcast’ parameter are set to False or a specific interface is defined.

Parameters:

• port (int) – the port to bind the socket
• mgroup (str) – the multicast group to join
• reuse (boolean (Default: True)) – allows the reusing of the port
• ttl (int (Default: 20)) – time to leave

close()

Unregister from the multicast group and close the socket.

hasEnabledMulticastIface()

Test all enabled interfaces for a MULTICAST flag. If no enabled interfaces has a multicast support, False will be returned.

Returns:True, if any interfaces with multicast support are enabled. Return type:bool

join_group()

static localifs()

Used to get a list of the up interfaces and associated IP addresses on this machine (linux only).

Returns:List of interface tuples. Each tuple consists of (interface name, interface IP) Return type:list of (str, str)

static normalize_mgroup(mgroup, getinterface=False)

recv_loop_multicast()

This method handles the received multicast messages.

recv_loop_unicast()

This method handles the received unicast messages.

send_queued(msg, destinations=[])

class fkie_master_discovery.udp.QueueReceiveItem(msg, sender_addr, via='LOOPBACK')

Bases: object

LOOPBACK = 'LOOPBACK'

MULTICAST = 'MULTICAST'

UNICAST = 'UNICAST'

class fkie_master_discovery.udp.QueueSendItem(msg, destinations=[])

Bases: object

class fkie_master_discovery.udp.UcastSocket(interface, port)

Bases: socket.socket

close()

Cleanup and close the socket

static getaddrinfo(addr, family=None)

Parameters:

• addr – the addess to get the info for
• family – type of the address family (e.g. socket.AF_INET)

send2addr(msg, addr)

Sends the given message to the joined multicast group. Some errors on send will be ignored (ENETRESET, ENETDOWN, ENETUNREACH) :param msg: message to send :type msg: str :param addr: IPv4 or IPv6 address :type addr: str

zeroconf — Module