..  _buttons:

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

Buttons all over the apartment can be used to request scenes, scenarios, or tasks
in the apartment's :ref:`coordination`. We reserved the button with a blue LED for scene, scenario, and task usage only.
The coordination observes all buttons offering an alias of the following structure:

``$TYPE: $ID - *``

while ``$TYPE`` is replaced by one of the following keywords: [``task``, ``scenario``, ``scene``] and ``$ID`` is the identifier used to match the related entry in the coordination configuration file.
Be aware that `` - `` is optional and everything after it will be ignored and not a part of the $ID.
This is for example useful to link more than one buttons to the same scene. 
Using the same alias would not work since they are unique on unit level.

For example a button in the living room has set the following alias ``Scene: Party - Living`` and another button in the kitchen has configured the alias ``Scene: Party - Kitchen``.
Both buttons would now trigger the ``$TYPE``=``scene`` with ``$ID``=``party`` while `` - Living`` and `` - Kitchen`` are ignored. 

Another example would be if the button is aliased to ``Scenario-learnface`` then the trigger :ref:`scenarios` with ``learnface`` is triggered at
``/coordination/request/scenario/learnface``.

Button aliases can be configured via the ``bco-registry-editor``.

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.