Edit this page on GitHub
This commit is contained in:
Otto Winter
parent
a0beaf0239
commit
e238eb4e54
|
|
@ -46,3 +46,4 @@ See Also
|
|||
|
||||
- :doc:`sensor/ads1115`
|
||||
- :doc:`API Reference </api/sensor/ads1115>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/ads1115.rst>`__
|
||||
|
|
|
|||
|
|
@ -63,4 +63,5 @@ See Also
|
|||
- :doc:`/esphomeyaml/components/esp32_ble`
|
||||
- :doc:`/esphomeyaml/components/binary_sensor/index`
|
||||
- :doc:`API Reference </api/misc/esp32_ble_tracker>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/binary_sensor/esp32_ble.rst>`__
|
||||
|
||||
|
|
|
|||
|
|
@ -98,3 +98,4 @@ See Also
|
|||
- :doc:`/esphomeyaml/components/esp32_touch`
|
||||
- :doc:`/esphomeyaml/components/binary_sensor/index`
|
||||
- :doc:`API Reference </api/binary_sensor/esp32_touch>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/binary_sensor/esp32_touch.rst>`__
|
||||
|
|
|
|||
|
|
@ -32,3 +32,4 @@ See Also
|
|||
- :doc:`/esphomeyaml/components/binary_sensor/index`
|
||||
- :ref:`config-pin_schema`
|
||||
- :doc:`API Reference </api/binary_sensor/gpio>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/binary_sensor/gpio.rst>`__
|
||||
|
|
|
|||
|
|
@ -155,6 +155,7 @@ See Also
|
|||
--------
|
||||
|
||||
- :doc:`API Reference </api/binary_sensor/index>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/binary_sensor/index.rst>`__
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
|
|
|||
|
|
@ -30,3 +30,4 @@ See Also
|
|||
- :doc:`/esphomeyaml/components/binary_sensor/index`
|
||||
- :doc:`/esphomeyaml/components/mqtt`
|
||||
- :doc:`API Reference </api/binary_sensor/status>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/binary_sensor/status.rst>`__
|
||||
|
|
|
|||
|
|
@ -53,5 +53,4 @@ See Also
|
|||
- :doc:`/esphomeyaml/components/sensor/template`
|
||||
- :ref:`automation`
|
||||
- :doc:`API Reference </api/binary_sensor/template>`
|
||||
|
||||
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/binary_sensor/template.rst>`__
|
||||
|
|
|
|||
|
|
@ -47,10 +47,11 @@ This action stops the cover with the given ID when executed.
|
|||
- cover.stop:
|
||||
id: cover_1
|
||||
|
||||
Full Cover Index
|
||||
^^^^^^^^^^^^^^^^
|
||||
See Also
|
||||
^^^^^^^^
|
||||
|
||||
- :doc:`API Reference </api/cover/index>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/cover/index.rst>`__
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
|
|
|||
|
|
@ -68,3 +68,4 @@ See Also
|
|||
- :ref:`automation`
|
||||
- :doc:`/esphomeyaml/cookbook/garage-door`
|
||||
- :doc:`API Reference </api/cover/template>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/cover/template.rst>`__
|
||||
|
|
|
|||
|
|
@ -36,3 +36,4 @@ See Also
|
|||
|
||||
- :doc:`sensor/dallas`
|
||||
- :doc:`API Reference </api/sensor/dallas>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/dallas.rst>`__
|
||||
|
|
|
|||
|
|
@ -25,3 +25,4 @@ See Also
|
|||
|
||||
- :doc:`logger`
|
||||
- :doc:`API Reference </api/misc/debug>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/debug.rst>`__
|
||||
|
|
|
|||
|
|
@ -44,4 +44,4 @@ See Also
|
|||
- :doc:`switch/shutdown`
|
||||
- :ref:`automation`
|
||||
- :doc:`API Reference </api/core/deep-sleep>`
|
||||
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/deep_sleep.rst>`__
|
||||
|
|
|
|||
|
|
@ -44,3 +44,4 @@ See Also
|
|||
|
||||
- :doc:`binary_sensor/esp32_ble`
|
||||
- :doc:`API Reference </api/misc/esp32_ble_tracker>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/esp32_ble.rst>`__
|
||||
|
|
|
|||
|
|
@ -54,3 +54,4 @@ See Also
|
|||
|
||||
- :doc:`binary_sensor/esp32_touch`
|
||||
- :doc:`API Reference </api/binary_sensor/esp32_touch>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/esp32_touch.rst>`__
|
||||
|
|
|
|||
|
|
@ -63,3 +63,8 @@ And for the ESP8266, the URL is https://github.com/platformio/platform-espressif
|
|||
name: livingroom
|
||||
platform: 'https://github.com/platformio/platform-espressif32.git#feature/stage'
|
||||
board: nodemcu-32s
|
||||
|
||||
See Also
|
||||
~~~~~~~~
|
||||
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/esphomeyaml.rst>`__
|
||||
|
|
|
|||
|
|
@ -35,3 +35,4 @@ See Also
|
|||
- :doc:`/esphomeyaml/components/output/gpio`
|
||||
- :doc:`/esphomeyaml/components/fan/index`
|
||||
- :doc:`API Reference </api/fan/index>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/fan/binary.rst>`__
|
||||
|
|
|
|||
|
|
@ -89,6 +89,7 @@ Full Fan Index
|
|||
^^^^^^^^^^^^^^
|
||||
|
||||
- :doc:`API Reference </api/fan/index>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/fan/index.rst>`__
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
|
|
|||
|
|
@ -46,3 +46,4 @@ See Also
|
|||
- :doc:`/esphomeyaml/components/output/esp8266_pwm`
|
||||
- :doc:`/esphomeyaml/components/output/pca9685`
|
||||
- :doc:`API Reference </api/fan/index>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/fan/speed.rst>`__
|
||||
|
|
|
|||
|
|
@ -38,3 +38,4 @@ See Also
|
|||
--------
|
||||
|
||||
- :doc:`API Reference </api/core/i2c>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/i2c.rst>`__
|
||||
|
|
|
|||
|
|
@ -43,3 +43,4 @@ See Also
|
|||
--------
|
||||
|
||||
- :doc:`API Reference </api/switch/ir-transmitter>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/ir_transmitter.rst>`__
|
||||
|
|
|
|||
|
|
@ -33,3 +33,4 @@ See Also
|
|||
- :doc:`/esphomeyaml/components/output/gpio`
|
||||
- :doc:`/esphomeyaml/components/power_supply`
|
||||
- :doc:`API Reference </api/light/index>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/light/binary.rst>`__
|
||||
|
|
|
|||
|
|
@ -97,3 +97,4 @@ See Also
|
|||
- :doc:`/esphomeyaml/components/light/fastled_spi`
|
||||
- :doc:`/esphomeyaml/components/power_supply`
|
||||
- :doc:`API Reference </api/light/fastled>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/light/fastled_clockless.rst>`__
|
||||
|
|
|
|||
|
|
@ -81,3 +81,4 @@ See Also
|
|||
- :doc:`/esphomeyaml/components/light/fastled_clockless`
|
||||
- :doc:`/esphomeyaml/components/power_supply`
|
||||
- :doc:`API Reference </api/light/fastled>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/light/fastled_spi.rst>`__
|
||||
|
|
|
|||
|
|
@ -96,6 +96,7 @@ See Also
|
|||
^^^^^^^^
|
||||
|
||||
- :doc:`API Reference </api/light/index>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/light/index.rst>`__
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
|
|
|||
|
|
@ -58,3 +58,4 @@ See Also
|
|||
- :doc:`/esphomeyaml/components/output/esp8266_pwm`
|
||||
- :doc:`/esphomeyaml/components/output/pca9685`
|
||||
- :doc:`API Reference </api/light/index>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/light/monochromatic.rst>`__
|
||||
|
|
|
|||
|
|
@ -60,3 +60,4 @@ See Also
|
|||
- :doc:`/esphomeyaml/components/output/esp8266_pwm`
|
||||
- :doc:`/esphomeyaml/components/output/pca9685`
|
||||
- :doc:`API Reference </api/light/index>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/light/rgb.rst>`__
|
||||
|
|
|
|||
|
|
@ -47,3 +47,4 @@ See Also
|
|||
- :doc:`/esphomeyaml/components/output/esp8266_pwm`
|
||||
- :doc:`/esphomeyaml/components/output/pca9685`
|
||||
- :doc:`API Reference </api/light/index>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/light/rgbw.rst>`__
|
||||
|
|
|
|||
|
|
@ -81,3 +81,4 @@ See Also
|
|||
--------
|
||||
|
||||
- :doc:`API Reference </api/core/log>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/logger.rst>`__
|
||||
|
|
|
|||
|
|
@ -338,3 +338,4 @@ See Also
|
|||
^^^^^^^^
|
||||
|
||||
- :doc:`API Reference </api/core/mqtt>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/mqtt.rst>`__
|
||||
|
|
|
|||
|
|
@ -39,3 +39,4 @@ See Also
|
|||
--------
|
||||
|
||||
- :doc:`API Reference </api/core/ota>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/ota.rst>`__
|
||||
|
|
|
|||
|
|
@ -38,3 +38,4 @@ See Also
|
|||
- :doc:`/esphomeyaml/components/fan/speed`
|
||||
- :doc:`/esphomeyaml/components/power_supply`
|
||||
- :doc:`API Reference </api/output/esp8266-pwm>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/output/esp8266_pwm.rst>`__
|
||||
|
|
|
|||
|
|
@ -37,3 +37,4 @@ See Also
|
|||
- :doc:`/esphomeyaml/components/fan/binary`
|
||||
- :doc:`/esphomeyaml/components/power_supply`
|
||||
- :doc:`API Reference </api/output/gpio-binary>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/output/gpio.rst>`__
|
||||
|
|
|
|||
|
|
@ -39,7 +39,6 @@ Configuration variables:
|
|||
Full Output Index
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
- :doc:`API Reference </api/output/index>`
|
||||
- :doc:`/esphomeyaml/components/switch/output`
|
||||
- :doc:`/esphomeyaml/components/power_supply`
|
||||
- :doc:`/esphomeyaml/components/light/binary`
|
||||
|
|
@ -47,6 +46,8 @@ Full Output Index
|
|||
- :doc:`/esphomeyaml/components/light/rgb`
|
||||
- :doc:`/esphomeyaml/components/fan/binary`
|
||||
- :doc:`/esphomeyaml/components/fan/speed`
|
||||
- :doc:`API Reference </api/output/index>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/output/index.rst>`__
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
|
|
|||
|
|
@ -36,3 +36,4 @@ See Also
|
|||
- :doc:`/esphomeyaml/components/fan/speed`
|
||||
- :doc:`/esphomeyaml/components/power_supply`
|
||||
- :doc:`API Reference </api/output/ledc>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/output/ledc.rst>`__
|
||||
|
|
|
|||
|
|
@ -45,3 +45,4 @@ See Also
|
|||
- :doc:`/esphomeyaml/components/fan/speed`
|
||||
- :doc:`/esphomeyaml/components/power_supply`
|
||||
- :doc:`API Reference </api/output/pca9685>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/output/pca9685.rst>`__
|
||||
|
|
|
|||
|
|
@ -41,3 +41,4 @@ See Also
|
|||
|
||||
- :doc:`output/pca9685`
|
||||
- :doc:`API Reference </api/output/pca9685>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/pca9685.rst>`__
|
||||
|
|
|
|||
|
|
@ -59,3 +59,4 @@ See Also
|
|||
- :doc:`switch/gpio`
|
||||
- :doc:`binary_sensor/gpio`
|
||||
- :doc:`API Reference </api/misc/pcf8574>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/pcf8574.rst>`__
|
||||
|
|
|
|||
|
|
@ -65,3 +65,4 @@ See Also
|
|||
|
||||
- :doc:`output/index`
|
||||
- :doc:`API Reference </api/core/power-supply>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/power_supply.rst>`__
|
||||
|
|
|
|||
|
|
@ -91,3 +91,4 @@ See Also
|
|||
- :doc:`ads1115`
|
||||
- :doc:`max6675`
|
||||
- :doc:`API Reference </api/sensor/adc-sensor>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/sensor/adc.rst>`__
|
||||
|
|
|
|||
|
|
@ -79,3 +79,4 @@ See Also
|
|||
- :doc:`adc`
|
||||
- :doc:`max6675`
|
||||
- :doc:`API Reference </api/sensor/ads1115>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/sensor/ads1115.rst>`__
|
||||
|
|
|
|||
|
|
@ -45,3 +45,4 @@ See Also
|
|||
- :ref:`sensor-filters`
|
||||
- :doc:`tsl2561`
|
||||
- :doc:`API Reference </api/sensor/bh1750>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/sensor/bh1750.rst>`__
|
||||
|
|
|
|||
|
|
@ -88,3 +88,4 @@ See Also
|
|||
- :doc:`bme680`
|
||||
- :doc:`bmp085`
|
||||
- :doc:`API Reference </api/sensor/bme280>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/sensor/bme280.rst>`__
|
||||
|
|
|
|||
|
Before Width: | Height: | Size: 3.3 KiB After Width: | Height: | Size: 3.4 KiB |
|
|
@ -99,3 +99,4 @@ See Also
|
|||
- :doc:`bme280`
|
||||
- :doc:`bmp085`
|
||||
- :doc:`API Reference </api/sensor/bme680>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/sensor/bme680.rst>`__
|
||||
|
|
|
|||
|
Before Width: | Height: | Size: 3.8 KiB After Width: | Height: | Size: 4.0 KiB |
|
|
@ -60,3 +60,4 @@ See Also
|
|||
- :doc:`bme280`
|
||||
- :doc:`bme680`
|
||||
- :doc:`API Reference </api/sensor/bmp085>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/sensor/bmp085.rst>`__
|
||||
|
|
|
|||
|
Before Width: | Height: | Size: 2.2 KiB After Width: | Height: | Size: 2.3 KiB |
|
|
@ -73,3 +73,4 @@ See Also
|
|||
- :doc:`/esphomeyaml/components/dallas`
|
||||
- :doc:`max6675`
|
||||
- :doc:`API Reference </api/sensor/dallas>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/sensor/dallas.rst>`__
|
||||
|
|
|
|||
|
|
@ -74,3 +74,4 @@ See Also
|
|||
- :doc:`htu21d`
|
||||
- :doc:`sht3xd`
|
||||
- :doc:`API Reference </api/sensor/dht>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/sensor/dht.rst>`__
|
||||
|
|
|
|||
|
|
@ -56,3 +56,4 @@ See Also
|
|||
- :doc:`htu21d`
|
||||
- :doc:`sht3xd`
|
||||
- :doc:`API Reference </api/sensor/dht12>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/sensor/dht12.rst>`__
|
||||
|
|
|
|||
|
|
@ -47,3 +47,4 @@ See Also
|
|||
- :doc:`adc`
|
||||
- :doc:`/esphomeyaml/devices/esp32`
|
||||
- :doc:`API Reference </api/sensor/adc-sensor>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/sensor/esp32_hall.rst>`__
|
||||
|
|
|
|||
|
|
@ -62,3 +62,4 @@ See Also
|
|||
- :doc:`htu21d`
|
||||
- :doc:`sht3xd`
|
||||
- :doc:`API Reference </api/sensor/hdc1080>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/sensor/hdc1080.rst>`__
|
||||
|
|
|
|||
|
|
@ -58,3 +58,4 @@ See Also
|
|||
- :doc:`hdc1080`
|
||||
- :doc:`sht3xd`
|
||||
- :doc:`API Reference </api/sensor/htu21d>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/sensor/htu21d.rst>`__
|
||||
|
|
|
|||
|
|
@ -265,6 +265,7 @@ See Also
|
|||
^^^^^^^^
|
||||
|
||||
- :doc:`API Reference </api/sensor/index>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/sensor/index.rst>`__
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
|
|
|||
|
|
@ -52,3 +52,4 @@ See Also
|
|||
- :doc:`adc`
|
||||
- :doc:`sht3xd`
|
||||
- :doc:`API Reference </api/sensor/max6675>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/sensor/max6675.rst>`__
|
||||
|
|
|
|||
|
|
@ -75,3 +75,4 @@ See Also
|
|||
- :doc:`template`
|
||||
- :doc:`ultrasonic`
|
||||
- :doc:`API Reference </api/sensor/mpu6050>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/sensor/mpu6050.rst>`__
|
||||
|
|
|
|||
|
|
@ -73,3 +73,4 @@ See Also
|
|||
- :doc:`rotary_encoder`
|
||||
- `esp-idf Pulse Counter API <https://esp-idf.readthedocs.io/en/latest/api-reference/peripherals/pcnt.html>`__.
|
||||
- :doc:`API Reference </api/sensor/pulse-counter>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/sensor/pulse_counter.rst>`__
|
||||
|
|
|
|||
|
|
@ -74,3 +74,4 @@ See Also
|
|||
- :doc:`pulse_counter`
|
||||
- :doc:`template`
|
||||
- :doc:`API Reference </api/sensor/rotary_encoder>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/sensor/rotary_encoder.rst>`__
|
||||
|
|
|
|||
|
|
@ -69,3 +69,4 @@ See Also
|
|||
- :doc:`hdc1080`
|
||||
- :doc:`htu21d`
|
||||
- :doc:`API Reference </api/sensor/sht3xd>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/sensor/sht3xd.rst>`__
|
||||
|
|
|
|||
|
|
@ -42,3 +42,4 @@ See Also
|
|||
- :ref:`sensor-filters`
|
||||
- :ref:`automation`
|
||||
- :doc:`API Reference </api/sensor/template>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/sensor/template.rst>`__
|
||||
|
|
|
|||
|
|
@ -55,3 +55,4 @@ See Also
|
|||
- :doc:`bh1750`
|
||||
- :doc:`adc`
|
||||
- :doc:`API Reference </api/sensor/tsl2561>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/sensor/tsl2561.rst>`__
|
||||
|
|
|
|||
|
|
@ -60,3 +60,4 @@ See Also
|
|||
- :ref:`sensor-filters`
|
||||
- :doc:`template`
|
||||
- :doc:`API Reference </api/sensor/ultrasonic>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/sensor/ultrasonic.rst>`__
|
||||
|
|
|
|||
|
|
@ -32,3 +32,4 @@ See Also
|
|||
- :doc:`index`
|
||||
- :doc:`/esphomeyaml/components/output/gpio`
|
||||
- :doc:`API Reference </api/switch/index>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/switch/gpio.rst>`__
|
||||
|
|
|
|||
|
|
@ -72,6 +72,7 @@ See Also
|
|||
^^^^^^^^
|
||||
|
||||
- :doc:`API Reference </api/switch/index>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/switch/index.rst>`__
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
|
|
|||
|
|
@ -113,3 +113,4 @@ See Also
|
|||
- :doc:`index`
|
||||
- :doc:`/esphomeyaml/components/ir_transmitter`
|
||||
- :doc:`API Reference </api/switch/ir-transmitter>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/switch/ir_transmitter.rst>`__
|
||||
|
|
|
|||
|
|
@ -34,3 +34,4 @@ See Also
|
|||
|
||||
- :doc:`/esphomeyaml/components/output/index`
|
||||
- :doc:`API Reference </api/switch/index>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/switch/output.rst>`__
|
||||
|
|
|
|||
|
|
@ -28,3 +28,4 @@ See Also
|
|||
- :doc:`shutdown`
|
||||
- :doc:`template`
|
||||
- :doc:`API Reference </api/switch/restart>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/switch/restart.rst>`__
|
||||
|
|
|
|||
|
|
@ -30,3 +30,4 @@ See Also
|
|||
- :doc:`restart`
|
||||
- :doc:`template`
|
||||
- :doc:`API Reference </api/switch/shutdown>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/switch/shutdown.rst>`__
|
||||
|
|
|
|||
|
|
@ -61,3 +61,4 @@ See Also
|
|||
- :doc:`/esphomeyaml/components/switch/index`
|
||||
- :doc:`/esphomeyaml/components/binary_sensor/index`
|
||||
- :doc:`API Reference </api/switch/template>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/switch/template.rst>`__
|
||||
|
|
|
|||
|
|
@ -39,3 +39,4 @@ See Also
|
|||
--------
|
||||
|
||||
- :doc:`API Reference </api/core/web-server>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/web_server.rst>`__
|
||||
|
|
|
|||
|
|
@ -68,3 +68,4 @@ See Also
|
|||
--------
|
||||
|
||||
- :doc:`API Reference </api/core/wifi>`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/wifi.rst>`__
|
||||
|
|
|
|||
|
|
@ -84,3 +84,4 @@ See Also
|
|||
- :doc:`/esphomeyaml/components/sensor/dht`
|
||||
- :doc:`/esphomeyaml/components/sensor/adc`
|
||||
- :doc:`/esphomeyaml/components/binary_sensor/gpio`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/cookbook/bruh.rst>`__
|
||||
|
|
|
|||
|
|
@ -51,3 +51,4 @@ See Also
|
|||
|
||||
- :doc:`/esphomeyaml/guides/automations`
|
||||
- :doc:`/esphomeyaml/components/cover/template`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/cookbook/garage-door.rst>`__
|
||||
|
|
|
|||
|
|
@ -58,3 +58,4 @@ See Also
|
|||
- `Awesome article explaining how PIR Sensors work <https://learn.adafruit.com/pir-passive-infrared-proximity-motion-sensor/how-pirs-work>`__.
|
||||
- :doc:`/esphomeyaml/components/binary_sensor/gpio`
|
||||
- :doc:`bruh`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/cookbook/pir.rst>`__
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ a magnetic field that closes a contact.
|
|||
On the output side you have three pins: common (``COM``), normally open (``NO``) and
|
||||
normally closed (``NC``). Connect ``COM`` and one of ``NO`` and ``NC`` in series
|
||||
with your load. When the input turns on, ``NO`` is connected to ``COM`` and
|
||||
when the input turns off, ``NO`` is connected to ``COM``.
|
||||
when the input turns off, ``NC`` is connected to ``COM``.
|
||||
|
||||
.. warning::
|
||||
|
||||
|
|
@ -40,3 +40,4 @@ See Also
|
|||
- :doc:`/esphomeyaml/components/switch/gpio`
|
||||
- :doc:`/esphomeyaml/components/output/gpio`
|
||||
- `How do relays work <https://www.explainthatstuff.com/howrelayswork.html>`__.
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/cookbook/relay.rst>`__
|
||||
|
|
|
|||
|
|
@ -53,3 +53,4 @@ See Also
|
|||
- :doc:`/esphomeyaml/components/sensor/adc`
|
||||
- `TEMT6000 datasheet <https://www.sparkfun.com/datasheets/Sensors/Imaging/TEMT6000.pdf>`__
|
||||
- :doc:`bruh`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/cookbook/temt6000.rst>`__
|
||||
|
|
|
|||
|
|
@ -46,3 +46,4 @@ See Also
|
|||
^^^^^^^^
|
||||
|
||||
- :doc:`nodemcu_esp32`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/devices/esp32.rst>`__
|
||||
|
|
|
|||
|
|
@ -46,3 +46,4 @@ See Also
|
|||
^^^^^^^^
|
||||
|
||||
- :doc:`nodemcu_esp8266`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/devices/esp8266.rst>`__
|
||||
|
|
|
|||
|
|
@ -57,3 +57,4 @@ See Also
|
|||
|
||||
- :doc:`esp32`
|
||||
- :doc:`nodemcu_esp8266`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/devices/nodemcu_esp32.rst>`__
|
||||
|
|
|
|||
|
|
@ -68,3 +68,4 @@ See Also
|
|||
|
||||
- :doc:`esp8266`
|
||||
- :doc:`nodemcu_esp32`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/devices/nodemcu_esp8266.rst>`__
|
||||
|
|
|
|||
|
|
@ -313,3 +313,4 @@ See Also
|
|||
- :doc:`sonoff_4ch`
|
||||
- :doc:`sonoff_basic`
|
||||
- :doc:`esp8266`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/devices/sonoff.rst>`__
|
||||
|
|
|
|||
|
|
@ -335,3 +335,4 @@ See Also
|
|||
|
||||
- :doc:`sonoff`
|
||||
- :doc:`sonoff_s20`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/devices/sonoff_4ch.rst>`__
|
||||
|
|
|
|||
|
|
@ -330,3 +330,4 @@ See Also
|
|||
|
||||
- :doc:`sonoff`
|
||||
- :doc:`sonoff_4ch`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/devices/sonoff_s20.rst>`__
|
||||
|
|
|
|||
|
|
@ -322,3 +322,4 @@ See Also
|
|||
|
||||
- :doc:`configuration-types`
|
||||
- :doc:`faq`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/guides/automations.rst>`__
|
||||
|
|
|
|||
|
|
@ -136,3 +136,4 @@ See Also
|
|||
- :doc:`esphomeyaml index </esphomeyaml/index>`
|
||||
- :doc:`getting_started_command_line`
|
||||
- :doc:`faq`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/guides/configuration-types.rst>`__
|
||||
|
|
|
|||
|
|
@ -172,23 +172,15 @@ RST primer:
|
|||
reStructured text can do a lot more than this, so if you're looking for a more complete guide
|
||||
please have a look at the `Sphinx reStructuredText Primer <http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`__.
|
||||
|
||||
To check your documentation changes locally, you first need install sphinx (**with Python 3**):
|
||||
To check your documentation changes locally, you first need install sphinx (**with Python 3**) and
|
||||
`doxygen <http://www.stack.nl/~dimitri/doxygen/>`__.
|
||||
|
||||
.. code:: bash
|
||||
|
||||
pip3 install sphinx breathe
|
||||
|
||||
Then, use the provided Makefile to build the changes and start a simple web server:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
# Build sources
|
||||
make html
|
||||
# Start web server on port 8000
|
||||
make webserver
|
||||
|
||||
If you also want to work on the API docs, you need to install `doxygen <http://www.stack.nl/~dimitri/doxygen/>`__
|
||||
and you need to have a special folder structure:
|
||||
Next, you will also need to clone the `esphomelib repository <https://github.com/OttoWinter/esphomelib>`__ into
|
||||
the folder where ``esphomedocs`` sits like this:
|
||||
|
||||
.. code::
|
||||
|
||||
|
|
@ -206,20 +198,26 @@ and you need to have a special folder structure:
|
|||
├── platformio.ini
|
||||
└── ...
|
||||
|
||||
To update the internal doxygen API documentation, run:
|
||||
Then, use the provided Makefile to build the changes and start a simple web server:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
# Update doxygen API docs
|
||||
make doxyg
|
||||
# Then:
|
||||
# Start web server on port 8000
|
||||
make webserver
|
||||
|
||||
# Updates then happen via:
|
||||
make html
|
||||
|
||||
Some notes about the docs:
|
||||
|
||||
* Use the english language (duh...)
|
||||
* An image tells a thousand words, please use them wherever possible.
|
||||
* An image tells a thousand words, please use them wherever possible. But also don't forget to shrink them, for example
|
||||
I often use https://tinypng.com/
|
||||
* Try to use examples as often as possible (also while it's great to use highly accurate,
|
||||
and domain-specific lingo, it should not interfere with new users understanding the content)
|
||||
* When adding new files, please also add them to the ``index.rst`` file in the directory you're editing.
|
||||
|
||||
Contributing to esphomelib
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
|
@ -369,3 +367,4 @@ See Also
|
|||
|
||||
- :doc:`esphomeyaml index </esphomeyaml/index>`
|
||||
- :doc:`faq`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/guides/contributing.rst>`__
|
||||
|
|
|
|||
|
|
@ -202,3 +202,4 @@ See Also
|
|||
|
||||
- :doc:`esphomeyaml index </esphomeyaml/index>`
|
||||
- :doc:`contributing`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/guides/faq.rst>`__
|
||||
|
|
|
|||
|
|
@ -223,3 +223,4 @@ See Also
|
|||
|
||||
- :doc:`esphomeyaml index </esphomeyaml/index>`
|
||||
- :doc:`getting_started_hassio`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/guides/getting_started_command_line.rst>`__
|
||||
|
|
|
|||
|
|
@ -198,3 +198,4 @@ See Also
|
|||
|
||||
- :doc:`esphomeyaml index </esphomeyaml/index>`
|
||||
- :doc:`getting_started_command_line`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/guides/getting_started_hassio.rst>`__
|
||||
|
|
|
|||
|
|
@ -51,3 +51,4 @@ See Also
|
|||
- :doc:`/esphomeyaml/devices/sonoff_4ch`
|
||||
- :doc:`migrate_espurna`
|
||||
- :doc:`migrate_sonoff_tasmota`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/guides/migrate_espeasy.rst>`__
|
||||
|
|
|
|||
|
|
@ -55,3 +55,4 @@ See Also
|
|||
- :doc:`/esphomeyaml/devices/sonoff_4ch`
|
||||
- :doc:`migrate_espeasy`
|
||||
- :doc:`migrate_sonoff_tasmota`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/guides/migrate_espurna.rst>`__
|
||||
|
|
|
|||
|
|
@ -57,3 +57,4 @@ See Also
|
|||
- :doc:`/esphomeyaml/devices/esp32`
|
||||
- :doc:`migrate_espurna`
|
||||
- :doc:`migrate_espeasy`
|
||||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/guides/migrate_sonoff_tasmota.rst>`__
|
||||
|
|
|
|||
Loading…
Reference in New Issue