Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2024-09-26 04:02:50 +02:00
Code Issues Projects Releases Wiki Activity

Replace table generator with custom RST directive (#75)

Browse Source
This commit is contained in:
Otto Winter 2018-11-09 20:06:56 +01:00 committed by GitHub
parent b716ba0a8d
commit f16b17aacd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
24 changed files with 389 additions and 1121 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
conf.py
View File

@ -43,11 +43,12 @@ sys.path.append(os.path.abspath('.'))
extensions = [
'breathe',
'disqus',
'github',
]
breathe_projects = {"esphomelib": "./_doxyxml/"}
breathe_default_project = "esphomelib"
breathe_domain_by_extension = {"h" : "cpp"}
breathe_domain_by_extension = {"h": "cpp"}
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

10
esphomeyaml/binary_sensor.csv
View File

@ -1,10 +0,0 @@
Binary Sensor Core, components/binary_sensor/index, folder-open.svg
GPIO, components/binary_sensor/gpio, pin.svg
Status, components/binary_sensor/status, server-network.svg
ESP32 BLE Device, components/binary_sensor/esp32_ble_tracker, bluetooth.svg
ESP32 Touch Pad, components/binary_sensor/esp32_touch, touch.svg
Nextion Touch, components/binary_sensor/nextion, nextion.jpg
Template Binary Sensor, components/binary_sensor/template, description.svg
Remote Receiver, components/binary_sensor/remote_receiver, remote.svg
PN532 Tag, components/binary_sensor/pn532, pn532.jpg
RDM6300 Tag, components/binary_sensor/rdm6300, rdm6300.jpg
1 Binary Sensor Core components/binary_sensor/index folder-open.svg
2 GPIO components/binary_sensor/gpio pin.svg
3 Status components/binary_sensor/status server-network.svg
4 ESP32 BLE Device components/binary_sensor/esp32_ble_tracker bluetooth.svg
5 ESP32 Touch Pad components/binary_sensor/esp32_touch touch.svg
6 Nextion Touch components/binary_sensor/nextion nextion.jpg
7 Template Binary Sensor components/binary_sensor/template description.svg
8 Remote Receiver components/binary_sensor/remote_receiver remote.svg
9 PN532 Tag components/binary_sensor/pn532 pn532.jpg
10 RDM6300 Tag components/binary_sensor/rdm6300 rdm6300.jpg

105
esphomeyaml/changelog/index.rst
View File

@ -1,34 +1,17 @@
Changelog - Version 1.9.0
=========================
================================================== ================================================== ==================================================
|Beta Releases|_ |Text Sensors|_ |MQTT Subscribe|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`Beta Releases`_ `Text Sensors`_ `MQTT Subscribe`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|Stepper|_ |CSE7766|_ |PMSX003|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`Stepper`_ `CSE7766`_ `PMSX003`_
================================================== ================================================== ==================================================
.. imgtable::
.. |Beta Releases| image:: /esphomeyaml/images/new-box.svg
:class: component-image
.. _Beta Releases: /esphomeyaml/guides/faq.html#how-do-i-update-to-the-latest-beta-release.html
.. |Text Sensors| image:: /esphomeyaml/images/folder-open.svg
:class: component-image
.. _Text Sensors: /esphomeyaml/components/text_sensor/index.html
.. |MQTT Subscribe| image:: /esphomeyaml/images/mqtt.png
:class: component-image
.. _MQTT Subscribe: /esphomeyaml/components/sensor/mqtt_subscribe.html
.. |Stepper| image:: /esphomeyaml/images/stepper.svg
:class: component-image
.. _Stepper: /esphomeyaml/components/stepper/index.html
.. |CSE7766| image:: /esphomeyaml/images/cse7766.svg
:class: component-image
.. _CSE7766: /esphomeyaml/components/sensor/cse7766.html
.. |PMSX003| image:: /esphomeyaml/images/pmsx003.svg
:class: component-image
.. _PMSX003: /esphomeyaml/components/sensor/pmsx003.html
Beta Releases, guides/faq.html#how-do-i-update-to-the-latest-beta-release, new-box.svg
Text Sensors, components/text_sensor/index, folder-open.svg
MQTT Subscribe, components/sensor/mqtt_subscribe, mqtt.png
Stepper, components/stepper/index, stepper.svg
CSE7766, components/sensor/cse7766, cse7766.svg
PMSX003, components/sensor/pmsx003, pmsx003.svg
esphomeflasher, guides/faq.html#i-can-t-get-flashing-over-usb-to-work, logo.svg
New Components
@ -36,20 +19,20 @@ New Components
- There's a new base component called :doc:`text sensors </esphomeyaml/components/text_sensor/index>` for using
text-based inputs, not just numbers like the generic :doc:`sensors </esphomeyaml/components/sensor/index>` did
(`#166 <https://github.com/OttoWinter/esphomeyaml/pull/166>`__, `#52 <https://github.com/OttoWinter/esphomedocs/pull/52>`__)
(:yamlpr:`166`, :docspr:`52`)
- The new MQTT Subscribe Sensors allow you to get external data into esphomelib's ecosystem via MQTT
(`#193 <https://github.com/OttoWinter/esphomelib/pull/193>`_, `#175 <https://github.com/OttoWinter/esphomeyaml/pull/175>`__,
`#50 <https://github.com/OttoWinter/esphomedocs/pull/50>`__)
(:libpr:`193`, :yamlpr:`175`, :docspr:`50`)
- Added :doc:`CSE7766 Power Sensor </esphomeyaml/components/sensor/cse7766>` to support power measurements
on the Sonoff Pow R2 (`#227 <https://github.com/OttoWinter/esphomelib/pull/227>`__, `#190 <https://github.com/OttoWinter/esphomeyaml/pull/190>`__, `#59 <https://github.com/OttoWinter/esphomedocs/pull/59>`__)
on the Sonoff Pow R2 (:libpr:`277`, :yamlpr:`190`, :docspr:`59`)
- Added the :doc:`PMSX003 Particulate Matter Sensor </esphomeyaml/components/sensor/pmsx003>`
(`#229 <https://github.com/OttoWinter/esphomelib/pull/229>`__, `#192 <https://github.com/OttoWinter/esphomeyaml/pull/192>`__, `#58 <https://github.com/OttoWinter/esphomedocs/pull/58>`__)
(:libpr:`229`, :yamlpr:`192`, :docspr:`58`)
- Added support for :doc:`A4988 Stepper Motors </esphomeyaml/components/stepper/index>` (`#239 <https://github.com/OttoWinter/esphomelib/pull/239>`__,
`#206 <https://github.com/OttoWinter/esphomeyaml/pull/206>`__, `#68 <https://github.com/OttoWinter/esphomedocs/pull/68>`__)
- Added support for :doc:`A4988 Stepper Motors </esphomeyaml/components/stepper/index>` (:libpr:`239`,
:yamlpr:`206`, :docspr:`68`)
New Features
------------
@ -57,57 +40,58 @@ New Features
- Compiling for ESP32s is now possible on RPis
- :doc:`GPIO Switches </esphomeyaml/components/switch/gpio>` now have a ``power_on_value`` option which will
initialize the state of the switch very early in the boot process. (`#207 <https://github.com/OttoWinter/esphomelib/pull/207>`__,
`#55 <https://github.com/OttoWinter/esphomedocs/pull/55>`__)
initialize the state of the switch very early in the boot process
(:libpr:`207`, :docspr:`55`).
- The :doc:`Over-the-Air Update </esphomeyaml/components/ota>` process was quite buggy sometimes and the Arduino-library
esphomelib used was doing some weird stuff. The OTA-process has now been completely re-written to be more stable
(`#204 <https://github.com/OttoWinter/esphomelib/pull/204>`__, `#177 <https://github.com/OttoWinter/esphomeyaml/pull/177>`__)
(:libpr:`204`, :yamlpr:`177`).
- Add support for the Home Assistant device registry. If you're using `Home Assistant 0.81.0 <https://www.home-assistant.io/blog/2018/10/26/release-81/>`__
or higher you will see a list of all components for each esphomelib node in the integrations screen (`#233 <https://github.com/OttoWinter/esphomelib/pull/233>`__).
or higher you will see a list of all components for each esphomelib node in the integrations screen
(:libpr:`233`).
- The current esphomelib version and compilation time are no printed on each boot
(`#189 <https://github.com/OttoWinter/esphomelib/pull/189>`__, `#159 <https://github.com/OttoWinter/esphomeyaml/pull/159>`__):
(:libpr:`189`, :yamlpr:`159`):
.. code:: bash
[13:57:33][I][application:092]: You're running esphomelib v1.9.0 compiled on Nov 3 2018, 13:55:11
- Stack traces in the USB logs are now automatically decoded to make debugging easier (`#214 <https://github.com/OttoWinter/esphomeyaml/pull/214>`__)
- Stack traces in the USB logs are now automatically decoded to make debugging easier
(:yamlpr:`214`)
- Added :ref:`mqtt-on_json_message` and :ref:`mqtt-publish_json_action` to make using JSON for MQTT payloads easier
(`#230 <https://github.com/OttoWinter/esphomelib/pull/230>`__, `#193 <https://github.com/OttoWinter/esphomeyaml/pull/193>`__,
`#60 <https://github.com/OttoWinter/esphomedocs/pull/60>`__)
(:libpr:`230`, :yamlpr:`193`, :docspr:`60`)
- The remote (IR) components have received support for Samsung's IR protocol (`#176 <https://github.com/OttoWinter/esphomeyaml/pull/176>`__,
`#48 <https://github.com/OttoWinter/esphomedocs/pull/48>`__)
- The remote (IR) components have received support for Samsung's IR protocol
(:yamlpr:`176`, :docspr:`48`)
- Added :ref:`component-update_action`, :ref:`logger-log_action` and :ref:`script-execute_action` for simplifying
automations (`#232 <https://github.com/OttoWinter/esphomelib/pull/232>`__, `#196 <https://github.com/OttoWinter/esphomeyaml/pull/196>`__,
`#198 <https://github.com/OttoWinter/esphomeyaml/pull/198>`__, `#61 <https://github.com/OttoWinter/esphomedocs/pull/61>`__,
`#63 <https://github.com/OttoWinter/esphomedocs/pull/63>`__)
automations
(:libpr:`232`, :yamlpr:`196`, :yamlpr:`198`, :docspr:`61`, :docspr:`63`)
- Added an :ref:`pn532-on_tag` to :doc:`PN532 NFC Readers </esphomeyaml/components/pn532>` so that automations
can directly use the NFC tag ID (`#194 <https://github.com/OttoWinter/esphomelib/pull/194>`__,
`#189 <https://github.com/OttoWinter/esphomeyaml/pull/189>`__, `#57 <https://github.com/OttoWinter/esphomedocs/pull/57>`__).
can directly use the NFC tag ID
(:libpr:`194`, :yamlpr:`189`, :doc:`57`)
- Added a ``hass-config`` command which generates a Home Assistant configuration for your esphomeyaml nodes.
Useful if you're not using MQTT discovery (`#208 <https://github.com/OttoWinter/esphomeyaml/pull/208>`__)
Useful if you're not using MQTT discovery (:yamlpr:`208`)
- All documentation pages now have comment systems powered by `disqus <https://disqus.com/>`__ (`#47 <https://github.com/OttoWinter/esphomedocs/pull/47>`__)
- All documentation pages now have comment systems powered by `disqus <https://disqus.com/>`__
(:docspr:`47`)
- You now have to option to have a different log level for log messages sent over MQTT (:ref:`docs <mqtt-message>`,
`#167 <https://github.com/OttoWinter/esphomeyaml/pull/167>`__, `#51 <https://github.com/OttoWinter/esphomedocs/pull/51>`__)
:yamlpr:`167`, :docspr:`51`)
- Added a color correction option to :doc:`FastLED addressable lights </esphomeyaml/components/light/fastled_clockless>`
(`#234 <https://github.com/OttoWinter/esphomelib/pull/234>`__, `#200 <https://github.com/OttoWinter/esphomeyaml/pull/200>`__,
`#64 <https://github.com/OttoWinter/esphomedocs/pull/64>`__)
(:libpr:`234`, :yamlpr:`200`, :docspr:`64`)
- Added a ``clean`` command to esphomeyaml to fix some occasional build errors (`#181 <https://github.com/OttoWinter/esphomeyaml/pull/181>`__)
- Added a ``clean`` command to esphomeyaml to fix some occasional build errors
(:yamlpr:`181`)
- Added a ``send_first_at`` option to sliding window moving average sensor filters (`#240 <https://github.com/OttoWinter/esphomelib/pull/240>`__,
`#207 <https://github.com/OttoWinter/esphomeyaml/pull/207>`__, `#69 <https://github.com/OttoWinter/esphomedocs/pull/69>`__)
- Added a ``send_first_at`` option to sliding window moving average sensor filters
(:libpr:`240`, :yamlpr:`207`, :docspr:`69`)
Breaking Changes
@ -116,16 +100,15 @@ Breaking Changes
- As part of the rewrite of Over-The-Air updates, the old OTA protocol is incompatible with the new one -
But fear not, esphomeyaml still supports the legacy OTA update process. On your first OTA upload with 1.9.0, you will
see esphomeyaml try with the new OTA method and fail. After that, esphomeyaml will fall back to the old OTA
process and upload correctly (`#204 <https://github.com/OttoWinter/esphomelib/pull/204>`__).
process and upload correctly (:libpr:`204`).
- esphomelib's naming convention has been made more consistent. If you're not using any :ref:`lambdas <config-lambda>`,
everything will still work. However, if you're using the C++ API, there are a couple of breaking changes:
For sensors and binary sensors, ``id(my_sensor).value`` has been deprecated and ``id(my_sensor).state`` should be used
instead. Additionally, the syntax for toggling lights and switches through C++ has been changed. Please see
the `esphomedocs (#62) <https://github.com/OttoWinter/esphomedocs/pull/62>`__ changeset for more information
(`#231 <https://github.com/OttoWinter/esphomelib/pull/231>`__, `#62 <https://github.com/OttoWinter/esphomedocs/pull/62>`__,
`#197 <https://github.com/OttoWinter/esphomeyaml/pull/197>`__)
the :doc:`62` changeset for more information
(:libpr:`231`, :docspr:`62`, :yamlpr:`197`)
- In 1.8.2, you might have noticed that the WiFi performance has been greatly improved. This was due to the new default of
the :ref:`power save mode <wifi-power_save_mode>` option: ``NONE``. However, that default made some other ESPs not

