API

namespace conf

Variables

string conf.on_rtd = ‘True’

list conf.extensions = [ ‘sphinx.ext.autodoc’, ‘sphinx.ext.doctest’, ‘sphinx.ext.intersphinx’, ‘sphinx.ext.todo’, ‘sphinx.ext.coverage’, ‘sphinx.ext.mathjax’, ‘sphinx.ext.ifconfig’, ‘sphinx.ext.viewcode’, ‘breathe’, ]

list conf.templates_path = [‘_templates’]

string conf.source_suffix = ‘.rst’

string conf.master_doc = ‘index’

string conf.project = u’Architecture Documentation Wiki’

string conf.copyright = u‘2016, Raphael Dürscheid, based on Template by Dr. Peter’

string conf.author = u’Raphael Dürscheid, based on Template by Dr. Peter’

string conf.version = u‘0.0.’

string conf.release = u‘0.0.’

dictionary conf.breathe_projects = { project: “doxyxml/” }

breathe_default_project = project

string conf.language = ‘en’

list conf.exclude_patterns = []

string conf.pygments_style = ‘sphinx’

bool conf.todo_include_todos = True

string conf.html_theme = “sphinx_rtd_theme”

list conf.html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

list conf.html_static_path = [‘_static’]

string conf.htmlhelp_basename = ‘ArchitectureDocumentationWikidoc’

dictionary conf.latex_elements = { # The paper size (‘letterpaper’ or ‘a4paper’). # # ‘papersize’: ‘letterpaper’, # The font size (‘10pt’, ‘11pt’ or ‘12pt’). # # ‘pointsize’: ‘10pt’, # Additional stuff for the LaTeX preamble. # # ‘preamble’: ‘’, # Latex figure (float) alignment # # ‘figure_align’: ‘htbp’, }

list conf.man_pages = [ (master_doc, ‘architecturedocumentationwiki’, u’Architecture Documentation Wiki Documentation’, [author], 1) ]

list conf.texinfo_documents = [ (master_doc, ‘ArchitectureDocumentationWiki’, u’Architecture Documentation Wiki Documentation’, author, ‘ArchitectureDocumentationWiki’, ‘One line description of project.’, ‘Miscellaneous’), ]

dictionary conf.intersphinx_mapping = {‘https://docs.python.org/’: None}

string conf.SUFFIX = source_suffix

bool conf.using_rtd_theme = False

html_style = None

dictionary conf.html_theme_options = {}

string conf.websupport2_base_url = ‘https://readthedocs.org/websupport’

string conf.websupport2_static_url = ‘https://media.readthedocs.org/static/’

dictionary conf.context

html_context = context

file conf.py

file requirements.txt

file README.md

page md__home_docs_checkouts_readthedocs.org_user_builds_roboy-audio_checkouts_doxy_setup_README

What is it?

This repository contains the audio related skills for the humanoid robot Roboy (roboy.org).

How does it work?

It procecess the microphone data from Matrix Creator (www.matrix.one) in two different ways. It wether reads the data directly out of the board related FPGA and processes it. Or it streams the data onto a ROS topic, from which on other modules can submit to this topic and process it further.

Most of the things (direct processing, streaming) run in C++. But there is also a template for receiving the stream in Python.

How to run it?

Will be defined in the future.

How to extend it?

Write cool stuff and add it to the repo.