..  _buttons:

Button Infrastructure
=====================

Buttons all over the apartment can be used to request scenes, scenarios, or tasks
in the apartment's :ref:`coordination`. For each labeled button (with a blue LED),
   the button service registers an rsb listener of the form ``/citec/csra/home/<location>/button/``.
   The location can be any of ``hallway``, ``kitchen``, or ``living``. If a button provides an alias (configured via the bco-registry-editor) with a prefix ``Task``, ``Scenario``, or ``Scene``, the respective
service is called with the remainder of the alias to execute. For example, the button
aliased to ``Scenario-learnface`` will trigger the :ref:`scenarios` with ``learnface`` at
``/coordination/request/scenario/learnface``. The button service will never send anything
on the button scopes, status updates however could be retrieved by listening on the respective
coordination components.

The following buttons are currently configured inside the apartment:

Main entrance
^^^^^^^^^^^^^

.. image:: /images/coordination/entrance.jpg
    :align: right
    :width: 250px
    :alt:   Buttons mounted at the main entrance

+--------------------------------------+----------------------------------------+
| Left                                 | Right                                  |
+======================================+========================================+
| Standard :ref:`Scene <scenes>`       | Demo :ref:`Scene <scenes>`             |
+--------------------------------------+----------------------------------------+
| Register :ref:`Scenario <scenarios>` | Learn Face :ref:`Scenario <scenarios>` |
+--------------------------------------+----------------------------------------+
| (light on)                           | (light off)                            |
+--------------------------------------+----------------------------------------+

|
|
|
|

Hallway
^^^^^^^

.. image:: /images/coordination/hallway.jpg
    :align: right
    :width: 250px
    :alt:   Buttons mounted at the end of the hallway

+--------------------------------+-------------------------------------+
| Scene Panel                                                          |
+--------------------------------+-------------------------------------+
| Left                           | Right                               |
+================================+=====================================+
| Meeting :ref:`Scene <scenes>`  | Debug :ref:`Scene <scenes>`         |
+--------------------------------+-------------------------------------+
| Reading :ref:`Scene <scenes>`  | Entertainment :ref:`Scene <scenes>` |
+--------------------------------+-------------------------------------+
| Pary :ref:`Scene <scenes>`     | Socialiing :ref:`Scene <scenes>`    |
+--------------------------------+-------------------------------------+

+--------------------------------+-------------------------------------+
| Task Panel                                                           |
+--------------------------------+-------------------------------------+
| Left                           | Right                               |
+================================+=====================================+
| Next Song :ref:`Task <tasks>`  | Stop Music :ref:`Task <tasks>`      |
+--------------------------------+-------------------------------------+
| Study Data :ref:`Task <tasks>` | Auto Light :ref:`Task <tasks>`      |
+--------------------------------+-------------------------------------+
| Light On :ref:`Task <tasks>`   | Light Off :ref:`Task <tasks>`       |
+--------------------------------+-------------------------------------+

|

Kitchen access
^^^^^^^^^^^^^^

.. image:: /images/coordination/kitchen.jpg
    :align: right
    :width: 250px
    :alt: Buttons mounted in the kitchen next to the fridge

+-------------------------------+-------------------------------------+
| Left                          | Right                               |
+===============================+=====================================+
| Cooking :ref:`Scene <scenes>` | Dinner :ref:`Scene <scenes>`        |
+-------------------------------+-------------------------------------+
| *-*                           | Cleanup :ref:`Scenario <scenarios>` |
+-------------------------------+-------------------------------------+
| (light on)                    | (light off)                         |
+-------------------------------+-------------------------------------+

|
|
|
|

Sports door
^^^^^^^^^^^

.. image:: /images/coordination/recordpanel.jpg
    :align: right
    :width: 250px
    :alt: Buttons mounted in the living room next to the sports door

+----------------------------------------+---------------------------------------+
| Left                                   | Right                                 |
+========================================+=======================================+
| (:ref:`record <auto_recording>` start) | (:ref:`record <auto_recording>` stop) |
+----------------------------------------+---------------------------------------+
| Testing :ref:`Scenario <scenarios>`    | Standard :ref:`Scene <scenes>`        |
+----------------------------------------+---------------------------------------+
| (light on)                             | (light off)                           |
+----------------------------------------+---------------------------------------+

The only buttons that do not trigger the coordination are light switches, "Aufnahme start"
and "Aufnamhe stop" at the sports door (see above). Those are instead handled by the
:ref:`auto_recording` component.