7
esphomeyaml/changelog/v1.7.0.csv
View File

@ -1,7 +0,0 @@
ESP32 BLE Beacon, components/esp32_ble_beacon, bluetooth.svg
Status LED, components/status_led, led-on.svg
WiFi Signal Strength, components/sensor/wifi_signal, network-wifi.svg
Duty Cycle Sensor, components/sensor/duty_cycle, percent.svg
Pulse Counter for ESP8266, components/sensor/pulse_counter, pulse.svg
Remote Transmitter, components/switch/remote_transmitter, remote.svg
Remote Receiver, components/remote_receiver, remote.svg
1 ESP32 BLE Beacon components/esp32_ble_beacon bluetooth.svg
2 Status LED components/status_led led-on.svg
3 WiFi Signal Strength components/sensor/wifi_signal network-wifi.svg
4 Duty Cycle Sensor components/sensor/duty_cycle percent.svg
5 Pulse Counter for ESP8266 components/sensor/pulse_counter pulse.svg
6 Remote Transmitter components/switch/remote_transmitter remote.svg
7 Remote Receiver components/remote_receiver remote.svg

44
esphomeyaml/changelog/v1.7.0.rst
View File

@ -12,41 +12,17 @@ Home Assistant.
In the next couple of weeks I unfortunately won't be able to "innovate" as quickly as in the previous weeks, as I will
be travelling a lot (and enjoying my vacation 😎), so don't expect too many awesome features 😸
================================================== ================================================== ==================================================
|ESP32 BLE Beacon|_ |Status LED|_ |WiFi Signal Strength|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`ESP32 BLE Beacon`_ `Status LED`_ `WiFi Signal Strength`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|Duty Cycle Sensor|_ |Pulse Counter for ESP8266|_ |Remote Transmitter|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`Duty Cycle Sensor`_ `Pulse Counter for ESP8266`_ `Remote Transmitter`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|Remote Receiver|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`Remote Receiver`_
================================================== ================================================== ==================================================
.. imgtable::
.. |ESP32 BLE Beacon| image:: /esphomeyaml/images/bluetooth.svg
:class: component-image
.. _ESP32 BLE Beacon: /esphomeyaml/components/esp32_ble_beacon.html
.. |Status LED| image:: /esphomeyaml/images/led-on.svg
:class: component-image
.. _Status LED: /esphomeyaml/components/status_led.html
.. |WiFi Signal Strength| image:: /esphomeyaml/images/network-wifi.svg
:class: component-image
.. _WiFi Signal Strength: /esphomeyaml/components/sensor/wifi_signal.html
.. |Duty Cycle Sensor| image:: /esphomeyaml/images/percent.svg
:class: component-image
.. _Duty Cycle Sensor: /esphomeyaml/components/sensor/duty_cycle.html
.. |Pulse Counter for ESP8266| image:: /esphomeyaml/images/pulse.svg
:class: component-image
.. _Pulse Counter for ESP8266: /esphomeyaml/components/sensor/pulse_counter.html
.. |Remote Transmitter| image:: /esphomeyaml/images/remote.svg
:class: component-image
.. _Remote Transmitter: /esphomeyaml/components/switch/remote_transmitter.html
.. |Remote Receiver| image:: /esphomeyaml/images/remote.svg
:class: component-image
.. _Remote Receiver: /esphomeyaml/components/binary_sensor/remote_receiver.html
ESP32 BLE Beacon, components/esp32_ble_beacon, bluetooth.svg
Status LED, components/status_led, led-on.svg
WiFi Signal Strength, components/sensor/wifi_signal, network-wifi.svg
Duty Cycle Sensor, components/sensor/duty_cycle, percent.svg
Pulse Counter for ESP8266, components/sensor/pulse_counter, pulse.svg
Remote Transmitter, components/switch/remote_transmitter, remote.svg
Remote Receiver, components/remote_receiver, remote.svg
New Components
**************

35
esphomeyaml/changelog/v1.8.0.csv
View File

@ -1,35 +0,0 @@
Waveshare E-Paper, components/display/waveshare_epaper, waveshare_epaper.jpg
Nextion, components/display/nextion, nextion.jpg
SSD1306, components/display/ssd1306_i2c, ssd1306.jpg
MAX7219, components/display/max7219, max7219.jpg
LCD Display, components/display/lcd_gpio, lcd.jpg
RCSwitch Integration, components/switch/remote_transmitter.html#rcswitch-remote-codes, remote.svg
SPI Bus, components/spi, spi.svg
UART Bus, components/uart, uart.svg
Real Time Clock, components/time, clock-outline.svg
Uptime Sensor, components/sensor/uptime, timer.svg
PN532, components/pn532, pn532.jpg
RDM6300, components/rdm6300, rdm6300.jpg
BLE RSSI, components/sensor/ble_rssi, bluetooth.svg
Xiaomi MiFlora, components/sensor/xiaomi_miflora, xiaomi_miflora.jpg
Xiaomi MiJia, components/sensor/xiaomi_mijia, xiaomi_mijia.jpg
HMC5883L, components/sensor/hmc5883l, hmc5883l.jpg
HX711, components/sensor/hx711, hx711.jpg
HLW8012, components/sensor/hlw8012, hlw8012.svg
BMP280, components/sensor/bmp280, bmp280.jpg
INA219, components/sensor/ina219, ina219.jpg
INA3221, components/sensor/ina3221, ina3221.jpg
MH-Z19, components/sensor/mhz19, mhz19.jpg
MS5611, components/sensor/ms5611, ms5611.jpg
TCS34725, components/sensor/tcs34725, tcs34725.jpg
RGBWW Light, components/light/rgbww, rgbw.png
Cold+Warm White Light, components/light/cwww, brightness-medium.svg
Light Effects, components/light/index#light-effects, creation.svg
1 Waveshare E-Paper components/display/waveshare_epaper waveshare_epaper.jpg
2 Nextion components/display/nextion nextion.jpg
3 SSD1306 components/display/ssd1306_i2c ssd1306.jpg
4 MAX7219 components/display/max7219 max7219.jpg
5 LCD Display components/display/lcd_gpio lcd.jpg
6 RCSwitch Integration components/switch/remote_transmitter.html#rcswitch-remote-codes remote.svg
7 SPI Bus components/spi spi.svg
8 UART Bus components/uart uart.svg
9 Real Time Clock components/time clock-outline.svg
10 Uptime Sensor components/sensor/uptime timer.svg
11 PN532 components/pn532 pn532.jpg
12 RDM6300 components/rdm6300 rdm6300.jpg
13 BLE RSSI components/sensor/ble_rssi bluetooth.svg
14 Xiaomi MiFlora components/sensor/xiaomi_miflora xiaomi_miflora.jpg
15 Xiaomi MiJia components/sensor/xiaomi_mijia xiaomi_mijia.jpg
16 HMC5883L components/sensor/hmc5883l hmc5883l.jpg
17 HX711 components/sensor/hx711 hx711.jpg
18 HLW8012 components/sensor/hlw8012 hlw8012.svg
19 BMP280 components/sensor/bmp280 bmp280.jpg
20 INA219 components/sensor/ina219 ina219.jpg
21 INA3221 components/sensor/ina3221 ina3221.jpg
22 MH-Z19 components/sensor/mhz19 mhz19.jpg
23 MS5611 components/sensor/ms5611 ms5611.jpg
24 TCS34725 components/sensor/tcs34725 tcs34725.jpg
25 RGBWW Light components/light/rgbww rgbw.png
26 Cold+Warm White Light components/light/cwww brightness-medium.svg
27 Light Effects components/light/index#light-effects creation.svg

154
esphomeyaml/changelog/v1.8.0.rst
View File

