Add Disqus and cleanup (#47)

This commit is contained in:
Otto Winter 2018-10-12 16:33:22 +02:00 committed by GitHub
parent 604d7bf6a2
commit 150dea575c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
138 changed files with 451 additions and 98 deletions

3
.gitignore vendored
View File

@ -2,3 +2,6 @@ _doxyxml
_build
.python-version
__pycache__/
*.py[cod]
*$py.class

View File

@ -23,7 +23,7 @@ doxyg: cleandoxyg _doxyxml
cleandoxyg:
rm -rf _doxyxml
_doxyxml: $(ESPHOMELIB_PATH)
_doxyxml:
ESPHOMELIB_PATH=$(ESPHOMELIB_PATH) doxygen Doxygen
$(ESPHOMELIB_PATH):

13
_static/disqus.js Normal file
View File

@ -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');
};

View File

@ -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/"}

50
disqus.py Normal file
View File

@ -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('</div>')
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'}

View File

@ -20,7 +20,7 @@ To use this hub, first setup the :ref:`I²C Bus <i2c>` and connect the sensor to
- address: 0x48
Configuration variables:
~~~~~~~~~~~~~~~~~~~~~~~~
------------------------
- **address** (**Required**, int): The i²c address of the sensor.
See :ref:`I²C Addresses <ads1115_i2c_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 <https://github.com/jrowberg/i2cdevlib>`__ by `Jeff Rowberg <https://github.com/jrowberg>`__
- :doc:`API Reference </api/sensor/ads1115>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/ads1115.rst>`__
.. disqus::

View File

@ -62,3 +62,5 @@ See Also
- :doc:`API Reference </api/misc/esp32_ble_tracker>`
- `ESP32 BLE for Arduino <https://github.com/nkolban/ESP32_BLE_Arduino>`__ by `Neil Kolban <https://github.com/nkolban>`__.
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/binary_sensor/esp32_ble_tracker.rst>`__
.. disqus::

View File

@ -100,3 +100,5 @@ See Also
- :doc:`API Reference </api/binary_sensor/esp32_touch>`
- `esp-idf Touch Sensor API <https://esp-idf.readthedocs.io/en/latest/api-reference/peripherals/touch_pad.html>`__
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/binary_sensor/esp32_touch.rst>`__
.. disqus::

View File

@ -93,3 +93,5 @@ See Also
- :ref:`config-pin_schema`
- :doc:`API Reference </api/binary_sensor/gpio>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/binary_sensor/gpio.rst>`__
.. disqus::

View File

@ -98,7 +98,7 @@ You can access the current state of the binary sensor in :ref:`lambdas <config-l
.. _binary_sensor-on_press:
``on_press``
""""""""""""
************
This automation will be triggered when the button is first pressed down, or in other words on the leading
edge of the signal.
@ -118,7 +118,7 @@ Configuration variables: See :ref:`Automation <automation>`.
.. _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 <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 <automation>`.
lambda calls
""""""""""""
************
From :ref:`lambdas <config-lambda>`, you can call several methods on all binary sensors to do some
advanced stuff (see the full :doc:`API Reference </api/binary_sensor/index>` for more info).
@ -241,3 +236,5 @@ See Also
pn532
rdm6300
nextion
.. disqus::

View File

@ -37,3 +37,4 @@ See Also
- :doc:`API Reference </api/display/nextion>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/binary_sensor/nextion.rst>`__
.. disqus::

View File

@ -61,3 +61,4 @@ See Also
- :doc:`API Reference </api/binary_sensor/pn532>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/binary_sensor/pn532.rst>`__
.. disqus::

View File

@ -61,3 +61,4 @@ See Also
- :doc:`API Reference </api/binary_sensor/rdm6300>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/binary_sensor/rdm6300.rst>`__
.. disqus::

View File

@ -64,3 +64,5 @@ See Also
- `IRRemoteESP8266 <https://github.com/markszabo/IRremoteESP8266/>`__ by `Mark Szabo-Simon <https://github.com/markszabo>`__
- :doc:`API Reference </api/binary_sensor/remote_receiver>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/binary_sensor/remote_receiver.rst>`__
.. disqus::

