Welcome to the Documentation of the Cognitive Service Robotics Apartment
========================================================================

This is the *user documentation* for the LSP CSRA project's |version| release (built on |release|).
It is produced with Sphinx (http://sphinx-doc.org/), thus it will be versioned and reflect the
according system status. The documentation for each release is built on our continous integration
server and deployed on a web server (http://ayq.csra.cit-ec.de:8080/) which is accessible from the
university-internal network (incl. VPN).

This is not the place for component documentation, e.g., API Docs etc. Also,
component descriptions are located in toolkit.cit-ec.de. This documentation
is intended to provide a high-level user-centered view, such as:

 * :ref:`component_knowledge` (components and their relations):

  * Where can I find the source code for a component?

  * How can I start the component?

  * What interfaces does a component provide?

  * Example usage (code)

 * :ref:`visualizations` (which data can be visualized in the apartment?):

  * Visualizations for specific components

  * Stand-alone visualizations

 * :ref:`software_architecture_knowledge`:

  * Prerequisites for creating own components

 * :ref:`hardware_architecture_knowledge`:

  * What kind of hardware do we have?

  * Where can I find a specific piece of hardware?

  * How is the hardware interconnected (cabling)?

 * :ref:`testing_knowledge`:

  * What tests do we currently employ?

  * How can the tests be carried out?

  * How can I write a test for my component?

 * :ref:`studies`:

  * How to record data?

 * :ref:`demos`:

  * Großgerätebegehung

 * :ref:`howtos`:

  * How to give a demo?

  * Tips & tricks

  * Links to external howtos

 * :ref:`troubleshooting` (What do I do if...):

  * Audio does not work

  * Dialog is stuck


.. toctree::
   :maxdepth: 2
   :caption: Table of Contents
   :titlesonly:
   :numbered:

   component_knowledge

   visualizations

   software_architecture_knowledge

   hardware_architecture_knowledge

   testing_knowledge

   studies

   demos

   howtos

   troubleshooting

   glossary


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`