Upstream
/
esphome-docs
mirror of https://github.com/esphome/esphome-docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update svg2png and seo.py (#1380) 

Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
This commit is contained in:
Otto Winter 2021-11-16 03:19:33 +01:00 committed by GitHub
parent 22ada42896
commit 6053f490b5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
191 changed files with 231 additions and 241 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
components/api.rst
View File

@ -3,7 +3,7 @@ Native API Component
.. seo::
:description: Instructions for setting up the native ESPHome API for communication with Home Assistant.
:image: server-network.png
:image: server-network.svg
:keywords: Native API, ESPHome, Home Assistant
The ESPHome native API is used to communicate with clients directly, with a highly-optimized

2
components/binary_sensor/ble_presence.rst
View File

@ -3,7 +3,7 @@ ESP32 Bluetooth Low Energy Device
.. seo::
:description: Instructions for setting up BLE binary sensors for the ESP32.
:image: bluetooth.png
:image: bluetooth.svg
The ``ble_presence`` binary sensor platform lets you track the presence of a
Bluetooth Low Energy device.

2
components/binary_sensor/esp32_touch.rst
View File

@ -3,7 +3,7 @@ ESP32 Touch Pad
.. seo::
:description: Instructions for setting up the touch pad on the ESP32.
:image: touch.png
:image: touch.svg
.. _esp32-touch-component:

2
components/binary_sensor/gpio.rst
View File

@ -3,7 +3,7 @@ GPIO Binary Sensor
.. seo::
:description: Instructions for setting up GPIO binary sensors with ESPHome.
:image: pin.png
:image: pin.svg
The GPIO Binary Sensor platform allows you to use any input pin on your
device as a binary sensor.

2
components/binary_sensor/homeassistant.rst
View File

@ -3,7 +3,7 @@ Home Assistant Binary Sensor
.. seo::
:description: Instructions for setting up Home Assistant binary sensors with ESPHome that import states from your Home Assistant instance.
:image: home-assistant.png
:image: home-assistant.svg
The ``homeassistant`` binary sensor platform allows you to create binary sensors that **import**
states from your Home Assistant instance using the :doc:`native API </components/api>`.

2
components/binary_sensor/index.rst
View File

@ -3,7 +3,7 @@ Binary Sensor Component
.. seo::
:description: Information about the base representation of all binary sensors.
:image: folder-open.png
:image: folder-open.svg
With ESPHome you can use different types of binary sensors. They will
automatically appear in the Home Assistant front-end and have several

2
components/binary_sensor/status.rst
View File

@ -3,7 +3,7 @@ Status Binary Sensor
.. seo::
:description: Instructions for setting up MQTT status binary sensors.
:image: server-network.png
:image: server-network.svg
The Status Binary Sensor exposes the node state (if it’s connected to via MQTT/native API)
for Home Assistant.

2
components/binary_sensor/template.rst
View File

@ -3,7 +3,7 @@ Template Binary Sensor
.. seo::
:description: Instructions for setting up template binary sensors.
:image: description.png
: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.

2
components/canbus.rst
View File

@ -5,7 +5,7 @@ CAN bus
.. seo::
:description: Instructions for setting up an CAN bus in ESPHome
:image: canbus.png
:image: canbus.svg
:keywords: CAN
Controller Area Network (CAN bus) is a serial bus protocol to connect individual systems and sensors

2
components/captive_portal.rst
View File

@ -3,7 +3,7 @@ Captive Portal
.. seo::
:description: Instructions for setting up the Captive Portal fallback mechanism in ESPHome.
:image: wifi-strength-alert-outline.png
:image: wifi-strength-alert-outline.svg
The captive portal component in ESPHome is a fallback mechanism for when connecting to the
configured :doc:`WiFi <wifi>` fails.

2
components/climate/bang_bang.rst
View File

@ -3,7 +3,7 @@ Bang Bang Climate Controller
.. seo::
:description: Instructions for setting up Bang Bang climate controllers with ESPHome.
:image: air-conditioner.png
:image: air-conditioner.svg
The ``bang_bang`` climate platform allows you to regulate a value with a
`bang-bang controller <https://en.wikipedia.org/wiki/Bang%E2%80%93bang_control>`__ (also called hysteresis controller).

2
components/climate/index.rst
View File

@ -3,7 +3,7 @@ Climate Component
.. seo::
:description: Information about the base representation of all climate devices.
:image: folder-open.png
:image: folder-open.svg
ESPHome has support for climate devices. Climate devices can represent different types of
hardware, but the defining factor is that climate devices have a settable target temperature

2
components/climate/ir_climate.rst
View File

@ -3,7 +3,7 @@ IR Remote Climate
.. seo::
:description: Controls a variety of compatible Climate devices via IR
:image: air-conditioner-ir.png
:image: air-conditioner-ir.svg
This climate component allows you to control compatible AC units by sending an infrared (IR)
control signal, just as the unit's handheld remote controller would.

2
components/climate/midea.rst
View File

@ -3,7 +3,7 @@ Midea Air Conditioner
.. seo::
:description: Instructions for setting up a Midea climate device
:image: air-conditioner.png
:image: air-conditioner.svg
The ``midea`` component creates a Midea air conditioner climate device.

2
components/climate/pid.rst
View File

@ -3,7 +3,7 @@ PID Climate
.. seo::
:description: Instructions for setting up PID climate controllers with ESPHome.
:image: function.png
:image: function.svg
The ``pid`` climate platform allows you to regulate a value with a
`PID controller <https://en.wikipedia.org/wiki/PID_controller>`__.

2
components/climate/thermostat.rst
View File

