.. _module-wifi:

WiFi
--------------------------

* **Identifier** - WIFI
* **Description** - Allows to control WiFi on device.
* **Current Version** - 3
* **Initialization** - None
* **Destroy** - None
* **Dependencies** - :ref:`module-core`

Trigger WiFi Enabled
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

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

Trigger WiFi Disabled
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

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

Trigger WiFi Connected
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+------------------------------+-----------------+--------------+----------------------------------------+
| Name         | CONNECTED                                                                                              |
+--------------+------------------------------+-----------------+--------------+----------------------------------------+
| Description  | Executes when device get connected to a WiFi network.                                                  |
+--------------+------------------------------+-----------------+--------------+----------------------------------------+

.. cssclass:: table-bordered

+--------------+------------------------------+-----------------+--------------+----------------------------------------+
|              | Type                         | Name            | Required     | Description                            |
+==============+==============================+=================+==============+========================================+
| Parameters   | CORE.STRING                  | SSID            | No           | WiFi network ID. If *null* any SSID    |
|              |                              |                 |              | leads to trigger execution.            |
+--------------+------------------------------+-----------------+--------------+----------------------------------------+

Condition Checker WiFi Enabled
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

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

Condition Checker WiFi Disabled
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

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

Condition Checker WiFi Connected
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+------------------------------+-----------------+--------------+----------------------------------------+
| Name         | CONNECTED                                                                                              |
+--------------+------------------------------+-----------------+--------------+----------------------------------------+
| Description  | Returns *true* if device is connected to a WiFi network, *false* otherwise.                            |
+--------------+------------------------------+-----------------+--------------+----------------------------------------+

.. cssclass:: table-bordered

+--------------+------------------------------+-----------------+--------------+----------------------------------------+
|              | Type                         | Name            | Required     | Description                            |
+==============+==============================+=================+==============+========================================+
| Parameters   | CORE.STRING                  | SSID            | No           | WiFi network ID. If *null* any SSID    |
|              |                              |                 |              | is valid for verification.             |
+--------------+------------------------------+-----------------+--------------+----------------------------------------+

Performer WiFi On
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

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

Performer WiFi Off
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

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