.. _module-bluetooth:

Bluetooth
--------------------------

* **Identifier** - BLUETOOTH
* **Description** - Allows to control Bluetooth on device.
* **Current Version** - 4
* **Initialization** - None
* **Destroy** - None
* **Dependencies** - :ref:`module-core`

Trigger Bluetooth Enabled
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+--------------------------------------------------------------------------------------------------------+
| Name         | ENABLED                                                                                                |
+--------------+--------------------------------------------------------------------------------------------------------+
| Description  | Executes when Bluetooth is enabled.                                                                    |
+--------------+--------------------------------------------------------------------------------------------------------+

Trigger Bluetooth Disabled
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+--------------------------------------------------------------------------------------------------------+
| Name         | DISABLED                                                                                               |
+--------------+--------------------------------------------------------------------------------------------------------+
| Description  | Executes when Bluetooth is disabled.                                                                   |
+--------------+--------------------------------------------------------------------------------------------------------+

Trigger Bluetooth Device Found
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+------------------------------+-----------------+--------------+----------------------------------------+
| Name         | FOUND                                                                                                  |
+--------------+------------------------------+-----------------+--------------+----------------------------------------+
| Description  | Executes when presence of a new Bluetooth device is detected. This can happen in case of execution of  |
|              | performer BLUETOOTH.DISCOVER or in case of manual scan by the user.                                    |
+--------------+------------------------------+-----------------+--------------+----------------------------------------+

.. cssclass:: table-bordered

+--------------+------------------------------+-----------------+--------------+----------------------------------------+
|              | Type                         | Name            | Required     | Description                            |
+==============+==============================+=================+==============+========================================+
| Parameters   | CORE.TEXT-FILTER             | NAME-FILTER     | No           | If present, activates trigger only if  |
|              |                              |                 |              | detected device name matches filter    |
|              |                              |                 |              | criteria.                              |
+--------------+------------------------------+-----------------+--------------+----------------------------------------+
| Variables    | CORE.STRING                  | DEVICE-NAME                    | Detected device name.                  |
+              +------------------------------+-----------------+--------------+----------------------------------------+
|              | CORE.STRING                  | DEVICE-ADDRESS                 | Detected device hardware address.      |
+--------------+------------------------------+-----------------+--------------+----------------------------------------+

Condition Checker Bluetooth Enabled
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+--------------------------------------------------------------------------------------------------------+
| Name         | ENABLED                                                                                                |
+--------------+--------------------------------------------------------------------------------------------------------+
| Description  | Returns *true* if Bluetooth is enabled, *false* otherwise.                                             |
+--------------+--------------------------------------------------------------------------------------------------------+

Condition Checker Bluetooth Disabled
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+--------------------------------------------------------------------------------------------------------+
| Name         | DISABLED                                                                                               |
+--------------+--------------------------------------------------------------------------------------------------------+
| Description  | Returns *true* if Bluetooth is enabled, *false* otherwise.                                             |
+--------------+--------------------------------------------------------------------------------------------------------+

Performer Bluetooth On
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+--------------------------------------------------------------------------------------------------------+
| Name         | ON                                                                                                     |
+--------------+--------------------------------------------------------------------------------------------------------+
| Description  | Activates Bluetooth.                                                                                   |
+--------------+--------------------------------------------------------------------------------------------------------+

.. cssclass:: table-bordered

+--------------+------------------------------+-----------------+--------------+----------------------------------------+
|              | Type                         | Name            | Required     | Description                            |
+==============+==============================+=================+==============+========================================+
| Parameters   | CORE.BOOLEAN                 | DISCOVERABLE    | YES          | Declares if discoverable or not.       |
+--------------+------------------------------+-----------------+--------------+----------------------------------------+

Performer Bluetooth Off
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+--------------------------------------------------------------------------------------------------------+
| Name         | OFF                                                                                                    |
+--------------+--------------------------------------------------------------------------------------------------------+
| Description  | Deactivates Bluetooth.                                                                                 |
+--------------+--------------------------------------------------------------------------------------------------------+

Performer Bluetooth Discover
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+--------------------------------------------------------------------------------------------------------+
| Name         | DISCOVER                                                                                               |
+--------------+--------------------------------------------------------------------------------------------------------+
| Description  | Begin search of devices, evantually activating Bluetooth.                                              |
+--------------+--------------------------------------------------------------------------------------------------------+