@ -3,7 +3,7 @@ Thermostat Climate Controller
.. seo::
:description: Instructions for setting up Thermostat climate controllers with ESPHome.
:image: air-conditioner.png
:image: air-conditioner.svg
The ``thermostat`` climate platform allows you to control a climate control system in much the same manner as a
physical thermostat. Its operation is similar to the :doc:`bang-bang <bang_bang>` controller; a sensor measures a value

2
components/climate/tuya.rst
View File

@ -3,7 +3,7 @@ Tuya Climate
.. seo::
:description: Instructions for setting up a Tuya climate device.
:image: air-conditioner.png
:image: air-conditioner.svg
The ``tuya`` climate platform creates a climate device from a tuya component.

2
components/cover/am43.rst
View File

@ -3,7 +3,7 @@ AM43 Cover
.. seo::
:description: Setting up AM43/BLE covers in ESPHome.
:image: am43.png
:image: am43.jpg
The ``am43`` cover platform allows you to control an AM43 based
BLE cover motor. These devices are sold under various brands, such

66
components/cover/current_based.rst
View File

@ -3,14 +3,14 @@ Current Based Cover
.. seo::
:description: Instructions for setting up current-based covers in ESPHome.
:image: window-open.jpg
:image: window-open.svg
The ``current_based`` cover platform allows you to create covers with position control by using current
sensors to detect the fully-open and fully-closed states. This is pretty useful when using motors with
integrated mechanical endstops. During cover operation, the component monitors the current consumption
to detect when the motor has stopped.
sensors to detect the fully-open and fully-closed states. This is pretty useful when using motors with
integrated mechanical endstops. During cover operation, the component monitors the current consumption
to detect when the motor has stopped.
When fully open or close is requested, the corresponding relay will stay on until the current the motor is
When fully open or close is requested, the corresponding relay will stay on until the current the motor is
consuming goes below a certain amount. The amount of current needs to be specified in the configuration.
Open and close durations can be specified to allow ESPHome to approximate the current position of the cover.
@ -19,14 +19,14 @@ Open and close durations can be specified to allow ESPHome to approximate the cu
:align: center
:width: 75.0%
This type of cover also provides safety features like current-based obstacle detection with automatic configurable
rollback as well as relay malfunction detection: operation cancels if there's a current flowing in the opposite
operation circuit (typically caused by welded relays).
This type of cover also provides safety features like current-based obstacle detection with automatic configurable
rollback as well as relay malfunction detection: operation cancels if there's a current flowing in the opposite
operation circuit (typically caused by welded relays).
.. warning::
Depending on the cover and motor type, obstacles can physically damage the cover before being detectable.
Verify your setup to ensure the current consumption will increase enough to be detectable before causing
Depending on the cover and motor type, obstacles can physically damage the cover before being detectable.
Verify your setup to ensure the current consumption will increase enough to be detectable before causing
any physical damage. Use it at your own risk.
.. code-block:: yaml
@ -56,7 +56,7 @@ operation circuit (typically caused by welded relays).
obstacle_rollback: 30%
start_sensing_delay: 0.8s
Configuration variables:
@ -68,32 +68,32 @@ Configuration variables:
be performed when the remote requests the cover to be opened.
- **open_duration** (**Required**, :ref:`config-time`): The amount of time it takes the cover
to open up from the fully-closed state.
- **open_moving_current_threshold** (**Required**, float): The amount of current in Amps the motor
should drain to consider the cover is opening.
- **open_obstacle_current_threshold** (**Required**, float): The amount of current in Amps the motor
- **open_moving_current_threshold** (**Required**, float): The amount of current in Amps the motor
should drain to consider the cover is opening.
- **open_obstacle_current_threshold** (**Required**, float): The amount of current in Amps the motor
should drain to consider the cover is blocked during opening.
- **close_sensor** (**Required**, :ref:`config-id`): The close current sensor.
- **close_action** (*Optional*, :ref:`Action <config-action>`): The action that should
be performed when the remote requests the cover to be closed.
- **close_duration** (**Required**, :ref:`config-time`): The amount of time it takes the cover
to close from the fully-open state.
- **close_moving_current_threshold** (**Required**, float): The amount of current in Amps the motor
- **close_moving_current_threshold** (**Required**, float): The amount of current in Amps the motor
should drain to consider the cover is closing.
- **close_obstacle_current_threshold** (**Required**, float): The amount of current in Amps the motor
- **close_obstacle_current_threshold** (**Required**, float): The amount of current in Amps the motor
should drain to consider the cover is blocked during closing.
- **stop_action** (**Required**, :ref:`Action <config-action>`): The action that should
be performed to stop the cover.
- **max_duration** (*Optional*, :ref:`config-time`): The maximum duration the cover should be opening
or closing. Useful for protecting from dysfunctional motor integrated endstops.
- **start_sensing_delay** (*Optional*, :ref:`config-time`): The amount of time the current sensing will be
disabled when the movement starts. Motors can take some time before reaching their average consumption.
Low values can cause an immediate stop because of the first current reading happening in the current-rising period.
- **start_sensing_delay** (*Optional*, :ref:`config-time`): The amount of time the current sensing will be
disabled when the movement starts. Motors can take some time before reaching their average consumption.
Low values can cause an immediate stop because of the first current reading happening in the current-rising period.
Defaults to ``500ms``.
- **obstacle_rollback** (*Optional*, percentage): The percentage of rollback the cover will perform in case of
- **obstacle_rollback** (*Optional*, percentage): The percentage of rollback the cover will perform in case of
obstacle detection. Defaults to ``10%``.
- **malfunction_detection** (*Optional*, boolean): Enable to detect malfunction detection (Tipically welded realys). Defaults to ``True``.
- **malfunction_action** (*Optional*, :ref:`Action <config-action>`): The action that should
be performed when relay malfunction is detected. Malfunction may require device servicing. You can use this action
be performed when relay malfunction is detected. Malfunction may require device servicing. You can use this action
to notify other systems about this situation
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Cover <config-cover>`.
@ -101,25 +101,21 @@ Configuration variables:
Use with Shelly 2.5
-------------------
.. seo::
:description: Instructions for setting up current-based covers in ESPHome using a Shelly 2.5.
:image: shelly2.5.png
The Shelly 2.5 is the perfect hardware for this platform. It features two outputs with current monitoring
(thanks to an embedded :doc:`ADE7953 </components/sensor/ade7953>`) in a very small form factor (39mm x 36mm x 17 mm).
(thanks to an embedded :doc:`ADE7953 </components/sensor/ade7953>`) in a very small form factor (39mm x 36mm x 17 mm).
It also features an :doc:`NTC temperature sensor </components/sensor/ntc>`.
.. figure:: images/shelly2.5.png
:align: center
:width: 30.0%
These devices typically run hot (~55Cº at 20ºC room temperature). Long-term heavy loads (near to its rated limit) can overheat the device.
It is strongly recommended to monitor the device temperature using the NTC temperature sensor, shutting down the device if it exceeds 90ºC.
These devices typically run hot (~55Cº at 20ºC room temperature). Long-term heavy loads (near to its rated limit) can overheat the device.
It is strongly recommended to monitor the device temperature using the NTC temperature sensor, shutting down the device if it exceeds 90ºC.
This safety feature is also present in the original firmware.
.. warning::
The ADE7953 IRQ line is connected to the GPIO16. The ``irq_pin`` parameter for the :doc:`ADE7953 </components/sensor/ade7953>` MUST be
The ADE7953 IRQ line is connected to the GPIO16. The ``irq_pin`` parameter for the :doc:`ADE7953 </components/sensor/ade7953>` MUST be
set to GPIO16 to prevent device overheat (>70ºC idling).
Configuration example:
@ -135,7 +131,7 @@ Configuration example:
i2c:
sda: GPIO12
scl: GPIO14
sensor:
- platform: ade7953
irq_pin: GPIO16
@ -153,7 +149,7 @@ Configuration example:
id: close_current
internal: true
update_interval: 0.5s
# NTC Temperature
- platform: ntc
sensor: temp_resistance_reading
@ -164,7 +160,7 @@ Configuration example:
b_constant: 3350
reference_resistance: 10kOhm
reference_temperature: 298.15K
on_value_range:
on_value_range:
above: 90
then: # Security shutdown by overheating
- switch.turn_on: _shutdown
@ -182,7 +178,7 @@ Configuration example:
internal: true
binary_sensor:
- platform: gpio
- platform: gpio
pin:
number: GPIO13
name: Shelly 2.5 Open Button
@ -243,8 +239,8 @@ Configuration example:
malfunction_detection: true
malfunction_action:
then:
- logger.log: "Malfunction detected. Relay welded."
- logger.log: "Malfunction detected. Relay welded."
status_led:

2
components/cover/endstop.rst
View File

@ -3,7 +3,7 @@ Endstop Cover
.. seo::
:description: Instructions for setting up time-based covers in ESPHome.
:image: electric-switch.png
:image: electric-switch.svg
The ``endstop`` cover platform allows you to create covers with position control that have
endstops at both ends of the cover to detect the fully-open and fully-closed states.

2
components/cover/index.rst
View File

@ -3,7 +3,7 @@ Cover Component
.. seo::
:description: Instructions for setting up base covers in ESPHome.
:image: folder-opn.png
:image: folder-open.svg
The ``cover`` component is a generic representation of covers in ESPHome.
A cover can (currently) either be *closed* or *open* and supports three types of

2
components/cover/template.rst
View File

@ -3,7 +3,7 @@ Template Cover
.. seo::
:description: Instructions for setting up template covers in ESPHome.
:image: description.png
: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

2
components/cover/time_based.rst
View File

@ -3,7 +3,7 @@ Time-Based Cover
.. seo::
:description: Instructions for setting up time-based covers in ESPHome.
:image: timer.png
:image: timer.svg
The ``time_based`` cover platform allows you to create covers with position control that do not
have any position feedback. The state of the cover is thus always an assumed one, the current

2
components/debug.rst
View File

@ -3,7 +3,7 @@ Debug Component
.. seo::
:description: Instructions for setting up the debug component in ESPHome
:image: bug-report.png
:image: bug-report.svg
The ``debug`` component can be used to debug problems with ESPHome. At startup, it prints
a bunch of useful information like reset reason, free heap size, ESPHome version and so on.

2
components/deep_sleep.rst
View File

@ -5,7 +5,7 @@ Deep Sleep Component
.. seo::
:description: Instructions for setting up the deep sleep support for minimizing power consumption on ESPs.
:image: hotel.png
: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

2
components/demo.rst
View File

@ -3,7 +3,7 @@ Demo Integration
.. seo::
:description: Instructions for setting up the demo integration in ESPHome
:image: description.png
:image: description.svg
The ``demo`` integration can be used for testing to generate sample instances of many
different integrations (sensors, lights, ...)

2
components/dfplayer.rst
View File

@ -3,7 +3,7 @@ DF-Player mini
.. seo::
:description: Instructions for setting up DF Player Mini integration in ESPHome.
:image: crosshair-gps.png
:image: dfplayer.svg
The ``dfplayer`` (`datasheet <https://wiki.dfrobot.com/DFPlayer_Mini_SKU_DFR0299>`__), component
allows you to play sound and music stored in an SD card or USB flash drive.

