Add WiFi signal API docs page

This commit is contained in:
Otto Winter 2018-06-08 20:41:32 +02:00
parent b64fe29589
commit f09db20190
No known key found for this signature in database
GPG Key ID: DB66C0BE6013F97E
3 changed files with 27 additions and 3 deletions

View File

@ -29,6 +29,7 @@ See :cpp:func:`Application::register_sensor`.
max6675.rst
rotary_encoder.rst
template.rst
wifi_signal.rst
API Reference

View File

@ -0,0 +1,23 @@
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:

View File

@ -2,7 +2,7 @@ WiFi Signal Sensor
==================
The ``wifi_signal`` sensor platform allows you to read the signal
strength of the currently connected WiFi Access Point.
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.
@ -37,6 +37,6 @@ See Also
--------
- :ref:`sensor-filters`
- :doc:`adc`
- :doc:`API Reference </api/sensor/adc-sensor>`
- :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>`__