@ -1,125 +1,43 @@
Version 1.8.0
=============
================================================== ================================================== ==================================================
|Waveshare E-Paper|_ |Nextion|_ |SSD1306|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`Waveshare E-Paper`_ `Nextion`_ `SSD1306`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|MAX7219|_ |LCD Display|_ |RCSwitch Integration|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`MAX7219`_ `LCD Display`_ `RCSwitch Integration`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|SPI Bus|_ |UART Bus|_ |Real Time Clock|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`SPI Bus`_ `UART Bus`_ `Real Time Clock`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|Uptime Sensor|_ |PN532|_ |RDM6300|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`Uptime Sensor`_ `PN532`_ `RDM6300`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|BLE RSSI|_ |Xiaomi MiFlora|_ |Xiaomi MiJia|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`BLE RSSI`_ `Xiaomi MiFlora`_ `Xiaomi MiJia`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|HMC5883L|_ |HX711|_ |HLW8012|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`HMC5883L`_ `HX711`_ `HLW8012`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|BMP280|_ |INA219|_ |INA3221|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`BMP280`_ `INA219`_ `INA3221`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|MH-Z19|_ |MS5611|_ |TCS34725|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`MH-Z19`_ `MS5611`_ `TCS34725`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|RGBWW Light|_ |Cold+Warm White Light|_ |Light Effects|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`RGBWW Light`_ `Cold+Warm White Light`_ `Light Effects`_
================================================== ================================================== ==================================================
.. imgtable::
.. |Waveshare E-Paper| image:: /esphomeyaml/images/waveshare_epaper.jpg
:class: component-image
.. _Waveshare E-Paper: /esphomeyaml/components/display/waveshare_epaper.html
.. |Nextion| image:: /esphomeyaml/images/nextion.jpg
:class: component-image
.. _Nextion: /esphomeyaml/components/display/nextion.html
.. |SSD1306| image:: /esphomeyaml/images/ssd1306.jpg
:class: component-image
.. _SSD1306: /esphomeyaml/components/display/ssd1306_i2c.html
.. |MAX7219| image:: /esphomeyaml/images/max7219.jpg
:class: component-image
.. _MAX7219: /esphomeyaml/components/display/max7219.html
.. |LCD Display| image:: /esphomeyaml/images/lcd.jpg
:class: component-image
.. _LCD Display: /esphomeyaml/components/display/lcd_gpio.html
.. |RCSwitch Integration| image:: /esphomeyaml/images/remote.svg
:class: component-image
.. _RCSwitch Integration: /esphomeyaml/components/switch/remote_transmitter.html#rcswitch-remote-codes.html
.. |SPI Bus| image:: /esphomeyaml/images/spi.svg
:class: component-image
.. _SPI Bus: /esphomeyaml/components/spi.html
.. |UART Bus| image:: /esphomeyaml/images/uart.svg
:class: component-image
.. _UART Bus: /esphomeyaml/components/uart.html
.. |Real Time Clock| image:: /esphomeyaml/images/clock-outline.svg
:class: component-image
.. _Real Time Clock: /esphomeyaml/components/time.html
.. |Uptime Sensor| image:: /esphomeyaml/images/timer.svg
:class: component-image
.. _Uptime Sensor: /esphomeyaml/components/sensor/uptime.html
.. |PN532| image:: /esphomeyaml/images/pn532.jpg
:class: component-image
.. _PN532: /esphomeyaml/components/pn532.html
.. |RDM6300| image:: /esphomeyaml/images/rdm6300.jpg
:class: component-image
.. _RDM6300: /esphomeyaml/components/rdm6300.html
.. |BLE RSSI| image:: /esphomeyaml/images/bluetooth.svg
:class: component-image
.. _BLE RSSI: /esphomeyaml/components/sensor/ble_rssi.html
.. |Xiaomi MiFlora| image:: /esphomeyaml/images/xiaomi_miflora.jpg
:class: component-image
.. _Xiaomi MiFlora: /esphomeyaml/components/sensor/xiaomi_miflora.html
.. |Xiaomi MiJia| image:: /esphomeyaml/images/xiaomi_mijia.jpg
:class: component-image
.. _Xiaomi MiJia: /esphomeyaml/components/sensor/xiaomi_mijia.html
.. |HMC5883L| image:: /esphomeyaml/images/hmc5883l.jpg
:class: component-image
.. _HMC5883L: /esphomeyaml/components/sensor/hmc5883l.html
.. |HX711| image:: /esphomeyaml/images/hx711.jpg
:class: component-image
.. _HX711: /esphomeyaml/components/sensor/hx711.html
.. |HLW8012| image:: /esphomeyaml/images/hlw8012.svg
:class: component-image
.. _HLW8012: /esphomeyaml/components/sensor/hlw8012.html
.. |BMP280| image:: /esphomeyaml/images/bmp280.jpg
:class: component-image
.. _BMP280: /esphomeyaml/components/sensor/bmp280.html
.. |INA219| image:: /esphomeyaml/images/ina219.jpg
:class: component-image
.. _INA219: /esphomeyaml/components/sensor/ina219.html
.. |INA3221| image:: /esphomeyaml/images/ina3221.jpg
:class: component-image
.. _INA3221: /esphomeyaml/components/sensor/ina3221.html
.. |MH-Z19| image:: /esphomeyaml/images/mhz19.jpg
:class: component-image
.. _MH-Z19: /esphomeyaml/components/sensor/mhz19.html
.. |MS5611| image:: /esphomeyaml/images/ms5611.jpg
:class: component-image
.. _MS5611: /esphomeyaml/components/sensor/ms5611.html
.. |TCS34725| image:: /esphomeyaml/images/tcs34725.jpg
:class: component-image
.. _TCS34725: /esphomeyaml/components/sensor/tcs34725.html
.. |RGBWW Light| image:: /esphomeyaml/images/rgbw.png
:class: component-image
.. _RGBWW Light: /esphomeyaml/components/light/rgbww.html
.. |Cold+Warm White Light| image:: /esphomeyaml/images/brightness-medium.svg
:class: component-image
.. _Cold+Warm White Light: /esphomeyaml/components/light/cwww.html
.. |Light Effects| image:: /esphomeyaml/images/creation.svg
:class: component-image
.. _Light Effects: /esphomeyaml/components/light/index#light-effects.html
Waveshare E-Paper, components/display/waveshare_epaper, waveshare_epaper.jpg
Nextion, components/display/nextion, nextion.jpg
SSD1306, components/display/ssd1306_i2c, ssd1306.jpg
MAX7219, components/display/max7219, max7219.jpg
LCD Display, components/display/lcd_gpio, lcd.jpg
RCSwitch Integration, components/switch/remote_transmitter.html#rcswitch-remote-codes, remote.svg
SPI Bus, components/spi, spi.svg
UART Bus, components/uart, uart.svg
Real Time Clock, components/time, clock-outline.svg
Uptime Sensor, components/sensor/uptime, timer.svg
PN532, components/pn532, pn532.jpg
RDM6300, components/rdm6300, rdm6300.jpg
BLE RSSI, components/sensor/ble_rssi, bluetooth.svg
Xiaomi MiFlora, components/sensor/xiaomi_miflora, xiaomi_miflora.jpg
Xiaomi MiJia, components/sensor/xiaomi_mijia, xiaomi_mijia.jpg
HMC5883L, components/sensor/hmc5883l, hmc5883l.jpg
HX711, components/sensor/hx711, hx711.jpg
HLW8012, components/sensor/hlw8012, hlw8012.svg
BMP280, components/sensor/bmp280, bmp280.jpg
INA219, components/sensor/ina219, ina219.jpg
INA3221, components/sensor/ina3221, ina3221.jpg
MH-Z19, components/sensor/mhz19, mhz19.jpg
MS5611, components/sensor/ms5611, ms5611.jpg
TCS34725, components/sensor/tcs34725, tcs34725.jpg
RGBWW Light, components/light/rgbww, rgbw.png
Cold+Warm White Light, components/light/cwww, brightness-medium.svg
Light Effects, components/light/index#light-effects, creation.svg
Hi everyone,

7
esphomeyaml/changelog/v1.9.0.csv
View File

@ -1,7 +0,0 @@
Beta Releases, guides/faq.html#how-do-i-update-to-the-latest-beta-release, new-box.svg
Text Sensors, components/text_sensor/index, folder-open.svg
MQTT Subscribe, components/sensor/mqtt_subscribe, mqtt.png
Stepper, components/stepper/index, stepper.svg
CSE7766, components/sensor/cse7766, cse7766.svg
PMSX003, components/sensor/pmsx003, pmsx003.svg
1 Beta Releases guides/faq.html#how-do-i-update-to-the-latest-beta-release new-box.svg
2 Text Sensors components/text_sensor/index folder-open.svg
3 MQTT Subscribe components/sensor/mqtt_subscribe mqtt.png
4 Stepper components/stepper/index stepper.svg
5 CSE7766 components/sensor/cse7766 cse7766.svg
6 PMSX003 components/sensor/pmsx003 pmsx003.svg

8
esphomeyaml/cookbook.csv
View File

@ -1,8 +0,0 @@
Garage Door, cookbook/garage-door, window-open.svg
PIR Sensor, cookbook/pir, pir.jpg
Relay, cookbook/relay, relay.jpg
BRUH Multisensor, cookbook/bruh, bruh.png
TEMT6000, cookbook/temt6000, temt6000.jpg
Non-Invasive Power Meter, cookbook/power_meter, power_meter.jpg
Dual Relay Motor Cover, cookbook/dual-r2-cover, sonoff_dual_r2.jpg
Total Energy Per Day, cookbook/total_energy, sigma.svg
1 Garage Door cookbook/garage-door window-open.svg
2 PIR Sensor cookbook/pir pir.jpg
3 Relay cookbook/relay relay.jpg
4 BRUH Multisensor cookbook/bruh bruh.png
5 TEMT6000 cookbook/temt6000 temt6000.jpg
6 Non-Invasive Power Meter cookbook/power_meter power_meter.jpg
7 Dual Relay Motor Cover cookbook/dual-r2-cover sonoff_dual_r2.jpg
8 Total Energy Per Day cookbook/total_energy sigma.svg

11
esphomeyaml/core.csv
View File

@ -1,11 +0,0 @@
Core, components/esphomeyaml, cloud-circle.svg
WiFi, components/wifi, network-wifi.svg
MQTT, components/mqtt, mqtt.png
I²C Bus, components/i2c, i2c.svg
SPI Bus, components/spi, spi.svg
UART Bus, components/uart, uart.svg
OTA Updates, components/ota, system-update.svg
Logger, components/logger, file-document-box.svg
Web Server, components/web_server, http.svg
Power Supply, components/power_supply, power.svg
Deep Sleep, components/deep_sleep, hotel.svg
1 Core components/esphomeyaml cloud-circle.svg
2 WiFi components/wifi network-wifi.svg
3 MQTT components/mqtt mqtt.png
4 I²C Bus components/i2c i2c.svg
5 SPI Bus components/spi spi.svg
6 UART Bus components/uart uart.svg
7 OTA Updates components/ota system-update.svg
8 Logger components/logger file-document-box.svg
9 Web Server components/web_server http.svg
10 Power Supply components/power_supply power.svg
11 Deep Sleep components/deep_sleep hotel.svg

2
esphomeyaml/cover.csv
View File

@ -1,2 +0,0 @@
Cover Core, components/cover/index, folder-open.svg
Template Cover, components/cover/template, description.svg
1 Cover Core components/cover/index folder-open.svg
2 Template Cover components/cover/template description.svg

8
esphomeyaml/devices.csv
View File

@ -1,8 +0,0 @@
Generic ESP8266, devices/esp8266, esp8266.svg
Generic ESP32, devices/esp32, esp32.svg
NodeMCU ESP8266, devices/nodemcu_esp8266, nodemcu_esp8266.jpg
NodeMCU ESP32, devices/nodemcu_esp32, nodemcu_esp32.jpg
Sonoff S20, devices/sonoff_s20, sonoff_s20.jpg
Sonoff 4CH, devices/sonoff_4ch, sonoff_4ch.jpg
Generic Sonoff, devices/sonoff, sonoff.svg
Sonoff Basic, devices/sonoff_basic, sonoff_basic.jpg
1 Generic ESP8266 devices/esp8266 esp8266.svg
2 Generic ESP32 devices/esp32 esp32.svg
3 NodeMCU ESP8266 devices/nodemcu_esp8266 nodemcu_esp8266.jpg
4 NodeMCU ESP32 devices/nodemcu_esp32 nodemcu_esp32.jpg
5 Sonoff S20 devices/sonoff_s20 sonoff_s20.jpg
6 Sonoff 4CH devices/sonoff_4ch sonoff_4ch.jpg
7 Generic Sonoff devices/sonoff sonoff.svg
8 Sonoff Basic devices/sonoff_basic sonoff_basic.jpg

8
esphomeyaml/display.csv
View File

@ -1,8 +0,0 @@
Display Core, components/display/index, folder-open.svg
GPIO LCD, components/display/lcd_gpio, lcd.jpg
PCF8574 LCD, components/display/lcd_pcf8574, lcd.jpg
MAX7219, components/display/max7219, max7219.jpg
Nextion, components/display/nextion, nextion.jpg
SSD1306 I2C, components/display/ssd1306_i2c, ssd1306.jpg
SSD1306 SPI, components/display/ssd1306_spi, ssd1306.jpg
Waveshare E-Paper, components/display/waveshare_epaper, waveshare_epaper.jpg
1 Display Core components/display/index folder-open.svg
2 GPIO LCD components/display/lcd_gpio lcd.jpg
3 PCF8574 LCD components/display/lcd_pcf8574 lcd.jpg
4 MAX7219 components/display/max7219 max7219.jpg
5 Nextion components/display/nextion nextion.jpg
6 SSD1306 I2C components/display/ssd1306_i2c ssd1306.jpg
7 SSD1306 SPI components/display/ssd1306_spi ssd1306.jpg
8 Waveshare E-Paper components/display/waveshare_epaper waveshare_epaper.jpg

3
esphomeyaml/fan.csv
View File

@ -1,3 +0,0 @@
Fan Core, components/fan/index, folder-open.svg
Binary Fan, components/fan/binary, fan.svg
Speed Fan, components/fan/speed, fan.svg
1 Fan Core components/fan/index folder-open.svg
2 Binary Fan components/fan/binary fan.svg
3 Speed Fan components/fan/speed fan.svg

10
esphomeyaml/guides.csv
View File