2
components/display/ili9341.rst
View File

@ -3,7 +3,7 @@ ILI9341 TFT LCD
.. seo::
:description: Instructions for setting up ILI9341 TFT LCD display drivers.
:image: ili9341-full.jpg
:image: ili9341.jpg
.. _ili9341:

2
components/display/index.rst
View File

@ -3,7 +3,7 @@ Display Component
.. seo::
:description: Instructions for setting up the display integration.
:image: folder-open.png
:image: folder-open.svg
The ``display`` component houses ESPHome's powerful rendering and display
engine. Fundamentally, there are these types of displays:

2
components/display/st7735.rst
View File

@ -4,7 +4,7 @@ ST7735 Display
.. seo::
:description: Instructions for setting up a ST7735 display drivers.
:keywords: ST7735
:image: ST7735.png
:image: st7735.jpg
ST7735 Display Driver.

2
components/display/st7789v.rst
View File

@ -3,7 +3,7 @@ ST7789V TFT LCD
.. seo::
:description: Instructions for setting up ST7789V TFT LCD display drivers.
:image: st7789v-full.jpg
:image: st7789v.jpg
.. _st7789v:

8
components/esp32.rst
View File

@ -3,7 +3,7 @@ ESP32 Platform
.. seo::
:description: Configuration for the ESP32 platform for ESPHome.
:image: esp32.png
:image: esp32.svg
This component contains platform-specific options for the ESP32 platform.
@ -18,7 +18,7 @@ Configuration variables:
- **board** (**Required**, string): The PlatformIO board ID that should
be used. Choose the appropriate board from
`this list <https://platformio.org/boards?count=1000&filter%5Bplatform%5D=espressif32>`__.
`this list <https://platformio.org/boards?count=1000&filter%5Bplatform%5D=espressif32>`__.
*This only affects pin aliases, flash size and some internal settings*, if unsure choose a generic board.
- **framework** (*Optional*): Options for the underlying framework used by ESPHome.
See :ref:`esp32-arduino_framework` and :ref:`esp32-espidf_framework`.
@ -42,7 +42,7 @@ This is the default framework for ESP32 chips at the moment.
type: arduino
version: 2.0.0
- **version** (*Optional*, string): The base framework version number to use, from
- **version** (*Optional*, string): The base framework version number to use, from
`ESP32 arduino releases <https://github.com/espressif/arduino-esp32/releases>`__. Defaults to ``recommended``. Additional values are:
- ``dev``: Use the latest commit from https://github.com/espressif/arduino-esp32, note this may break at any time
@ -72,7 +72,7 @@ of the ESP32 like ESP32S2, ESP32S3, ESP32C3 and single-core ESP32 chips.
sdkconfig_options:
CONFIG_COMPILER_OPTIMIZATION_SIZE: y
- **version** (*Optional*, string): The base framework version number to use, from
- **version** (*Optional*, string): The base framework version number to use, from
`ESP32 ESP-IDF releases <https://github.com/espressif/esp-idf/releases>`__. Defaults to ``recommended``. Additional values are:
- ``dev``: Use the latest commit from https://github.com/espressif/esp-idf, note this may break at any time