View File

@ -31,3 +31,5 @@ See Also
- :doc:`/esphomeyaml/components/mqtt`
- :doc:`API Reference </api/binary_sensor/status>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/binary_sensor/status.rst>`__
.. disqus::

View File

@ -54,3 +54,5 @@ See Also
- :ref:`automation`
- :doc:`API Reference </api/binary_sensor/template>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/binary_sensor/template.rst>`__
.. disqus::

View File

@ -107,3 +107,5 @@ See Also
:maxdepth: 1
template.rst
.. disqus::

View File

@ -69,3 +69,5 @@ See Also
- :doc:`/esphomeyaml/cookbook/garage-door`
- :doc:`API Reference </api/cover/template>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/cover/template.rst>`__
.. disqus::

View File

@ -39,3 +39,5 @@ See Also
- `Arduino DallasTemperature library <https://github.com/milesburton/Arduino-Temperature-Control-Library>`__ by `Miles Burton <https://github.com/milesburton>`__
- :doc:`API Reference </api/sensor/dallas>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/dallas.rst>`__
.. disqus::

View File

@ -26,3 +26,5 @@ See Also
- :doc:`logger`
- :doc:`API Reference </api/misc/debug>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/debug.rst>`__
.. disqus::

View File

@ -134,3 +134,5 @@ See Also
- :ref:`automation`
- :doc:`API Reference </api/core/deep-sleep>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/deep_sleep.rst>`__
.. disqus::

View File

@ -355,3 +355,5 @@ See Also
ssd1306_i2c
ssd1306_spi
waveshare_epaper
.. disqus::

View File

@ -106,3 +106,5 @@ See Also
- :doc:`API Reference </api/display/lcd_display>`
- `Arduino LiquidCrystal Library <https://www.arduino.cc/en/Reference/LiquidCrystal>`__
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/display/lcd_gpio.rst>`__
.. disqus::

View File

@ -53,3 +53,5 @@ See Also
- :doc:`API Reference </api/display/lcd_display>`
- `Arduino LiquidCrystal Library <https://www.arduino.cc/en/Reference/LiquidCrystal>`__
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/display/lcd_pcf8574.rst>`__
.. disqus::

View File

@ -331,3 +331,5 @@ See Also
- :doc:`API Reference </api/display/max7219>`
- `MAX7219 Library <https://github.com/nickgammon/MAX7219>`__ by `Nick Gammon <https://github.com/nickgammon>`__
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/display/max7219.rst>`__
.. disqus::

View File

@ -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 <https://discord.gg/KhAMKrd>`__.
The ``nextion`` display platform allows you to use Nextion LCD displays (`datasheet <https://nextion.itead.cc/resources/datasheets/>`__,
`iTead <https://www.itead.cc/display/nextion.html>`__)
with esphomelib.
@ -83,3 +88,5 @@ See Also
- `Simple Nextion Library <https://github.com/bborncr/nextion>`__ by `Bentley Born <https://github.com/bborncr>`__
- `Official Nextion Library <https://github.com/itead/ITEADLIB_Arduino_Nextion>`__ by `iTead <http://itead.cc/>`__
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/display/nextion.rst>`__
.. disqus::

View File

@ -64,3 +64,5 @@ See Also
- :doc:`API Reference </api/display/ssd1306>`
- `SSD1306 Library <https://github.com/adafruit/Adafruit_SSD1306>`__ by `Adafruit <http://adafruit.com/>`__
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/display/ssd1306_i2c.rst>`__
.. disqus::

View File

@ -69,3 +69,5 @@ See Also
- :doc:`API Reference </api/display/ssd1306>`
- `SSD1306 Library <https://github.com/adafruit/Adafruit_SSD1306>`__ by `Adafruit <http://adafruit.com/>`__
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/display/ssd1306_spi.rst>`__
.. disqus::

View File

@ -100,3 +100,5 @@ See Also
- :doc:`API Reference </api/display/waveshare_epaper>`
- `Arduino Waveshare E-Paper library <https://github.com/soonuse/epd-library-arduino>`__ by `Yehui (@soonuse) <https://github.com/soonuse>`__
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/display/waveshare_epaper.rst>`__
.. disqus::

View File

@ -87,3 +87,5 @@ See Also
- :doc:`API Reference </api/misc/esp32_ble_beacon>`
- `ESP32 BLE for Arduino <https://github.com/nkolban/ESP32_BLE_Arduino>`__ by `Neil Kolban <https://github.com/nkolban>`__.
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/esp32_ble_beacon.rst>`__
.. disqus::

View File

@ -78,3 +78,5 @@ See Also
- :doc:`API Reference </api/misc/esp32_ble_tracker>`
- `ESP32 BLE for Arduino <https://github.com/nkolban/ESP32_BLE_Arduino>`__ by `Neil Kolban <https://github.com/nkolban>`__.
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/esp32_ble_tracker.rst>`__
.. disqus::

View File

@ -53,3 +53,5 @@ 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/current/esphomeyaml/components/esp32_touch.rst>`__
.. disqus::