@ -1,10 +0,0 @@
Getting Started through Command Line, guides/getting_started_command_line, console.svg
Getting Started through HassIO Add-On, guides/getting_started_hassio, home-assistant.svg
Configuration Types, guides/configuration-types, settings.svg
Migrating from Sonoff-Tasmota, guides/migrate_sonoff_tasmota, tasmota.svg
Migrating from ESPurna, guides/migrate_espurna, espurna.svg
Migrating from ESPEasy, guides/migrate_espeasy, espeasy.svg
Automations, guides/automations, auto-fix.svg
FAQ and Tips, guides/faq, question_answer.svg
Contributing, guides/contributing, github-circle.svg
Changelog, guides/changelog, new-box.svg
1 Getting Started through Command Line guides/getting_started_command_line console.svg
2 Getting Started through HassIO Add-On guides/getting_started_hassio home-assistant.svg
3 Configuration Types guides/configuration-types settings.svg
4 Migrating from Sonoff-Tasmota guides/migrate_sonoff_tasmota tasmota.svg
5 Migrating from ESPurna guides/migrate_espurna espurna.svg
6 Migrating from ESPEasy guides/migrate_espeasy espeasy.svg
7 Automations guides/automations auto-fix.svg
8 FAQ and Tips guides/faq question_answer.svg
9 Contributing guides/contributing github-circle.svg
10 Changelog guides/changelog new-box.svg

813
esphomeyaml/index.rst
View File