2
components/esp32_ble_beacon.rst
View File

@ -3,7 +3,7 @@ ESP32 Bluetooth Low Energy Beacon
.. seo::
:description: Instructions for setting up Bluetooth Low Energy iBeacons using the BLE feature on ESP32s.
:image: bluetooth.png
: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

2
components/esp32_ble_tracker.rst
View File

@ -3,7 +3,7 @@ ESP32 Bluetooth Low Energy Tracker Hub
.. seo::
:description: Instructions for setting up ESP32 bluetooth low energy device trackers using ESPHome.
:image: bluetooth.png
: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.

2
components/esp32_camera.rst
View File

@ -3,7 +3,7 @@ ESP32 Camera Component
.. seo::
:description: Instructions for setting up the ESP32 Cameras in ESPHome
:image: camera.png
:image: camera.svg
The ``esp32_camera`` component allows you to use ESP32-based camera boards in ESPHome that
directly integrate into Home Assistant through the native API.

2
components/esp32_camera_web_server.rst
View File

@ -3,7 +3,7 @@ ESP32 Camera Web Server Component
.. seo::
:description: Instructions for setting up the ESP32 Camera Web Server in ESPHome
:image: camera.png
:image: camera.svg
The ``esp32_camera_web_server`` component allows you to use expose web server of
ESP32-based camera boards in ESPHome that directly can be integrated into external

6
components/esp8266.rst
View File

@ -3,7 +3,7 @@ ESP8266 Platform
.. seo::
:description: Configuration for the ESP8266 platform for ESPHome.
:image: esp8266.png
:image: esp8266.svg
This component contains platform-specific options for the ESP8266 platform.
@ -20,11 +20,11 @@ Configuration variables:
- **board** (**Required**, string): The PlatformIO board ID that should
be used. Choose the appropriate board from
`this list <https://platformio.org/boards?count=1000&filter%5Bplatform%5D=espressif8266>`__.
`this list <https://platformio.org/boards?count=1000&filter%5Bplatform%5D=espressif8266>`__.
*This only affects pin aliases, flash size and some internal settings*, if unsure choose a generic board.
- **framework** (*Optional*): Options for the underlying framework used by ESPHome.
- **version** (*Optional*, string): The base framework version number to use, from
- **version** (*Optional*, string): The base framework version number to use, from
`esp8266 arduino releases <https://github.com/esp8266/Arduino/releases>`__. Defaults to ``recommended``. Additional values
- ``dev``: Use the latest commit from https://github.com/esp8266/Arduino, note this may break at any time

2
components/esphome.rst
View File