View File

@ -234,3 +234,5 @@ See Also
--------
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/esphomeyaml.rst>`__
.. disqus::

View File

@ -36,3 +36,5 @@ See Also
- :doc:`/esphomeyaml/components/fan/index`
- :doc:`API Reference </api/fan/index>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/fan/binary.rst>`__
.. disqus::

View File

@ -96,3 +96,5 @@ Full Fan Index
binary.rst
speed.rst
.. disqus::

View File

@ -47,3 +47,5 @@ See Also
- :doc:`/esphomeyaml/components/output/pca9685`
- :doc:`API Reference </api/fan/index>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/fan/speed.rst>`__
.. disqus::

View File

@ -37,3 +37,5 @@ See Also
- :doc:`API Reference </api/core/i2c>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/i2c.rst>`__
.. disqus::

View File

@ -36,3 +36,5 @@ See Also
- :doc:`/esphomeyaml/components/power_supply`
- :doc:`API Reference </api/light/index>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/light/binary.rst>`__
.. disqus::

View File

@ -54,3 +54,5 @@ See Also
- :doc:`/esphomeyaml/components/output/pca9685`
- :doc:`API Reference </api/light/index>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/light/cwww.rst>`__
.. disqus::

View File

@ -88,3 +88,5 @@ See Also
- :doc:`API Reference </api/light/fastled>`
- `Arduino FastLED library <https://github.com/FastLED/FastLED>`__
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/light/fastled_clockless.rst>`__
.. disqus::

View File

@ -72,3 +72,5 @@ See Also
- :doc:`API Reference </api/light/fastled>`
- `Arduino FastLED library <https://github.com/FastLED/FastLED>`__
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/light/fastled_spi.rst>`__
.. disqus::

View File

@ -471,3 +471,5 @@ See Also
rgbww.rst
fastled_clockless.rst
fastled_spi.rst
.. disqus::

View File

@ -60,3 +60,5 @@ See Also
- :doc:`/esphomeyaml/components/output/pca9685`
- :doc:`API Reference </api/light/index>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/light/monochromatic.rst>`__
.. disqus::

View File

@ -62,3 +62,5 @@ See Also
- :doc:`/esphomeyaml/components/output/pca9685`
- :doc:`API Reference </api/light/index>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/light/rgb.rst>`__
.. disqus::

View File

@ -49,3 +49,5 @@ See Also
- :doc:`/esphomeyaml/components/output/pca9685`
- :doc:`API Reference </api/light/index>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/light/rgbw.rst>`__
.. disqus::

View File

@ -60,3 +60,5 @@ See Also
- :doc:`/esphomeyaml/components/output/pca9685`
- :doc:`API Reference </api/light/index>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/light/rgbww.rst>`__
.. disqus::

View File

@ -79,3 +79,5 @@ See Also
- :doc:`API Reference </api/core/log>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/logger.rst>`__
.. disqus::

View File

@ -350,3 +350,5 @@ See Also
- :doc:`API Reference </api/core/mqtt>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/mqtt.rst>`__
.. disqus::

View File

@ -60,3 +60,5 @@ See Also
- :doc:`API Reference </api/core/ota>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/ota.rst>`__
.. disqus::

View File

@ -23,14 +23,14 @@ successor of the ESP8266, the ESP32, and its :doc:`ESP32 LEDC PWM <ledc>` instea
id: pwm-output
Configuration variables:
~~~~~~~~~~~~~~~~~~~~~~~~
------------------------
- **pin** (**Required**, :ref:`Pin Schema <config-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 <config-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 </api/output/esp8266-pwm>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/output/esp8266_pwm.rst>`__
.. disqus::

View File

@ -14,7 +14,7 @@ will not show up in Home Assistant. See :doc:`GPIO Switch <gpio>`.
id: gpio_d1
Configuration variables:
~~~~~~~~~~~~~~~~~~~~~~~~
------------------------
- **pin** (**Required**, :ref:`Pin Schema <config-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 </api/output/gpio-binary>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/output/gpio.rst>`__
.. disqus::

View File

@ -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::

View File

@ -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 <config-output>`.
See Also
^^^^^^^^
--------
- :doc:`/esphomeyaml/components/output/index`
- :doc:`/esphomeyaml/components/output/esp8266_pwm`
@ -38,3 +38,5 @@ See Also
- :doc:`API Reference </api/output/ledc>`
- `esp-idf LEDC API docs <https://esp-idf.readthedocs.io/en/latest/api-reference/peripherals/ledc.html>`__
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/output/ledc.rst>`__
.. disqus::

View File

@ -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 <config-output>`.
See Also
^^^^^^^^
--------
- :doc:`/esphomeyaml/components/pca9685`
- :doc:`/esphomeyaml/components/output/index`
@ -47,3 +47,5 @@ See Also
- :doc:`API Reference </api/output/pca9685>`
- `PCA9685 Arduino Library <https://github.com/NachtRaveVL/PCA9685-Arduino>`__ by `@NachtRaveVL <https://github.com/NachtRaveVL>`__
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/output/pca9685.rst>`__
.. disqus::

View File

@ -39,3 +39,5 @@ See Also
- :doc:`output/pca9685`
- :doc:`API Reference </api/output/pca9685>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/pca9685.rst>`__
.. disqus::

View File

@ -59,3 +59,5 @@ See Also
- `PCF8574 Arduino Library <https://github.com/skywodd/pcf8574_arduino_library>`__ by `Fabien Batteix <https://github.com/skywodd>`__
- :doc:`API Reference </api/misc/pcf8574>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/pcf8574.rst>`__
.. disqus::