@ -37,55 +37,18 @@ Features
Guides
------
================================================== ================================================== ==================================================
|Getting Started through Command Line|_ |Getting Started through HassIO Add-On|_ |Configuration Types|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`Getting Started through Command Line`_ `Getting Started through HassIO Add-On`_ `Configuration Types`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|Migrating from Sonoff-Tasmota|_ |Migrating from ESPurna|_ |Migrating from ESPEasy|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`Migrating from Sonoff-Tasmota`_ `Migrating from ESPurna`_ `Migrating from ESPEasy`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|Automations|_ |FAQ and Tips|_ |Contributing|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`Automations`_ `FAQ and Tips`_ `Contributing`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|Changelog|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`Changelog`_
================================================== ================================================== ==================================================
.. |Getting Started through Command Line| image:: /esphomeyaml/images/console.svg
:class: component-image
.. _Getting Started through Command Line: /esphomeyaml/guides/getting_started_command_line.html
.. |Getting Started through HassIO Add-On| image:: /esphomeyaml/images/home-assistant.svg
:class: component-image
.. _Getting Started through HassIO Add-On: /esphomeyaml/guides/getting_started_hassio.html
.. |Configuration Types| image:: /esphomeyaml/images/settings.svg
:class: component-image
.. _Configuration Types: /esphomeyaml/guides/configuration-types.html
.. |Migrating from Sonoff-Tasmota| image:: /esphomeyaml/images/tasmota.svg
:class: component-image
.. _Migrating from Sonoff-Tasmota: /esphomeyaml/guides/migrate_sonoff_tasmota.html
.. |Migrating from ESPurna| image:: /esphomeyaml/images/espurna.svg
:class: component-image
.. _Migrating from ESPurna: /esphomeyaml/guides/migrate_espurna.html
.. |Migrating from ESPEasy| image:: /esphomeyaml/images/espeasy.svg
:class: component-image
.. _Migrating from ESPEasy: /esphomeyaml/guides/migrate_espeasy.html
.. |Automations| image:: /esphomeyaml/images/auto-fix.svg
:class: component-image
.. _Automations: /esphomeyaml/guides/automations.html
.. |FAQ and Tips| image:: /esphomeyaml/images/question_answer.svg
:class: component-image
.. _FAQ and Tips: /esphomeyaml/guides/faq.html
.. |Contributing| image:: /esphomeyaml/images/github-circle.svg
:class: component-image
.. _Contributing: /esphomeyaml/guides/contributing.html
.. |Changelog| image:: /esphomeyaml/images/new-box.svg
:class: component-image
.. _Changelog: /esphomeyaml/changelog/index.html
.. imgtable::
Getting Started through Command Line, guides/getting_started_command_line, console.svg
Getting Started through HassIO Add-On, guides/getting_started_hassio, home-assistant.svg
Configuration Types, guides/configuration-types, settings.svg
Migrating from Sonoff-Tasmota, guides/migrate_sonoff_tasmota, tasmota.svg
Migrating from ESPurna, guides/migrate_espurna, espurna.svg
Migrating from ESPEasy, guides/migrate_espeasy, espeasy.svg
Automations, guides/automations, auto-fix.svg
FAQ and Tips, guides/faq, question_answer.svg
Contributing, guides/contributing, github-circle.svg
Changelog, changelog/index, new-box.svg
.. _devices:
@ -96,285 +59,79 @@ This list contains a bunch of getting started and more advanced guides for using
Technically, all ESP8266/ESP32 devices (and therefore all Sonoff devices) are supported by esphomeyaml/lib.
These are only the devices for which I've had the time to set up dedicated guides.
================================================== ================================================== ==================================================
|Generic ESP8266|_ |Generic ESP32|_ |NodeMCU ESP8266|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`Generic ESP8266`_ `Generic ESP32`_ `NodeMCU ESP8266`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|NodeMCU ESP32|_ |Sonoff S20|_ |Sonoff 4CH|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`NodeMCU ESP32`_ `Sonoff S20`_ `Sonoff 4CH`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|Generic Sonoff|_ |Sonoff Basic|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`Generic Sonoff`_ `Sonoff Basic`_
================================================== ================================================== ==================================================
.. |Generic ESP8266| image:: /esphomeyaml/images/esp8266.svg
:class: component-image
.. _Generic ESP8266: /esphomeyaml/devices/esp8266.html
.. |Generic ESP32| image:: /esphomeyaml/images/esp32.svg
:class: component-image
.. _Generic ESP32: /esphomeyaml/devices/esp32.html
.. |NodeMCU ESP8266| image:: /esphomeyaml/images/nodemcu_esp8266.jpg
:class: component-image
.. _NodeMCU ESP8266: /esphomeyaml/devices/nodemcu_esp8266.html
.. |NodeMCU ESP32| image:: /esphomeyaml/images/nodemcu_esp32.jpg
:class: component-image
.. _NodeMCU ESP32: /esphomeyaml/devices/nodemcu_esp32.html
.. |Sonoff S20| image:: /esphomeyaml/images/sonoff_s20.jpg
:class: component-image
.. _Sonoff S20: /esphomeyaml/devices/sonoff_s20.html
.. |Sonoff 4CH| image:: /esphomeyaml/images/sonoff_4ch.jpg
:class: component-image
.. _Sonoff 4CH: /esphomeyaml/devices/sonoff_4ch.html
.. |Generic Sonoff| image:: /esphomeyaml/images/sonoff.svg
:class: component-image
.. _Generic Sonoff: /esphomeyaml/devices/sonoff.html
.. |Sonoff Basic| image:: /esphomeyaml/images/sonoff_basic.jpg
:class: component-image
.. _Sonoff Basic: /esphomeyaml/devices/sonoff_basic.html
.. imgtable::
Generic ESP8266, devices/esp8266, esp8266.svg
Generic ESP32, devices/esp32, esp32.svg
NodeMCU ESP8266, devices/nodemcu_esp8266, nodemcu_esp8266.jpg
NodeMCU ESP32, devices/nodemcu_esp32, nodemcu_esp32.jpg
Sonoff S20, devices/sonoff_s20, sonoff_s20.jpg
Sonoff 4CH, devices/sonoff_4ch, sonoff_4ch.jpg
Generic Sonoff, devices/sonoff, sonoff.svg
Sonoff Basic, devices/sonoff_basic, sonoff_basic.jpg
Core Components
---------------
================================================== ================================================== ==================================================
|Core|_ |WiFi|_ |MQTT|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`Core`_ `WiFi`_ `MQTT`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|I²C Bus|_ |SPI Bus|_ |UART Bus|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`I²C Bus`_ `SPI Bus`_ `UART Bus`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|OTA Updates|_ |Logger|_ |Web Server|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`OTA Updates`_ `Logger`_ `Web Server`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|Power Supply|_ |Deep Sleep|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`Power Supply`_ `Deep Sleep`_
================================================== ================================================== ==================================================
.. |Core| image:: /esphomeyaml/images/cloud-circle.svg
:class: component-image
.. _Core: /esphomeyaml/components/esphomeyaml.html
.. |WiFi| image:: /esphomeyaml/images/network-wifi.svg
:class: component-image
.. _WiFi: /esphomeyaml/components/wifi.html
.. |MQTT| image:: /esphomeyaml/images/mqtt.png
:class: component-image
.. _MQTT: /esphomeyaml/components/mqtt.html
.. |I²C Bus| image:: /esphomeyaml/images/i2c.svg
:class: component-image
.. _I²C Bus: /esphomeyaml/components/i2c.html
.. |SPI Bus| image:: /esphomeyaml/images/spi.svg
:class: component-image
.. _SPI Bus: /esphomeyaml/components/spi.html
.. |UART Bus| image:: /esphomeyaml/images/uart.svg
:class: component-image
.. _UART Bus: /esphomeyaml/components/uart.html
.. |OTA Updates| image:: /esphomeyaml/images/system-update.svg
:class: component-image
.. _OTA Updates: /esphomeyaml/components/ota.html
.. |Logger| image:: /esphomeyaml/images/file-document-box.svg
:class: component-image
.. _Logger: /esphomeyaml/components/logger.html
.. |Web Server| image:: /esphomeyaml/images/http.svg
:class: component-image
.. _Web Server: /esphomeyaml/components/web_server.html
.. |Power Supply| image:: /esphomeyaml/images/power.svg
:class: component-image
.. _Power Supply: /esphomeyaml/components/power_supply.html
.. |Deep Sleep| image:: /esphomeyaml/images/hotel.svg
:class: component-image
.. _Deep Sleep: /esphomeyaml/components/deep_sleep.html
.. imgtable::
Core, components/esphomeyaml, cloud-circle.svg
WiFi, components/wifi, network-wifi.svg
MQTT, components/mqtt, mqtt.png
I²C Bus, components/i2c, i2c.svg
SPI Bus, components/spi, spi.svg
UART Bus, components/uart, uart.svg
OTA Updates, components/ota, system-update.svg
Logger, components/logger, file-document-box.svg
Web Server, components/web_server, http.svg
Power Supply, components/power_supply, power.svg
Deep Sleep, components/deep_sleep, hotel.svg
Sensor Components
-----------------
================================================== ================================================== ==================================================
|Sensor Core|_ |ADC|_ |ADS1115|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`Sensor Core`_ `ADC`_ `ADS1115`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|BH1750|_ |BLE RSSI|_ |BME280|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`BH1750`_ `BLE RSSI`_ `BME280`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|BME680|_ |BMP085|_ |BMP280|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`BME680`_ `BMP085`_ `BMP280`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|CSE7766|_ |Dallas|_ |DHT|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`CSE7766`_ `Dallas`_ `DHT`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|DHT12|_ |Duty Cycle|_ |ESP32 Hall Sensor|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`DHT12`_ `Duty Cycle`_ `ESP32 Hall Sensor`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|HDC1080|_ |HLW8012|_ |HMC5883L|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`HDC1080`_ `HLW8012`_ `HMC5883L`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|HX711|_ |INA219|_ |INA3221|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`HX711`_ `INA219`_ `INA3221`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|HTU21D|_ |MAX6675|_ |MH-Z19|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`HTU21D`_ `MAX6675`_ `MH-Z19`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|MPU6050|_ |MQTT Subscribe|_ |MS5611|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`MPU6050`_ `MQTT Subscribe`_ `MS5611`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|PMSX003|_ |Pulse Counter|_ |Rotary Encoder|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`PMSX003`_ `Pulse Counter`_ `Rotary Encoder`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|SHT3X-D|_ |TCS34725|_ |Template Sensor|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`SHT3X-D`_ `TCS34725`_ `Template Sensor`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|TSL2561|_ |Ultrasonic Sensor|_ |Uptime Sensor|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`TSL2561`_ `Ultrasonic Sensor`_ `Uptime Sensor`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|WiFi Signal Strength|_ |Xiaomi MiFlora|_ |Xiaomi MiJia|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`WiFi Signal Strength`_ `Xiaomi MiFlora`_ `Xiaomi MiJia`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|Custom Sensor|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`Custom Sensor`_
================================================== ================================================== ==================================================
.. imgtable::
.. |Sensor Core| image:: /esphomeyaml/images/folder-open.svg
:class: component-image
.. _Sensor Core: /esphomeyaml/components/sensor/index.html
.. |ADC| image:: /esphomeyaml/images/flash.svg
:class: component-image
.. _ADC: /esphomeyaml/components/sensor/adc.html
.. |ADS1115| image:: /esphomeyaml/images/ads1115.jpg
:class: component-image
.. _ADS1115: /esphomeyaml/components/sensor/ads1115.html
.. |BH1750| image:: /esphomeyaml/images/bh1750.jpg
:class: component-image
.. _BH1750: /esphomeyaml/components/sensor/bh1750.html
.. |BLE RSSI| image:: /esphomeyaml/images/bluetooth.svg
:class: component-image
.. _BLE RSSI: /esphomeyaml/components/sensor/ble_rssi.html
.. |BME280| image:: /esphomeyaml/images/bme280.jpg
:class: component-image
.. _BME280: /esphomeyaml/components/sensor/bme280.html
.. |BME680| image:: /esphomeyaml/images/bme680.jpg
:class: component-image
.. _BME680: /esphomeyaml/components/sensor/bme680.html
.. |BMP085| image:: /esphomeyaml/images/bmp180.jpg
:class: component-image
.. _BMP085: /esphomeyaml/components/sensor/bmp085.html
.. |BMP280| image:: /esphomeyaml/images/bmp280.jpg
:class: component-image
.. _BMP280: /esphomeyaml/components/sensor/bmp280.html
.. |CSE7766| image:: /esphomeyaml/images/cse7766.svg
:class: component-image
.. _CSE7766: /esphomeyaml/components/sensor/cse7766.html
.. |Dallas| image:: /esphomeyaml/images/dallas.jpg
:class: component-image
.. _Dallas: /esphomeyaml/components/sensor/dallas.html
.. |DHT| image:: /esphomeyaml/images/dht.jpg
:class: component-image
.. _DHT: /esphomeyaml/components/sensor/dht.html
.. |DHT12| image:: /esphomeyaml/images/dht12.jpg
:class: component-image
.. _DHT12: /esphomeyaml/components/sensor/dht12.html
.. |Duty Cycle| image:: /esphomeyaml/images/percent.svg
:class: component-image
.. _Duty Cycle: /esphomeyaml/components/sensor/duty_cycle.html
.. |ESP32 Hall Sensor| image:: /esphomeyaml/images/magnet.svg
:class: component-image
.. _ESP32 Hall Sensor: /esphomeyaml/components/sensor/esp32_hall.html
.. |HDC1080| image:: /esphomeyaml/images/hdc1080.jpg
:class: component-image
.. _HDC1080: /esphomeyaml/components/sensor/hdc1080.html
.. |HLW8012| image:: /esphomeyaml/images/hlw8012.svg
:class: component-image
.. _HLW8012: /esphomeyaml/components/sensor/hlw8012.html
.. |HMC5883L| image:: /esphomeyaml/images/hmc5883l.jpg
:class: component-image
.. _HMC5883L: /esphomeyaml/components/sensor/hmc5883l.html
.. |HX711| image:: /esphomeyaml/images/hx711.jpg
:class: component-image
.. _HX711: /esphomeyaml/components/sensor/hx711.html
.. |INA219| image:: /esphomeyaml/images/ina219.jpg
:class: component-image
.. _INA219: /esphomeyaml/components/sensor/ina219.html
.. |INA3221| image:: /esphomeyaml/images/ina3221.jpg
:class: component-image
.. _INA3221: /esphomeyaml/components/sensor/ina3221.html
.. |HTU21D| image:: /esphomeyaml/images/htu21d.jpg
:class: component-image
.. _HTU21D: /esphomeyaml/components/sensor/htu21d.html
.. |MAX6675| image:: /esphomeyaml/images/max6675.jpg
:class: component-image
.. _MAX6675: /esphomeyaml/components/sensor/max6675.html
.. |MH-Z19| image:: /esphomeyaml/images/mhz19.jpg
:class: component-image
.. _MH-Z19: /esphomeyaml/components/sensor/mhz19.html
.. |MPU6050| image:: /esphomeyaml/images/mpu6050.jpg
:class: component-image
.. _MPU6050: /esphomeyaml/components/sensor/mpu6050.html
.. |MQTT Subscribe| image:: /esphomeyaml/images/mqtt.png
:class: component-image
.. _MQTT Subscribe: /esphomeyaml/components/sensor/mqtt_subscribe.html
.. |MS5611| image:: /esphomeyaml/images/ms5611.jpg
:class: component-image
.. _MS5611: /esphomeyaml/components/sensor/ms5611.html
.. |PMSX003| image:: /esphomeyaml/images/pmsx003.svg
:class: component-image
.. _PMSX003: /esphomeyaml/components/sensor/pmsx003.html
.. |Pulse Counter| image:: /esphomeyaml/images/pulse.svg
:class: component-image
.. _Pulse Counter: /esphomeyaml/components/sensor/pulse_counter.html
.. |Rotary Encoder| image:: /esphomeyaml/images/rotary_encoder.jpg
:class: component-image
.. _Rotary Encoder: /esphomeyaml/components/sensor/rotary_encoder.html
.. |SHT3X-D| image:: /esphomeyaml/images/sht3xd.jpg
:class: component-image
.. _SHT3X-D: /esphomeyaml/components/sensor/sht3xd.html
.. |TCS34725| image:: /esphomeyaml/images/tcs34725.jpg
:class: component-image
.. _TCS34725: /esphomeyaml/components/sensor/tcs34725.html
.. |Template Sensor| image:: /esphomeyaml/images/description.svg
:class: component-image
.. _Template Sensor: /esphomeyaml/components/sensor/template.html
.. |TSL2561| image:: /esphomeyaml/images/tsl2561.jpg
:class: component-image
.. _TSL2561: /esphomeyaml/components/sensor/tsl2561.html
.. |Ultrasonic Sensor| image:: /esphomeyaml/images/ultrasonic.jpg
:class: component-image
.. _Ultrasonic Sensor: /esphomeyaml/components/sensor/ultrasonic.html
.. |Uptime Sensor| image:: /esphomeyaml/images/timer.svg
:class: component-image
.. _Uptime Sensor: /esphomeyaml/components/sensor/uptime.html
.. |WiFi Signal Strength| image:: /esphomeyaml/images/network-wifi.svg
:class: component-image
.. _WiFi Signal Strength: /esphomeyaml/components/sensor/wifi_signal.html
.. |Xiaomi MiFlora| image:: /esphomeyaml/images/xiaomi_miflora.jpg
:class: component-image
.. _Xiaomi MiFlora: /esphomeyaml/components/sensor/xiaomi_miflora.html
.. |Xiaomi MiJia| image:: /esphomeyaml/images/xiaomi_mijia.jpg
:class: component-image
.. _Xiaomi MiJia: /esphomeyaml/components/sensor/xiaomi_mijia.html
.. |Custom Sensor| image:: /esphomeyaml/images/language-cpp.svg
:class: component-image
.. _Custom Sensor: /esphomeyaml/components/sensor/custom.html
Sensor Core, components/sensor/index, folder-open.svg
ADC, components/sensor/adc, flash.svg
ADS1115, components/sensor/ads1115, ads1115.jpg
BH1750, components/sensor/bh1750, bh1750.jpg
BLE RSSI, components/sensor/ble_rssi, bluetooth.svg
BME280, components/sensor/bme280, bme280.jpg
BME680, components/sensor/bme680, bme680.jpg
BMP085, components/sensor/bmp085, bmp180.jpg
BMP280, components/sensor/bmp280, bmp280.jpg
CSE7766, components/sensor/cse7766, cse7766.svg
Dallas, components/sensor/dallas, dallas.jpg
DHT, components/sensor/dht, dht.jpg
DHT12, components/sensor/dht12, dht12.jpg
Duty Cycle, components/sensor/duty_cycle, percent.svg
ESP32 Hall Sensor, components/sensor/esp32_hall, magnet.svg
HDC1080, components/sensor/hdc1080, hdc1080.jpg
HLW8012, components/sensor/hlw8012, hlw8012.svg
HMC5883L, components/sensor/hmc5883l, hmc5883l.jpg
HX711, components/sensor/hx711, hx711.jpg
INA219, components/sensor/ina219, ina219.jpg
INA3221, components/sensor/ina3221, ina3221.jpg
HTU21D, components/sensor/htu21d, htu21d.jpg
MAX6675, components/sensor/max6675, max6675.jpg
MH-Z19, components/sensor/mhz19, mhz19.jpg
MPU6050, components/sensor/mpu6050, mpu6050.jpg
MQTT Subscribe, components/sensor/mqtt_subscribe, mqtt.png
MS5611, components/sensor/ms5611, ms5611.jpg
PMSX003, components/sensor/pmsx003, pmsx003.svg
Pulse Counter, components/sensor/pulse_counter, pulse.svg
Rotary Encoder, components/sensor/rotary_encoder, rotary_encoder.jpg
SHT3X-D, components/sensor/sht3xd, sht3xd.jpg
TCS34725, components/sensor/tcs34725, tcs34725.jpg
Template Sensor, components/sensor/template, description.svg
TSL2561, components/sensor/tsl2561, tsl2561.jpg
Ultrasonic Sensor, components/sensor/ultrasonic, ultrasonic.jpg
Uptime Sensor, components/sensor/uptime, timer.svg
WiFi Signal Strength, components/sensor/wifi_signal, network-wifi.svg
Xiaomi MiFlora, components/sensor/xiaomi_miflora, xiaomi_miflora.jpg
Xiaomi MiJia, components/sensor/xiaomi_mijia, xiaomi_mijia.jpg
Custom Sensor, components/sensor/custom, language-cpp.svg
Looking for a sensor that outputs its values as an analog voltage? Have a look at the
:doc:`ADC Sensor <components/sensor/adc>` together with a formula like in the :doc:`TEMT6000
@ -384,131 +141,44 @@ example </esphomeyaml/cookbook/temt6000>`.
Binary Sensor Components
------------------------
================================================== ================================================== ==================================================
|Binary Sensor Core|_ |GPIO|_ |Status|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`Binary Sensor Core`_ `GPIO`_ `Status`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|ESP32 BLE Device|_ |ESP32 Touch Pad|_ |Nextion Touch|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`ESP32 BLE Device`_ `ESP32 Touch Pad`_ `Nextion Touch`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|Template Binary Sensor|_ |Remote Receiver|_ |PN532 Tag|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`Template Binary Sensor`_ `Remote Receiver`_ `PN532 Tag`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|RDM6300 Tag|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`RDM6300 Tag`_
================================================== ================================================== ==================================================
.. |Binary Sensor Core| image:: /esphomeyaml/images/folder-open.svg
:class: component-image
.. _Binary Sensor Core: /esphomeyaml/components/binary_sensor/index.html
.. |GPIO| image:: /esphomeyaml/images/pin.svg
:class: component-image
.. _GPIO: /esphomeyaml/components/binary_sensor/gpio.html
.. |Status| image:: /esphomeyaml/images/server-network.svg
:class: component-image
.. _Status: /esphomeyaml/components/binary_sensor/status.html
.. |ESP32 BLE Device| image:: /esphomeyaml/images/bluetooth.svg
:class: component-image
.. _ESP32 BLE Device: /esphomeyaml/components/binary_sensor/esp32_ble_tracker.html
.. |ESP32 Touch Pad| image:: /esphomeyaml/images/touch.svg
:class: component-image
.. _ESP32 Touch Pad: /esphomeyaml/components/binary_sensor/esp32_touch.html
.. |Nextion Touch| image:: /esphomeyaml/images/nextion.jpg
:class: component-image
.. _Nextion Touch: /esphomeyaml/components/binary_sensor/nextion.html
.. |Template Binary Sensor| image:: /esphomeyaml/images/description.svg
:class: component-image
.. _Template Binary Sensor: /esphomeyaml/components/binary_sensor/template.html
.. |Remote Receiver| image:: /esphomeyaml/images/remote.svg
:class: component-image
.. _Remote Receiver: /esphomeyaml/components/binary_sensor/remote_receiver.html
.. |PN532 Tag| image:: /esphomeyaml/images/pn532.jpg
:class: component-image
.. _PN532 Tag: /esphomeyaml/components/binary_sensor/pn532.html
.. |RDM6300 Tag| image:: /esphomeyaml/images/rdm6300.jpg
:class: component-image
.. _RDM6300 Tag: /esphomeyaml/components/binary_sensor/rdm6300.html
.. imgtable::
Binary Sensor Core, components/binary_sensor/index, folder-open.svg
GPIO, components/binary_sensor/gpio, pin.svg
Status, components/binary_sensor/status, server-network.svg
ESP32 BLE Device, components/binary_sensor/esp32_ble_tracker, bluetooth.svg
ESP32 Touch Pad, components/binary_sensor/esp32_touch, touch.svg
Nextion Touch, components/binary_sensor/nextion, nextion.jpg
Template Binary Sensor, components/binary_sensor/template, description.svg
Remote Receiver, components/binary_sensor/remote_receiver, remote.svg
PN532 Tag, components/binary_sensor/pn532, pn532.jpg
RDM6300 Tag, components/binary_sensor/rdm6300, rdm6300.jpg
Output Components
-----------------
============================== ============================== ==============================
|Output Core|_ |ESP8266 Software PWM|_ |GPIO Output|_
------------------------------ ------------------------------ ------------------------------
`Output Core`_ `ESP8266 Software PWM`_ `GPIO Output`_
------------------------------ ------------------------------ ------------------------------
|ESP32 LEDC|_ |PCA9685|_
------------------------------ ------------------------------ ------------------------------
`ESP32 LEDC`_ `PCA9685`_
============================== ============================== ==============================
.. |Output Core| image:: /esphomeyaml/images/folder-open.svg
:class: component-image
.. _Output Core: /esphomeyaml/components/output/index.html
.. |ESP8266 Software PWM| image:: /esphomeyaml/images/pwm.png
:class: component-image
.. _ESP8266 Software PWM: /esphomeyaml/components/output/esp8266_pwm.html
.. |GPIO Output| image:: /esphomeyaml/images/pin.svg
:class: component-image
.. _GPIO Output: /esphomeyaml/components/output/gpio.html
.. |ESP32 LEDC| image:: /esphomeyaml/images/pwm.png
:class: component-image
.. _ESP32 LEDC: /esphomeyaml/components/output/ledc.html
.. |PCA9685| image:: /esphomeyaml/images/pca9685.jpg
:class: component-image
.. _PCA9685: /esphomeyaml/components/output/pca9685.html
.. imgtable::
Output Core, components/output/index, folder-open.svg
ESP8266 Software PWM, components/output/esp8266_pwm, pwm.png
GPIO Output, components/output/gpio, pin.svg
ESP32 LEDC, components/output/ledc, pwm.png
PCA9685, components/output/pca9685, pca9685.jpg
Light Components
----------------
================================================== ================================================== ==================================================
|Light Core|_ |Binary Light|_ |Monochromatic Light|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`Light Core`_ `Binary Light`_ `Monochromatic Light`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|Cold+Warm White Light|_ |RGB Light|_ |RGBW Light|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`Cold+Warm White Light`_ `RGB Light`_ `RGBW Light`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|RGBWW Light|_ |FastLED Clockless Light|_ |FastLED SPI Light|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`RGBWW Light`_ `FastLED Clockless Light`_ `FastLED SPI Light`_
================================================== ================================================== ==================================================
.. |Light Core| image:: /esphomeyaml/images/folder-open.svg
:class: component-image
.. _Light Core: /esphomeyaml/components/light/index.html
.. |Binary Light| image:: /esphomeyaml/images/lightbulb.svg
:class: component-image
.. _Binary Light: /esphomeyaml/components/light/binary.html
.. |Monochromatic Light| image:: /esphomeyaml/images/brightness-medium.svg
:class: component-image
.. _Monochromatic Light: /esphomeyaml/components/light/monochromatic.html
.. |Cold+Warm White Light| image:: /esphomeyaml/images/brightness-medium.svg
:class: component-image
.. _Cold+Warm White Light: /esphomeyaml/components/light/cwww.html
.. |RGB Light| image:: /esphomeyaml/images/rgb.png
:class: component-image
.. _RGB Light: /esphomeyaml/components/light/rgb.html
.. |RGBW Light| image:: /esphomeyaml/images/rgbw.png
:class: component-image
.. _RGBW Light: /esphomeyaml/components/light/rgbw.html
.. |RGBWW Light| image:: /esphomeyaml/images/rgbw.png
:class: component-image
.. _RGBWW Light: /esphomeyaml/components/light/rgbww.html
.. |FastLED Clockless Light| image:: /esphomeyaml/images/color_lens.svg
:class: component-image
.. _FastLED Clockless Light: /esphomeyaml/components/light/fastled_clockless.html
.. |FastLED SPI Light| image:: /esphomeyaml/images/color_lens.svg
:class: component-image
.. _FastLED SPI Light: /esphomeyaml/components/light/fastled_spi.html
.. imgtable::
Light Core, components/light/index, folder-open.svg
Binary Light, components/light/binary, lightbulb.svg
Monochromatic Light, components/light/monochromatic, brightness-medium.svg
Cold+Warm White Light, components/light/cwww, brightness-medium.svg
RGB Light, components/light/rgb, rgb.png
RGBW Light, components/light/rgbw, rgbw.png
RGBWW Light, components/light/rgbww, rgbw.png
FastLED Clockless Light, components/light/fastled_clockless, color_lens.svg
FastLED SPI Light, components/light/fastled_spi, color_lens.svg
Looking for WS2811 and similar individually addressable lights? Have a look at the
:doc:`FastLED Clockless Light <components/light/fastled_clockless>`.
@ -516,222 +186,78 @@ Looking for WS2811 and similar individually addressable lights? Have a look at t
Switch Components
-----------------
================================================== ================================================== ==================================================
|Switch Core|_ |GPIO Switch|_ |Remote Transmitter|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`Switch Core`_ `GPIO Switch`_ `Remote Transmitter`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|Restart Switch|_ |Shutdown Switch|_ |Generic Output Switch|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`Restart Switch`_ `Shutdown Switch`_ `Generic Output Switch`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|Template Switch|_ |UART Switch|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`Template Switch`_ `UART Switch`_
================================================== ================================================== ==================================================
.. |Switch Core| image:: /esphomeyaml/images/folder-open.svg
:class: component-image
.. _Switch Core: /esphomeyaml/components/switch/index.html
.. |GPIO Switch| image:: /esphomeyaml/images/pin.svg
:class: component-image
.. _GPIO Switch: /esphomeyaml/components/switch/gpio.html
.. |Remote Transmitter| image:: /esphomeyaml/images/remote.svg
:class: component-image
.. _Remote Transmitter: /esphomeyaml/components/switch/remote_transmitter.html
.. |Restart Switch| image:: /esphomeyaml/images/restart.svg
:class: component-image
.. _Restart Switch: /esphomeyaml/components/switch/restart.html
.. |Shutdown Switch| image:: /esphomeyaml/images/power_settings.svg
:class: component-image
.. _Shutdown Switch: /esphomeyaml/components/switch/shutdown.html
.. |Generic Output Switch| image:: /esphomeyaml/images/upload.svg
:class: component-image
.. _Generic Output Switch: /esphomeyaml/components/switch/output.html
.. |Template Switch| image:: /esphomeyaml/images/description.svg
:class: component-image
.. _Template Switch: /esphomeyaml/components/switch/template.html
.. |UART Switch| image:: /esphomeyaml/images/uart.svg
:class: component-image
.. _UART Switch: /esphomeyaml/components/switch/uart.html
.. imgtable::
Switch Core, components/switch/index, folder-open.svg
GPIO Switch, components/switch/gpio, pin.svg
Remote Transmitter, components/switch/remote_transmitter, remote.svg
Restart Switch, components/switch/restart, restart.svg
Shutdown Switch, components/switch/shutdown, power_settings.svg
Generic Output Switch, components/switch/output, upload.svg
Template Switch, components/switch/template, description.svg
UART Switch, components/switch/uart, uart.svg
Fan Components
--------------
============================== ============================== ==============================
|Fan Core|_ |Binary Fan|_ |Speed Fan|_
------------------------------ ------------------------------ ------------------------------
`Fan Core`_ `Binary Fan`_ `Speed Fan`_
============================== ============================== ==============================
.. |Fan Core| image:: /esphomeyaml/images/folder-open.svg
:class: component-image
.. _Fan Core: /esphomeyaml/components/fan/index.html
.. |Binary Fan| image:: /esphomeyaml/images/fan.svg
:class: component-image
.. _Binary Fan: /esphomeyaml/components/fan/binary.html
.. |Speed Fan| image:: /esphomeyaml/images/fan.svg
:class: component-image
.. _Speed Fan: /esphomeyaml/components/fan/speed.html
.. imgtable::
Fan Core, components/fan/index, folder-open.svg
Binary Fan, components/fan/binary, fan.svg
Speed Fan, components/fan/speed, fan.svg
Display Components
------------------
================================================== ================================================== ==================================================
|Display Core|_ |GPIO LCD|_ |PCF8574 LCD|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`Display Core`_ `GPIO LCD`_ `PCF8574 LCD`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|MAX7219|_ |Nextion|_ |SSD1306 I2C|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`MAX7219`_ `Nextion`_ `SSD1306 I2C`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|SSD1306 SPI|_ |Waveshare E-Paper|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`SSD1306 SPI`_ `Waveshare E-Paper`_
================================================== ================================================== ==================================================
.. imgtable::
.. |Display Core| image:: /esphomeyaml/images/folder-open.svg
:class: component-image
.. _Display Core: /esphomeyaml/components/display/index.html
.. |GPIO LCD| image:: /esphomeyaml/images/lcd.jpg
:class: component-image
.. _GPIO LCD: /esphomeyaml/components/display/lcd_gpio.html
.. |PCF8574 LCD| image:: /esphomeyaml/images/lcd.jpg
:class: component-image
.. _PCF8574 LCD: /esphomeyaml/components/display/lcd_pcf8574.html
.. |MAX7219| image:: /esphomeyaml/images/max7219.jpg
:class: component-image
.. _MAX7219: /esphomeyaml/components/display/max7219.html
.. |Nextion| image:: /esphomeyaml/images/nextion.jpg
:class: component-image
.. _Nextion: /esphomeyaml/components/display/nextion.html
.. |SSD1306 I2C| image:: /esphomeyaml/images/ssd1306.jpg
:class: component-image
.. _SSD1306 I2C: /esphomeyaml/components/display/ssd1306_i2c.html
.. |SSD1306 SPI| image:: /esphomeyaml/images/ssd1306.jpg
:class: component-image
.. _SSD1306 SPI: /esphomeyaml/components/display/ssd1306_spi.html
.. |Waveshare E-Paper| image:: /esphomeyaml/images/waveshare_epaper.jpg
:class: component-image
.. _Waveshare E-Paper: /esphomeyaml/components/display/waveshare_epaper.html
Display Core, components/display/index, folder-open.svg
GPIO LCD, components/display/lcd_gpio, lcd.jpg
PCF8574 LCD, components/display/lcd_pcf8574, lcd.jpg
MAX7219, components/display/max7219, max7219.jpg
Nextion, components/display/nextion, nextion.jpg
SSD1306 I2C, components/display/ssd1306_i2c, ssd1306.jpg
SSD1306 SPI, components/display/ssd1306_spi, ssd1306.jpg
Waveshare E-Paper, components/display/waveshare_epaper, waveshare_epaper.jpg
Cover Components
----------------
============================== ============================== ==============================
|Cover Core|_ |Template Cover|_
------------------------------ ------------------------------ ------------------------------
`Cover Core`_ `Template Cover`_
============================== ============================== ==============================
.. imgtable::
.. |Cover Core| image:: /esphomeyaml/images/folder-open.svg
:class: component-image
.. _Cover Core: /esphomeyaml/components/cover/index.html
.. |Template Cover| image:: /esphomeyaml/images/description.svg
:class: component-image
.. _Template Cover: /esphomeyaml/components/cover/template.html
Cover Core, components/cover/index, folder-open.svg
Template Cover, components/cover/template, description.svg
Text Sensor Components
----------------------
================================================== ================================================== ==================================================
|Text Sensor Core|_ |MQTT Subscribe Text|_ |Version|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`Text Sensor Core`_ `MQTT Subscribe Text`_ `Version`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|Template Text Sensor|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`Template Text Sensor`_
================================================== ================================================== ==================================================
.. |Text Sensor Core| image:: /esphomeyaml/images/folder-open.svg
:class: component-image
.. _Text Sensor Core: /esphomeyaml/components/text_sensor/index.html
.. |MQTT Subscribe Text| image:: /esphomeyaml/images/mqtt.png
:class: component-image
.. _MQTT Subscribe Text: /esphomeyaml/components/text_sensor/mqtt_subscribe.html
.. |Version| image:: /esphomeyaml/images/new-box.svg
:class: component-image
.. _Version: /esphomeyaml/components/text_sensor/version.html
.. |Template Text Sensor| image:: /esphomeyaml/images/description.svg
:class: component-image
.. _Template Text Sensor: /esphomeyaml/components/text_sensor/template.html
.. imgtable::
Text Sensor Core, components/text_sensor/index, folder-open.svg
MQTT Subscribe Text, components/text_sensor/mqtt_subscribe, mqtt.png
Version, components/text_sensor/version, new-box.svg
Template Text Sensor, components/text_sensor/template, description.svg
Misc Components
---------------
================================================== ================================================== ==================================================
|Dallas Hub|_ |Remote Transmitter Hub|_ |Remote Receiver Hub|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`Dallas Hub`_ `Remote Transmitter Hub`_ `Remote Receiver Hub`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|PCA9685 Hub|_ |ADS1115 Hub|_ |Debug Component|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`PCA9685 Hub`_ `ADS1115 Hub`_ `Debug Component`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|PCF8574 I/O Expander|_ |ESP32 BLE Tracker|_ |ESP32 BLE Beacon|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`PCF8574 I/O Expander`_ `ESP32 BLE Tracker`_ `ESP32 BLE Beacon`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|ESP32 Touch Hub|_ |Status LED|_ |PN532|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`ESP32 Touch Hub`_ `Status LED`_ `PN532`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|RDM6300|_ |Time|_ |Stepper|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`RDM6300`_ `Time`_ `Stepper`_
================================================== ================================================== ==================================================
.. |Dallas Hub| image:: /esphomeyaml/images/dallas.jpg
:class: component-image
.. _Dallas Hub: /esphomeyaml/components/dallas.html
.. |Remote Transmitter Hub| image:: /esphomeyaml/images/remote.svg
:class: component-image
.. _Remote Transmitter Hub: /esphomeyaml/components/remote_transmitter.html
.. |Remote Receiver Hub| image:: /esphomeyaml/images/remote.svg
:class: component-image
.. _Remote Receiver Hub: /esphomeyaml/components/remote_receiver.html
.. |PCA9685 Hub| image:: /esphomeyaml/images/pca9685.jpg
:class: component-image
.. _PCA9685 Hub: /esphomeyaml/components/pca9685.html
.. |ADS1115 Hub| image:: /esphomeyaml/images/ads1115.jpg
:class: component-image
.. _ADS1115 Hub: /esphomeyaml/components/ads1115.html
.. |Debug Component| image:: /esphomeyaml/images/bug-report.svg
:class: component-image
.. _Debug Component: /esphomeyaml/components/debug.html
.. |PCF8574 I/O Expander| image:: /esphomeyaml/images/pcf8574.jpg
:class: component-image
.. _PCF8574 I/O Expander: /esphomeyaml/components/pcf8574.html
.. |ESP32 BLE Tracker| image:: /esphomeyaml/images/bluetooth.svg
:class: component-image
.. _ESP32 BLE Tracker: /esphomeyaml/components/esp32_ble_tracker.html
.. |ESP32 BLE Beacon| image:: /esphomeyaml/images/bluetooth.svg
:class: component-image
.. _ESP32 BLE Beacon: /esphomeyaml/components/esp32_ble_beacon.html
.. |ESP32 Touch Hub| image:: /esphomeyaml/images/touch.svg
:class: component-image
.. _ESP32 Touch Hub: /esphomeyaml/components/esp32_touch.html
.. |Status LED| image:: /esphomeyaml/images/led-on.svg
:class: component-image
.. _Status LED: /esphomeyaml/components/status_led.html
.. |PN532| image:: /esphomeyaml/images/pn532.jpg
:class: component-image
.. _PN532: /esphomeyaml/components/pn532.html
.. |RDM6300| image:: /esphomeyaml/images/rdm6300.jpg
:class: component-image
.. _RDM6300: /esphomeyaml/components/rdm6300.html
.. |Time| image:: /esphomeyaml/images/clock-outline.svg
:class: component-image
.. _Time: /esphomeyaml/components/time.html
.. |Stepper| image:: /esphomeyaml/images/stepper.svg
:class: component-image
.. _Stepper: /esphomeyaml/components/stepper.html
.. imgtable::
Dallas Hub, components/dallas, dallas.jpg
Remote Transmitter Hub, components/remote_transmitter, remote.svg
Remote Receiver Hub, components/remote_receiver, remote.svg
PCA9685 Hub, components/pca9685, pca9685.jpg
ADS1115 Hub, components/ads1115, ads1115.jpg
Debug Component, components/debug, bug-report.svg
PCF8574 I/O Expander, components/pcf8574, pcf8574.jpg
ESP32 BLE Tracker, components/esp32_ble_tracker, bluetooth.svg
ESP32 BLE Beacon, components/esp32_ble_beacon, bluetooth.svg
ESP32 Touch Hub, components/esp32_touch, touch.svg
Status LED, components/status_led, led-on.svg
PN532, components/pn532, pn532.jpg
RDM6300, components/rdm6300, rdm6300.jpg
Time, components/time, clock-outline.svg
Stepper, components/stepper/index, stepper.svg
.. _cookbook:
@ -740,45 +266,16 @@ Cookbook
This list contains items that are technically already supported by other components.
================================================== ================================================== ==================================================
|Garage Door|_ |PIR Sensor|_ |Relay|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`Garage Door`_ `PIR Sensor`_ `Relay`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|BRUH Multisensor|_ |TEMT6000|_ |Non-Invasive Power Meter|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`BRUH Multisensor`_ `TEMT6000`_ `Non-Invasive Power Meter`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|Dual Relay Motor Cover|_ |Total Energy Per Day|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`Dual Relay Motor Cover`_ `Total Energy Per Day`_
================================================== ================================================== ==================================================
.. |Garage Door| image:: /esphomeyaml/images/window-open.svg
:class: component-image
.. _Garage Door: /esphomeyaml/cookbook/garage-door.html
.. |PIR Sensor| image:: /esphomeyaml/images/pir.jpg
:class: component-image
.. _PIR Sensor: /esphomeyaml/cookbook/pir.html
.. |Relay| image:: /esphomeyaml/images/relay.jpg
:class: component-image
.. _Relay: /esphomeyaml/cookbook/relay.html
.. |BRUH Multisensor| image:: /esphomeyaml/images/bruh.png
:class: component-image
.. _BRUH Multisensor: /esphomeyaml/cookbook/bruh.html
.. |TEMT6000| image:: /esphomeyaml/images/temt6000.jpg
:class: component-image
.. _TEMT6000: /esphomeyaml/cookbook/temt6000.html
.. |Non-Invasive Power Meter| image:: /esphomeyaml/images/power_meter.jpg
:class: component-image
.. _Non-Invasive Power Meter: /esphomeyaml/cookbook/power_meter.html
.. |Dual Relay Motor Cover| image:: /esphomeyaml/images/sonoff_dual_r2.jpg
:class: component-image
.. _Dual Relay Motor Cover: /esphomeyaml/cookbook/dual-r2-cover.html
.. |Total Energy Per Day| image:: /esphomeyaml/images/sigma.svg
:class: component-image
.. _Total Energy Per Day: /esphomeyaml/cookbook/total_energy.html
.. imgtable::
Garage Door, cookbook/garage-door, window-open.svg
PIR Sensor, cookbook/pir, pir.jpg
Relay, cookbook/relay, relay.jpg
BRUH Multisensor, cookbook/bruh, bruh.png
TEMT6000, cookbook/temt6000, temt6000.jpg
Non-Invasive Power Meter, cookbook/power_meter, power_meter.jpg
Dual Relay Motor Cover, cookbook/dual-r2-cover, sonoff_dual_r2.jpg
Total Energy Per Day, cookbook/total_energy, sigma.svg
Do you have other awesome automations or 2nd order components? Please feel free to add them to the
documentation for others to copy. See :doc:`Contributing <guides/contributing>`.

