mirror of
https://github.com/esphome/esphome-docs.git
synced 2025-01-12 20:10:50 +01:00
Move WiFi signal docs to next branch
This commit is contained in:
parent
c3c50f2854
commit
8e1602bc6e
@ -29,7 +29,6 @@ See :cpp:func:`Application::register_sensor`.
|
||||
max6675.rst
|
||||
rotary_encoder.rst
|
||||
template.rst
|
||||
wifi_signal.rst
|
||||
|
||||
|
||||
API Reference
|
||||
|
@ -1,23 +0,0 @@
|
||||
WiFi Signal Sensor
|
||||
==================
|
||||
|
||||
Example Usage
|
||||
-------------
|
||||
|
||||
.. code-block:: cpp
|
||||
|
||||
App.make_wifi_signal_sensor("WiFi Signal Sensor");
|
||||
|
||||
.. cpp:namespace:: nullptr
|
||||
|
||||
See :cpp:func:`Application::make_wifi_signal_sensor`.
|
||||
|
||||
API Reference
|
||||
-------------
|
||||
|
||||
.. cpp:namespace:: nullptr
|
||||
|
||||
.. doxygenclass:: sensor::WiFiSignalSensor
|
||||
:members:
|
||||
:protected-members:
|
||||
:undoc-members:
|
@ -310,7 +310,6 @@ See Also
|
||||
htu21d.rst
|
||||
pulse_counter.rst
|
||||
ultrasonic.rst
|
||||
wifi_signal.rst
|
||||
mpu6050.rst
|
||||
bh1750.rst
|
||||
bme280.rst
|
||||
|
@ -1,42 +0,0 @@
|
||||
WiFi Signal Sensor
|
||||
==================
|
||||
|
||||
The ``wifi_signal`` sensor platform allows you to read the signal
|
||||
strength of the currently connected :doc:`WiFi Access Point </esphomeyaml/components/wifi>`.
|
||||
|
||||
The sensor value is the `"Received signal strength indication" <https://en.wikipedia.org/wiki/Received_signal_strength_indication>`__
|
||||
measured in decibels. These values are always negative and the closer they are to zero, the better the signal is.
|
||||
|
||||
.. figure:: images/wifi_signal-ui.png
|
||||
:align: center
|
||||
:width: 80.0%
|
||||
|
||||
.. code:: yaml
|
||||
|
||||
# Example configuration entry
|
||||
sensor:
|
||||
- platform: wifi_signal
|
||||
name: "WiFi Signal Sensor"
|
||||
update_interval: 15s
|
||||
|
||||
Configuration variables:
|
||||
------------------------
|
||||
|
||||
- **name** (**Required**, string): The name of the hall effect sensor.
|
||||
- **update_interval** (*Optional*, :ref:`config-time`): The interval
|
||||
to check the sensor. Defaults to ``15s``. See :ref:`sensor-default_filter`.
|
||||
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
||||
- All other options from :ref:`Sensor <config-sensor>` and :ref:`MQTT Component <config-mqtt-component>`.
|
||||
|
||||
.. warning::
|
||||
|
||||
Signal strength readings are only available when WiFi in in station mode. Readings are not valid
|
||||
if the device is acting as an access point without any station mode connection.
|
||||
|
||||
See Also
|
||||
--------
|
||||
|
||||
- :ref:`sensor-filters`
|
||||
- :doc:`/esphomeyaml/components/wifi`
|
||||
- :doc:`API Reference </api/sensor/wifi_signal>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/sensor/wifi_signal.rst>`__
|
@ -201,9 +201,9 @@ Sensor Components
|
||||
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|
||||
`Template Sensor`_ `TSL2561`_ `Ultrasonic Sensor`_
|
||||
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|
||||
|WiFi Signal Sensor|_ |Custom Sensor|_
|
||||
|Custom Sensor|_
|
||||
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|
||||
`WiFi Signal Sensor`_ `Custom Sensor`_
|
||||
`Custom Sensor`_
|
||||
================================================== ================================================== ==================================================
|
||||
|
||||
.. |Sensor Core| image:: /esphomeyaml/images/folder-open.svg
|
||||
@ -269,9 +269,6 @@ Sensor Components
|
||||
.. |Ultrasonic Sensor| image:: /esphomeyaml/images/ultrasonic.jpg
|
||||
:class: component-image
|
||||
.. _Ultrasonic Sensor: /esphomeyaml/components/sensor/ultrasonic.html
|
||||
.. |WiFi Signal Sensor| image:: /esphomeyaml/images/network-wifi.svg
|
||||
:class: component-image
|
||||
.. _WiFi Signal Sensor: /esphomeyaml/components/sensor/wifi_signal.html
|
||||
.. |Custom Sensor| image:: /esphomeyaml/images/language-cpp.svg
|
||||
:class: component-image
|
||||
.. _Custom Sensor: /esphomeyaml/components/sensor/custom.html
|
||||
|
@ -19,5 +19,4 @@ SHT3X-D, components/sensor/sht3xd, sht3xd.jpg
|
||||
Template Sensor, components/sensor/template, description.svg
|
||||
TSL2561, components/sensor/tsl2561, tsl2561.jpg
|
||||
Ultrasonic Sensor, components/sensor/ultrasonic, ultrasonic.jpg
|
||||
WiFi Signal Sensor, components/sensor/wifi_signal, network-wifi.svg
|
||||
Custom Sensor, components/sensor/custom, build.svg
|
||||
|
|
Loading…
Reference in New Issue
Block a user