mirror of
https://github.com/esphome/esphome-docs.git
synced 2025-01-22 21:41:39 +01:00
SEO Optimization (#82)
This commit is contained in:
Otto Winter
GitHub
parent
1d8147aa72
commit
f2102ff9e8
@ -39,6 +39,7 @@ deploy-release:
|
||||
TARGET_REPO: OttoWinter/esphomedocs
|
||||
PRIVATE_KEY: ${GITHUB_PRIVATE_KEY}
|
||||
CNAME: esphomelib.com
|
||||
BASE_URL: https://esphomelib.com
|
||||
only:
|
||||
- current
|
||||
|
||||
@ -48,5 +49,6 @@ deploy-beta:
|
||||
TARGET_REPO: OttoWinter/esphomedocs-beta
|
||||
PRIVATE_KEY: ${GITHUB_BETA_PRIVATE_KEY}
|
||||
CNAME: beta.esphomelib.com
|
||||
BASE_URL: https://beta.esphomelib.com
|
||||
only:
|
||||
- rc
|
||||
|
||||
BIN
_static/changelog-1.9.0.png
Normal file
BIN
_static/changelog-1.9.0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 49 KiB |
2
conf.py
2
conf.py
@ -44,6 +44,7 @@ extensions = [
|
||||
'breathe',
|
||||
'disqus',
|
||||
'github',
|
||||
'seo',
|
||||
]
|
||||
|
||||
breathe_projects = {"esphomelib": "./_doxyxml/"}
|
||||
@ -207,3 +208,4 @@ texinfo_documents = [
|
||||
author, 'esphomelib', 'One line description of project.',
|
||||
'Miscellaneous'),
|
||||
]
|
||||
html_baseurl = os.getenv('BASE_URL', 'https://esphomelib.com')
|
||||
|
||||
@ -1,6 +1,12 @@
|
||||
Changelog - Version 1.9.0
|
||||
=========================
|
||||
|
||||
.. seo::
|
||||
:description: Changelog for esphomelib version 1.9.0.
|
||||
:image: /_static/_changelog-1.9.0.png
|
||||
:author: Otto Winter
|
||||
:author_twitter: @OttoWinter_
|
||||
|
||||
.. imgtable::
|
||||
|
||||
Beta Releases, guides/faq.html#how-do-i-update-to-the-latest-beta-release, new-box.svg
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
Version 1.7.0
|
||||
=============
|
||||
|
||||
.. seo::
|
||||
:description: Changelog for esphomelib version 1.7.0.
|
||||
:author: Otto Winter
|
||||
:author_twitter: @OttoWinter_
|
||||
|
||||
Wow, what a week! As you may know, I wrote a blog post on the `Home Assistant web site <https://www.home-assistant.io/blog/2018/06/05/esphomelib/>`__
|
||||
and since then, the amount of esphomelib users has grown sixfold according to the number of GitHub clones!
|
||||
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
Version 1.8.0
|
||||
=============
|
||||
|
||||
.. seo::
|
||||
:description: Changelog for esphomelib version 1.8.0.
|
||||
:author: Otto Winter
|
||||
:author_twitter: @OttoWinter_
|
||||
|
||||
.. imgtable::
|
||||
|
||||
Waveshare E-Paper, components/display/waveshare_epaper, waveshare_epaper.jpg
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
ADS1115 Hub
|
||||
===========
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up ADS1115 analog voltage multiplexer hubs.
|
||||
:image: ads1115.jpg
|
||||
:keywords: ADS1115
|
||||
|
||||
The ``ads1115`` domain creates a global hub so that you can later create
|
||||
individual sensors using the :doc:`ADS1115 Sensor Platform </esphomeyaml/components/sensor/ads1115>`.
|
||||
To use this hub, first setup the :ref:`I²C Bus <i2c>` and connect the sensor to the pins specified there.
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
ESP32 Bluetooth Low Energy Device
|
||||
=================================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up BLE binary sensors for the ESP32.
|
||||
:image: bluetooth.svg
|
||||
|
||||
The ``esp32_ble_tracker`` binary sensor platform lets you track the presence of a
|
||||
bluetooth low energy device.
|
||||
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
ESP32 Touch Pad Binary Sensor
|
||||
=============================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up the touch pad on the ESP32.
|
||||
:image: touch.svg
|
||||
|
||||
The ``esp32_touch`` binary sensor platform lets you use the touch peripheral of the
|
||||
ESP32 to detect if a certain pin is being "touched".
|
||||
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
GPIO Binary Sensor
|
||||
==================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up GPIO binary sensors with esphomelib.
|
||||
:image: pin.svg
|
||||
|
||||
The GPIO Binary Sensor platform allows you to use any input pin on your
|
||||
device as a binary sensor.
|
||||
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
Binary Sensor Component
|
||||
=======================
|
||||
|
||||
.. seo::
|
||||
:description: Information about the base representation of all binary sensors.
|
||||
:image: folder-open.svg
|
||||
|
||||
With esphomelib you can use different types of binary sensors. They will
|
||||
automatically appear in the Home Assistant front-end and have several
|
||||
configuration options.
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
Nextion Touch Component
|
||||
=======================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up Nextion touch binary sensors.
|
||||
:image: nextion.jpg
|
||||
|
||||
The ``nextion`` binary sensor platform lets you track when a component on the display is
|
||||
touched or not. The binary sensor will turn on when the component with the given component and page id is
|
||||
pressed on, and will turn off as soon as the finger is released.
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
PN532 NFC/RFID Tag
|
||||
==================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up NFC tags for the PN532 integration.
|
||||
:image: pn532.jpg
|
||||
|
||||
The ``pn532`` binary sensor platform lets you track if an NFC/RFID tag with a given
|
||||
unique id (``uid``) is currently being detected by the PN532 or not.
|
||||
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
RDM6300 NFC/RFID Tag
|
||||
====================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up NFC tags for the RDM6300 integration.
|
||||
:image: rdm6300.jpg
|
||||
|
||||
The ``rdm6300`` binary sensor platform lets you track if an NFC/RFID tag with a given
|
||||
unique id (``uid``) is currently being detected by the RDM6300 or not.
|
||||
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
Remote Receiver Binary Sensor
|
||||
=============================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up remote receiver binary sensors for infrared and RF codes.
|
||||
:image: remote.svg
|
||||
|
||||
The ``remote_receiver`` binary sensor lets you track when a button on a remote control is pressed.
|
||||
|
||||
Each time the pre-defined signal is received, the binary sensor will briefly go ON and
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
Status Binary Sensor
|
||||
====================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up MQTT status binary sensors.
|
||||
:image: server-network.svg
|
||||
|
||||
The Status Binary Sensor exposes the node state (if it’s connected to
|
||||
MQTT or not) for Home Assistant. It uses the :ref:`MQTT birth and last will messages <mqtt-last_will_birth>`
|
||||
to do this.
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
Template Binary Sensor
|
||||
======================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up template binary sensors.
|
||||
:image: description.svg
|
||||
|
||||
The ``template`` binary sensor platform allows you to define any :ref:`lambda template <config-lambda>`
|
||||
and construct a binary sensor out if it.
|
||||
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
Cover Component
|
||||
===============
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up base covers in esphomelib.
|
||||
:image: folder-opn.svg
|
||||
|
||||
The ``cover`` component is a generic representation of covers in esphomelib/yaml.
|
||||
A cover can (currently) either be *closed* or *open* and supports three types of
|
||||
commands: *open*, *close* and *stop*.
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
Template Cover
|
||||
==============
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up template covers in esphomelib.
|
||||
:image: description.svg
|
||||
|
||||
The ``template`` cover platform allows you to create simple covers out of just a few
|
||||
actions and a value lambda. Once defined, it will automatically appear in Home Assistant
|
||||
as a cover and can be controlled through the frontend.
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
Dallas Temperature Component
|
||||
============================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up dallas temperature sensor hubs that can expose many temperature sensors on a single pin using the one wire protocol.
|
||||
:image: dallas.jpg
|
||||
:keywords: Dallas, ds18b20, onewire
|
||||
|
||||
The ``dallas`` component allows you to use your
|
||||
`DS18b20 <https://www.adafruit.com/product/374>`__
|
||||
(`datasheet <https://datasheets.maximintegrated.com/en/ds/DS18B20.pdf>`__)
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
Debug Component
|
||||
===============
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up the debug component in esphomelib
|
||||
:image: bug-report.svg
|
||||
|
||||
The ``debug`` component can be used to debug problems with esphomelib. At startup, it prints
|
||||
a bunch of useful information like reset reason, free heap size, esphomelib version and so on.
|
||||
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
Deep Sleep Component
|
||||
====================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up the deep sleep support for minimizing power consumption on ESPs.
|
||||
:image: hotel.svg
|
||||
|
||||
The ``deep_sleep`` component can be used to automatically enter a deep sleep mode on the
|
||||
ESP8266/ESP32 after a certain amount of time. This is especially useful with nodes that operate
|
||||
on batteries and therefore need to conserve as much energy as possible.
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
Display Component
|
||||
=================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up the display integration.
|
||||
:image: folder-open.svg
|
||||
|
||||
The ``display`` component houses esphomelib's powerful rendering and display
|
||||
engine. Fundamentally, there are these types of displays:
|
||||
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
GPIO Character-Based LCD Display
|
||||
================================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up GPIO character-based LCD displays.
|
||||
:image: lcd.jpg
|
||||
|
||||
The ``lcd_gpio`` display platform allows you to use standard character-based LCD displays like `this one <https://www.adafruit.com/product/181>`__
|
||||
with esphomelib. This integration is only for LCD displays that display individual characters on a screen (usually 16-20 columns
|
||||
and 2-4 rows), and not for LCD displays that can control each pixel individually. Also, this is the GPIO version of the LCD
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
PCF8574 Character-Based LCD Display
|
||||
===================================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up the touch pad on the ESP32.
|
||||
:image: lcd.jpg
|
||||
|
||||
The ``lcd_pcf8574`` display platform allows you to use standard character-based LCD displays like `this one <https://docs.labs.mediatek.com/resource/linkit7697-arduino/en/tutorial/driving-1602-lcd-with-pcf8574-pcf8574a>`__
|
||||
with esphomelib. This integration is only for LCD displays that display individual characters on a screen (usually 16-20 columns
|
||||
and 2-4 rows), and not for LCD displays that can control each pixel individually.
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
MAX7219 7-Segment Display
|
||||
=========================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up MAX7129 7-segment displays.
|
||||
:image: max7219.jpg
|
||||
|
||||
The ``max7219`` display platform allows you to use MAX7219 7-segment display drivers (`datasheet <https://datasheets.maximintegrated.com/en/ds/MAX7219-MAX7221.pdf>`__,
|
||||
`hobbycomponents <https://hobbycomponents.com/displays/597-max7219-8-digit-seven-segment-display-module>`__)
|
||||
with esphomelib. Please note that this integration is *only* for 7-segment display, not matrix configurations.
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
Nextion TFT LCD Display
|
||||
=======================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up Nextion TFT LCD displays
|
||||
:image: nextion.jpg
|
||||
|
||||
.. warning::
|
||||
|
||||
This integration is experimental as I don't have the hardware to test it (yet).
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
SSD1306 OLED Display over I²C
|
||||
=============================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up SSD1306 OLED display drivers using the i2c bus.
|
||||
:image: ssd1306.jpg
|
||||
|
||||
The ``ssd1306_i2c`` display platform allows you to use
|
||||
SSD1306 (`datasheet <https://cdn-shop.adafruit.com/datasheets/SSD1306.pdf>`__, `Adafruit <https://www.adafruit.com/product/326>`__)
|
||||
and SH1106 (`datasheet <https://www.elecrow.com/download/SH1106%20datasheet.pdf>`__, `electrodragon <https://www.electrodragon.com/product/1-3-12864-blue-oled-display-iicspi/>`__)
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
SSD1306 OLED Display over SPI
|
||||
=============================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up SSD1306 OLED display drivers using an SPI bus
|
||||
:image: ssd1306.jpg
|
||||
|
||||
The ``ssd1306_spi`` display platform allows you to use
|
||||
SSD1306 (`datasheet <https://cdn-shop.adafruit.com/datasheets/SSD1306.pdf>`__, `Adafruit <https://www.adafruit.com/product/326>`__)
|
||||
and SH1106 (`datasheet <https://www.elecrow.com/download/SH1106%20datasheet.pdf>`__, `electrodragon <https://www.electrodragon.com/product/1-3-12864-blue-oled-display-iicspi/>`__)
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
Waveshare E-Paper Display
|
||||
=========================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up Waveshare E-Paper displays in esphomelib.
|
||||
:image: waveshare_epaper.jpg
|
||||
|
||||
The ``waveshare_epaper`` display platform allows you to use
|
||||
some E-Paper displays sold by `Waveshare <https://www.waveshare.com/product/modules/oleds-lcds/e-paper.htm>`__
|
||||
with esphomelib. Similar modules sold by other vendors might also work but not have been tested yet. Currently only
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
ESP32 Bluetooth Low Energy Beacon
|
||||
=================================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up Bluetooth Low Energy iBeacons using the BLE feature on ESP32s.
|
||||
:image: bluetooth.svg
|
||||
|
||||
The ``esp32_ble_beacon`` component creates a Bluetooth Low Energy Beacon with your ESP32 device.
|
||||
Beacons are BLE devices that repeatedly just send out a pre-defined packet of data. This packet
|
||||
can then be received by devices like smartphones and can then be used to track a phone's location.
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
ESP32 Bluetooth Low Energy Tracker Hub
|
||||
======================================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up ESP32 bluetooth low energy device trackers using esphomelib.
|
||||
:image: bluetooth.svg
|
||||
|
||||
The ``esp32_ble_tracker`` component creates a global hub so that you can track bluetooth low
|
||||
energy devices using your ESP32 node.
|
||||
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
ESP32 Touch Pad Hub
|
||||
===================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up the touch pad feature on the ESP32.
|
||||
:image: touch.svg
|
||||
|
||||
The ``esp32_touch`` component creates a global hub for detecting touches on
|
||||
the eight touch pads of the ESP32 as :doc:`binary senors </esphomeyaml/components/binary_sensor/esp32_touch>`.
|
||||
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
esphomeyaml Core Configuration
|
||||
==============================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up the core esphomeyaml configuration.
|
||||
:image: cloud-circle.svg
|
||||
|
||||
Here you specify some core information that esphomeyaml needs to create
|
||||
firmwares. Most importantly, this is the section of the configuration
|
||||
where you specify the **name** of the node, the **platform** and
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
Binary Fan
|
||||
==========
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up binary fans.
|
||||
:image: fan.svg
|
||||
|
||||
The ``binary`` fan platform lets you represent any binary :ref:`output` as a fan.
|
||||
|
||||
.. figure:: images/fan-ui.png
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
Fan Component
|
||||
=============
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up the base fan component.
|
||||
:image: folder-open.svg
|
||||
|
||||
With the ``fan`` domain you can create components that appear as fans in
|
||||
the Home Assistant frontend. A fan can be switched ON or OFF, optionally
|
||||
has a speed setting (``LOW``, ``MEDIUM``, ``HIGH``) and can have an
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
Speed Fan
|
||||
=========
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up speed-controllable fans.
|
||||
:image: fan.svg
|
||||
|
||||
The ``speed`` fan platform lets you represent any float :ref:`output` as a fan that
|
||||
supports speed settings.
|
||||
|
||||
|
||||
@ -3,6 +3,11 @@
|
||||
I²C Bus
|
||||
=======
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up the i2c bus to communicate with 2-wire devices in esphomelib
|
||||
:image: i2c.svg
|
||||
:keywords: i2c, iic, bus
|
||||
|
||||
This component sets up the i²c bus for your ESP32 or ESP8266. In order for those components
|
||||
to work correctly, you need to define the i²c bus in your configuration.
|
||||
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
Binary Light
|
||||
============
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up binary ON/OFF lights in esphomelib.
|
||||
:image: lightbulb.svg
|
||||
|
||||
The ``binary`` light platform creates a simple ON/OFF-only light from a
|
||||
:ref:`binary output component <output>`.
|
||||
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
Cold White + Warm White Light
|
||||
=============================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up Cold White + Warm White lights.
|
||||
:image: brightness-medium.svg
|
||||
|
||||
The ``cwww`` light platform creates an Cold-White+Warm-White
|
||||
light from 2 :ref:`float output components <output>` (one for each channel). The two
|
||||
channels will be mixed using the color temperature configuration options.
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
FastLED Clockless Light
|
||||
=======================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up FastLED addressable lights like NEXTION.
|
||||
:image: color_lens.svg
|
||||
|
||||
The ``fastled_clockless`` light platform allows you to create RGB lights
|
||||
in esphomelib for a :ref:`number of supported chipsets <fastled_clockless-chipsets>`.
|
||||
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
FastLED SPI Light
|
||||
=================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up other FastLED addressable lights.
|
||||
:image: color_lens.svg
|
||||
|
||||
The ``fastled_spi`` light platform allows you to create RGB lights
|
||||
in esphomelib for a :ref:`number of supported chipsets <fastled_spi-chipsets>`.
|
||||
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
Light Component
|
||||
===============
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up lights and light effects in esphomelib.
|
||||
:image: folder-open.svg
|
||||
|
||||
The ``light`` domain in esphomeyaml lets you create lights that will
|
||||
automatically be shown in Home Assistant’s frontend and have many
|
||||
features such as RGB colors, transitions, flashing and effects.
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
Monochromatic Light
|
||||
===================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up monochromatic (brightness-only) lights.
|
||||
:image: brightness-medium.svg
|
||||
|
||||
The ``monochromatic`` light platform creates a simple brightness-only light from an
|
||||
:ref:`float output component <output>`.
|
||||
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
RGB Light
|
||||
=========
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up RGB lights in esphomelib.
|
||||
:image: rgb.png
|
||||
|
||||
The ``rgb`` light platform creates an RGB light from 3 :ref:`float output components <output>`
|
||||
(one for each color channel).
|
||||
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
RGBW Light
|
||||
==========
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up RGB + White-Channel lights.
|
||||
:image: rgbw.png
|
||||
|
||||
The ``rgbw`` light platform creates an RGBW light from 4 :ref:`float output components <output>` (one for each channel).
|
||||
|
||||
.. code:: yaml
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
RGBWW Light
|
||||
===========
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up RGBWW lights.
|
||||
:image: rgbw.png
|
||||
|
||||
The ``rgbww`` light platform creates an RGBWW (cold white + warm white)
|
||||
light from 5 :ref:`float output components <output>` (one for each channel). The cold white
|
||||
and warm white channels will be mixed using the color temperature configuration options.
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
Logger Component
|
||||
================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up the central logging component in esphomelib.
|
||||
:image: file-document-box.svg
|
||||
|
||||
The logger component automatically logs all log messages through the
|
||||
serial port and through MQTT topics. By default, all logs with a
|
||||
severity higher than ``DEBUG`` will be shown. Decreasing the log level
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
MQTT Client Component
|
||||
=====================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up the MQTT client to communicate with the local network in esphomelib.
|
||||
:image: mqtt.png
|
||||
:keywords: MQTT
|
||||
|
||||
The MQTT Client Component sets up the MQTT connection to your broker and
|
||||
is currently required for esphomelib to work. In most cases, you will
|
||||
just be able to copy over the `MQTT
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
MY9231/MY9291 LED driver Component
|
||||
==================================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up MY9231 and MY9291 LED drives in esphomelib.
|
||||
:image: my9231.svg
|
||||
:keywords: MY9231, MY9291, Sonoff B1, Ai-thinker AiLight WiFi light bulb, Arilux E27 Smart Bulb
|
||||
|
||||
The MY9231/MY9291 component represents a MY9231/MY9291 LED diver chain
|
||||
(`MY9231 description <http://www.my-semi.com.tw/file/MY9231_BF_0.91.pdf>`__,
|
||||
`MY9291 description <http://www.my-semi.com.tw/file/MY9291_BF_0.91.pdf>`__) in
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
OTA Update Component
|
||||
====================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up Over-The-Air (OTA) updates for ESPs to upload firmwares remotely.
|
||||
:image: system-update.svg
|
||||
:keywords: Xiaomi, Mi Flora, BLE, Bluetooth
|
||||
|
||||
With the OTA (Over The Air) update component you can upload your
|
||||
firmware binaries to your node without having to use an USB cable for
|
||||
uploads. esphomeyaml natively supports this through its ``run`` and
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
ESP8266 Software PWM Output
|
||||
===========================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up ESP8266 software-based PWMs.
|
||||
:image: pwm.png
|
||||
|
||||
The ESP8266 Software PWM platform allows you to use a software PWM on
|
||||
the pins GPIO0-GPIO16 on your ESP8266. As this is only a software PWM
|
||||
and not a hardware PWM (like the :doc:`ESP32 LEDC PWM <ledc>`) and has a few
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
GPIO Output
|
||||
===========
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up binary outputs for GPIO pins.
|
||||
:image: pin.svg
|
||||
|
||||
The GPIO output component is quite simple: It exposes a single GPIO pin
|
||||
as an output component. Note that output components are **not** switches and
|
||||
will not show up in Home Assistant. See :doc:`GPIO Switch <gpio>`.
|
||||
|
||||
@ -3,6 +3,10 @@
|
||||
Output Component
|
||||
================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up generic outputs in esphomelib
|
||||
:image: folder-open.svg
|
||||
|
||||
Each platform of the ``output`` domain exposes some output to
|
||||
esphomelib. These are grouped into two categories: ``binary`` outputs
|
||||
(that can only be ON/OFF) and ``float`` outputs (like PWM, can output
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
ESP32 LEDC Output
|
||||
=================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up LEDC hardware PWM outputs on the ESP32.
|
||||
:image: pwm.png
|
||||
|
||||
The LEDC output component exposes a `LEDC PWM
|
||||
channel <https://esp-idf.readthedocs.io/en/latest/api-reference/peripherals/ledc.html>`__
|
||||
of the ESP32 as an output component.
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
MY9231/MY9291 Output
|
||||
====================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up MY931 and MY9231 outputs.
|
||||
:image: my9231.svg
|
||||
|
||||
The MY931/MY9291 output component exposes a MY931/MY9291 channel of a global
|
||||
:doc:`/esphomeyaml/components/my9231` as a float output.
|
||||
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
PCA9685 PWM Output
|
||||
==================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up PCA9685 PWM controller outputs.
|
||||
:image: pca9685.jpg
|
||||
|
||||
The PCA9685 output component exposes a PCA9685 PWM channel of a global
|
||||
:doc:`PCA9685 hub </esphomeyaml/components/pca9685>` as a float
|
||||
output.
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
PCA9685 PWM Component
|
||||
=====================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up PCA9685 LED PWM drivers.
|
||||
:image: pca9685.jpg
|
||||
:keywords: PCA9685
|
||||
|
||||
The PCA9685 component represents a PCA9685 12-bit PWM driver
|
||||
(`datasheet <https://esp-idf.readthedocs.io/en/latest/api-reference/peripherals/ledc.html#configure-channel>`__,
|
||||
`adafruit <https://www.adafruit.com/product/815>`__) in esphomelib. It
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
PCF8574 I/O Expander
|
||||
====================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up PCA8574 digital port expanders in esphomelib.
|
||||
:image: pcf8574.jpg
|
||||
:keywords: Xiaomi, Mi Flora, BLE, Bluetooth
|
||||
|
||||
The PCF8574 component allows you to use PCF8574 or PCF8575 I/O expanders
|
||||
(`datasheet <http://www.ti.com/lit/ds/symlink/pcf8574.pdf>`__,
|
||||
`Sparkfun`_) in esphomeyaml. It uses :ref:`I²C Bus <i2c>` for communication.
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
PN532 NFC/RFID Controller Hub
|
||||
=============================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up PN532 NFC tag readers in esphomelib
|
||||
:image: pn532.jpg
|
||||
:keywords: PN532, NFC, RFID
|
||||
|
||||
The ``pn532`` component allows you to use PN532 NFC/RFID controllers
|
||||
(`datasheet <https://cdn-shop.adafruit.com/datasheets/pn532ds.pdf>`__, `adafruit <https://www.adafruit.com/product/364>`__)
|
||||
with esphomelib. This component is a global hub that establishes the connection to the PN532 via :ref:`SPI <spi>` and
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
Power Supply Component
|
||||
======================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up power supplies which will automatically turn on together with outputs.
|
||||
:image: power.svg
|
||||
:keywords: power, ATX
|
||||
|
||||
The ``power_supply`` component allows you to have a high power mode for
|
||||
certain outputs. For example, if you’re using an `ATX power
|
||||
supply <https://en.wikipedia.org/wiki/ATX>`__ to power your LED strips,
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
RDM6300 NFC/RFID Hub
|
||||
====================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up RDM6300 NFC/RFID tag readers in esphomelib.
|
||||
:image: rdm6300.jpg
|
||||
:keywords: RDM6300, NFC, RFID
|
||||
|
||||
The ``rdm6300`` component allows you to use RDM6300 NFC/RFID controllers
|
||||
(`datasheet <https://elty.pl/upload/download/RFID/RDM630-Spec.pdf>`__, `iTead <https://www.itead.cc/rdm6300.html>`__)
|
||||
with esphomelib. This component is a global hub that establishes the connection to the RDM6300 via :ref:`UART <uart>` and
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
Remote Receiver Component
|
||||
=========================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up remote receivers in esphomelib.
|
||||
:image: remote.svg
|
||||
:keywords: RF, infrared
|
||||
|
||||
The ``remote_receiver`` component lets you receive and decode any remote signal, these can
|
||||
for example be infrared remotes or 433MHz signals.
|
||||
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
Remote Transmitter Component
|
||||
============================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up remote transmitters in esphomelib
|
||||
:image: remote.svg
|
||||
:keywords: RF, infrared
|
||||
|
||||
The ``remote_transmitter`` component lets you send infrared messages to control
|
||||
devices in your home. First, you need to setup a global hub that specifies which pin your remote
|
||||
sender is connected to. Afterwards you can create :doc:`individual
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
Analog To Digital Sensor
|
||||
========================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up built-in analog voltage sensors.
|
||||
:image: flash.svg
|
||||
|
||||
The Analog To Digital (``adc``) Sensor allows you to use the built-in
|
||||
ADC in your device to measure a voltage on certain pins. On the ESP8266
|
||||
only pin A0 (GPIO17) supports this. On the ESP32 pins GPIO32 through
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
ADS1115 Sensor
|
||||
==============
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up ADS1115 multiplexed analog voltage sensors.
|
||||
:image: ads1115.jpg
|
||||
:keywords: ADS1115
|
||||
|
||||
The ``ads1115`` sensor allows you to use your ADS1115 sigma-delta ADC
|
||||
sensors (`datasheet <http://www.ti.com/lit/ds/symlink/ads1115.pdf>`__, `Adafruit`_) with esphomelib.
|
||||
First, setup a :doc:`ADS1115 Hub </esphomeyaml/components/ads1115>` for your ADS1115 sensor and then use this
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
BH1750 Ambient Light Sensor
|
||||
===========================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up BH1750 ambient light sensors in esphomelib.
|
||||
:image: bh1750.jpg
|
||||
:keywords: BH1750
|
||||
|
||||
The ``bh1750`` sensor platform allows you to use your BH1750
|
||||
(`datasheet <http://www.mouser.com/ds/2/348/bh1750fvi-e-186247.pdf>`__, `Aliexpress`_, `mklec`_)
|
||||
ambient light sensor with esphomelib. The :ref:`I²C bus <i2c>` is required to be set up in
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
ESP32 Bluetooth Low Energy RSSI Sensor
|
||||
======================================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up RSSI sensors for the ESP32 BLE.
|
||||
:image: bluetooth.svg
|
||||
:keywords: ESP32
|
||||
|
||||
The ``ble_rssi`` sensor platform lets you track the RSSI value or signal strength of a
|
||||
BLE device. See :ref:`the binary sensor setup <esp32_ble_tracker-setting_up_devices>` for
|
||||
instructions for setting up this platform.
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
BME280 Temperature+Pressure+Humidity Sensor
|
||||
===========================================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up BME280 temperature, pressure and humidity sensors
|
||||
:image: bme280.jpg
|
||||
:keywords: BME280
|
||||
|
||||
The ``bme280`` sensor platform allows you to use your BME280
|
||||
(`datasheet <https://cdn-shop.adafruit.com/datasheets/BST-BME280_DS001-10.pdf>`__,
|
||||
`Adafruit`_) temperature, pressure and humidity sensors with esphomelib. The :ref:`I²C <i2c>` is
|
||||
|
||||
|
Before Width: | Height: | Size: 3.6 KiB After Width: | Height: | Size: 3.8 KiB |
@ -1,6 +1,11 @@
|
||||
BME680 Temperature+Pressure+Humidity+Gas Sensor
|
||||
===============================================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up BME680 temperature, humidity, pressure and gas sensors.
|
||||
:image: bme680.jpg
|
||||
:keywords: BME680
|
||||
|
||||
The ``bme680`` sensor platform allows you to use your BME680
|
||||
(`datasheet <https://cdn-shop.adafruit.com/product-files/3660/BME680.pdf>`__,
|
||||
`Adafruit`_) temperature, pressure and humidity sensors with esphomelib. The :ref:`I²C <i2c>` is required to be set up in
|
||||
|
||||
|
Before Width: | Height: | Size: 4.3 KiB After Width: | Height: | Size: 4.5 KiB |
@ -1,6 +1,11 @@
|
||||
BMP085 Temperature+Pressure Sensor
|
||||
==================================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up BMP085 temperature and temperature sensors
|
||||
:image: bmp180.jpg
|
||||
:keywords: BMP085, BMP180
|
||||
|
||||
The BMP085 sensor platform allows you to use your BMP085
|
||||
(`datasheet <https://www.sparkfun.com/datasheets/Components/General/BST-BMP085-DS000-05.pdf>`__,
|
||||
`adafruit <https://www.adafruit.com/product/391>`__) and BMP180
|
||||
|
||||
|
Before Width: | Height: | Size: 2.3 KiB After Width: | Height: | Size: 2.5 KiB |
@ -1,6 +1,11 @@
|
||||
BMP280 Temperature+Pressure Sensor
|
||||
==================================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up BMP280 temperature and pressure sensors with esphomelib
|
||||
:image: bmp280.jpg
|
||||
:keywords: BMP280
|
||||
|
||||
The ``bmp280`` sensor platform allows you to use your BMP280
|
||||
(`datasheet <https://cdn-shop.adafruit.com/datasheets/BST-BMP280-DS001-11.pdf>`__,
|
||||
`Adafruit`_) temperature and pressure sensors with esphomelib. The :ref:`I²C <i2c>` is
|
||||
|
||||
|
Before Width: | Height: | Size: 3.1 KiB After Width: | Height: | Size: 3.2 KiB |
@ -1,6 +1,11 @@
|
||||
CSE7766 Power Sensor
|
||||
====================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up CSE7766 power sensors for the Sonoff Pow R2
|
||||
:image: cse7766.svg
|
||||
:keywords: cse7766, Sonoff Pow R2
|
||||
|
||||
.. warning::
|
||||
|
||||
This integration is experimental as I don't have the hardware to test it (yet).
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
Custom Sensor Component
|
||||
=======================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up Custom C++ sensors with esphomelib.
|
||||
:image: language-cpp.svg
|
||||
:keywords: C++, Custom
|
||||
|
||||
.. warning::
|
||||
|
||||
While I do try to keep the esphomeyaml configuration options as stable as possible
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
Dallas Temperature Sensor
|
||||
=========================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up DS18b20 and similar temperature sensors
|
||||
:image: dallas.jpg
|
||||
:keywords: dallas, ds18b20
|
||||
|
||||
The ``dallas`` sensor allows you to use ds18b20 and similar sensors.
|
||||
First, you need to define a :doc:`dallas sensor component </esphomeyaml/components/dallas>`.
|
||||
The dallas sensor component (or "hub") is an internal model that defines which pins the ds18b20
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
DHT Temperature+Humidity Sensor
|
||||
===============================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up DHT11 and DHT22 temperature and humidity sensors.
|
||||
:image: dht.jpg
|
||||
:keywords: DHT11, DHT22, AM2302, RHT03
|
||||
|
||||
The DHT Temperature+Humidity sensor allows you to use your DHT11
|
||||
(`datasheet <https://akizukidenshi.com/download/ds/aosong/DHT11.pdf>`__,
|
||||
`adafruit <https://www.adafruit.com/product/386>`__), DHT22
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
DHT12 Temperature+Humidity Sensor
|
||||
=================================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up DHT12 temperature and humidity sensors
|
||||
:image: dht12.jpg
|
||||
:keywords: dht12
|
||||
|
||||
The ``dht12`` Temperature+Humidity sensor allows you to use your DHT12
|
||||
(`datasheet <http://www.robototehnika.ru/file/DHT12.pdf>`__,
|
||||
`electrodragon`_) i2c-based sensor with esphomelib.
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
Duty Cycle Sensor
|
||||
=================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up duty cycle sensors in esphomelib
|
||||
:image: percent.svg
|
||||
|
||||
The duty cycle sensor allows you to measure for what percentage of time a signal
|
||||
on a GPIO pin is HIGH or LOW.
|
||||
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
ESP32 Hall Sensor
|
||||
=================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up the integrated hall-effect sensor of the ESP32.
|
||||
:image: magnet.svg
|
||||
:keywords: esp32, hall
|
||||
|
||||
The ``esp32_hall`` sensor platform allows you to use the integrated
|
||||
`hall effect sensor <https://en.wikipedia.org/wiki/Hall_effect_sensor>`__ of the
|
||||
ESP32 chip to measure the magnitude and direction of magnetic field around the
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
HDC1080 Temperature+Humidity Sensor
|
||||
===================================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up HDC1080 temperature and humidity sensors.
|
||||
:image: hdc1080.jpg
|
||||
:keywords: HDC1080
|
||||
|
||||
The HDC1080 Temperature+Humidity sensor allows you to use your HDC1080
|
||||
(`datasheet <http://www.ti.com/lit/ds/symlink/hdc1080.pdf>`__,
|
||||
`adafruit <https://www.adafruit.com/product/2635>`__) sensors with
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
HLW8012 Power Sensor
|
||||
====================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up HLW8012 power sensors for the Sonoff Pow R1
|
||||
:image: hlw8012.svg
|
||||
:keywords: HLW8012, Sonoff Pow R1
|
||||
|
||||
The ``hlw8012`` sensor platform allows you to use your HLW8012 voltage/current and power sensors
|
||||
(`datasheet <https://github.com/xoseperez/hlw8012/blob/master/docs/HLW8012.pdf>`__) sensors with
|
||||
esphomelib. This sensor is commonly found in Sonoff POWs.
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
HMC5883L Magnetometer
|
||||
=====================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up HMC5883L IMU compass sensors.
|
||||
:image: hmc5883l.jpg
|
||||
:keywords: HMC5883L
|
||||
|
||||
The ``hmc5883l`` allows you to use your HMC5883L triple-axis magnetometers
|
||||
(`datasheet <https://cdn-shop.adafruit.com/datasheets/HMC5883L_3-Axis_Digital_Compass_IC.pdf>`__,
|
||||
`Adafruit`_) with
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
HTU21D Temperature+Humidity Sensor
|
||||
==================================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up HTU21D temperature and humidity sensors.
|
||||
:image: htu21d.jpg
|
||||
:keywords: HTU21D
|
||||
|
||||
The HTU21D Temperature+Humidity sensor allows you to use your HTU21D
|
||||
(`datasheet <http://www.te.com/commerce/DocumentDelivery/DDEController?Action=showdoc&DocId=Data+Sheet%7FHPC199_6%7FA6%7Fpdf%7FEnglish%7FENG_DS_HPC199_6_A6.pdf%7FCAT-HSC0004>`__,
|
||||
`adafruit <https://www.adafruit.com/product/1899>`__) sensors with
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
HX711 Load Cell Amplifier
|
||||
=========================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up HX711 load cell amplifiers with esphomelib
|
||||
:image: hx711.svg
|
||||
:keywords: HX711
|
||||
|
||||
The ``hx711`` sensor platform allows you to use your HX711
|
||||
load cell amplifier
|
||||
(`datasheet <https://www.mouser.com/ds/2/813/hx711_english-1022875.pdf>`__, `Sparkfun`_) with esphomelib
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
INA219 DC Current Sensor
|
||||
========================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up INA219 DC current sensors
|
||||
:image: ina219.jpg
|
||||
:keywords: ina219
|
||||
|
||||
The ``ina219`` sensor platform allows you to use your INA219 High Side DC Current Sensor
|
||||
(`datasheet <https://cdn-learn.adafruit.com/downloads/pdf/adafruit-ina219-current-sensor-breakout.pdf>`__,
|
||||
`Adafruit`_) sensors with
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
INA3221 3-Channel DC Current Sensor
|
||||
===================================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up INA3221 3-channel DC current sensors.
|
||||
:image: ina3221.jpg
|
||||
:keywords: ina3221
|
||||
|
||||
The ``ina3221`` sensor platform allows you to use your INA3221 3-Channel DC Current Sensor
|
||||
(`datasheet <http://www.ti.com/lit/ds/symlink/ina3221.pdf>`__,
|
||||
`switchdoc`_) sensors with
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
Sensor Component
|
||||
================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up sensor components in esphomelib.
|
||||
:image: folder-open.svg
|
||||
|
||||
esphomelib has support for many different sensors. Each of them is a
|
||||
platform of the ``sensor`` domain and each sensor has several base
|
||||
configuration options.
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
MAX6675 K-Type Thermocouple Temperature Sensor
|
||||
==============================================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up MAX6675 Thermocouple temperature sensors.
|
||||
:image: max6675.jpg
|
||||
|
||||
The ``max6675`` temperature sensor allows you to use your max6675 thermocouple
|
||||
temperature sensor (`datasheet <https://datasheets.maximintegrated.com/en/ds/MAX6675.pdf>`__, `sainsmart`_) with esphomelib
|
||||
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
MH-Z19 CO_2 and Temperature Sensor
|
||||
==================================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up MH-Z19 CO2 and temperature sensors
|
||||
:image: mhz19.jpg
|
||||
:keywords: mh-z19
|
||||
|
||||
The ``mhz19`` sensor platform allows you to use MH-Z19 CO_2 and temperature sensors
|
||||
(`refspace`_) with esphomelib.
|
||||
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
MPU6050 Accelerometer/Gyroscope Sensor
|
||||
======================================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up MPU6050 Accelerometer and Gyroscope sensors.
|
||||
:image: mpu6050.jpg
|
||||
|
||||
The ``mpu6050`` sensor platform allows you to use your MPU6050 Accelerometer/Gyroscope
|
||||
(`datasheet <https://www.invensense.com/wp-content/uploads/2015/02/MPU-6000-Datasheet1.pdf>`__,
|
||||
`Sparkfun`_) sensors with
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
MQTT Subscribe Sensor
|
||||
=====================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up MQTT subscribe sensors
|
||||
:image: mqtt.png
|
||||
:keywords: MQTT
|
||||
|
||||
The ``mqtt_subscribe`` sensor platform allows you to get external data into esphomelib.
|
||||
The sensor will subscribe to messages on the given MQTT topic and parse each message into
|
||||
a floating point number.
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
MS5611 Atmospheric Pressure Sensor
|
||||
==================================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up MS5611 atmospheric pressure sensors.
|
||||
:image: ms5611.jpg
|
||||
:keywords: MS5611
|
||||
|
||||
The ``ms5611`` sensor platform allows you to use your MS5611 atmospheric pressure sensors
|
||||
(`datasheet <http://www.te.com/commerce/DocumentDelivery/DDEController?Action=showdoc&DocId=Data+Sheet%7FMS5611-01BA03%7FB3%7Fpdf%7FEnglish%7FENG_DS_MS5611-01BA03_B3.pdf%7FCAT-BLPS0036>`__,
|
||||
`hobbytronics`_) temperature and pressure sensors with esphomelib. The :ref:`I²C <i2c>` is
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
PMSX003 Particulate Matter Sensor
|
||||
=================================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up PMSX003 Particulate matter sensors
|
||||
:image: pmsx003.svg
|
||||
|
||||
.. warning::
|
||||
|
||||
This integration is experimental as I don't have the hardware to test it (yet).
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
Pulse Counter Sensor
|
||||
====================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up pulse counter sensors.
|
||||
:image: pulse.svg
|
||||
|
||||
The pulse counter sensor allows you to count the number of pulses and the frequency of a signal
|
||||
on any pin.
|
||||
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
Rotary Encoder Sensor
|
||||
=====================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up rotary encoders.
|
||||
:image: rotary_encoder.jpg
|
||||
|
||||
The ``rotary_encoder`` sensor platform allows you to use any continuous-rotation
|
||||
rotary encoders with esphomeyaml. These devices usually have two pins with which
|
||||
they encode the rotation. Every time the knob of the rotary encoder is turned, the
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
SHT3X-D Temperature+Humidity Sensor
|
||||
===================================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up SHT31-D temperature and humidity sensors
|
||||
:image: sht3xd.jpg
|
||||
|
||||
The ``sht3xd`` sensor platform Temperature+Humidity sensor allows you to use your Sensiron SHT31-D
|
||||
(`datasheet <https://cdn-shop.adafruit.com/product-files/2857/Sensirion_Humidity_SHT3x_Datasheet_digital-767294.pdf>`__,
|
||||
`Adafruit`_ ) sensors with
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
TCS34725 RGB Color Sensor
|
||||
=========================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up TCS34725 RGB color sensors.
|
||||
:image: tcs34725.jpg
|
||||
:keywords: tcs34725
|
||||
|
||||
The ``tcs34725`` sensor platform allows you to use your TCS34725 RGB color sensors
|
||||
(`datasheet <https://cdn-shop.adafruit.com/datasheets/TCS34725.pdf>`__,
|
||||
`Adafruit`_) temperature and pressure sensors with esphomelib. The :ref:`I²C <i2c>` is
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
Template Sensor
|
||||
===============
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up template sensors with esphomelib.
|
||||
:image: description.svg
|
||||
|
||||
The ``template`` sensor platform allows you to create a sensor with templated values
|
||||
using :ref:`lambdas <config-lambda>`.
|
||||
|
||||
@ -36,6 +40,15 @@ Configuration variables:
|
||||
- **id** (*Optional*,:ref:`config-id`): Manually specify the ID used for code generation.
|
||||
- All other options from :ref:`Sensor <config-sensor>` and :ref:`MQTT Component <config-mqtt-component>`.
|
||||
|
||||
.. note::
|
||||
|
||||
You can use the ``publish_state()`` method to set the value of a template
|
||||
sensor from other automations:
|
||||
|
||||
.. code:: cpp
|
||||
|
||||
id(my_sensor).publish_state(42.0);
|
||||
|
||||
See Also
|
||||
--------
|
||||
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
Total Daily Energy Sensor
|
||||
=========================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up sensors that track the total daily energy usage per day and accumulate the power usage.
|
||||
:image: sigma.svg
|
||||
|
||||
The ``total_daily_energy`` sensor is a helper sensor that can use the energy value of
|
||||
other sensors like the :doc:`HLW8012 <hlw8012>`, :doc:`CSE7766 <cse7766>`, etc and integrate
|
||||
it over time.
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
TSL2561 Ambient Light Sensor
|
||||
============================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up TSL2561 ambient light sensors in esphomelib.
|
||||
:image: tsl2561.jpg
|
||||
:keywords: TSL2561
|
||||
|
||||
The ``tsl2561`` sensor platform allows you to use your TSL2561
|
||||
(`datasheet <https://cdn-shop.adafruit.com/datasheets/TSL2561.pdf>`__,
|
||||
`Adafruit`_)
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user