9
esphomeyaml/light.csv
View File

@ -1,9 +0,0 @@
Light Core, components/light/index, folder-open.svg
Binary Light, components/light/binary, lightbulb.svg
Monochromatic Light, components/light/monochromatic, brightness-medium.svg
Cold+Warm White Light, components/light/cwww, brightness-medium.svg
RGB Light, components/light/rgb, rgb.png
RGBW Light, components/light/rgbw, rgbw.png
RGBWW Light, components/light/rgbww, rgbw.png
FastLED Clockless Light, components/light/fastled_clockless, color_lens.svg
FastLED SPI Light, components/light/fastled_spi, color_lens.svg
1 Light Core components/light/index folder-open.svg
2 Binary Light components/light/binary lightbulb.svg
3 Monochromatic Light components/light/monochromatic brightness-medium.svg
4 Cold+Warm White Light components/light/cwww brightness-medium.svg
5 RGB Light components/light/rgb rgb.png
6 RGBW Light components/light/rgbw rgbw.png
7 RGBWW Light components/light/rgbww rgbw.png
8 FastLED Clockless Light components/light/fastled_clockless color_lens.svg
9 FastLED SPI Light components/light/fastled_spi color_lens.svg

15
esphomeyaml/misc.csv
View File

@ -1,15 +0,0 @@
Dallas Hub, components/dallas, dallas.jpg
Remote Transmitter Hub, components/remote_transmitter, remote.svg
Remote Receiver Hub, components/remote_receiver, remote.svg
PCA9685 Hub, components/pca9685, pca9685.jpg
ADS1115 Hub, components/ads1115, ads1115.jpg
Debug Component, components/debug, bug-report.svg
PCF8574 I/O Expander, components/pcf8574, pcf8574.jpg
ESP32 BLE Tracker, components/esp32_ble_tracker, bluetooth.svg
ESP32 BLE Beacon, components/esp32_ble_beacon, bluetooth.svg
ESP32 Touch Hub, components/esp32_touch, touch.svg
Status LED, components/status_led, led-on.svg
PN532, components/pn532, pn532.jpg
RDM6300, components/rdm6300, rdm6300.jpg
Time, components/time, clock-outline.svg
Stepper, components/stepper/index, stepper.svg
1 Dallas Hub components/dallas dallas.jpg
2 Remote Transmitter Hub components/remote_transmitter remote.svg
3 Remote Receiver Hub components/remote_receiver remote.svg
4 PCA9685 Hub components/pca9685 pca9685.jpg
5 ADS1115 Hub components/ads1115 ads1115.jpg
6 Debug Component components/debug bug-report.svg
7 PCF8574 I/O Expander components/pcf8574 pcf8574.jpg
8 ESP32 BLE Tracker components/esp32_ble_tracker bluetooth.svg
9 ESP32 BLE Beacon components/esp32_ble_beacon bluetooth.svg
10 ESP32 Touch Hub components/esp32_touch touch.svg
11 Status LED components/status_led led-on.svg
12 PN532 components/pn532 pn532.jpg
13 RDM6300 components/rdm6300 rdm6300.jpg
14 Time components/time clock-outline.svg
15 Stepper components/stepper/index stepper.svg