@ -3,7 +3,7 @@ ESPHome Core Configuration
.. seo::
:description: Instructions for setting up the core ESPHome configuration.
:image: cloud-circle.png
:image: cloud-circle.svg
Here you specify some core information that ESPHome needs to create
firmwares. Most importantly, this is the section of the configuration

2
components/ethernet.rst
View File

@ -3,7 +3,7 @@ Ethernet Component
.. seo::
:description: Instructions for setting up the Ethernet configuration for your ESP32 node in ESPHome.
:image: ethernet.png
:image: ethernet.svg
:keywords: Ethernet, ESP32
This core ESPHome component sets up ethernet connections for ESP32s.

2
components/fan/binary.rst
View File

@ -3,7 +3,7 @@ Binary Fan
.. seo::
:description: Instructions for setting up binary fans.
:image: fan.png
:image: fan.svg
The ``binary`` fan platform lets you represent any binary :ref:`output` as a fan.

2
components/fan/hbridge.rst
View File

@ -3,7 +3,7 @@ H-bridge Fan
.. seo::
:description: Instructions for setting up hbridge controlled fans (or motors).
:image: fan.png
:image: fan.svg
The `'hbridge`' fan platform allows you to use a compatible `h-bridge` (L298N, DRV8871, MX1508, BTS7960, L9110S, DRV8833, TB6612, etc.) to control a fan (or motor/solenoid).

2
components/fan/index.rst
View File

@ -3,7 +3,7 @@ Fan Component
.. seo::
:description: Instructions for setting up the base fan component.
:image: folder-open.png
: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

2
components/fan/speed.rst
View File

@ -3,7 +3,7 @@ Speed Fan
.. seo::
:description: Instructions for setting up speed-controllable fans.
:image: fan.png
:image: fan.svg
The ``speed`` fan platform lets you represent any float :ref:`output` as a fan that
supports speed settings.

2
components/fingerprint_grow.rst
View File

@ -3,7 +3,7 @@ Grow Fingerprint Reader
.. seo::
:description: Instructions for setting up Grow Fingerprint Reader integration in ESPHome.
:image: fingerprint.png
:image: fingerprint.svg
The ``fingerprint_grow`` component allows you to use your R307, R503, ZFM-20, ... fingerprint sensors with ESPHome.

2
components/gps.rst
View File

@ -3,7 +3,7 @@ GPS Component
.. seo::
:description: Instructions for setting up GPS integration in ESPHome.
:image: crosshair-gps.png
:image: crosshairs-gps.svg
The ``gps`` component allows you to connect GPS modules to your ESPHome project.
Any GPS module that uses the standardized NMEA communication protocol will work.

2
components/http_request.rst
View File

@ -3,7 +3,7 @@ HTTP Request
.. seo::
:description: Instructions for setting up HTTP Requests in ESPHome
:image: connection.png
:image: connection.svg
:keywords: http, request

2
components/i2c.rst
View File

@ -5,7 +5,7 @@ I²C Bus
.. seo::
:description: Instructions for setting up the I²C bus to communicate with 2-wire devices in ESPHome
:image: i2c.png
:image: i2c.svg
:keywords: i2c, iic, bus
This component sets up the I²C bus for your ESP32 or ESP8266. In order for these components

2
components/light/binary.rst
View File

@ -3,7 +3,7 @@ Binary Light
.. seo::
:description: Instructions for setting up binary ON/OFF lights in ESPHome.
:image: lightbulb.png
:image: lightbulb.svg
The ``binary`` light platform creates a simple ON/OFF-only light from a
:ref:`binary output component <output>`.

2
components/light/color_temperature.rst
View File

@ -3,7 +3,7 @@ Color Temperature Light
.. seo::
:description: Instructions for setting up Color Temperature lights.
:image: brightness-medium.png
:image: brightness-medium.svg
The ``color_temperature`` light platform creates a Color Temperature
light from 2 :ref:`float output components <output>`. One channel controls the LED temperature,

2
components/light/cwww.rst
View File

@ -3,7 +3,7 @@ Cold White + Warm White Light
.. seo::
:description: Instructions for setting up Cold White + Warm White lights.
:image: brightness-medium.png
:image: brightness-medium.svg
The ``cwww`` light platform creates a cold white + warm white light from 2
:ref:`float output components <output>` (one for each channel). The two channels

2
components/light/fastled.rst
View File

@ -3,7 +3,7 @@ FastLED Light
.. seo::
:description: Instructions for setting up FastLED addressable lights like NEOPIXEL.
:image: color_lens.png
:image: color_lens.svg
.. _fastled-clockless:

2
components/light/hbridge.rst
View File

@ -3,7 +3,7 @@ H-bridge Light
.. seo::
:description: Instructions for setting up a hbridge light.
:image: brightness-medium.png
:image: brightness-medium.svg
The ``hbridge`` light platform creates a dual color brightness controlled light from two
:ref:`float output component <output>`.

2
components/light/index.rst
View File

@ -3,7 +3,7 @@ Light Component
.. seo::
:description: Instructions for setting up lights and light effects in ESPHome.
:image: folder-open.png
:image: folder-open.svg
The ``light`` domain in ESPHome lets you create lights that will
automatically be shown in Home Assistant’s frontend and have many

2
components/light/monochromatic.rst
View File

@ -3,7 +3,7 @@ Monochromatic Light
.. seo::
:description: Instructions for setting up monochromatic (brightness-only) lights.
:image: brightness-medium.png
:image: brightness-medium.svg
The ``monochromatic`` light platform creates a simple brightness-only light from an
:ref:`float output component <output>`.

2
components/light/neopixelbus.rst
View File

@ -3,7 +3,7 @@ NeoPixelBus Light
.. seo::
:description: Instructions for setting up Neopixel addressable lights.
:image: color_lens.png
:image: color_lens.svg
The ``neopixelbus`` light platform allows you to create RGB lights
in ESPHome for an individually addressable lights like NeoPixel or WS2812.