View File

@ -60,3 +60,5 @@ See Also
- `PN532 Library <https://github.com/adafruit/Adafruit-PN532/blob/master/Adafruit_PN532.cpp>`__ by `Adafruit <https://www.adafruit.com/>`__
- :doc:`API Reference </api/binary_sensor/pn532>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/pn532.rst>`__
.. disqus::

View File

@ -66,3 +66,5 @@ See Also
- :doc:`output/index`
- :doc:`API Reference </api/core/power-supply>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/power_supply.rst>`__
.. disqus::

View File

@ -46,3 +46,5 @@ See Also
- `RDM6300 Arduino Library <https://github.com/arliones/RDM6300-Arduino>`__ by `Arliones Hoeller Jr <https://github.com/arliones>`__
- :doc:`API Reference </api/binary_sensor/rdm6300>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/rdm6300.rst>`__
.. disqus::

View File

@ -53,3 +53,5 @@ See Also
- `IRRemoteESP8266 <https://github.com/markszabo/IRremoteESP8266/>`__ by `Mark Szabo-Simon <https://github.com/markszabo>`__
- :doc:`API Reference </api/switch/remote_transmitter>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/remote_transmitter.rst>`__
.. disqus::

View File

@ -49,3 +49,5 @@ See Also
- `IRRemoteESP8266 <https://github.com/markszabo/IRremoteESP8266/>`__ by `Mark Szabo-Simon <https://github.com/markszabo>`__
- :doc:`API Reference </api/switch/remote_transmitter>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/remote_transmitter.rst>`__
.. disqus::

