.. _module-battery:

Battery
--------------------------

* **Identifier** - BATTERY
* **Description** - Allows to control functionalities concerned with device battery.
* **Current Version** - 1
* **Initialization** - None
* **Destroy** - None
* **Dependencies** - :ref:`module-core`

Trigger Battery Plugged
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+--------------------------------------------------------------------------------------------------------+
| Name         | PLUGGED                                                                                                |
+--------------+--------------------------------------------------------------------------------------------------------+
| Description  | Executes when device is connected to battery charger.                                                  |
+--------------+--------------------------------------------------------------------------------------------------------+

Trigger Battery Unplugged
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+--------------------------------------------------------------------------------------------------------+
| Name         | UNPLUGGED                                                                                              |
+--------------+--------------------------------------------------------------------------------------------------------+
| Description  | Executes when device is disconnected from battery charger.                                             |
+--------------+--------------------------------------------------------------------------------------------------------+

Trigger Level
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+---------------------------------+--------------+--------------+----------------------------------------+
| Name         | UNPLUGGED                                                                                              |
+--------------+---------------------------------+--------------+--------------+----------------------------------------+
| Description  | Executes when battery level changes.                                                                   |
+--------------+---------------------------------+--------------+--------------+----------------------------------------+

.. cssclass:: table-bordered

+--------------+---------------------------------+--------------+--------------+----------------------------------------+
|              | Type                            | Name         | Required     | Description                            |
+==============+=================================+==============+==============+========================================+
| Parameters   | CORE.PERCENT-FILTER             | FILTER       | Yes          | Percentage filter to apply.            |
+--------------+---------------------------------+--------------+--------------+----------------------------------------+

Condition Checker Battery Plugged
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+--------------------------------------------------------------------------------------------------------+
| Name         | PLUGGED                                                                                                |
+--------------+--------------------------------------------------------------------------------------------------------+
| Description  | Returns *true* if device is connected to battery charger.                                              |
+--------------+--------------------------------------------------------------------------------------------------------+

Condition Checker Battery Unplugged
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+--------------------------------------------------------------------------------------------------------+
| Name         | UNPLUGGED                                                                                              |
+--------------+--------------------------------------------------------------------------------------------------------+
| Description  | Returns *true* if device is disconnected to battery charger.                                           |
+--------------+--------------------------------------------------------------------------------------------------------+

Condition Checker Level
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+---------------------------------+--------------+--------------+----------------------------------------+
| Name         | LEVEL                                                                                                  |
+--------------+---------------------------------+--------------+--------------+----------------------------------------+
| Description  | Returns *true* if current level matches filter criteria, *false* otherwise.                            |
+--------------+---------------------------------+--------------+--------------+----------------------------------------+

.. cssclass:: table-bordered

+--------------+---------------------------------+--------------+--------------+----------------------------------------+
|              | Type                            | Name         | Required     | Description                            |
+==============+=================================+==============+==============+========================================+
| Parameters   | CORE.PERCENT-FILTER             | FILTER       | Yes          | Percentage filter to apply.            |
+--------------+---------------------------------+--------------+--------------+----------------------------------------+