2
components/light/partition.rst
View File

@ -3,7 +3,7 @@ Light Partition
.. seo::
:description: Instructions for setting up light partitions.
:image: color_lens.png
:image: color_lens.svg
The ``partition`` light platform allows you to combine multiple addressable light segments
(like :doc:`fastled` or :doc:`neopixelbus`) and/or individual lights (like :doc:`rgb`) into a single addressable light.

10
components/light/status_led.rst
View File

@ -3,14 +3,14 @@ Status LED Light
.. seo::
:description: Instructions for setting up a Status LED shared also as binary ON/OFF light in ESPHome.
:image: led-on.png
:image: led-on.svg
The ``status_led`` light platform allows to share a single LED for indicating the status of
the device (when on error/warning state) or as binary light (when on OK state).
the device (when on error/warning state) or as binary light (when on OK state).
This is useful for devices with only one LED available.
It provides the combined functionality of :doc:`status_led component </components/status_led>` and a
:doc:`binary light component </components/light/binary>` over a single shared GPIO led.
It provides the combined functionality of :doc:`status_led component </components/status_led>` and a
:doc:`binary light component </components/light/binary>` over a single shared GPIO led.
When the device is on error/warning state, the function of ``status_led`` will take precedence and control the blinking of the LED.
When the device is in OK state, the LED will be restored to the state of the ``binary light`` function and can be controlled as such.
@ -26,7 +26,7 @@ When the device is in OK state, the LED will be restored to the state of the ``b
.. note::
When using this platform the high level ``status_led`` component should not be included (at least over the same pin),
as its functionality is directly provided by this platform.
as its functionality is directly provided by this platform.
The only difference is that the platform won't be loaded in OTA safe mode, while the component would be.

2
components/light/tuya.rst
View File

@ -3,7 +3,7 @@ Tuya Dimmer
.. seo::
:description: Instructions for setting up a Tuya dimmer switch.
:image: brightness-medium.png
:image: brightness-medium.svg
The ``tuya`` light platform creates a simple brightness-only light from a
tuya serial component.

2
components/logger.rst
View File

@ -3,7 +3,7 @@ Logger Component
.. seo::
:description: Instructions for setting up the central logging component in ESPHome.
:image: file-document-box.png
: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

2
components/mcp230xx.rst
View File

@ -3,7 +3,7 @@ MCP230xx I/O Expander
.. seo::
:description: Instructions for setting up MCP23008, MCP23016 or MCP23017 digital port expander in ESPHome.
:image: mcp230xx.png
:image: mcp230xx.svg
The Microchip MCP230xx series of general purpose, parallel I/O expansion for I²C bus applications.

2
components/mcp23Sxx.rst
View File

@ -3,7 +3,7 @@ MCP23Sxx I/O Expander
.. seo::
:description: Instructions for setting up MCP23S08, MCP23S16 or MCP23S17 digital port expander in ESPHome. This is exactly the same API as the MCP23SXX I/O Expander except talks on the SPI bus
:image: mcp23Sxx.png
:image: mcp230xx.svg
The Microchip MCP23Sxx series of general purpose, parallel I/O expansion for SPI bus applications.
This is exactly the same API as the MCP23SXX I/O Expander except talks on the SPI bus

2
components/number/index.rst
View File

@ -3,7 +3,7 @@ Number Component
.. seo::
:description: Instructions for setting up number components in ESPHome.
:image: folder-open.png
:image: folder-open.svg
ESPHome has support for components to create a number entity. A number entity is
like a sensor that can read a value from a device, but is useful when that value

1
components/number/modbus_controller.rst
View File

@ -3,7 +3,6 @@ Modbus Controller Number
.. seo::
:description: Instructions for setting up a modbus_controller device sensor.
:image: modbus_controller.png
The ``modbus_controller`` platform creates a Number from a modbus_controller.
When the Number is updated a modbus write command is created sent to the device.

2
components/number/template.rst
View File

@ -3,7 +3,7 @@ Template Number
.. seo::
:description: Instructions for setting up template numbers with ESPHome.
:image: description.png
:image: description.svg
The ``template`` number platform allows you to create a number with templated values
using :ref:`lambdas <config-lambda>`.

2
components/ota.rst
View File

@ -3,7 +3,7 @@ OTA Update Component
.. seo::
:description: Instructions for setting up Over-The-Air (OTA) updates for ESPs to upload firmwares remotely.
:image: system-update.png
:image: system-update.svg
.. _config-ota:

2
components/output/gpio.rst
View File

@ -3,7 +3,7 @@ GPIO Output
.. seo::
:description: Instructions for setting up binary outputs for GPIO pins.
:image: pin.png
: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

2
components/output/index.rst
View File

@ -5,7 +5,7 @@ Output Component
.. seo::
:description: Instructions for setting up generic outputs in ESPHome
:image: folder-open.png
:image: folder-open.svg
Each platform of the ``output`` domain exposes some output to
ESPHome. These are grouped into two categories: ``binary`` outputs

2
components/output/mcp4725.rst
View File

@ -3,7 +3,7 @@ MCP4725 Output
.. seo::
:description: Instructions for setting up MCP4725 outputs on the ESP.
:image: mcp4725.png
:image: mcp4725.jpg
The MCP4725 output component allows to use `12bit external DAC
<https://learn.sparkfun.com/tutorials/mcp4725-digital-to-analog-converter-hookup-guide/all>`__

1
components/output/modbus_controller.rst
View File