View File

@ -92,3 +92,5 @@ See Also
- :doc:`max6675`
- :doc:`API Reference </api/sensor/adc>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/sensor/adc.rst>`__
.. disqus::

View File

@ -74,3 +74,5 @@ See Also
- :doc:`API Reference </api/sensor/ads1115>`
- `i2cdevlib <https://github.com/jrowberg/i2cdevlib>`__ by `Jeff Rowberg <https://github.com/jrowberg>`__
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/sensor/ads1115.rst>`__
.. disqus::

View File

@ -51,3 +51,5 @@ See Also
- :doc:`API Reference </api/sensor/bh1750>`
- `BH1750 Library <https://github.com/claws/BH1750>`__ by `@claws <https://github.com/claws>`__
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/sensor/bh1750.rst>`__
.. disqus::

View File

@ -32,3 +32,5 @@ See Also
- :doc:`/esphomeyaml/components/sensor/index`
- :doc:`API Reference </api/misc/esp32_ble_tracker>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/sensor/esp32_ble_tracker.rst>`__
.. disqus::

View File

@ -90,3 +90,5 @@ See Also
- `Adafruit BME280 Library <https://github.com/adafruit/Adafruit_BME280_Library>`__ by `Adafruit <https://www.adafruit.com/>`__
- `Sparkfun BME280 Library <https://github.com/sparkfun/SparkFun_BME280_Arduino_Library>`__ by `Sparkfun <https://www.sparkfun.com/>`__
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/sensor/bme280.rst>`__
.. disqus::

Before

Width:  |  Height:  |  Size: 3.6 KiB

After

Width:  |  Height:  |  Size: 3.6 KiB

View File

@ -107,3 +107,5 @@ See Also
- :doc:`API Reference </api/sensor/bme680>`
- `BME680 Sensor API <https://github.com/BoschSensortec/BME680_driver>`__ by `Bosch Sensortec <https://www.bosch-sensortec.com/>`__
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/sensor/bme680.rst>`__
.. disqus::

Before

Width:  |  Height:  |  Size: 4.3 KiB

After

Width:  |  Height:  |  Size: 4.3 KiB

View File

@ -60,3 +60,5 @@ See Also
- :doc:`API Reference </api/sensor/bmp085>`
- `i2cdevlib <https://github.com/jrowberg/i2cdevlib>`__ by `Jeff Rowberg <https://github.com/jrowberg>`__
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/sensor/bmp085.rst>`__
.. disqus::

Before

Width:  |  Height:  |  Size: 2.3 KiB

After

Width:  |  Height:  |  Size: 2.3 KiB

View File

@ -86,3 +86,5 @@ See Also
- :doc:`API Reference </api/sensor/bmp280>`
- `BME280 Library <https://github.com/adafruit/Adafruit_BMP280_Library>`__ by `Adafruit <https://www.adafruit.com/>`__
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/sensor/bmp280.rst>`__
.. disqus::

Before

Width:  |  Height:  |  Size: 3.1 KiB

After

Width:  |  Height:  |  Size: 3.1 KiB

View File

@ -372,3 +372,5 @@ See Also
- `Full source code <https://github.com/OttoWinter/esphomelib/blob/master/examples/custom-bmp180-sensor/custom-bmp180-sensor.cpp>`__
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/sensor/custom.rst>`__
.. disqus::

View File

@ -106,3 +106,5 @@ See Also
- `Arduino DallasTemperature library <https://github.com/milesburton/Arduino-Temperature-Control-Library>`__ by `Miles Burton <https://github.com/milesburton>`__
- :doc:`API Reference </api/sensor/dallas>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/sensor/dallas.rst>`__
.. disqus::

View File