5
esphomeyaml/output.csv
View File

@ -1,5 +0,0 @@
Output Core, components/output/index, folder-open.svg
ESP8266 Software PWM, components/output/esp8266_pwm, pwm.png
GPIO Output, components/output/gpio, pin.svg
ESP32 LEDC, components/output/ledc, pwm.png
PCA9685, components/output/pca9685, pca9685.jpg
1 Output Core components/output/index folder-open.svg
2 ESP8266 Software PWM components/output/esp8266_pwm pwm.png
3 GPIO Output components/output/gpio pin.svg
4 ESP32 LEDC components/output/ledc pwm.png
5 PCA9685 components/output/pca9685 pca9685.jpg

40
esphomeyaml/sensor.csv
View File

@ -1,40 +0,0 @@
Sensor Core, components/sensor/index, folder-open.svg
ADC, components/sensor/adc, flash.svg
ADS1115, components/sensor/ads1115, ads1115.jpg
BH1750, components/sensor/bh1750, bh1750.jpg
BLE RSSI, components/sensor/ble_rssi, bluetooth.svg
BME280, components/sensor/bme280, bme280.jpg
BME680, components/sensor/bme680, bme680.jpg
BMP085, components/sensor/bmp085, bmp180.jpg
BMP280, components/sensor/bmp280, bmp280.jpg
CSE7766, components/sensor/cse7766, cse7766.svg
Dallas, components/sensor/dallas, dallas.jpg
DHT, components/sensor/dht, dht.jpg
DHT12, components/sensor/dht12, dht12.jpg
Duty Cycle, components/sensor/duty_cycle, percent.svg
ESP32 Hall Sensor, components/sensor/esp32_hall, magnet.svg
HDC1080, components/sensor/hdc1080, hdc1080.jpg
HLW8012, components/sensor/hlw8012, hlw8012.svg
HMC5883L, components/sensor/hmc5883l, hmc5883l.jpg
HX711, components/sensor/hx711, hx711.jpg
INA219, components/sensor/ina219, ina219.jpg
INA3221, components/sensor/ina3221, ina3221.jpg
HTU21D, components/sensor/htu21d, htu21d.jpg
MAX6675, components/sensor/max6675, max6675.jpg
MH-Z19, components/sensor/mhz19, mhz19.jpg
MPU6050, components/sensor/mpu6050, mpu6050.jpg
MQTT Subscribe, components/sensor/mqtt_subscribe, mqtt.png
MS5611, components/sensor/ms5611, ms5611.jpg
PMSX003, components/sensor/pmsx003, pmsx003.svg
Pulse Counter, components/sensor/pulse_counter, pulse.svg
Rotary Encoder, components/sensor/rotary_encoder, rotary_encoder.jpg
SHT3X-D, components/sensor/sht3xd, sht3xd.jpg
TCS34725, components/sensor/tcs34725, tcs34725.jpg
Template Sensor, components/sensor/template, description.svg
TSL2561, components/sensor/tsl2561, tsl2561.jpg
Ultrasonic Sensor, components/sensor/ultrasonic, ultrasonic.jpg
Uptime Sensor, components/sensor/uptime, timer.svg
WiFi Signal Strength, components/sensor/wifi_signal, network-wifi.svg
Xiaomi MiFlora, components/sensor/xiaomi_miflora, xiaomi_miflora.jpg
Xiaomi MiJia, components/sensor/xiaomi_mijia, xiaomi_mijia.jpg
Custom Sensor, components/sensor/custom, language-cpp.svg
1 Sensor Core components/sensor/index folder-open.svg
2 ADC components/sensor/adc flash.svg
3 ADS1115 components/sensor/ads1115 ads1115.jpg
4 BH1750 components/sensor/bh1750 bh1750.jpg
5 BLE RSSI components/sensor/ble_rssi bluetooth.svg
6 BME280 components/sensor/bme280 bme280.jpg
7 BME680 components/sensor/bme680 bme680.jpg
8 BMP085 components/sensor/bmp085 bmp180.jpg
9 BMP280 components/sensor/bmp280 bmp280.jpg
10 CSE7766 components/sensor/cse7766 cse7766.svg
11 Dallas components/sensor/dallas dallas.jpg
12 DHT components/sensor/dht dht.jpg
13 DHT12 components/sensor/dht12 dht12.jpg
14 Duty Cycle components/sensor/duty_cycle percent.svg
15 ESP32 Hall Sensor components/sensor/esp32_hall magnet.svg
16 HDC1080 components/sensor/hdc1080 hdc1080.jpg
17 HLW8012 components/sensor/hlw8012 hlw8012.svg
18 HMC5883L components/sensor/hmc5883l hmc5883l.jpg
19 HX711 components/sensor/hx711 hx711.jpg
20 INA219 components/sensor/ina219 ina219.jpg
21 INA3221 components/sensor/ina3221 ina3221.jpg
22 HTU21D components/sensor/htu21d htu21d.jpg
23 MAX6675 components/sensor/max6675 max6675.jpg
24 MH-Z19 components/sensor/mhz19 mhz19.jpg
25 MPU6050 components/sensor/mpu6050 mpu6050.jpg
26 MQTT Subscribe components/sensor/mqtt_subscribe mqtt.png
27 MS5611 components/sensor/ms5611 ms5611.jpg
28 PMSX003 components/sensor/pmsx003 pmsx003.svg
29 Pulse Counter components/sensor/pulse_counter pulse.svg
30 Rotary Encoder components/sensor/rotary_encoder rotary_encoder.jpg
31 SHT3X-D components/sensor/sht3xd sht3xd.jpg
32 TCS34725 components/sensor/tcs34725 tcs34725.jpg
33 Template Sensor components/sensor/template description.svg
34 TSL2561 components/sensor/tsl2561 tsl2561.jpg
35 Ultrasonic Sensor components/sensor/ultrasonic ultrasonic.jpg
36 Uptime Sensor components/sensor/uptime timer.svg
37 WiFi Signal Strength components/sensor/wifi_signal network-wifi.svg
38 Xiaomi MiFlora components/sensor/xiaomi_miflora xiaomi_miflora.jpg
39 Xiaomi MiJia components/sensor/xiaomi_mijia xiaomi_mijia.jpg
40 Custom Sensor components/sensor/custom language-cpp.svg

