esphome-docs/components/sensor/wifi_signal.rst

47 lines
1.5 KiB
ReStructuredText
Raw Normal View History

2018-06-09 10:43:48 +02:00
WiFi Signal Sensor
==================
2018-11-14 22:12:27 +01:00
.. seo::
:description: Instructions for setting up WiFi signal sensors that track the RSSI connection strength value to the network.
:image: network-wifi.svg
2018-11-14 22:12:27 +01:00
2018-06-09 10:43:48 +02:00
The ``wifi_signal`` sensor platform allows you to read the signal
strength of the currently connected :doc:`WiFi Access Point </components/wifi>`.
2018-06-09 10:43:48 +02:00
The sensor value is the `"Received signal strength indication" <https://en.wikipedia.org/wiki/Received_signal_strength_indication>`__
measured in decibel-milliwatts (dBm). These values are always negative and the closer they are to zero, the better the signal is.
2018-06-09 10:43:48 +02:00
.. figure:: images/wifi_signal-ui.png
:align: center
:width: 80.0%
.. code-block:: yaml
2018-06-09 10:43:48 +02:00
# Example configuration entry
sensor:
- platform: wifi_signal
name: "WiFi Signal Sensor"
2019-01-06 18:56:14 +01:00
update_interval: 60s
2018-06-09 10:43:48 +02:00
Configuration variables:
------------------------
2018-12-11 08:57:29 +01:00
- **name** (**Required**, string): The name of the WiFi signal sensor.
2018-06-09 10:43:48 +02:00
- **update_interval** (*Optional*, :ref:`config-time`): The interval
2019-01-06 18:56:14 +01:00
to check the sensor. Defaults to ``60s``.
2018-06-09 10:43:48 +02:00
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
2019-02-17 12:28:17 +01:00
- All other options from :ref:`Sensor <config-sensor>`.
2018-06-09 10:43:48 +02:00
.. warning::
Signal strength readings are only available when WiFi is in station mode. Readings are not valid
2018-06-09 10:43:48 +02:00
if the device is acting as an access point without any station mode connection.
See Also
--------
- :ref:`sensor-filters`
- :doc:`/components/wifi`
2019-05-12 22:44:59 +02:00
- :apiref:`wifi_signal/wifi_signal_sensor.h`
- :ghedit:`Edit`