.. _module-alarm:

Alarm
--------------------------

* **Identifier** - ALARM
* **Description** - Defines functionalities concerned with alarms and temporal controls.
* **Current Version** - 3
* **Initialization** - None
* **Destroy** - None
* **Dependencies** - :ref:`module-core`

Trigger Alarm
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+---------------------------------+--------------+--------------+----------------------------------------+
| Name         | ALARM                                                                                                  |
+--------------+---------------------------------+--------------+--------------+----------------------------------------+
| Description  | Executes every day at specified time (like a normal alarm clock).                                      |
+--------------+---------------------------------+--------------+--------------+----------------------------------------+

.. cssclass:: table-bordered

+--------------+---------------------------------+--------------+--------------+----------------------------------------+
|              | Type                            | Name         | Required     | Description                            |
+==============+=================================+==============+==============+========================================+
| Parameters   | CORE.TIME                       | TIME         | Yes          | Activation time.                       |
+              +---------------------------------+--------------+--------------+----------------------------------------+
|              | CORE.BOOLEAN                    | REPEAT       | Yes          | If *true*, alarm is repeated daily in  |
|              |                                 |              |              | all days defined by REPEAT-DAYS,       |
|              |                                 |              |              | otherwise only at next occurrence of   |
|              |                                 |              |              | TIME.                                  |
+              +---------------------------------+--------------+--------------+----------------------------------------+
|              | CORE.DAY-OF-WEEK-ARRAY          | REPEAT-DAYS  | Yes          | Array with all days of the week when   |
|              |                                 |              |              | alarm must activate. It is ignored in  |
|              |                                 |              |              | case REPEAT is *false*.                |
+--------------+---------------------------------+--------------+--------------+----------------------------------------+

Trigger Alarm Every
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+---------------------------------+--------------+--------------+----------------------------------------+
| Name         | ALARM-EVERY                                                                                            |
+--------------+---------------------------------+--------------+--------------+----------------------------------------+
| Description  | Executes at rule activation and repeat indefinitely at regular intervals.                              |
+--------------+---------------------------------+--------------+--------------+----------------------------------------+

.. cssclass:: table-bordered

+--------------+---------------------------------+--------------+--------------+----------------------------------------+
|              | Type                            | Name         | Required     | Description                            |
+==============+=================================+==============+==============+========================================+
| Parameters   | CORE-DURATION                   | INTERVAL     | Yes          | Repetition interval.                   |
+--------------+---------------------------------+--------------+--------------+----------------------------------------+

Condition Checker Time Between
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+---------------------------------+--------------+--------------+----------------------------------------+
| Name         | TIME-BETWEEN                                                                                           |
+--------------+---------------------------------+--------------+--------------+----------------------------------------+
| Description  | Returns *true* if current time is within the specified interval.                                       |
+--------------+---------------------------------+--------------+--------------+----------------------------------------+

.. cssclass:: table-bordered

+--------------+---------------------------------+--------------+--------------+----------------------------------------+
|              | Type                            | Name         | Required     | Description                            |
+==============+=================================+==============+==============+========================================+
| Parameters   | CORE.TIME                       | BEGIN        | Yes          | Begin time of interval to check.       |
+              +---------------------------------+--------------+--------------+----------------------------------------+
|              | CORE.TIME                       | END          | Yes          | End time of interval to check.         |
+--------------+---------------------------------+--------------+--------------+----------------------------------------+