@ -79,3 +79,5 @@ See Also
- :doc:`API Reference </api/sensor/dht>`
- `Arduino DHTLib <https://playground.arduino.cc/Main/DHTLib>`__
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/sensor/dht.rst>`__
.. disqus::

View File

@ -57,3 +57,5 @@ See Also
- :doc:`API Reference </api/sensor/dht12>`
- `DHT12 Library <https://github.com/dplasa/dht>`__ by `Daniel Plasa <https://github.com/dplasa>`__
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/sensor/dht12.rst>`__
.. disqus::

View File

@ -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 <config-sensor>` and :ref:`MQTT Component <config-mqtt-component>`.
.. disqus::

View File

@ -48,3 +48,5 @@ See Also
- :doc:`/esphomeyaml/devices/esp32`
- :doc:`API Reference </api/sensor/esp32_hall>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/sensor/esp32_hall.rst>`__
.. disqus::

View File

@ -64,3 +64,5 @@ See Also
- :doc:`API Reference </api/sensor/hdc1080>`
- `HDC1080 Library <https://github.com/closedcube/ClosedCube_HDC1080_Arduino>`__ by `ClosedCube <https://www.tindie.com/stores/closedcube/>`__
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/sensor/hdc1080.rst>`__
.. disqus::

View File

@ -60,3 +60,5 @@ See Also
- :doc:`API Reference </api/sensor/hlw8012>`
- `HLW8012 Library <https://github.com/xoseperez/hlw8012>`__ by `Xose Pérez <https://github.com/xoseperez>`__
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/sensor/hlw8012.rst>`__
.. disqus::

View File

@ -51,3 +51,5 @@ See Also
- :doc:`API Reference </api/sensor/hmc5883l>`
- `HMC5883L Library <https://github.com/jarzebski/Arduino-HMC5883L>`__ by `Korneliusz Jarzębski <https://github.com/jarzebski>`__
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/sensor/hmc5883l.rst>`__
.. disqus::

View File

@ -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 </api/sensor/htu21d>`
- `i2cdevlib <https://github.com/jrowberg/i2cdevlib>`__ by `Jeff Rowberg <https://github.com/jrowberg>`__
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/sensor/htu21d.rst>`__
.. disqus::

View File

@ -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 <config-pin_schema>`): The DOUT (or DAT) pin.
@ -40,10 +40,12 @@ Configuration variables:
- All other options from :ref:`Sensor <config-sensor>` and :ref:`MQTT Component <config-mqtt-component>`.
See Also
^^^^^^^^
--------
- :ref:`sensor-filters`
- :doc:`adc`
- :doc:`API Reference </api/sensor/hx711>`
- `HX711 Library <https://github.com/bogde/HX711>`__ by `@bogde <https://github.com/bogde>`__
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/sensor/hx711.rst>`__
.. disqus::

View File

@ -68,3 +68,5 @@ See Also
- :doc:`API Reference </api/sensor/ina219>`
- `INA291 Arduino Library <https://github.com/adafruit/Adafruit_INA219>`__ by `Adafruit <https://www.adafruit.com/>`__
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/sensor/ina219.rst>`__
.. disqus::

View File

@ -79,3 +79,5 @@ See Also
- :doc:`API Reference </api/sensor/ina3221>`
- `INA3221 Arduino Library <https://github.com/switchdoclabs/SDL_Arduino_INA3221>`__ by `SwitchDoc Labs <https://github.com/switchdoclabs>`__
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/sensor/ina3221.rst>`__
.. disqus::

View File

@ -357,3 +357,5 @@ See Also
wifi_signal
xiaomi_miflora
xiaomi_mijia
.. disqus::

View File

@ -58,3 +58,5 @@ See Also
- `MAX6675 Library <https://github.com/adafruit/MAX6675-library>`__ by `Adafruit <https://www.adafruit.com/>`__
- :doc:`API Reference </api/sensor/max6675>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/sensor/max6675.rst>`__
.. disqus::

View File

@ -69,3 +69,5 @@ See Also
- `MH-Z19 library <https://github.com/nara256/mhz19_uart>`__ by `@nara356 <https://github.com/nara256>`__
- :doc:`API Reference </api/sensor/mhz19>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/sensor/mhz19.rst>`__
.. disqus::

