Upstream
/
esphome-docs
mirror of https://github.com/esphome/esphome-docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Docs for wifi enable/disable (#2958)

This commit is contained in:
Jesse Hills 2023-06-01 11:34:38 +12:00 committed by GitHub
parent 7d796d3ba3
commit 48392c73ca
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
components/wifi.rst
View File

@ -89,6 +89,8 @@ Configuration variables:
- **enable_btm** (*Optional*, bool): Only on ``esp32`` with ``esp-idf``. Enable 802.11v BSS Transition Management support.
- **enable_rrm** (*Optional*, bool): Only on ``esp32`` with ``esp-idf``. Enable 802.11k Radio Resource Management support.
- **enable_on_boot** (*Optional*, boolean): If enabled, the WiFi interface will be enabled on boot. Defaults to ``true``.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
Access Point Mode
@ -270,6 +272,18 @@ Configuration variables:
- **key** (*Optional*, string): Path to a PEM encoded private key matching ``certificate`` for EAP-TLS authentication.
Optionally encrypted with ``password``.
Turning on and off WiFi
-----------------------
Using the actions ``wifi.enable`` and ``wifi.disable``, you can turn on and off the WiFi interface on demand.
The configuration option ``enable_on_boot`` can be set to ``false`` if you do not want wifi to be enabled on boot.
.. note::
Be aware that if you disable WiFi, the API timeout will need to be disabled otherwise the device will reboot.
.. _wifi-connected_condition:
``wifi.connected`` Condition