From 150dea575c199af1bebb982b099d8ad0fb52c396 Mon Sep 17 00:00:00 2001 From: Otto Winter Date: Fri, 12 Oct 2018 16:33:22 +0200 Subject: [PATCH] Add Disqus and cleanup (#47) --- .gitignore | 3 ++ Makefile | 2 +- _static/disqus.js | 13 +++++ conf.py | 7 ++- disqus.py | 50 +++++++++++++++++++ esphomeyaml/components/ads1115.rst | 8 +-- .../binary_sensor/esp32_ble_tracker.rst | 2 + .../components/binary_sensor/esp32_touch.rst | 2 + esphomeyaml/components/binary_sensor/gpio.rst | 2 + .../components/binary_sensor/index.rst | 17 +++---- .../components/binary_sensor/nextion.rst | 1 + .../components/binary_sensor/pn532.rst | 1 + .../components/binary_sensor/rdm6300.rst | 1 + .../binary_sensor/remote_receiver.rst | 2 + .../components/binary_sensor/status.rst | 2 + .../components/binary_sensor/template.rst | 2 + esphomeyaml/components/cover/index.rst | 2 + esphomeyaml/components/cover/template.rst | 2 + esphomeyaml/components/dallas.rst | 2 + esphomeyaml/components/debug.rst | 2 + esphomeyaml/components/deep_sleep.rst | 2 + esphomeyaml/components/display/index.rst | 2 + esphomeyaml/components/display/lcd_gpio.rst | 2 + .../components/display/lcd_pcf8574.rst | 2 + esphomeyaml/components/display/max7219.rst | 2 + esphomeyaml/components/display/nextion.rst | 7 +++ .../components/display/ssd1306_i2c.rst | 2 + .../components/display/ssd1306_spi.rst | 2 + .../components/display/waveshare_epaper.rst | 2 + esphomeyaml/components/esp32_ble_beacon.rst | 2 + esphomeyaml/components/esp32_ble_tracker.rst | 2 + esphomeyaml/components/esp32_touch.rst | 2 + esphomeyaml/components/esphomeyaml.rst | 2 + esphomeyaml/components/fan/binary.rst | 2 + esphomeyaml/components/fan/index.rst | 2 + esphomeyaml/components/fan/speed.rst | 2 + esphomeyaml/components/i2c.rst | 2 + esphomeyaml/components/light/binary.rst | 2 + esphomeyaml/components/light/cwww.rst | 2 + .../components/light/fastled_clockless.rst | 2 + esphomeyaml/components/light/fastled_spi.rst | 2 + esphomeyaml/components/light/index.rst | 2 + .../components/light/monochromatic.rst | 2 + esphomeyaml/components/light/rgb.rst | 2 + esphomeyaml/components/light/rgbw.rst | 2 + esphomeyaml/components/light/rgbww.rst | 2 + esphomeyaml/components/logger.rst | 2 + esphomeyaml/components/mqtt.rst | 2 + esphomeyaml/components/ota.rst | 2 + esphomeyaml/components/output/esp8266_pwm.rst | 6 ++- esphomeyaml/components/output/gpio.rst | 6 ++- esphomeyaml/components/output/index.rst | 13 ++--- esphomeyaml/components/output/ledc.rst | 6 ++- esphomeyaml/components/output/pca9685.rst | 6 ++- esphomeyaml/components/pca9685.rst | 2 + esphomeyaml/components/pcf8574.rst | 2 + esphomeyaml/components/pn532.rst | 2 + esphomeyaml/components/power_supply.rst | 2 + esphomeyaml/components/rdm6300.rst | 2 + esphomeyaml/components/remote_receiver.rst | 2 + esphomeyaml/components/remote_transmitter.rst | 2 + esphomeyaml/components/sensor/adc.rst | 2 + esphomeyaml/components/sensor/ads1115.rst | 2 + esphomeyaml/components/sensor/bh1750.rst | 2 + esphomeyaml/components/sensor/ble_rssi.rst | 2 + esphomeyaml/components/sensor/bme280.rst | 2 + esphomeyaml/components/sensor/bme680.rst | 2 + esphomeyaml/components/sensor/bmp085.rst | 2 + esphomeyaml/components/sensor/bmp280.rst | 2 + esphomeyaml/components/sensor/custom.rst | 2 + esphomeyaml/components/sensor/dallas.rst | 2 + esphomeyaml/components/sensor/dht.rst | 2 + esphomeyaml/components/sensor/dht12.rst | 2 + esphomeyaml/components/sensor/duty_cycle.rst | 2 + esphomeyaml/components/sensor/esp32_hall.rst | 2 + esphomeyaml/components/sensor/hdc1080.rst | 2 + esphomeyaml/components/sensor/hlw8012.rst | 2 + esphomeyaml/components/sensor/hmc5883l.rst | 2 + esphomeyaml/components/sensor/htu21d.rst | 10 +++- esphomeyaml/components/sensor/hx711.rst | 6 ++- esphomeyaml/components/sensor/ina219.rst | 2 + esphomeyaml/components/sensor/ina3221.rst | 2 + esphomeyaml/components/sensor/index.rst | 2 + esphomeyaml/components/sensor/max6675.rst | 2 + esphomeyaml/components/sensor/mhz19.rst | 2 + esphomeyaml/components/sensor/mpu6050.rst | 6 ++- esphomeyaml/components/sensor/ms5611.rst | 6 ++- .../components/sensor/pulse_counter.rst | 2 + .../components/sensor/rotary_encoder.rst | 2 + esphomeyaml/components/sensor/sht3xd.rst | 2 + esphomeyaml/components/sensor/tcs34725.rst | 2 + esphomeyaml/components/sensor/template.rst | 2 + esphomeyaml/components/sensor/tsl2561.rst | 2 + esphomeyaml/components/sensor/ultrasonic.rst | 2 + esphomeyaml/components/sensor/uptime.rst | 2 + esphomeyaml/components/sensor/wifi_signal.rst | 2 + .../components/sensor/xiaomi_miflora.rst | 2 + .../components/sensor/xiaomi_mijia.rst | 2 + esphomeyaml/components/spi.rst | 2 + esphomeyaml/components/status_led.rst | 2 + esphomeyaml/components/switch/gpio.rst | 2 + esphomeyaml/components/switch/index.rst | 2 + esphomeyaml/components/switch/output.rst | 2 + .../components/switch/remote_transmitter.rst | 2 + esphomeyaml/components/switch/restart.rst | 2 + esphomeyaml/components/switch/shutdown.rst | 2 + esphomeyaml/components/switch/template.rst | 2 + esphomeyaml/components/switch/uart.rst | 2 + esphomeyaml/components/time.rst | 2 + esphomeyaml/components/uart.rst | 2 + esphomeyaml/components/web_server.rst | 2 + esphomeyaml/components/wifi.rst | 2 + esphomeyaml/cookbook/bruh.rst | 2 + esphomeyaml/cookbook/dual-r2-cover.rst | 2 + esphomeyaml/cookbook/garage-door.rst | 2 + esphomeyaml/cookbook/pir.rst | 2 + esphomeyaml/cookbook/power_meter.rst | 14 +++--- esphomeyaml/cookbook/relay.rst | 2 + esphomeyaml/cookbook/temt6000.rst | 2 + esphomeyaml/devices/esp32.rst | 2 + esphomeyaml/devices/esp8266.rst | 2 + esphomeyaml/devices/nodemcu_esp32.rst | 2 + esphomeyaml/devices/nodemcu_esp8266.rst | 2 + esphomeyaml/devices/sonoff.rst | 2 + esphomeyaml/devices/sonoff_4ch.rst | 4 +- esphomeyaml/devices/sonoff_basic.rst | 4 +- esphomeyaml/devices/sonoff_s20.rst | 2 + esphomeyaml/guides/automations.rst | 26 +++++----- esphomeyaml/guides/configuration-types.rst | 12 +++-- esphomeyaml/guides/contributing.rst | 36 ++++++++++--- esphomeyaml/guides/faq.rst | 2 + .../guides/getting_started_command_line.rst | 20 ++++---- esphomeyaml/guides/getting_started_hassio.rst | 16 +++--- esphomeyaml/guides/migrate_espeasy.rst | 8 +-- esphomeyaml/guides/migrate_espurna.rst | 8 +-- esphomeyaml/guides/migrate_sonoff_tasmota.rst | 8 +-- esphomeyaml/index.rst | 6 +++ requirements.txt | 2 + 138 files changed, 451 insertions(+), 98 deletions(-) create mode 100644 _static/disqus.js create mode 100644 disqus.py create mode 100644 requirements.txt diff --git a/.gitignore b/.gitignore index 7fbb9283b..401e5e2f8 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,6 @@ _doxyxml _build .python-version +__pycache__/ +*.py[cod] +*$py.class diff --git a/Makefile b/Makefile index 1869435fd..533113b44 100644 --- a/Makefile +++ b/Makefile @@ -23,7 +23,7 @@ doxyg: cleandoxyg _doxyxml cleandoxyg: rm -rf _doxyxml -_doxyxml: $(ESPHOMELIB_PATH) +_doxyxml: ESPHOMELIB_PATH=$(ESPHOMELIB_PATH) doxygen Doxygen $(ESPHOMELIB_PATH): diff --git a/_static/disqus.js b/_static/disqus.js new file mode 100644 index 000000000..ce9c941e8 --- /dev/null +++ b/_static/disqus.js @@ -0,0 +1,13 @@ +(function() { + var d = document, s = d.createElement('script'); + s.src = 'https://esphomelib.disqus.com/embed.js'; + s.setAttribute('data-timestamp', +new Date()); + (d.head || d.body).appendChild(s); +})(); + +var disqus_config = function () { + let disqusThread = document.getElementById("disqus_thread"); + if (disqusThread === null) + return; + this.page.identifier = disqusThread.getAttribute('data-disqus-identifier'); +}; diff --git a/conf.py b/conf.py index 84a54be8f..5622bccb6 100644 --- a/conf.py +++ b/conf.py @@ -26,12 +26,10 @@ import subprocess from sphinx import addnodes from sphinx.util.docfields import Field, GroupedField import re +import sys -on_rtd = os.environ.get('READTHEDOCS', None) == 'True' - -if on_rtd: - subprocess.call('doxygen', shell=True) +sys.path.append(os.path.abspath('.')) # -- General configuration ------------------------------------------------ @@ -44,6 +42,7 @@ if on_rtd: # ones. extensions = [ 'breathe', + 'disqus', ] breathe_projects = {"esphomelib": "./_doxyxml/"} diff --git a/disqus.py b/disqus.py new file mode 100644 index 000000000..20775241d --- /dev/null +++ b/disqus.py @@ -0,0 +1,50 @@ +# Based on https://github.com/rmk135/sphinxcontrib-disqus +from docutils import nodes +from docutils.parsers.rst import Directive + + +class DisqusNode(nodes.General, nodes.Element): + def __init__(self, disqus_identifier): + super(DisqusNode, self).__init__() + self.disqus_identifier = disqus_identifier + + +def disqus_visit(self, node): + html_attrs = { + 'ids': ['disqus_thread'], + 'data-disqus-identifier': node.disqus_identifier, + } + self.body.append(self.starttag(node, 'div', '', **html_attrs)) + + +def disqus_depart(self, _): + self.body.append('') + + +class DisqusDirective(Directive): + option_spec = dict(identifier=str) + + def get_identifier(self): + if 'identifier' in self.options: + return self.options['identifier'] + + env = self.state.document.settings.env + return env.docname.replace('/', '-') + + def run(self): + disqus_identifier = self.get_identifier() + return [DisqusNode(disqus_identifier)] + + +def event_html_page_context(app, pagename, templatename, context, doctree): + if not doctree or 'script_files' not in context: + return + if any(hasattr(n, 'disqus_identifier') for n in doctree.traverse()): + context['script_files'] = context['script_files'][:] + ['_static/disqus.js'] + + +def setup(app): + app.add_directive('disqus', DisqusDirective) + app.add_node(DisqusNode, html=(disqus_visit, disqus_depart)) + app.connect('html-page-context', event_html_page_context) + return {'version': '1.0'} diff --git a/esphomeyaml/components/ads1115.rst b/esphomeyaml/components/ads1115.rst index a677f060e..d52f56fa7 100644 --- a/esphomeyaml/components/ads1115.rst +++ b/esphomeyaml/components/ads1115.rst @@ -20,7 +20,7 @@ To use this hub, first setup the :ref:`I²C Bus ` and connect the sensor to - address: 0x48 Configuration variables: -~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------ - **address** (**Required**, int): The i²c address of the sensor. See :ref:`I²C Addresses ` for more information. @@ -30,7 +30,7 @@ Configuration variables: .. _ads1115_i2c_addresses: I²C Addresses -~~~~~~~~~~~~~ +------------- In order to allow multiple sensors to be connected to the same i²c bus, the creators of this sensor hardware have included some options to @@ -42,9 +42,11 @@ change the i²c address. - If the address pin is tied to SCL, the address is ``0x4B``. See Also -^^^^^^^^ +-------- - :doc:`sensor/ads1115` - `i2cdevlib `__ by `Jeff Rowberg `__ - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/binary_sensor/esp32_ble_tracker.rst b/esphomeyaml/components/binary_sensor/esp32_ble_tracker.rst index 7475e6e5e..218990a90 100644 --- a/esphomeyaml/components/binary_sensor/esp32_ble_tracker.rst +++ b/esphomeyaml/components/binary_sensor/esp32_ble_tracker.rst @@ -62,3 +62,5 @@ See Also - :doc:`API Reference ` - `ESP32 BLE for Arduino `__ by `Neil Kolban `__. - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/binary_sensor/esp32_touch.rst b/esphomeyaml/components/binary_sensor/esp32_touch.rst index c9f6ca856..84044ea10 100644 --- a/esphomeyaml/components/binary_sensor/esp32_touch.rst +++ b/esphomeyaml/components/binary_sensor/esp32_touch.rst @@ -100,3 +100,5 @@ See Also - :doc:`API Reference ` - `esp-idf Touch Sensor API `__ - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/binary_sensor/gpio.rst b/esphomeyaml/components/binary_sensor/gpio.rst index f5abd562d..9cbb101dc 100644 --- a/esphomeyaml/components/binary_sensor/gpio.rst +++ b/esphomeyaml/components/binary_sensor/gpio.rst @@ -93,3 +93,5 @@ See Also - :ref:`config-pin_schema` - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/binary_sensor/index.rst b/esphomeyaml/components/binary_sensor/index.rst index a9e7cd1c8..425c71fce 100644 --- a/esphomeyaml/components/binary_sensor/index.rst +++ b/esphomeyaml/components/binary_sensor/index.rst @@ -98,7 +98,7 @@ You can access the current state of the binary sensor in :ref:`lambdas `. .. _binary_sensor-on_release: ``on_release`` -"""""""""""""" +************** This automation will be triggered when a button press ends, or in other words on the falling edge of the signal. @@ -138,7 +138,7 @@ Configuration variables: See :ref:`Automation `. .. _binary_sensor-on_click: ``on_click`` -"""""""""""" +************ This automation will be triggered when a button is pressed down for a time period of length ``min_length`` to ``max_length``. Any click longer or shorter than this will not trigger the automation. @@ -165,12 +165,7 @@ Configuration variables: .. _binary_sensor-on_double_click: ``on_double_click`` -""""""""""""""""""" - -.. warning:: - - This trigger is not final and could be replaced by a ``on_multi_click`` option which would - allow triggering for any number of clicks. +******************* This automation will be triggered when a button is pressed down twice, with the first click lasting between ``min_length`` and ``max_length``. When a second leading edge then happens within ``min_length`` and @@ -195,7 +190,7 @@ Configuration variables: - See :ref:`Automation `. lambda calls -"""""""""""" +************ From :ref:`lambdas `, you can call several methods on all binary sensors to do some advanced stuff (see the full :doc:`API Reference ` for more info). @@ -241,3 +236,5 @@ See Also pn532 rdm6300 nextion + +.. disqus:: diff --git a/esphomeyaml/components/binary_sensor/nextion.rst b/esphomeyaml/components/binary_sensor/nextion.rst index 9083ea967..1cf65c517 100644 --- a/esphomeyaml/components/binary_sensor/nextion.rst +++ b/esphomeyaml/components/binary_sensor/nextion.rst @@ -37,3 +37,4 @@ See Also - :doc:`API Reference ` - `Edit this page on GitHub `__ +.. disqus:: diff --git a/esphomeyaml/components/binary_sensor/pn532.rst b/esphomeyaml/components/binary_sensor/pn532.rst index 7e1c8413d..fe7f59969 100644 --- a/esphomeyaml/components/binary_sensor/pn532.rst +++ b/esphomeyaml/components/binary_sensor/pn532.rst @@ -61,3 +61,4 @@ See Also - :doc:`API Reference ` - `Edit this page on GitHub `__ +.. disqus:: diff --git a/esphomeyaml/components/binary_sensor/rdm6300.rst b/esphomeyaml/components/binary_sensor/rdm6300.rst index 257c52faf..7d8433cf1 100644 --- a/esphomeyaml/components/binary_sensor/rdm6300.rst +++ b/esphomeyaml/components/binary_sensor/rdm6300.rst @@ -61,3 +61,4 @@ See Also - :doc:`API Reference ` - `Edit this page on GitHub `__ +.. disqus:: diff --git a/esphomeyaml/components/binary_sensor/remote_receiver.rst b/esphomeyaml/components/binary_sensor/remote_receiver.rst index a8d6620bb..991970c78 100644 --- a/esphomeyaml/components/binary_sensor/remote_receiver.rst +++ b/esphomeyaml/components/binary_sensor/remote_receiver.rst @@ -64,3 +64,5 @@ See Also - `IRRemoteESP8266 `__ by `Mark Szabo-Simon `__ - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/binary_sensor/status.rst b/esphomeyaml/components/binary_sensor/status.rst index fa305a00e..9b28ccd6d 100644 --- a/esphomeyaml/components/binary_sensor/status.rst +++ b/esphomeyaml/components/binary_sensor/status.rst @@ -31,3 +31,5 @@ See Also - :doc:`/esphomeyaml/components/mqtt` - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/binary_sensor/template.rst b/esphomeyaml/components/binary_sensor/template.rst index b4c423c0f..91dd6a505 100644 --- a/esphomeyaml/components/binary_sensor/template.rst +++ b/esphomeyaml/components/binary_sensor/template.rst @@ -54,3 +54,5 @@ See Also - :ref:`automation` - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/cover/index.rst b/esphomeyaml/components/cover/index.rst index 9ac79454c..7d7938b71 100644 --- a/esphomeyaml/components/cover/index.rst +++ b/esphomeyaml/components/cover/index.rst @@ -107,3 +107,5 @@ See Also :maxdepth: 1 template.rst + +.. disqus:: diff --git a/esphomeyaml/components/cover/template.rst b/esphomeyaml/components/cover/template.rst index 50510b40b..e7044923b 100644 --- a/esphomeyaml/components/cover/template.rst +++ b/esphomeyaml/components/cover/template.rst @@ -69,3 +69,5 @@ See Also - :doc:`/esphomeyaml/cookbook/garage-door` - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/dallas.rst b/esphomeyaml/components/dallas.rst index b76884f13..fdac28f01 100644 --- a/esphomeyaml/components/dallas.rst +++ b/esphomeyaml/components/dallas.rst @@ -39,3 +39,5 @@ See Also - `Arduino DallasTemperature library `__ by `Miles Burton `__ - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/debug.rst b/esphomeyaml/components/debug.rst index 64e8ba4ef..9ab5dbfe9 100644 --- a/esphomeyaml/components/debug.rst +++ b/esphomeyaml/components/debug.rst @@ -26,3 +26,5 @@ See Also - :doc:`logger` - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/deep_sleep.rst b/esphomeyaml/components/deep_sleep.rst index 126ce4e36..3a255f292 100644 --- a/esphomeyaml/components/deep_sleep.rst +++ b/esphomeyaml/components/deep_sleep.rst @@ -134,3 +134,5 @@ See Also - :ref:`automation` - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/display/index.rst b/esphomeyaml/components/display/index.rst index 3bce9f21a..16e2f8415 100644 --- a/esphomeyaml/components/display/index.rst +++ b/esphomeyaml/components/display/index.rst @@ -355,3 +355,5 @@ See Also ssd1306_i2c ssd1306_spi waveshare_epaper + +.. disqus:: diff --git a/esphomeyaml/components/display/lcd_gpio.rst b/esphomeyaml/components/display/lcd_gpio.rst index a7fb4945d..576adb1ef 100644 --- a/esphomeyaml/components/display/lcd_gpio.rst +++ b/esphomeyaml/components/display/lcd_gpio.rst @@ -106,3 +106,5 @@ See Also - :doc:`API Reference ` - `Arduino LiquidCrystal Library `__ - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/display/lcd_pcf8574.rst b/esphomeyaml/components/display/lcd_pcf8574.rst index 5296f4398..d2d8bc61a 100644 --- a/esphomeyaml/components/display/lcd_pcf8574.rst +++ b/esphomeyaml/components/display/lcd_pcf8574.rst @@ -53,3 +53,5 @@ See Also - :doc:`API Reference ` - `Arduino LiquidCrystal Library `__ - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/display/max7219.rst b/esphomeyaml/components/display/max7219.rst index da5d55cfa..01dd39c92 100644 --- a/esphomeyaml/components/display/max7219.rst +++ b/esphomeyaml/components/display/max7219.rst @@ -331,3 +331,5 @@ See Also - :doc:`API Reference ` - `MAX7219 Library `__ by `Nick Gammon `__ - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/display/nextion.rst b/esphomeyaml/components/display/nextion.rst index d9cfcc980..0194501d2 100644 --- a/esphomeyaml/components/display/nextion.rst +++ b/esphomeyaml/components/display/nextion.rst @@ -1,6 +1,11 @@ Nextion TFT LCD Display ======================= +.. warning:: + + This integration is experimental as I don't have the hardware to test it (yet). + If you can verify it works (or if it doesn't), notify me on `discord `__. + The ``nextion`` display platform allows you to use Nextion LCD displays (`datasheet `__, `iTead `__) with esphomelib. @@ -83,3 +88,5 @@ See Also - `Simple Nextion Library `__ by `Bentley Born `__ - `Official Nextion Library `__ by `iTead `__ - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/display/ssd1306_i2c.rst b/esphomeyaml/components/display/ssd1306_i2c.rst index 37fcec22d..5f03571c6 100644 --- a/esphomeyaml/components/display/ssd1306_i2c.rst +++ b/esphomeyaml/components/display/ssd1306_i2c.rst @@ -64,3 +64,5 @@ See Also - :doc:`API Reference ` - `SSD1306 Library `__ by `Adafruit `__ - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/display/ssd1306_spi.rst b/esphomeyaml/components/display/ssd1306_spi.rst index 39c64dd29..3e52bae6c 100644 --- a/esphomeyaml/components/display/ssd1306_spi.rst +++ b/esphomeyaml/components/display/ssd1306_spi.rst @@ -69,3 +69,5 @@ See Also - :doc:`API Reference ` - `SSD1306 Library `__ by `Adafruit `__ - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/display/waveshare_epaper.rst b/esphomeyaml/components/display/waveshare_epaper.rst index 487af27f0..7a82f681c 100644 --- a/esphomeyaml/components/display/waveshare_epaper.rst +++ b/esphomeyaml/components/display/waveshare_epaper.rst @@ -100,3 +100,5 @@ See Also - :doc:`API Reference ` - `Arduino Waveshare E-Paper library `__ by `Yehui (@soonuse) `__ - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/esp32_ble_beacon.rst b/esphomeyaml/components/esp32_ble_beacon.rst index 354e72898..ccdb7508a 100644 --- a/esphomeyaml/components/esp32_ble_beacon.rst +++ b/esphomeyaml/components/esp32_ble_beacon.rst @@ -87,3 +87,5 @@ See Also - :doc:`API Reference ` - `ESP32 BLE for Arduino `__ by `Neil Kolban `__. - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/esp32_ble_tracker.rst b/esphomeyaml/components/esp32_ble_tracker.rst index 682f5f18a..9d4997626 100644 --- a/esphomeyaml/components/esp32_ble_tracker.rst +++ b/esphomeyaml/components/esp32_ble_tracker.rst @@ -78,3 +78,5 @@ See Also - :doc:`API Reference ` - `ESP32 BLE for Arduino `__ by `Neil Kolban `__. - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/esp32_touch.rst b/esphomeyaml/components/esp32_touch.rst index bcf4138f1..f0b90330d 100644 --- a/esphomeyaml/components/esp32_touch.rst +++ b/esphomeyaml/components/esp32_touch.rst @@ -53,3 +53,5 @@ See Also - :doc:`binary_sensor/esp32_touch` - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/esphomeyaml.rst b/esphomeyaml/components/esphomeyaml.rst index b6573f707..3146b4adf 100644 --- a/esphomeyaml/components/esphomeyaml.rst +++ b/esphomeyaml/components/esphomeyaml.rst @@ -234,3 +234,5 @@ See Also -------- - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/fan/binary.rst b/esphomeyaml/components/fan/binary.rst index f0a1acbab..9ec794a8b 100644 --- a/esphomeyaml/components/fan/binary.rst +++ b/esphomeyaml/components/fan/binary.rst @@ -36,3 +36,5 @@ See Also - :doc:`/esphomeyaml/components/fan/index` - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/fan/index.rst b/esphomeyaml/components/fan/index.rst index fbfeb9e72..12f3d51fa 100644 --- a/esphomeyaml/components/fan/index.rst +++ b/esphomeyaml/components/fan/index.rst @@ -96,3 +96,5 @@ Full Fan Index binary.rst speed.rst + +.. disqus:: diff --git a/esphomeyaml/components/fan/speed.rst b/esphomeyaml/components/fan/speed.rst index 3b9508966..d1694f153 100644 --- a/esphomeyaml/components/fan/speed.rst +++ b/esphomeyaml/components/fan/speed.rst @@ -47,3 +47,5 @@ See Also - :doc:`/esphomeyaml/components/output/pca9685` - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/i2c.rst b/esphomeyaml/components/i2c.rst index ca55613ba..c8f68a635 100644 --- a/esphomeyaml/components/i2c.rst +++ b/esphomeyaml/components/i2c.rst @@ -37,3 +37,5 @@ See Also - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/light/binary.rst b/esphomeyaml/components/light/binary.rst index 05cc77d1e..6a87561ad 100644 --- a/esphomeyaml/components/light/binary.rst +++ b/esphomeyaml/components/light/binary.rst @@ -36,3 +36,5 @@ See Also - :doc:`/esphomeyaml/components/power_supply` - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/light/cwww.rst b/esphomeyaml/components/light/cwww.rst index adc1839ca..94ea86b8c 100644 --- a/esphomeyaml/components/light/cwww.rst +++ b/esphomeyaml/components/light/cwww.rst @@ -54,3 +54,5 @@ See Also - :doc:`/esphomeyaml/components/output/pca9685` - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/light/fastled_clockless.rst b/esphomeyaml/components/light/fastled_clockless.rst index 7247b1acb..28cf960ed 100644 --- a/esphomeyaml/components/light/fastled_clockless.rst +++ b/esphomeyaml/components/light/fastled_clockless.rst @@ -88,3 +88,5 @@ See Also - :doc:`API Reference ` - `Arduino FastLED library `__ - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/light/fastled_spi.rst b/esphomeyaml/components/light/fastled_spi.rst index 330f714e0..7a15e961e 100644 --- a/esphomeyaml/components/light/fastled_spi.rst +++ b/esphomeyaml/components/light/fastled_spi.rst @@ -72,3 +72,5 @@ See Also - :doc:`API Reference ` - `Arduino FastLED library `__ - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/light/index.rst b/esphomeyaml/components/light/index.rst index 2721e77c2..2be3c6627 100644 --- a/esphomeyaml/components/light/index.rst +++ b/esphomeyaml/components/light/index.rst @@ -471,3 +471,5 @@ See Also rgbww.rst fastled_clockless.rst fastled_spi.rst + +.. disqus:: diff --git a/esphomeyaml/components/light/monochromatic.rst b/esphomeyaml/components/light/monochromatic.rst index d0deddd66..d9a06f12e 100644 --- a/esphomeyaml/components/light/monochromatic.rst +++ b/esphomeyaml/components/light/monochromatic.rst @@ -60,3 +60,5 @@ See Also - :doc:`/esphomeyaml/components/output/pca9685` - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/light/rgb.rst b/esphomeyaml/components/light/rgb.rst index cb93ff854..3d1b963ed 100644 --- a/esphomeyaml/components/light/rgb.rst +++ b/esphomeyaml/components/light/rgb.rst @@ -62,3 +62,5 @@ See Also - :doc:`/esphomeyaml/components/output/pca9685` - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/light/rgbw.rst b/esphomeyaml/components/light/rgbw.rst index 55cb28f24..cae0bef39 100644 --- a/esphomeyaml/components/light/rgbw.rst +++ b/esphomeyaml/components/light/rgbw.rst @@ -49,3 +49,5 @@ See Also - :doc:`/esphomeyaml/components/output/pca9685` - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/light/rgbww.rst b/esphomeyaml/components/light/rgbww.rst index b610f6408..7da2f364c 100644 --- a/esphomeyaml/components/light/rgbww.rst +++ b/esphomeyaml/components/light/rgbww.rst @@ -60,3 +60,5 @@ See Also - :doc:`/esphomeyaml/components/output/pca9685` - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/logger.rst b/esphomeyaml/components/logger.rst index fd177c598..df27c02c0 100644 --- a/esphomeyaml/components/logger.rst +++ b/esphomeyaml/components/logger.rst @@ -79,3 +79,5 @@ See Also - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/mqtt.rst b/esphomeyaml/components/mqtt.rst index 41daa6d84..ee12de26a 100644 --- a/esphomeyaml/components/mqtt.rst +++ b/esphomeyaml/components/mqtt.rst @@ -350,3 +350,5 @@ See Also - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/ota.rst b/esphomeyaml/components/ota.rst index f08b1582e..7c9988b89 100644 --- a/esphomeyaml/components/ota.rst +++ b/esphomeyaml/components/ota.rst @@ -60,3 +60,5 @@ See Also - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/output/esp8266_pwm.rst b/esphomeyaml/components/output/esp8266_pwm.rst index c7f6c0b01..5b9519ece 100644 --- a/esphomeyaml/components/output/esp8266_pwm.rst +++ b/esphomeyaml/components/output/esp8266_pwm.rst @@ -23,14 +23,14 @@ successor of the ESP8266, the ESP32, and its :doc:`ESP32 LEDC PWM ` instea id: pwm-output Configuration variables: -~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------ - **pin** (**Required**, :ref:`Pin Schema `): The pin to use PWM on. - **id** (**Required**, :ref:`config-id`): The id to use for this output component. - All other options from :ref:`Output `. See Also -^^^^^^^^ +-------- - :doc:`/esphomeyaml/components/output/index` - :doc:`/esphomeyaml/components/output/ledc` @@ -39,3 +39,5 @@ See Also - :doc:`/esphomeyaml/components/power_supply` - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/output/gpio.rst b/esphomeyaml/components/output/gpio.rst index 19e964804..e5d76a25c 100644 --- a/esphomeyaml/components/output/gpio.rst +++ b/esphomeyaml/components/output/gpio.rst @@ -14,7 +14,7 @@ will not show up in Home Assistant. See :doc:`GPIO Switch `. id: gpio_d1 Configuration variables: -~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------ - **pin** (**Required**, :ref:`Pin Schema `): The pin to use PWM on. - **id** (**Required**, :ref:`config-id`): The id to use for this output component. @@ -27,7 +27,7 @@ Configuration variables: see the :doc:`/esphomeyaml/components/switch/gpio`. See Also -^^^^^^^^ +-------- - :doc:`/esphomeyaml/components/switch/gpio` - :doc:`/esphomeyaml/components/output/index` @@ -38,3 +38,5 @@ See Also - :doc:`/esphomeyaml/components/power_supply` - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/output/index.rst b/esphomeyaml/components/output/index.rst index b6ebb5c22..94aa65444 100644 --- a/esphomeyaml/components/output/index.rst +++ b/esphomeyaml/components/output/index.rst @@ -11,7 +11,7 @@ any rational value between 0 and 1). .. _config-output: Base Output Configuration -~~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------- Each output platform extends this configuration schema. @@ -39,11 +39,10 @@ Configuration variables: multiplied by this. Must be in range from 0 to 1. Defaults to 1. - .. _output-turn_on_action: ``output.turn_on`` Action -^^^^^^^^^^^^^^^^^^^^^^^^^ +************************* This action turns the output with the given ID on when executed. @@ -56,7 +55,7 @@ This action turns the output with the given ID on when executed. .. _output-turn_off_action: ``output.turn_off`` Action -^^^^^^^^^^^^^^^^^^^^^^^^^^ +************************** This action turns the output with the given ID off when executed. @@ -69,7 +68,7 @@ This action turns the output with the given ID off when executed. .. _output-set_level_action: ``output.set_level`` Action -^^^^^^^^^^^^^^^^^^^^^^^^^^^ +*************************** This action sets the float output to the given level when executed. Note: This only works with floating point outputs like ESP8266 PWM or LEDC. @@ -83,7 +82,7 @@ works with floating point outputs like ESP8266 PWM or LEDC. level: 50% Full Output Index -^^^^^^^^^^^^^^^^^ +----------------- - :doc:`/esphomeyaml/components/switch/output` - :doc:`/esphomeyaml/components/power_supply` @@ -102,3 +101,5 @@ Full Output Index gpio.rst ledc.rst pca9685.rst + +.. disqus:: diff --git a/esphomeyaml/components/output/ledc.rst b/esphomeyaml/components/output/ledc.rst index 9d45c0eb9..2a2f61a02 100644 --- a/esphomeyaml/components/output/ledc.rst +++ b/esphomeyaml/components/output/ledc.rst @@ -14,7 +14,7 @@ of the ESP32 as an output component. id: gpio_19 Configuration variables: -~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------ - **pin** (**Required**, :ref:`config-pin`): The pin to use LEDC on. Can only be GPIO0-GPIO33. - **id** (**Required**, :ref:`config-id`): The id to use for this output component. @@ -28,7 +28,7 @@ Configuration variables: - All other options from :ref:`Output `. See Also -^^^^^^^^ +-------- - :doc:`/esphomeyaml/components/output/index` - :doc:`/esphomeyaml/components/output/esp8266_pwm` @@ -38,3 +38,5 @@ See Also - :doc:`API Reference ` - `esp-idf LEDC API docs `__ - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/output/pca9685.rst b/esphomeyaml/components/output/pca9685.rst index ddb1fbf69..416b43467 100644 --- a/esphomeyaml/components/output/pca9685.rst +++ b/esphomeyaml/components/output/pca9685.rst @@ -24,7 +24,7 @@ output. channel: 0 Configuration variables: -~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------ - **id** (**Required**, :ref:`config-id`): The id to use for this output component. - **channel** (**Required**, int): Chose the channel of the PCA9685 of @@ -35,7 +35,7 @@ Configuration variables: - All other options from :ref:`Output `. See Also -^^^^^^^^ +-------- - :doc:`/esphomeyaml/components/pca9685` - :doc:`/esphomeyaml/components/output/index` @@ -47,3 +47,5 @@ See Also - :doc:`API Reference ` - `PCA9685 Arduino Library `__ by `@NachtRaveVL `__ - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/pca9685.rst b/esphomeyaml/components/pca9685.rst index 494d5d0ba..23fe6af00 100644 --- a/esphomeyaml/components/pca9685.rst +++ b/esphomeyaml/components/pca9685.rst @@ -39,3 +39,5 @@ See Also - :doc:`output/pca9685` - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/pcf8574.rst b/esphomeyaml/components/pcf8574.rst index 2c3c52356..ee509fac9 100644 --- a/esphomeyaml/components/pcf8574.rst +++ b/esphomeyaml/components/pcf8574.rst @@ -59,3 +59,5 @@ See Also - `PCF8574 Arduino Library `__ by `Fabien Batteix `__ - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/pn532.rst b/esphomeyaml/components/pn532.rst index bab3940c4..e25421f40 100644 --- a/esphomeyaml/components/pn532.rst +++ b/esphomeyaml/components/pn532.rst @@ -60,3 +60,5 @@ See Also - `PN532 Library `__ by `Adafruit `__ - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/power_supply.rst b/esphomeyaml/components/power_supply.rst index 3001d1a1e..c10d6a881 100644 --- a/esphomeyaml/components/power_supply.rst +++ b/esphomeyaml/components/power_supply.rst @@ -66,3 +66,5 @@ See Also - :doc:`output/index` - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/rdm6300.rst b/esphomeyaml/components/rdm6300.rst index 9ecc55f4b..1739f785f 100644 --- a/esphomeyaml/components/rdm6300.rst +++ b/esphomeyaml/components/rdm6300.rst @@ -46,3 +46,5 @@ See Also - `RDM6300 Arduino Library `__ by `Arliones Hoeller Jr `__ - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/remote_receiver.rst b/esphomeyaml/components/remote_receiver.rst index 16a675cfb..fc65ce8da 100644 --- a/esphomeyaml/components/remote_receiver.rst +++ b/esphomeyaml/components/remote_receiver.rst @@ -53,3 +53,5 @@ See Also - `IRRemoteESP8266 `__ by `Mark Szabo-Simon `__ - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/remote_transmitter.rst b/esphomeyaml/components/remote_transmitter.rst index a752f3e9c..a26534d05 100644 --- a/esphomeyaml/components/remote_transmitter.rst +++ b/esphomeyaml/components/remote_transmitter.rst @@ -49,3 +49,5 @@ See Also - `IRRemoteESP8266 `__ by `Mark Szabo-Simon `__ - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/sensor/adc.rst b/esphomeyaml/components/sensor/adc.rst index 544238834..984594c61 100644 --- a/esphomeyaml/components/sensor/adc.rst +++ b/esphomeyaml/components/sensor/adc.rst @@ -92,3 +92,5 @@ See Also - :doc:`max6675` - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/sensor/ads1115.rst b/esphomeyaml/components/sensor/ads1115.rst index 6a7b5795f..7a7f73989 100644 --- a/esphomeyaml/components/sensor/ads1115.rst +++ b/esphomeyaml/components/sensor/ads1115.rst @@ -74,3 +74,5 @@ See Also - :doc:`API Reference ` - `i2cdevlib `__ by `Jeff Rowberg `__ - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/sensor/bh1750.rst b/esphomeyaml/components/sensor/bh1750.rst index 6cc8d623e..af5d4a498 100644 --- a/esphomeyaml/components/sensor/bh1750.rst +++ b/esphomeyaml/components/sensor/bh1750.rst @@ -51,3 +51,5 @@ See Also - :doc:`API Reference ` - `BH1750 Library `__ by `@claws `__ - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/sensor/ble_rssi.rst b/esphomeyaml/components/sensor/ble_rssi.rst index 0e294a660..3dfa6d450 100644 --- a/esphomeyaml/components/sensor/ble_rssi.rst +++ b/esphomeyaml/components/sensor/ble_rssi.rst @@ -32,3 +32,5 @@ See Also - :doc:`/esphomeyaml/components/sensor/index` - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/sensor/bme280.rst b/esphomeyaml/components/sensor/bme280.rst index a9ed0a31d..2f3090f74 100644 --- a/esphomeyaml/components/sensor/bme280.rst +++ b/esphomeyaml/components/sensor/bme280.rst @@ -90,3 +90,5 @@ See Also - `Adafruit BME280 Library `__ by `Adafruit `__ - `Sparkfun BME280 Library `__ by `Sparkfun `__ - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/sensor/bme680.rst b/esphomeyaml/components/sensor/bme680.rst index f58514237..2ad22d8ad 100644 --- a/esphomeyaml/components/sensor/bme680.rst +++ b/esphomeyaml/components/sensor/bme680.rst @@ -107,3 +107,5 @@ See Also - :doc:`API Reference ` - `BME680 Sensor API `__ by `Bosch Sensortec `__ - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/sensor/bmp085.rst b/esphomeyaml/components/sensor/bmp085.rst index 2a6060da9..24c6bb6da 100644 --- a/esphomeyaml/components/sensor/bmp085.rst +++ b/esphomeyaml/components/sensor/bmp085.rst @@ -60,3 +60,5 @@ See Also - :doc:`API Reference ` - `i2cdevlib `__ by `Jeff Rowberg `__ - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/sensor/bmp280.rst b/esphomeyaml/components/sensor/bmp280.rst index 0b6ba750a..3e4f62ae1 100644 --- a/esphomeyaml/components/sensor/bmp280.rst +++ b/esphomeyaml/components/sensor/bmp280.rst @@ -86,3 +86,5 @@ See Also - :doc:`API Reference ` - `BME280 Library `__ by `Adafruit `__ - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/sensor/custom.rst b/esphomeyaml/components/sensor/custom.rst index 0197df1e3..1ef266200 100644 --- a/esphomeyaml/components/sensor/custom.rst +++ b/esphomeyaml/components/sensor/custom.rst @@ -372,3 +372,5 @@ See Also - `Full source code `__ - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/sensor/dallas.rst b/esphomeyaml/components/sensor/dallas.rst index cf4322deb..30f9fcc82 100644 --- a/esphomeyaml/components/sensor/dallas.rst +++ b/esphomeyaml/components/sensor/dallas.rst @@ -106,3 +106,5 @@ See Also - `Arduino DallasTemperature library `__ by `Miles Burton `__ - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/sensor/dht.rst b/esphomeyaml/components/sensor/dht.rst index 9a9ae0c51..4ce3a2985 100644 --- a/esphomeyaml/components/sensor/dht.rst +++ b/esphomeyaml/components/sensor/dht.rst @@ -79,3 +79,5 @@ See Also - :doc:`API Reference ` - `Arduino DHTLib `__ - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/sensor/dht12.rst b/esphomeyaml/components/sensor/dht12.rst index a09950189..5695495c3 100644 --- a/esphomeyaml/components/sensor/dht12.rst +++ b/esphomeyaml/components/sensor/dht12.rst @@ -57,3 +57,5 @@ See Also - :doc:`API Reference ` - `DHT12 Library `__ by `Daniel Plasa `__ - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/sensor/duty_cycle.rst b/esphomeyaml/components/sensor/duty_cycle.rst index 82be64443..51f138b82 100644 --- a/esphomeyaml/components/sensor/duty_cycle.rst +++ b/esphomeyaml/components/sensor/duty_cycle.rst @@ -28,3 +28,5 @@ Configuration variables: See :ref:`sensor-default_filter`. - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - All other options from :ref:`Sensor ` and :ref:`MQTT Component `. + +.. disqus:: diff --git a/esphomeyaml/components/sensor/esp32_hall.rst b/esphomeyaml/components/sensor/esp32_hall.rst index 2809c155f..142d7064b 100644 --- a/esphomeyaml/components/sensor/esp32_hall.rst +++ b/esphomeyaml/components/sensor/esp32_hall.rst @@ -48,3 +48,5 @@ See Also - :doc:`/esphomeyaml/devices/esp32` - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/sensor/hdc1080.rst b/esphomeyaml/components/sensor/hdc1080.rst index b5274d53f..29817e6c8 100644 --- a/esphomeyaml/components/sensor/hdc1080.rst +++ b/esphomeyaml/components/sensor/hdc1080.rst @@ -64,3 +64,5 @@ See Also - :doc:`API Reference ` - `HDC1080 Library `__ by `ClosedCube `__ - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/sensor/hlw8012.rst b/esphomeyaml/components/sensor/hlw8012.rst index e3dcd8ce4..bcbc894ad 100644 --- a/esphomeyaml/components/sensor/hlw8012.rst +++ b/esphomeyaml/components/sensor/hlw8012.rst @@ -60,3 +60,5 @@ See Also - :doc:`API Reference ` - `HLW8012 Library `__ by `Xose Pérez `__ - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/sensor/hmc5883l.rst b/esphomeyaml/components/sensor/hmc5883l.rst index 9eb253820..886dd3dbf 100644 --- a/esphomeyaml/components/sensor/hmc5883l.rst +++ b/esphomeyaml/components/sensor/hmc5883l.rst @@ -51,3 +51,5 @@ See Also - :doc:`API Reference ` - `HMC5883L Library `__ by `Korneliusz Jarzębski `__ - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/sensor/htu21d.rst b/esphomeyaml/components/sensor/htu21d.rst index 52f6e34e2..e09a53819 100644 --- a/esphomeyaml/components/sensor/htu21d.rst +++ b/esphomeyaml/components/sensor/htu21d.rst @@ -19,6 +19,10 @@ required to be set up in your configuration for this sensor to work. :align: center :width: 80.0% +.. note:: + + The **SI7021** sensor also works with this integration. + .. code:: yaml # Example configuration entry @@ -31,7 +35,7 @@ required to be set up in your configuration for this sensor to work. update_interval: 15s Configuration variables: -~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------ - **temperature** (**Required**): The information for the temperature sensor. @@ -49,7 +53,7 @@ Configuration variables: See :ref:`sensor-default_filter`. See Also -^^^^^^^^ +-------- - :ref:`sensor-filters` - :doc:`dht` @@ -59,3 +63,5 @@ See Also - :doc:`API Reference ` - `i2cdevlib `__ by `Jeff Rowberg `__ - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/sensor/hx711.rst b/esphomeyaml/components/sensor/hx711.rst index 55d146c63..571f93ba6 100644 --- a/esphomeyaml/components/sensor/hx711.rst +++ b/esphomeyaml/components/sensor/hx711.rst @@ -29,7 +29,7 @@ Connect ``GND`` to ``GND``, ``VCC`` to ``3.3V`` and the other three ``MISO`` (or update_interval: 15s Configuration variables: -~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------ - **name** (**Required**, string): The name for the load cell sensor. - **dout_pin** (**Required**, :ref:`Pin Schema `): The DOUT (or DAT) pin. @@ -40,10 +40,12 @@ Configuration variables: - All other options from :ref:`Sensor ` and :ref:`MQTT Component `. See Also -^^^^^^^^ +-------- - :ref:`sensor-filters` - :doc:`adc` - :doc:`API Reference ` - `HX711 Library `__ by `@bogde `__ - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/sensor/ina219.rst b/esphomeyaml/components/sensor/ina219.rst index ebec27e8d..c950dafed 100644 --- a/esphomeyaml/components/sensor/ina219.rst +++ b/esphomeyaml/components/sensor/ina219.rst @@ -68,3 +68,5 @@ See Also - :doc:`API Reference ` - `INA291 Arduino Library `__ by `Adafruit `__ - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/sensor/ina3221.rst b/esphomeyaml/components/sensor/ina3221.rst index 7690972dd..c2b6781c3 100644 --- a/esphomeyaml/components/sensor/ina3221.rst +++ b/esphomeyaml/components/sensor/ina3221.rst @@ -79,3 +79,5 @@ See Also - :doc:`API Reference ` - `INA3221 Arduino Library `__ by `SwitchDoc Labs `__ - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/sensor/index.rst b/esphomeyaml/components/sensor/index.rst index 20efa22b3..b597296ce 100644 --- a/esphomeyaml/components/sensor/index.rst +++ b/esphomeyaml/components/sensor/index.rst @@ -357,3 +357,5 @@ See Also wifi_signal xiaomi_miflora xiaomi_mijia + +.. disqus:: diff --git a/esphomeyaml/components/sensor/max6675.rst b/esphomeyaml/components/sensor/max6675.rst index ffcd2748c..8794ebc7c 100644 --- a/esphomeyaml/components/sensor/max6675.rst +++ b/esphomeyaml/components/sensor/max6675.rst @@ -58,3 +58,5 @@ See Also - `MAX6675 Library `__ by `Adafruit `__ - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/sensor/mhz19.rst b/esphomeyaml/components/sensor/mhz19.rst index d424b49ff..5826953dc 100644 --- a/esphomeyaml/components/sensor/mhz19.rst +++ b/esphomeyaml/components/sensor/mhz19.rst @@ -69,3 +69,5 @@ See Also - `MH-Z19 library `__ by `@nara356 `__ - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/sensor/mpu6050.rst b/esphomeyaml/components/sensor/mpu6050.rst index dc82f4d36..964f78b25 100644 --- a/esphomeyaml/components/sensor/mpu6050.rst +++ b/esphomeyaml/components/sensor/mpu6050.rst @@ -47,7 +47,7 @@ new feature. Supporting all possible use-cases would be quite hard. name: "MPU6050 Temperature" Configuration variables: -~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------ - **address** (*Optional*, int): Manually specify the i^2c address of the sensor. Defaults to ``0x68``. - **accel_x** (*Optional*): Use the X-Axis of the Accelerometer. All options from @@ -69,7 +69,7 @@ Configuration variables: - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. See Also -^^^^^^^^ +-------- - :ref:`sensor-filters` - :doc:`template` @@ -77,3 +77,5 @@ See Also - :doc:`API Reference ` - `i2cdevlib `__ by `Jeff Rowberg `__ - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/sensor/ms5611.rst b/esphomeyaml/components/sensor/ms5611.rst index 09e5533fc..1ba04b44e 100644 --- a/esphomeyaml/components/sensor/ms5611.rst +++ b/esphomeyaml/components/sensor/ms5611.rst @@ -31,7 +31,7 @@ required to be set up in your configuration for this sensor to work. update_interval: 15s Configuration variables: -~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------ - **pressure** (**Required**): The information for the pressure sensor. @@ -53,7 +53,7 @@ Configuration variables: sensor. Defaults to ``15s``. See :ref:`sensor-default_filter`. See Also -^^^^^^^^ +-------- - :ref:`sensor-filters` - :doc:`bmp280` @@ -62,3 +62,5 @@ See Also - `Arduino MS5611 Library `__ by `Korneliusz Jarzębski `__ - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/sensor/pulse_counter.rst b/esphomeyaml/components/sensor/pulse_counter.rst index 847a2919c..0e16cb0d4 100644 --- a/esphomeyaml/components/sensor/pulse_counter.rst +++ b/esphomeyaml/components/sensor/pulse_counter.rst @@ -72,3 +72,5 @@ See Also - `esp-idf Pulse Counter API `__. - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/sensor/rotary_encoder.rst b/esphomeyaml/components/sensor/rotary_encoder.rst index d413e1ea3..c1e7a501e 100644 --- a/esphomeyaml/components/sensor/rotary_encoder.rst +++ b/esphomeyaml/components/sensor/rotary_encoder.rst @@ -76,3 +76,5 @@ See Also - `Mechanical Input Library `__ by `Jochen Krapf `__ - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/sensor/sht3xd.rst b/esphomeyaml/components/sensor/sht3xd.rst index 9c0636106..1ecb0ab49 100644 --- a/esphomeyaml/components/sensor/sht3xd.rst +++ b/esphomeyaml/components/sensor/sht3xd.rst @@ -55,3 +55,5 @@ See Also - :doc:`htu21d` - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/sensor/tcs34725.rst b/esphomeyaml/components/sensor/tcs34725.rst index 90bca436d..d2e8f12f5 100644 --- a/esphomeyaml/components/sensor/tcs34725.rst +++ b/esphomeyaml/components/sensor/tcs34725.rst @@ -70,3 +70,5 @@ See Also - `TCS34725 library `__ by `Adafruit `__ - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/sensor/template.rst b/esphomeyaml/components/sensor/template.rst index aa3c10b9f..00299a17a 100644 --- a/esphomeyaml/components/sensor/template.rst +++ b/esphomeyaml/components/sensor/template.rst @@ -43,3 +43,5 @@ See Also - :ref:`automation` - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/sensor/tsl2561.rst b/esphomeyaml/components/sensor/tsl2561.rst index a9e4da5e4..e198e3ab0 100644 --- a/esphomeyaml/components/sensor/tsl2561.rst +++ b/esphomeyaml/components/sensor/tsl2561.rst @@ -55,3 +55,5 @@ See Also - `SparkFun TSL2561 Arduino Library `__ by `Sparkfun `__ - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/sensor/ultrasonic.rst b/esphomeyaml/components/sensor/ultrasonic.rst index 8f550ec35..b094d4475 100644 --- a/esphomeyaml/components/sensor/ultrasonic.rst +++ b/esphomeyaml/components/sensor/ultrasonic.rst @@ -83,3 +83,5 @@ See Also - :doc:`template` - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/sensor/uptime.rst b/esphomeyaml/components/sensor/uptime.rst index 0ab0515db..694b9f39a 100644 --- a/esphomeyaml/components/sensor/uptime.rst +++ b/esphomeyaml/components/sensor/uptime.rst @@ -25,3 +25,5 @@ See Also - :ref:`sensor-filters` - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/sensor/wifi_signal.rst b/esphomeyaml/components/sensor/wifi_signal.rst index 12e7294b1..e79ba7d5b 100644 --- a/esphomeyaml/components/sensor/wifi_signal.rst +++ b/esphomeyaml/components/sensor/wifi_signal.rst @@ -40,3 +40,5 @@ See Also - :doc:`/esphomeyaml/components/wifi` - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/sensor/xiaomi_miflora.rst b/esphomeyaml/components/sensor/xiaomi_miflora.rst index e49391c91..f2b6b09f0 100644 --- a/esphomeyaml/components/sensor/xiaomi_miflora.rst +++ b/esphomeyaml/components/sensor/xiaomi_miflora.rst @@ -97,3 +97,5 @@ See Also - :doc:`API Reference ` - `OpenMQTTGateway `__ by `@1technophile `__ - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/sensor/xiaomi_mijia.rst b/esphomeyaml/components/sensor/xiaomi_mijia.rst index dcfc59f8b..74d0e66f2 100644 --- a/esphomeyaml/components/sensor/xiaomi_mijia.rst +++ b/esphomeyaml/components/sensor/xiaomi_mijia.rst @@ -88,3 +88,5 @@ See Also - `Xiaomi Mijia BLE protocl `__ by `@mspider65 `__ - `OpenMQTTGateway `__ by `@1technophile `__ - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/spi.rst b/esphomeyaml/components/spi.rst index eaabb2cc2..9c1300d64 100644 --- a/esphomeyaml/components/spi.rst +++ b/esphomeyaml/components/spi.rst @@ -42,3 +42,5 @@ See Also - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/status_led.rst b/esphomeyaml/components/status_led.rst index 0b64bce3e..b79aa4557 100644 --- a/esphomeyaml/components/status_led.rst +++ b/esphomeyaml/components/status_led.rst @@ -41,3 +41,5 @@ See Also - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/switch/gpio.rst b/esphomeyaml/components/switch/gpio.rst index 73a1e8d3e..f6c695d4e 100644 --- a/esphomeyaml/components/switch/gpio.rst +++ b/esphomeyaml/components/switch/gpio.rst @@ -48,3 +48,5 @@ See Also - :doc:`/esphomeyaml/components/output/gpio` - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/switch/index.rst b/esphomeyaml/components/switch/index.rst index 518a6695f..7ca9ec63d 100644 --- a/esphomeyaml/components/switch/index.rst +++ b/esphomeyaml/components/switch/index.rst @@ -121,3 +121,5 @@ See Also shutdown template uart + +.. disqus:: diff --git a/esphomeyaml/components/switch/output.rst b/esphomeyaml/components/switch/output.rst index db8066bf0..525eef3ed 100644 --- a/esphomeyaml/components/switch/output.rst +++ b/esphomeyaml/components/switch/output.rst @@ -33,3 +33,5 @@ See Also - :doc:`/esphomeyaml/components/output/index` - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/switch/remote_transmitter.rst b/esphomeyaml/components/switch/remote_transmitter.rst index 1def2aff5..db7eb1761 100644 --- a/esphomeyaml/components/switch/remote_transmitter.rst +++ b/esphomeyaml/components/switch/remote_transmitter.rst @@ -350,3 +350,5 @@ See Also - `IRRemoteESP8266 `__ by `Mark Szabo-Simon `__ - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/switch/restart.rst b/esphomeyaml/components/switch/restart.rst index ec0f4edea..2600f4dd8 100644 --- a/esphomeyaml/components/switch/restart.rst +++ b/esphomeyaml/components/switch/restart.rst @@ -29,3 +29,5 @@ See Also - :doc:`template` - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/switch/shutdown.rst b/esphomeyaml/components/switch/shutdown.rst index 3c70a1dfd..3864cd1c8 100644 --- a/esphomeyaml/components/switch/shutdown.rst +++ b/esphomeyaml/components/switch/shutdown.rst @@ -31,3 +31,5 @@ See Also - :doc:`template` - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/switch/template.rst b/esphomeyaml/components/switch/template.rst index 893682f59..6822e0527 100644 --- a/esphomeyaml/components/switch/template.rst +++ b/esphomeyaml/components/switch/template.rst @@ -62,3 +62,5 @@ See Also - :doc:`/esphomeyaml/components/binary_sensor/index` - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/switch/uart.rst b/esphomeyaml/components/switch/uart.rst index 9242bfbe0..0d4d69baf 100644 --- a/esphomeyaml/components/switch/uart.rst +++ b/esphomeyaml/components/switch/uart.rst @@ -35,3 +35,5 @@ See Also - :doc:`/esphomeyaml/components/uart` - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/time.rst b/esphomeyaml/components/time.rst index f2e0685d9..9a118b6f7 100644 --- a/esphomeyaml/components/time.rst +++ b/esphomeyaml/components/time.rst @@ -296,3 +296,5 @@ See Also - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/uart.rst b/esphomeyaml/components/uart.rst index b40a39956..4d71ac169 100644 --- a/esphomeyaml/components/uart.rst +++ b/esphomeyaml/components/uart.rst @@ -49,3 +49,5 @@ See Also - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/web_server.rst b/esphomeyaml/components/web_server.rst index 28a036ce0..a4da58693 100644 --- a/esphomeyaml/components/web_server.rst +++ b/esphomeyaml/components/web_server.rst @@ -40,3 +40,5 @@ See Also - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/components/wifi.rst b/esphomeyaml/components/wifi.rst index c4b932178..abed879fb 100644 --- a/esphomeyaml/components/wifi.rst +++ b/esphomeyaml/components/wifi.rst @@ -127,3 +127,5 @@ See Also - :doc:`API Reference ` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/cookbook/bruh.rst b/esphomeyaml/cookbook/bruh.rst index 6f832c5ab..ece6f6f18 100644 --- a/esphomeyaml/cookbook/bruh.rst +++ b/esphomeyaml/cookbook/bruh.rst @@ -85,3 +85,5 @@ See Also - :doc:`/esphomeyaml/components/sensor/adc` - :doc:`/esphomeyaml/components/binary_sensor/gpio` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/cookbook/dual-r2-cover.rst b/esphomeyaml/cookbook/dual-r2-cover.rst index 9bde694f4..6a0e13dee 100644 --- a/esphomeyaml/cookbook/dual-r2-cover.rst +++ b/esphomeyaml/cookbook/dual-r2-cover.rst @@ -119,3 +119,5 @@ See Also - :doc:`/esphomeyaml/components/cover/template` - :doc:`/esphomeyaml/devices/sonoff` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/cookbook/garage-door.rst b/esphomeyaml/cookbook/garage-door.rst index 5a2e4afff..3797cbaa9 100644 --- a/esphomeyaml/cookbook/garage-door.rst +++ b/esphomeyaml/cookbook/garage-door.rst @@ -52,3 +52,5 @@ See Also - :doc:`/esphomeyaml/guides/automations` - :doc:`/esphomeyaml/components/cover/template` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/cookbook/pir.rst b/esphomeyaml/cookbook/pir.rst index 9f0aec716..78b4fb239 100644 --- a/esphomeyaml/cookbook/pir.rst +++ b/esphomeyaml/cookbook/pir.rst @@ -59,3 +59,5 @@ See Also - :doc:`/esphomeyaml/components/binary_sensor/gpio` - :doc:`bruh` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/cookbook/power_meter.rst b/esphomeyaml/cookbook/power_meter.rst index 7ef67362e..63ecb25bb 100644 --- a/esphomeyaml/cookbook/power_meter.rst +++ b/esphomeyaml/cookbook/power_meter.rst @@ -11,12 +11,6 @@ IoT enabled? We just have to hook up a simple photoresistor in front of that afo LED and track the amount of pulses we receive. Then using esphomelib we can instantly have the power meter show up in Home Assistant 🎉 -.. note:: - - This guide currently only works with the ESP32, and even if it is ported back to the ESP8266 - at some point, the ESP32 will still achieve a much higher accuracy because it has a - hardware-based pulse counter. - Hooking it all up is quite easy: Just buy a suitable photoresistor (make sure the wave length approximately matches the one from your power meter). Then connect it using a simple variable resistor divider (see `this article `__ for inspiration). @@ -46,3 +40,11 @@ Thus, rearranging the expression yields a proportional factor of ``0.06`` from ` And if a technician shows up and he looks confused about what the heck you have done to your power meter, tell them about esphomelib 😉 + +See Also +-------- + +- :doc:`/esphomeyaml/components/sensor/pulse_counter` +- `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/cookbook/relay.rst b/esphomeyaml/cookbook/relay.rst index 46736e412..39d8ae347 100644 --- a/esphomeyaml/cookbook/relay.rst +++ b/esphomeyaml/cookbook/relay.rst @@ -41,3 +41,5 @@ See Also - :doc:`/esphomeyaml/components/output/gpio` - `How do relays work `__. - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/cookbook/temt6000.rst b/esphomeyaml/cookbook/temt6000.rst index 48f1f5aa8..749f0aa54 100644 --- a/esphomeyaml/cookbook/temt6000.rst +++ b/esphomeyaml/cookbook/temt6000.rst @@ -66,3 +66,5 @@ See Also - `TEMT6000 datasheet `__ - :doc:`bruh` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/devices/esp32.rst b/esphomeyaml/devices/esp32.rst index 02f67d1ea..7ab887790 100644 --- a/esphomeyaml/devices/esp32.rst +++ b/esphomeyaml/devices/esp32.rst @@ -47,3 +47,5 @@ See Also - :doc:`nodemcu_esp32` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/devices/esp8266.rst b/esphomeyaml/devices/esp8266.rst index c9c6a7d06..274029edd 100644 --- a/esphomeyaml/devices/esp8266.rst +++ b/esphomeyaml/devices/esp8266.rst @@ -47,3 +47,5 @@ See Also - :doc:`nodemcu_esp8266` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/devices/nodemcu_esp32.rst b/esphomeyaml/devices/nodemcu_esp32.rst index 27e135829..e8a6c9a9f 100644 --- a/esphomeyaml/devices/nodemcu_esp32.rst +++ b/esphomeyaml/devices/nodemcu_esp32.rst @@ -58,3 +58,5 @@ See Also - :doc:`esp32` - :doc:`nodemcu_esp8266` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/devices/nodemcu_esp8266.rst b/esphomeyaml/devices/nodemcu_esp8266.rst index 027d456ba..61a830ab7 100644 --- a/esphomeyaml/devices/nodemcu_esp8266.rst +++ b/esphomeyaml/devices/nodemcu_esp8266.rst @@ -69,3 +69,5 @@ See Also - :doc:`esp8266` - :doc:`nodemcu_esp32` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/devices/sonoff.rst b/esphomeyaml/devices/sonoff.rst index 15aa21a76..78302a0f3 100644 --- a/esphomeyaml/devices/sonoff.rst +++ b/esphomeyaml/devices/sonoff.rst @@ -314,3 +314,5 @@ See Also - :doc:`sonoff_basic` - :doc:`esp8266` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/devices/sonoff_4ch.rst b/esphomeyaml/devices/sonoff_4ch.rst index bd744e7dd..ce1f03202 100644 --- a/esphomeyaml/devices/sonoff_4ch.rst +++ b/esphomeyaml/devices/sonoff_4ch.rst @@ -331,8 +331,10 @@ connect it. Happy hacking! See Also ----------- +-------- - :doc:`sonoff` - :doc:`sonoff_s20` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/devices/sonoff_basic.rst b/esphomeyaml/devices/sonoff_basic.rst index 3e40d7283..2aeb48434 100644 --- a/esphomeyaml/devices/sonoff_basic.rst +++ b/esphomeyaml/devices/sonoff_basic.rst @@ -121,9 +121,11 @@ Or run the upload command if your device is connected to the serial interface: esphomeyaml sonoff_basic.yaml run See Also ----------- +-------- - :doc:`sonoff` - :doc:`sonoff_4ch` - :doc:`sonoff_s20` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/devices/sonoff_s20.rst b/esphomeyaml/devices/sonoff_s20.rst index 5bdc99858..c04341ce6 100644 --- a/esphomeyaml/devices/sonoff_s20.rst +++ b/esphomeyaml/devices/sonoff_s20.rst @@ -334,3 +334,5 @@ See Also - :doc:`sonoff` - :doc:`sonoff_4ch` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/guides/automations.rst b/esphomeyaml/guides/automations.rst index e5b17d1ea..3fd2e4f67 100644 --- a/esphomeyaml/guides/automations.rst +++ b/esphomeyaml/guides/automations.rst @@ -93,7 +93,7 @@ There are also other triggers like ``on_release``, ``on_click`` or ``on_double_c .. _config-action: Actions -^^^^^^^ +------- Now comes the actual automation block. With ``then``, you tell esphomeyaml what should happen when the press happens. Within this block, you can define several "actions". For example, ``switch.toggle`` and the line after that form an @@ -166,7 +166,7 @@ esphomelib has another extremely powerful tool to offer: Templates. .. _config-lambda: Templates (Lambdas) -^^^^^^^^^^^^^^^^^^^ +------------------- With templates inside esphomelib, you can do almost *everything*. If for example you want to only perform a certain automation if a certain complex formula evaluates to true, you can do that with templates. Let's look at an example @@ -267,7 +267,7 @@ we're retrieving the current state of the end stop using ``.value`` and using it .. _config-templatable: Bonus: Templating Actions -^^^^^^^^^^^^^^^^^^^^^^^^^ +************************* Another feature of esphomeyaml is that you can template almost every parameter for actions in automations. For example if you have a light and want to set it to a pre-defined color when a button is pressed, you can do this: @@ -290,7 +290,7 @@ Every parameter in actions that has the label "templatable" in the docs can be t all of the usual lambda syntax. All Triggers -~~~~~~~~~~~~ +------------ - :ref:`mqtt.on_message ` - :ref:`sensor.on_value ` @@ -305,7 +305,7 @@ All Triggers - :ref:`esphomeyaml.on_loop ` All Actions -~~~~~~~~~~~ +----------- - :ref:`delay ` - :ref:`lambda ` @@ -331,8 +331,8 @@ All Actions .. _delay_action: -Delay Action -~~~~~~~~~~~~ +``delay`` Action +---------------- This action delays the execution of the next action in the action list by a specified time period. @@ -356,8 +356,8 @@ time period. .. _lambda_action: -Lambda Action -~~~~~~~~~~~~~ +``lambda`` Action +----------------- This action executes an arbitrary piece of C++ code (see :ref:`Lambda `). @@ -370,8 +370,8 @@ This action executes an arbitrary piece of C++ code (see :ref:`Lambda `__ + +.. disqus:: diff --git a/esphomeyaml/guides/configuration-types.rst b/esphomeyaml/guides/configuration-types.rst index 1c5488133..f19a2e2cf 100644 --- a/esphomeyaml/guides/configuration-types.rst +++ b/esphomeyaml/guides/configuration-types.rst @@ -7,7 +7,7 @@ page describes them. .. _config-id: ID -~~ +-- Quite an important aspect of esphomeyaml are “ids”. They are used to connect components from different domains. For example, you define an @@ -30,7 +30,7 @@ names .. _config-pin: Pin -~~~ +--- esphomeyaml always uses the **chip-internal GPIO numbers**. These internal numbers are always integers like ``16`` and can be prefixed by @@ -57,7 +57,7 @@ either one of these names in your configuration will lead to the same result. .. _config-pin_schema: Pin Schema -~~~~~~~~~~ +---------- In some places, esphomeyaml also supports a more advanced “pin schema”. @@ -107,7 +107,7 @@ More exotic Pin Modes are also supported, but rarely used: .. _config-time: Time -~~~~ +---- In lots of places in esphomeyaml you need to define time periods. There are several ways of doing this. See below examples to see how you can specify time periods: @@ -138,9 +138,11 @@ There are several ways of doing this. See below examples to see how you can spec update_interval: 0ms # update in every loop() iteration See Also -~~~~~~~~ +-------- - :doc:`esphomeyaml index ` - :doc:`getting_started_command_line` - :doc:`faq` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/guides/contributing.rst b/esphomeyaml/guides/contributing.rst index 53c518f49..f9d7191ac 100644 --- a/esphomeyaml/guides/contributing.rst +++ b/esphomeyaml/guides/contributing.rst @@ -12,7 +12,7 @@ Just clone the repository locally, do the changes for your new feature/bugfix an a pull request. I will try to take a look at your PR as soon as possible. Contributing to esphomedocs -^^^^^^^^^^^^^^^^^^^^^^^^^^^ +--------------------------- One of the areas of esphomelib that can always be improved is the documentation. If you see an issue somewhere, or spelling mistakes or if you want to share your awesome @@ -32,12 +32,19 @@ RST primer: My Title ======== - and sub-titles like this: + and section headers like this: .. code:: rst - My Sub Title - ^^^^^^^^^^^^ + My Sub Section + -------------- + + and sub-section headers like this: + + .. code:: rst + + My Sub-sub section + ****************** - **Links**: To create a link to an external resource (for example https://www.google.com), use ``\`Link text \`__``. For example: @@ -177,7 +184,18 @@ To check your documentation changes locally, you first need install sphinx (**wi .. code:: bash - pip3 install sphinx breathe + # in esphomedocs repo: + pip3 install -r requirements.txt + +.. note:: + + Alternatively, you can use the `esphomedocs docker image `__: + + .. code:: bash + + docker run --rm -v "$PWD/..":/data -p 8000:8000 -it ottowinter/esphomedocs + + And then go to ``:8000`` in your browser. Next, you will also need to clone the `esphomelib repository `__ into the folder where ``esphomedocs`` sits like this: @@ -222,7 +240,7 @@ Some notes about the docs: esphomedocs repository. New features should be added against the ``next`` branch. Contributing to esphomelib -^^^^^^^^^^^^^^^^^^^^^^^^^^ +-------------------------- esphomelib is the engine behind all the esphomeyaml stuff. The framework is also designed to be used on its own - i.e. without esphomeyaml. To contribute code to esphomelib to fix @@ -276,7 +294,7 @@ For editing a local copy of esphomelib within the esphomeyaml ecosystem please s :ref:`esphomeyaml.esphomelib_version ` option. Contributing to esphomeyaml -^^^^^^^^^^^^^^^^^^^^^^^^^^^ +--------------------------- esphomeyaml primarily does two things: It validates the configuration and creates C++ code. @@ -368,8 +386,10 @@ it in the configuration. Specifically, it may contain these fields: Run ``pip2 install -e .`` to install a development version of esphomeyaml. See Also -~~~~~~~~ +-------- - :doc:`esphomeyaml index ` - :doc:`faq` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/guides/faq.rst b/esphomeyaml/guides/faq.rst index 0249a2959..219f1ce89 100644 --- a/esphomeyaml/guides/faq.rst +++ b/esphomeyaml/guides/faq.rst @@ -246,3 +246,5 @@ See Also - :doc:`esphomeyaml index ` - :doc:`contributing` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/guides/getting_started_command_line.rst b/esphomeyaml/guides/getting_started_command_line.rst index 7c06ac6b9..dc62af03e 100644 --- a/esphomeyaml/guides/getting_started_command_line.rst +++ b/esphomeyaml/guides/getting_started_command_line.rst @@ -6,7 +6,7 @@ your ESP8266/ESP32 boards. In this guide we’ll go through how to setup a basic “node” in a few simple steps. Installation -~~~~~~~~~~~~ +------------ Installing epshomeyaml is very easy. All you need to do is have `Python 2.7 `__ installed @@ -26,7 +26,7 @@ an RPi, please install esphomelib through ``pip`` or use :doc:`the HassIO add-on docker pull ottowinter/esphomeyaml Creating A Project -~~~~~~~~~~~~~~~~~~ +------------------ Now let’s setup a configuration file. Fortunately, esphomeyaml has a friendly setup wizard that will guide you through creating your first @@ -49,7 +49,7 @@ file ready. It doesn't do much yet and only makes your device connect to the WiFi network and MQTT broker, but still it’s a first step. Adding some features -~~~~~~~~~~~~~~~~~~~~ +-------------------- So now you should have a file called ``livingroom.yaml`` (or similar). Go open that file in an editor of your choice and let’s add a :doc:`simple @@ -73,7 +73,7 @@ above configuration, if using a NodeMCU board, you could have just as well set ``D1`` as the ``pin:`` option. First Uploading -~~~~~~~~~~~~~~~ +--------------- Now you can go ahead and add some more components. Once you feel like you have something you want to upload to your ESP board, simply plug in @@ -116,7 +116,7 @@ cable again, as all features of esphomelib are enabled remotely as well. No more opening hidden boxes stowed in places hard to reach. Yay! Adding A Binary Sensor -~~~~~~~~~~~~~~~~~~~~~~ +---------------------- Next, we’re going to add a very simple binary sensor that periodically checks a GPIO pin whether it’s pulled high or low - the :doc:`GPIO Binary @@ -150,7 +150,7 @@ for docker you need to supply an additional parameter: .. figure:: /esphomeyaml/components/binary_sensor/images/gpio-ui.png Where To Go Next -~~~~~~~~~~~~~~~~ +---------------- Great 🎉! You’ve now successfully setup your first esphomeyaml project and uploaded your first esphomelib custom firmware to your node. You’ve @@ -164,7 +164,7 @@ tracker `__ or contact me via the `Discord chat `__. Bonus: esphomeyaml dashboard -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +---------------------------- Starting with version 1.6.0 esphomeyaml features a dashboard that you can use to easily manage your nodes from a nice web interface. It was primarily designed for @@ -187,7 +187,7 @@ After that, you will be able to access the dashboard through ``localhost:6052``. .. figure:: images/dashboard.png Using Custom components -~~~~~~~~~~~~~~~~~~~~~~~ +----------------------- esphomelib’s powerful core makes it easy to create own custom sensors. Please first follow the `Custom Sensor Component @@ -223,8 +223,10 @@ esphomeyaml’s great configuration options. } See Also -~~~~~~~~ +-------- - :doc:`esphomeyaml index ` - :doc:`getting_started_hassio` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/guides/getting_started_hassio.rst b/esphomeyaml/guides/getting_started_hassio.rst index 1505768d0..fe751817c 100644 --- a/esphomeyaml/guides/getting_started_hassio.rst +++ b/esphomeyaml/guides/getting_started_hassio.rst @@ -13,7 +13,7 @@ or sensors in esphomeyaml's configuration, they will even automatically show up Assistant's UI. Installation -~~~~~~~~~~~~ +------------ Installing the epshomeyaml HassIO add-on is easy. Just navigate to the HassIO panel in your Home Assistant frontend and add the esphomeyaml add-on repository: @@ -41,7 +41,7 @@ creating your first configuration. supported. Please try using Google Chrome in that case. Dashboard Interface -~~~~~~~~~~~~~~~~~~~ +------------------- Assuming you created your first configuration file with the wizard, let's take a quick tour of the esphomeyaml dashboard interface. @@ -94,7 +94,7 @@ using the ``password`` option in the HassIO add-on page. By default, this is an Adding some (basic) features -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +---------------------------- So now you should have a file called ``/config/esphomeyaml/livingroom.yaml`` (or similar). Go open that file in and add a :doc:`simple GPIO switch ` @@ -124,7 +124,7 @@ cable again, as all features of esphomelib are enabled remotely as well. No more opening hidden boxes stowed in places hard to reach. Yay! Adding A Binary Sensor -~~~~~~~~~~~~~~~~~~~~~~ +---------------------- Next, we’re going to add a very simple binary sensor that periodically checks a GPIO pin whether it’s pulled high or low - the :doc:`GPIO Binary @@ -152,7 +152,7 @@ through USB again. The upload will magically happen :doc:`"over the air" `__ or contact me via the `Discord chat `__. Using Custom components -~~~~~~~~~~~~~~~~~~~~~~~ +----------------------- esphomelib’s powerful core makes it easy to create own custom sensors. Please first follow the `Custom Sensor Component @@ -202,8 +202,10 @@ esphomeyaml’s great configuration options. } See Also -~~~~~~~~ +-------- - :doc:`esphomeyaml index ` - :doc:`getting_started_command_line` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/guides/migrate_espeasy.rst b/esphomeyaml/guides/migrate_espeasy.rst index 5556b443e..eda44ba0b 100644 --- a/esphomeyaml/guides/migrate_espeasy.rst +++ b/esphomeyaml/guides/migrate_espeasy.rst @@ -5,7 +5,7 @@ Migrating from previous ESPEasy setups is very easy. You just need to have esphomeyaml create a binary for you and then upload that in the ESPEasy web interface. Getting Binary -^^^^^^^^^^^^^^ +-------------- First follow the guides for the :ref:`different supported devices ` and create a configuration file. Then, generate and download the binary: @@ -21,7 +21,7 @@ file. Then, generate and download the binary: this is the binary you will upload. Uploading Binary -^^^^^^^^^^^^^^^^ +---------------- To upload the binary, navigate to the ESPEasy web interface and enter the "Tools " section. @@ -41,7 +41,7 @@ the binary. If everything succeeds, you should now have esphomelib on your node Happy Hacking! See Also -~~~~~~~~ +-------- - :doc:`/esphomeyaml/devices/nodemcu_esp8266` - :doc:`/esphomeyaml/devices/nodemcu_esp32` @@ -52,3 +52,5 @@ See Also - :doc:`migrate_espurna` - :doc:`migrate_sonoff_tasmota` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/guides/migrate_espurna.rst b/esphomeyaml/guides/migrate_espurna.rst index f018bfcb9..99c9f1b01 100644 --- a/esphomeyaml/guides/migrate_espurna.rst +++ b/esphomeyaml/guides/migrate_espurna.rst @@ -5,7 +5,7 @@ Migrating from previous ESPurna setups is very easy. You just need to have esphomeyaml create a binary for you and then upload that in the ESPurna web interface. Getting Binary -^^^^^^^^^^^^^^ +-------------- First follow the guides for the :ref:`different supported devices ` and create a configuration file. Then, generate and download the binary: @@ -21,7 +21,7 @@ file. Then, generate and download the binary: this is the binary you will upload. Uploading Binary -^^^^^^^^^^^^^^^^ +---------------- To upload the binary, navigate to the ESPurna web interface and enter the "General " section. @@ -45,7 +45,7 @@ If everything succeeds, you should now have esphomelib on your node 🎉 Happy Hacking! See Also -~~~~~~~~ +-------- - :doc:`/esphomeyaml/devices/nodemcu_esp8266` - :doc:`/esphomeyaml/devices/nodemcu_esp32` @@ -56,3 +56,5 @@ See Also - :doc:`migrate_espeasy` - :doc:`migrate_sonoff_tasmota` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/guides/migrate_sonoff_tasmota.rst b/esphomeyaml/guides/migrate_sonoff_tasmota.rst index e27b29989..65c980994 100644 --- a/esphomeyaml/guides/migrate_sonoff_tasmota.rst +++ b/esphomeyaml/guides/migrate_sonoff_tasmota.rst @@ -5,7 +5,7 @@ Migrating from previous Sonoff Tasmota setups is very easy. You just need to hav esphomeyaml create a binary for you and then upload that in the Tasmota web interface. Getting Binary -^^^^^^^^^^^^^^ +-------------- First follow the guides for the :ref:`different supported devices ` and create a configuration file. Then, generate and download the binary: @@ -21,7 +21,7 @@ file. Then, generate and download the binary: this is the binary you will upload. Uploading Binary -^^^^^^^^^^^^^^^^ +---------------- To upload the binary, navigate to the tasmota web interface and enter the "Firmware Upgrade" section. @@ -46,7 +46,7 @@ will connect to the configured WiFi network 🎉 Happy Hacking! See Also -~~~~~~~~ +-------- - :doc:`/esphomeyaml/devices/sonoff_s20` - :doc:`/esphomeyaml/devices/sonoff_4ch` @@ -58,3 +58,5 @@ See Also - :doc:`migrate_espurna` - :doc:`migrate_espeasy` - `Edit this page on GitHub `__ + +.. disqus:: diff --git a/esphomeyaml/index.rst b/esphomeyaml/index.rst index 317b805f0..038073bcd 100644 --- a/esphomeyaml/index.rst +++ b/esphomeyaml/index.rst @@ -1,6 +1,12 @@ esphomeyaml =========== +.. raw:: html + + GitHub stars + Release + Discord Chat + Hi there! This is the documentation for esphomeyaml, a project that aims to make using ESP8266/ESP32 boards with Home Assistant very easy with no programming experience required. diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 000000000..9ccf803e7 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,2 @@ +sphinx +breathe