Welcome to the Documentation of the Cognitive Service Robotics Apartment

This is the user documentation for the LSP CSRA project’s 0.17 release (built on 2019-11-14). 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:

• 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)

• Visualizations (which data can be visualized in the apartment?):

• Visualizations for specific components
• Stand-alone visualizations

• Software Architecture Knowledge:

• Prerequisites for creating own components

• 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)?

• Testing Knowledge:

• What tests do we currently employ?
• How can the tests be carried out?
• How can I write a test for my component?

• Studies:

• How to record data?

• Demos:

• Großgerätebegehung

• Howtos:

• How to give a demo?
• Tips & tricks
• Links to external howtos

• Troubleshooting (What do I do if...):

• Audio does not work
• Dialog is stuck

Table of Contents

• 1. Component Knowledge
  • 1.1. Component Coordination
  • 1.2. Audio Components
  • 1.3. Calendar
  • 1.4. Moving Head
  • 1.5. BaseCubeOne
  • 1.6. Dialog Components
  • 1.7. Dimension Reduction
  • 1.8. Floor
  • 1.9. Handle Service
  • 1.10. Location Registry
  • 1.11. Long Term Memory
  • 1.12. MockUp UI
  • 1.13. RFID Device Manager Mockup
  • 1.14. Object Detection Mock
  • 1.15. RGBD Grabber
  • 1.16. Person Tracking
  • 1.17. Person Manager
  • 1.18. Head Recognition
  • 1.19. Camera Calibration
  • 1.20. Recording Components
  • 1.21. Registry Editor
  • 1.22. Person Smart Control
  • 1.23. BComfy
  • 1.24. Screen Service
  • 1.25. Situation Recognition
  • 1.26. Touch Screen Utils
  • 1.27. Waternotifier
  • 1.28. Release Script
  • 1.29. Citk Version Updater
  • 1.30. KogniHome Documentation
• 2. Visualizations
  • 2.1.1. Apartment live 2D Map
  • 2.1.2. State Engine Viewer
  • 1.2.2. Audio Visualizer
• 3. Software Architecture Knowledge
• 4. Hardware Architecture Knowledge
  • 4.1. Audio Hardware
• 5. Testing Knowledge
• 6. Studies
  • 6.1. Study Control
  • 6.2. Video Generation
• 7. Demos
  • 7.1. Performing an apartment test and a demonstration
• 8. Howtos
  • 8.1. Distribution Release
  • 8.2. Audio Howtos
  • 8.3. Console Howtos
  • 8.4. External Howtos
  • 8.5. System Reboot
  • 8.6. Get Apartment Access
• 9. Troubleshooting
  • 9.1. Audio Troubleshooting
  • 9.2. Dialog Troubleshooting
• 10. Glossar

Indices and tables

• Index
• Module Index
• Search Page