8
esphomeyaml/switch.csv
View File

@ -1,8 +0,0 @@
Switch Core, components/switch/index, folder-open.svg
GPIO Switch, components/switch/gpio, pin.svg
Remote Transmitter, components/switch/remote_transmitter, remote.svg
Restart Switch, components/switch/restart, restart.svg
Shutdown Switch, components/switch/shutdown, power_settings.svg
Generic Output Switch, components/switch/output, upload.svg
Template Switch, components/switch/template, description.svg
UART Switch, components/switch/uart, uart.svg
1 Switch Core components/switch/index folder-open.svg
2 GPIO Switch components/switch/gpio pin.svg
3 Remote Transmitter components/switch/remote_transmitter remote.svg
4 Restart Switch components/switch/restart restart.svg
5 Shutdown Switch components/switch/shutdown power_settings.svg
6 Generic Output Switch components/switch/output upload.svg
7 Template Switch components/switch/template description.svg
8 UART Switch components/switch/uart uart.svg

4
esphomeyaml/text_sensor.csv
View File

@ -1,4 +0,0 @@
Text Sensor Core, components/text_sensor/index, folder-open.svg
MQTT Subscribe Text, components/text_sensor/mqtt_subscribe, mqtt.png
Version, components/text_sensor/version, new-box.svg
Template Text Sensor, components/text_sensor/template, description.svg
1 Text Sensor Core components/text_sensor/index folder-open.svg
2 MQTT Subscribe Text components/text_sensor/mqtt_subscribe mqtt.png
3 Version components/text_sensor/version new-box.svg
4 Template Text Sensor components/text_sensor/template description.svg

142
github.py Normal file
View File

@ -0,0 +1,142 @@
import csv
from itertools import zip_longest
from docutils import nodes, utils
from docutils.parsers.rst import directives, states
from docutils.parsers.rst.directives.tables import Table
from sphinx.util.nodes import make_refnode
def libpr_role(name, rawtext, text, lineno, inliner, options=None,
content=None):
ref = 'https://github.com/OttoWinter/esphomelib/pull/{}'.format(text)
return [make_link_node(rawtext, 'lib#{}'.format(text), ref, options)], []
def yamlpr_role(name, rawtext, text, lineno, inliner, options=None,
content=None):
ref = 'https://github.com/OttoWinter/esphomeyaml/pull/{}'.format(text)
return [make_link_node(rawtext, 'yaml#{}'.format(text), ref, options)], []
def docspr_role(name, rawtext, text, lineno, inliner, options=None,
content=None):
ref = 'https://github.com/OttoWinter/esphomedocs/pull/{}'.format(text)
return [make_link_node(rawtext, 'docs#{}'.format(text), ref, options)], []
def ghuser_role(name, rawtext, text, lineno, inliner, options=None,
content=None):
ref = 'https://github.com/{}'.format(text)
return [make_link_node(rawtext, '@{}'.format(text), ref, options)], []
def make_link_node(rawtext, text, ref, options=None):
options = options or {}
node = nodes.reference(rawtext,
utils.unescape(text),
refuri=ref,
**options)
return node
# https://stackoverflow.com/a/3415150/8924614
def grouper(n, iterable, fillvalue=None):
"""grouper(3, 'ABCDEFG', 'x') --> ABC DEF Gxx"""
args = [iter(iterable)] * n
return zip_longest(fillvalue=fillvalue, *args)
# Based on https://www.slideshare.net/doughellmann/better-documentation-through-automation-creating-docutils-sphinx-extensions
class ImageTableDirective(Table):
option_spec = {}
def run(self):
env = self.state.document.settings.env
items = []
data = list(csv.reader(self.content))
for row in data:
if not row:
continue
name, page, image = row
link = page.strip()
if not link.startswith('http'):
link = '/esphomeyaml/{}'.format(link)
if '.html' not in link:
link += '.html'
items.append({
'name': name.strip(),
'link': link,
'image': '/esphomeyaml/images/{}'.format(image.strip()),
})
col_widths = self.get_column_widths(3)
title, messages = self.make_title()
table = nodes.table()
# Set up column specifications based on widths
tgroup = nodes.tgroup(cols=3)
table += tgroup
tgroup.extend(
nodes.colspec(colwidth=col_width)
for col_width in col_widths
)
tbody = nodes.tbody()
tgroup += tbody
rows = []
for value in grouper(3, items):
trow = nodes.row()
for cell in value:
entry = nodes.entry()
if cell is None:
entry += nodes.paragraph()
trow += entry
continue
name = cell['name']
link = cell['link']
image = cell['image']
reference_node = nodes.reference(refuri=link)
img = nodes.image(uri=directives.uri(image))
img['classes'].append('component-image')
reference_node += img
para = nodes.paragraph()
para += reference_node
entry += para
trow += entry
rows.append(trow)
trow = nodes.row()
for cell in value:
entry = nodes.entry()
if cell is None:
entry += nodes.paragraph()
trow += entry
continue
name = cell['name']
link = cell['link']
ref = nodes.reference(name, name, refuri=link)
para = nodes.paragraph()
para += ref
entry += para
trow += entry
rows.append(trow)
tbody.extend(rows)
table['classes'] += []
self.add_name(table)
if title:
table.insert(0, title)
return [table] + messages
def setup(app):
app.add_role('libpr', libpr_role)
app.add_role('yamlpr', yamlpr_role)
app.add_role('docspr', docspr_role)
app.add_role('ghuser', ghuser_role)
app.add_directive('imgtable', ImageTableDirective)

59
table-generator.py
View File

@ -1,59 +0,0 @@
import csv
import sys
from itertools import zip_longest
items = []
data = list(csv.reader(open(sys.argv[1], 'r')))
for row in data:
if not row:
continue
name, page, image = row
items.append({
'name': name.strip(),
'link': '/esphomeyaml/{}.html'.format(page.strip()),
'image': '/esphomeyaml/images/{}'.format(image.strip()),
})
TABLE_ITEM_LENGTH = 50
TABLE_COLUMNS = 3
def create_row_str(type):
return ' '.join([(type * TABLE_ITEM_LENGTH) for _ in range(TABLE_COLUMNS)])
# https://stackoverflow.com/a/3415150/8924614
def grouper(n, iterable, fillvalue=None):
"""grouper(3, 'ABCDEFG', 'x') --> ABC DEF Gxx"""
args = [iter(iterable)] * n
return zip_longest(fillvalue=fillvalue, *args)
print(create_row_str('='))
prev_row = False
for value in grouper(TABLE_COLUMNS, items):
row1 = []
row2 = []
for x in value:
if x is None:
continue
row1.append('|{}|_'.format(x['name']).ljust(TABLE_ITEM_LENGTH))
row2.append('`{}`_'.format(x['name']).ljust(TABLE_ITEM_LENGTH))
if prev_row:
print(create_row_str('-'))
prev_row = True
print(' '.join(row1).rstrip())
print(create_row_str('-'))
print(' '.join(row2).rstrip())
print(create_row_str('='))
print()
for item in items:
print('.. |{}| image:: {}'.format(item['name'], item['image']))
print(' :class: component-image')
print('.. _{}: {}'.format(item['name'], item['link']))
print()