@ -3,7 +3,6 @@ Modbus Controller Output
.. seo::
:description: Instructions for setting up a modbus_controller device sensor.
:image: modbus_controller.png
The ``modbus_controller`` platform creates a output from a modbus_controller.

2
components/output/my9231.rst
View File

@ -3,7 +3,7 @@ MY9231/MY9291 LED driver
.. seo::
:description: Instructions for setting up MY9231 and MY9291 LED drives in ESPHome.
:image: my9231.png
:image: my9231.svg
:keywords: MY9231, MY9291, Sonoff B1, Ai-thinker AiLight WiFi light bulb, Arilux E27 Smart Bulb
.. _my9231-component:

2
components/output/sm16716.rst
View File

@ -3,7 +3,7 @@ SM16716 LED driver
.. seo::
:description: Instructions for setting up SM16716 LED drivers in ESPHome.
:image: sm16716.png
:image: sm16716.svg
:keywords: SM16716, Feit Electric A19 Smart WiFi Bulb, Merkury Innovations A21 Smart Wi-Fi Bulb
.. _sm16716-component:

2
components/output/template.rst
View File

@ -3,7 +3,7 @@ Template Output
.. seo::
:description: Instructions for setting up template outputs with ESPHome.
:image: description.png
:image: description.svg
The ``template`` output component can be used to create templated binary and float outputs in ESPHome.

2
components/output/tlc5947.rst
View File

@ -3,7 +3,7 @@ TLC5947 LED driver
.. seo::
:description: Instructions for setting up TLC5947 LED drivers in ESPHome.
:image: images/tlc5947.jpg
:image: tlc5947.jpg
:keywords: tlc5947,
.. _tlc5947-component:

2
components/power_supply.rst
View File

@ -3,7 +3,7 @@ Power Supply Component
.. seo::
:description: Instructions for setting up power supplies which will automatically turn on together with outputs.
:image: power.png
:image: power.svg
:keywords: power, ATX
The ``power_supply`` component allows you to have a high power mode for

2
components/prometheus.rst
View File

@ -3,7 +3,7 @@ Prometheus Component
.. seo::
:description: Instructions for setting up a prometheus exporter with ESPHome.
:image: prometheus.png
:image: prometheus.svg
The ``prometheus`` component enables an HTTP endpoint for the
:doc:`web_server` in order to integrate a `Prometheus <https://prometheus.io/>`__ installation.

2
components/remote_receiver.rst
View File

@ -3,7 +3,7 @@ Remote Receiver
.. seo::
:description: Instructions for setting up remote receiver binary sensors for infrared and RF codes.
:image: remote.png
:image: remote.svg
:keywords: RF, infrared
The ``remote_receiver`` component lets you receive and decode any remote signal, these can

2
components/remote_transmitter.rst
View File

@ -3,7 +3,7 @@ Remote Transmitter
.. seo::
:description: Instructions for setting up switches that send out pre-defined sequences of IR or RF signals
:image: remote.png
:image: remote.svg
:keywords: Infrared, IR, RF, Remote, TX
The ``remote_transmitter`` component lets you send digital packets to control

2
components/rtttl.rst
View File