View File

@ -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 </api/sensor/mpu6050>`
- `i2cdevlib <https://github.com/jrowberg/i2cdevlib>`__ by `Jeff Rowberg <https://github.com/jrowberg>`__
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/sensor/mpu6050.rst>`__
.. disqus::

View File

@ -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 <https://github.com/jarzebski/Arduino-MS5611>`__ by `Korneliusz Jarzębski <https://github.com/jarzebski>`__
- :doc:`API Reference </api/sensor/ms5611>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/sensor/ms5611.rst>`__
.. disqus::

View File

@ -72,3 +72,5 @@ See Also
- `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/current/esphomeyaml/components/sensor/pulse_counter.rst>`__
.. disqus::

View File

@ -76,3 +76,5 @@ See Also
- `Mechanical Input Library <https://github.com/jkDesignDE/MechInputs>`__ by `Jochen Krapf <https://github.com/JK-de>`__
- :doc:`API Reference </api/sensor/rotary_encoder>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/sensor/rotary_encoder.rst>`__
.. disqus::

View File

@ -55,3 +55,5 @@ See Also
- :doc:`htu21d`
- :doc:`API Reference </api/sensor/sht3xd>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/sensor/sht3xd.rst>`__
.. disqus::

View File

@ -70,3 +70,5 @@ See Also
- `TCS34725 library <https://github.com/adafruit/Adafruit_TCS34725>`__ by `Adafruit <https://www.adafruit.com/>`__
- :doc:`API Reference </api/sensor/tcs34725>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/sensor/tcs34725.rst>`__
.. disqus::

View File

@ -43,3 +43,5 @@ See Also
- :ref:`automation`
- :doc:`API Reference </api/sensor/template>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/sensor/template.rst>`__
.. disqus::

View File

@ -55,3 +55,5 @@ See Also
- `SparkFun TSL2561 Arduino Library <https://github.com/sparkfun/SparkFun_TSL2561_Arduino_Library>`__ by `Sparkfun <http://sparkfun.com/>`__
- :doc:`API Reference </api/sensor/tsl2561>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/sensor/tsl2561.rst>`__
.. disqus::

View File

@ -83,3 +83,5 @@ See Also
- :doc:`template`
- :doc:`API Reference </api/sensor/ultrasonic>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/sensor/ultrasonic.rst>`__
.. disqus::

View File

@ -25,3 +25,5 @@ See Also
- :ref:`sensor-filters`
- :doc:`API Reference </api/sensor/uptime>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/sensor/uptime.rst>`__
.. disqus::

View File

@ -40,3 +40,5 @@ See Also
- :doc:`/esphomeyaml/components/wifi`
- :doc:`API Reference </api/sensor/wifi_signal>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/sensor/wifi_signal.rst>`__
.. disqus::

View File

@ -97,3 +97,5 @@ See Also
- :doc:`API Reference </api/misc/esp32_ble_tracker>`
- `OpenMQTTGateway <https://github.com/1technophile/OpenMQTTGateway>`__ by `@1technophile <https://github.com/1technophile>`__
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/sensor/xiaomi_miflora.rst>`__
.. disqus::

View File

@ -88,3 +88,5 @@ See Also
- `Xiaomi Mijia BLE protocl <https://github.com/mspider65/Xiaomi-Mijia-Bluetooth-Temperature-and-Humidity-Sensor>`__ by `@mspider65 <https://github.com/mspider65>`__
- `OpenMQTTGateway <https://github.com/1technophile/OpenMQTTGateway>`__ by `@1technophile <https://github.com/1technophile>`__
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/sensor/xiaomi_mijia.rst>`__
.. disqus::

View File

@ -42,3 +42,5 @@ See Also
- :doc:`API Reference </api/core/spi>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/spi.rst>`__
.. disqus::

View File

@ -41,3 +41,5 @@ See Also
- :doc:`API Reference </api/misc/status_led>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/status_led.rst>`__
.. disqus::

Some files were not shown because too many files have changed in this diff Show More