[Documentation] [TitleIndex] [WordIndex

New in Indigo

  Show EOL distros: 

rocon_tools: rocon_console | rocon_ebnf | rocon_interactions | rocon_launch | rocon_master_info | rocon_python_comms | rocon_python_redis | rocon_python_utils | rocon_python_wifi | rocon_semantic_version | rocon_uri

Package Summary

Module for working with rocon uri strings.

Overview

Various entities in the rocon framework require a specification for describing the kind of resource it is, or the kind of resource it is compatible with. In particular, such a specification must describe entities like robots, define compatibility strings for apps (i.e. what robots/platforms can run this app) and shape robot requests (give me a robot with this specification and able to run this robot app). It is the glue which will ultimately enable us to run a diverse mix of robots and applications together to provide useful robotic solutions.

A typical rocon uri string is of the form:

rocon://concert_name/hardware_platform/name/application_framework/operating_system#rocon_app

You will see these flung around a rocon concert frequently at the ros api level. Examples:

Command Line Tools

There is a command line tool for introspecting and testing rocon uri strings:

Utility for introspecting on rocon uri strings.

Commands:
        rocon_uri parse URI     parse and attempt to validate a rocon URI.
        rocon_uri fields        print a full list of permitted fields in a rocon uri string.
        rocon_uri rules         print a full list of the ebnf rules for a rocon uri string.

Python Module

A detailed specification, the ebnf rules table and examples for parsing and compatibility checking with the python module can be found in the sphinx documentation.


2019-12-07 13:02