esphome-docs/components/text_sensor/wifi_info.rst
2019-05-12 22:44:59 +02:00

38 lines
1.1 KiB
ReStructuredText

WiFi Info Text Sensor
=====================
.. seo::
:description: Instructions for setting up wifi info text sensors.
:image: network-wifi.png
The ``wifi_info`` text sensor platform exposes different wifi information
via text sensors.
.. code-block:: yaml
# Example configuration entry
text_sensor:
- platform: wifi_info
ip_address:
name: ESP IP Address
ssid:
name: ESP Connected SSID
bssid:
name: ESP Connected BSSID
Configuration variables:
------------------------
- **ip_address** (*Optional*): Expose the IP Address of the ESP as a text sensor. All options from
:ref:`Text Sensor <config-text_sensor>`.
- **ssid** (*Optional*): Expose the SSID of the currently connected WiFi network as a text sensor. All options from
:ref:`Text Sensor <config-text_sensor>`.
- **bssid** (*Optional*): Expose the BSSID of the currently connected WiFi network as a text sensor. All options from
:ref:`Text Sensor <config-text_sensor>`.
See Also
--------
- :apiref:`wifi_info/wifi_info_text_sensor.h`
- :ghedit:`Edit`