@ -3,7 +3,7 @@ Rtttl Buzzer
.. seo::
:description: Instructions for setting up a buzzer to play tones and rtttl songs with ESPHome.
:image: crosshair-gps.png
:image: buzzer.jpg
The ``rtttl``, component allows you to easily connect a passive piezo buzzer to your microcontroller
and play monophonic songs. It accepts the Ring Tone Text Transfer Language, rtttl format (`Wikipedia

2
components/select/index.rst
View File

@ -3,7 +3,7 @@ Select Component
.. seo::
:description: Instructions for setting up select components in ESPHome.
:image: folder-open.png
:image: folder-open.svg
ESPHome has support for components to create a select entity. A select entity is
basically an option list that can be set by either yaml, hardware or the user/frontend.

2
components/select/template.rst
View File

@ -3,7 +3,7 @@ Template Select
.. seo::
:description: Instructions for setting up Template Select(s) with ESPHome.
:image: description.png
:image: description.svg
The ``template`` Select platform allows you to create a Select with templated values
using :ref:`lambdas <config-lambda>`.

2
components/sensor/adc.rst
View File

@ -3,7 +3,7 @@ Analog To Digital Sensor
.. seo::
:description: Instructions for setting up built-in analog voltage sensors.
:image: flash.png
: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

2
components/sensor/ade7953.rst
View File

@ -3,7 +3,7 @@ ADE7953 Power Sensor
.. seo::
:description: Instructions for setting up ADE7953 power sensors
:image: ade7953.png
:image: ade7953.svg
.. note::

2
components/sensor/am43.rst
View File

@ -3,7 +3,7 @@ AM43 Sensor
.. seo::
:description: Sensors on AM43/BLE covers in ESPHome.
:image: am43.png
:image: am43.jpg
The ``am43`` sensor platform allows you to read the light and
battery sensors on an AM43 BLE cover motor. The platform connects

2
components/sensor/as3935.rst
View File

@ -3,7 +3,7 @@ AMS AS3935 Franklin Lightning Sensor
.. seo::
:description: Instructions for setting up AS3935 lightning sensor
:image: images/as3935.jpg
:image: as3935.jpg
:keywords: as3935
The **AS3935** sensor platform allows you to use your AS3935 sensor

2
components/sensor/atm90e32.rst
View File

@ -3,7 +3,7 @@ ATM90E32 Power Sensor
.. seo::
:description: Instructions for setting up ATM90E32 energy metering sensors
:image: atm90e32.png
:image: atm90e32.jpg
:keywords: ATM90E32, CircuitSetup, Split Single Phase Real Time Whole House Energy Meter, Expandable 6 Channel ESP32 Energy Meter Main Board
The ``atm90e32`` sensor platform allows you to use your ATM90E32 voltage/current and power sensors

2
components/sensor/ble_rssi.rst
View File

@ -3,7 +3,7 @@ ESP32 Bluetooth Low Energy RSSI Sensor
.. seo::
:description: Instructions for setting up RSSI sensors for the ESP32 BLE.
:image: bluetooth.png
:image: bluetooth.svg
:keywords: ESP32
The ``ble_rssi`` sensor platform lets you track the RSSI value or signal strength of a

2
components/sensor/cse7761.rst
View File

@ -3,7 +3,7 @@ CSE7761 Power Sensor
.. seo::
:description: Instructions for setting up CSE7761 power sensors for the Sonoff Dual R3 v1.x
:image: cse7761.png
:image: cse7761.svg
:keywords: cse7761, Sonoff Dual R3
The ``cse7761`` sensor platform allows you to use your CSE7761 voltage/current and power sensors

2
components/sensor/cse7766.rst
View File

@ -3,7 +3,7 @@ CSE7766 Power Sensor
.. seo::
:description: Instructions for setting up CSE7766 power sensors for the Sonoff Pow R2
:image: cse7766.png
:image: cse7766.svg
:keywords: cse7766, cse7759b, Sonoff Pow R2
The ``cse7766`` sensor platform allows you to use your CSE7766 voltage/current and power sensors

2
components/sensor/custom.rst
View File

@ -3,7 +3,7 @@ Custom Sensor Component
.. seo::
:description: Instructions for setting up Custom C++ sensors with ESPHome.
:image: language-cpp.png
:image: language-cpp.svg
:keywords: C++, Custom
.. warning::

2
components/sensor/dsmr.rst
View File

@ -3,7 +3,7 @@ DSMR Component
.. seo::
:description: Instructions for setting up DSMR Meter component in ESPHome.
:image: dsmr.png
:image: dsmr.svg
Component/Hub
*************

2
components/sensor/duty_cycle.rst
View File

@ -3,7 +3,7 @@ Duty Cycle Sensor
.. seo::
:description: Instructions for setting up duty cycle sensors in ESPHome
:image: percent.png
: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.

2
components/sensor/esp32_hall.rst
View File

@ -3,7 +3,7 @@ ESP32 Hall Sensor
.. seo::
:description: Instructions for setting up the integrated hall-effect sensor of the ESP32.
:image: magnet.png
:image: magnet.svg
:keywords: esp32, hall
The ``esp32_hall`` sensor platform allows you to use the integrated

2
components/sensor/havells_solar.rst
View File

@ -3,7 +3,7 @@ Havells Solar
.. seo::
:description: Instructions for setting up Havells inverter reading on modbus.
:image: images/havellsgti5000d.jpg
:image: havellsgti5000d_s.jpg
:keywords: Havells Enviro, Havells GTI
The ``Havells Inverter`` sensor platform allows you to use Havells inverter data reading on modbus

2
components/sensor/hlw8012.rst
View File

@ -3,7 +3,7 @@ HLW8012 Power Sensor
.. seo::
:description: Instructions for setting up HLW8012 power sensors for the Sonoff Pow R1
:image: hlw8012.png
:image: hlw8012.svg
:keywords: HLW8012, CSE7759, BL0937, Sonoff Pow R1
The ``hlw8012`` sensor platform allows you to use your HLW8012 voltage/current and power sensors

2
components/sensor/hm3301.rst
View File

@ -3,7 +3,7 @@ The Grove - Laser PM2.5 Sensor (HM3301)
.. seo::
:description: Instructions for setting up HM3301 Particulate matter sensor
:image: hm3301.png
:image: hm3301.jpg
The ``HM3301`` sensor platform allows you to use your HM3301 particulate matter sensor
(`more info <http://wiki.seeedstudio.com/Grove-Laser_PM2.5_Sensor-HM3301>`__)

2
components/sensor/homeassistant.rst
View File

@ -3,7 +3,7 @@ Home Assistant Sensor
.. seo::
:description: Instructions for setting up Home Assistant sensors with ESPHome that import states from your Home Assistant instance.
:image: home-assistant.png
:image: home-assistant.svg
The ``homeassistant`` sensor platform allows you to create sensors that import
states from your Home Assistant instance using the :doc:`native API </components/api>`.

2
components/sensor/hx711.rst
View File

@ -3,7 +3,7 @@ HX711 Load Cell Amplifier
.. seo::
:description: Instructions for setting up HX711 load cell amplifiers with ESPHome
:image: hx711.png
:image: hx711.jpg
:keywords: HX711
The ``hx711`` sensor platform allows you to use your HX711

2
components/sensor/index.rst
View File

@ -3,7 +3,7 @@ Sensor Component
.. seo::
:description: Instructions for setting up sensor components in ESPHome.
:image: folder-open.png
:image: folder-open.svg
ESPHome has support for many different sensors. Each of them is a
platform of the ``sensor`` domain and each sensor has several base

2
components/sensor/integration.rst
View File

@ -3,7 +3,7 @@ Integration Sensor
.. seo::
:description: Instructions for setting up sensors that integrate values over time.
:image: sigma.png
:image: sigma.svg
The ``integration`` sensor is a helper sensor that can integrate values from other sensors over
time. This can for example be useful to integrate the values of a water flow sensor (in m^3/s) over

2
components/sensor/ltr390.rst
View File

@ -3,7 +3,7 @@ LTR390 UV and Ambient Light Sensor
.. seo::
:description: Instructions for setting up LTR390 UV and light sensor
:image: images/ltr390-full.jpg
:image: ltr390.jpg
The ``ltr390`` sensor platform allows you to use your LTR390 UV and ambient
light sensor

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