mirror of
https://github.com/esphome/esphome-docs.git
synced 2025-04-12 19:46:23 +02:00
Add WiFi Signal Strength sensor (#5)
This commit is contained in:
parent
c35ee72d11
commit
1e6255870a
17
Makefile
17
Makefile
@ -9,16 +9,23 @@ SOURCEDIR = .
|
||||
BUILDDIR = _build
|
||||
ESPHOMELIB_PATH = ../esphomelib
|
||||
|
||||
html:
|
||||
.PHONY: html cleanhtml minifyhtml doxyg cleandoxyg copypdf fixdeploy releasedeploy help webserver Makefile
|
||||
|
||||
html: _doxyxml
|
||||
$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
|
||||
cleanhtml:
|
||||
rm -rf "$(BUILDDIR)/html/*" _doxyxml/
|
||||
cleanhtml: cleandoxy
|
||||
rm -rf "$(BUILDDIR)/html/*"
|
||||
|
||||
minifyhtml: html
|
||||
./minify.sh
|
||||
|
||||
doxyg:
|
||||
doxyg: cleandoxyg _doxyxml
|
||||
|
||||
cleandoxyg:
|
||||
rm -rf _doxyxml
|
||||
|
||||
_doxyxml:
|
||||
ESPHOMELIB_PATH=$(ESPHOMELIB_PATH) doxygen Doxygen
|
||||
|
||||
copypdf:
|
||||
@ -45,8 +52,6 @@ help:
|
||||
webserver: html
|
||||
cd "$(BUILDDIR)/html" && python3 -m http.server
|
||||
|
||||
.PHONY: help Makefile
|
||||
|
||||
# Catch-all target: route all unknown targets to Sphinx using the new
|
||||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
||||
%: Makefile
|
||||
|
@ -310,6 +310,7 @@ See Also
|
||||
htu21d.rst
|
||||
pulse_counter.rst
|
||||
ultrasonic.rst
|
||||
wifi_signal.rst
|
||||
mpu6050.rst
|
||||
bh1750.rst
|
||||
bme280.rst
|
||||
|
35
esphomeyaml/components/sensor/wifi_signal.rst
Normal file
35
esphomeyaml/components/sensor/wifi_signal.rst
Normal file
@ -0,0 +1,35 @@
|
||||
WiFi Signal Sensor
|
||||
==================
|
||||
|
||||
The ``wifi_signal`` sensor platform allows you to read the signal
|
||||
strength of the currently connected WiFi Access Point.
|
||||
|
||||
.. 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:`adc`
|
||||
- :doc:`API Reference </api/sensor/adc-sensor>`
|
||||
- `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`_
|
||||
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|
||||
|Custom Sensor|_
|
||||
|WiFi Signal Sensor|_ |Custom Sensor|_
|
||||
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|
||||
`Custom Sensor`_
|
||||
`WiFi Signal Sensor`_ `Custom Sensor`_
|
||||
================================================== ================================================== ==================================================
|
||||
|
||||
.. |Sensor Core| image:: /esphomeyaml/images/folder-open.svg
|
||||
@ -239,7 +239,7 @@ Sensor Components
|
||||
.. |ESP32 Hall Sensor| image:: /esphomeyaml/images/magnet.svg
|
||||
:class: component-image
|
||||
.. _ESP32 Hall Sensor: /esphomeyaml/components/sensor/esp32_hall.html
|
||||
.. |HDC1080| image:: /esphomeyaml/images/HDC1080.jpg
|
||||
.. |HDC1080| image:: /esphomeyaml/images/hdc1080.jpg
|
||||
:class: component-image
|
||||
.. _HDC1080: /esphomeyaml/components/sensor/hdc1080.html
|
||||
.. |HTU21D| image:: /esphomeyaml/images/htu21d.jpg
|
||||
@ -269,6 +269,9 @@ 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
|
||||
|
@ -9,7 +9,7 @@ Dallas, components/sensor/dallas, dallas.jpg
|
||||
DHT, components/sensor/dht, dht22.jpg
|
||||
DHT12, components/sensor/dht12, dht12.jpg
|
||||
ESP32 Hall Sensor, components/sensor/esp32_hall, magnet.svg
|
||||
HDC1080, components/sensor/hdc1080, HDC1080.jpg
|
||||
HDC1080, components/sensor/hdc1080, hdc1080.jpg
|
||||
HTU21D, components/sensor/htu21d, htu21d.jpg
|
||||
MAX6675, components/sensor/max6675, max6675.jpg
|
||||
MPU6050, components/sensor/mpu6050, mpu6050.jpg
|
||||
@ -19,4 +19,5 @@ 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