Skip to content

Commit 6053f49

Browse files
OttoWinterjesserockz
OttoWinter
and
jesserockz
authored
Update svg2png and seo.py (esphome#1380)
Co-authored-by: Jesse Hills <[email protected]>
1 parent 22ada42 commit 6053f49

File tree

191 files changed

+231
-241
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

191 files changed

+231
-241
lines changed

‎components/api.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Native API Component
33

44
.. seo::
55
:description: Instructions for setting up the native ESPHome API for communication with Home Assistant.
6-
:image: server-network.png
6+
:image: server-network.svg
77
:keywords: Native API, ESPHome, Home Assistant
88

99
The ESPHome native API is used to communicate with clients directly, with a highly-optimized

‎components/binary_sensor/ble_presence.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ ESP32 Bluetooth Low Energy Device
33

44
.. seo::
55
:description: Instructions for setting up BLE binary sensors for the ESP32.
6-
:image: bluetooth.png
6+
:image: bluetooth.svg
77

88
The ``ble_presence`` binary sensor platform lets you track the presence of a
99
Bluetooth Low Energy device.

‎components/binary_sensor/esp32_touch.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ ESP32 Touch Pad
33

44
.. seo::
55
:description: Instructions for setting up the touch pad on the ESP32.
6-
:image: touch.png
6+
:image: touch.svg
77

88
.. _esp32-touch-component:
99

‎components/binary_sensor/gpio.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ GPIO Binary Sensor
33

44
.. seo::
55
:description: Instructions for setting up GPIO binary sensors with ESPHome.
6-
:image: pin.png
6+
:image: pin.svg
77

88
The GPIO Binary Sensor platform allows you to use any input pin on your
99
device as a binary sensor.

‎components/binary_sensor/homeassistant.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Home Assistant Binary Sensor
33

44
.. seo::
55
:description: Instructions for setting up Home Assistant binary sensors with ESPHome that import states from your Home Assistant instance.
6-
:image: home-assistant.png
6+
:image: home-assistant.svg
77

88
The ``homeassistant`` binary sensor platform allows you to create binary sensors that **import**
99
states from your Home Assistant instance using the :doc:`native API </components/api>`.

‎components/binary_sensor/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Binary Sensor Component
33

44
.. seo::
55
:description: Information about the base representation of all binary sensors.
6-
:image: folder-open.png
6+
:image: folder-open.svg
77

88
With ESPHome you can use different types of binary sensors. They will
99
automatically appear in the Home Assistant front-end and have several

‎components/binary_sensor/status.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Status Binary Sensor
33

44
.. seo::
55
:description: Instructions for setting up MQTT status binary sensors.
6-
:image: server-network.png
6+
:image: server-network.svg
77

88
The Status Binary Sensor exposes the node state (if it’s connected to via MQTT/native API)
99
for Home Assistant.

‎components/binary_sensor/template.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Template Binary Sensor
33

44
.. seo::
55
:description: Instructions for setting up template binary sensors.
6-
:image: description.png
6+
:image: description.svg
77

88
The ``template`` binary sensor platform allows you to define any :ref:`lambda template <config-lambda>`
99
and construct a binary sensor out if it.

‎components/canbus.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ CAN bus
55

66
.. seo::
77
:description: Instructions for setting up an CAN bus in ESPHome
8-
:image: canbus.png
8+
:image: canbus.svg
99
:keywords: CAN
1010

1111
Controller Area Network (CAN bus) is a serial bus protocol to connect individual systems and sensors

‎components/captive_portal.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Captive Portal
33

44
.. seo::
55
:description: Instructions for setting up the Captive Portal fallback mechanism in ESPHome.
6-
:image: wifi-strength-alert-outline.png
6+
:image: wifi-strength-alert-outline.svg
77

88
The captive portal component in ESPHome is a fallback mechanism for when connecting to the
99
configured :doc:`WiFi <wifi>` fails.

‎components/climate/bang_bang.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Bang Bang Climate Controller
33

44
.. seo::
55
:description: Instructions for setting up Bang Bang climate controllers with ESPHome.
6-
:image: air-conditioner.png
6+
:image: air-conditioner.svg
77

88
The ``bang_bang`` climate platform allows you to regulate a value with a
99
`bang-bang controller <https://en.wikipedia.org/wiki/Bang%E2%80%93bang_control>`__ (also called hysteresis controller).

‎components/climate/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Climate Component
33

44
.. seo::
55
:description: Information about the base representation of all climate devices.
6-
:image: folder-open.png
6+
:image: folder-open.svg
77

88
ESPHome has support for climate devices. Climate devices can represent different types of
99
hardware, but the defining factor is that climate devices have a settable target temperature

‎components/climate/ir_climate.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ IR Remote Climate
33

44
.. seo::
55
:description: Controls a variety of compatible Climate devices via IR
6-
:image: air-conditioner-ir.png
6+
:image: air-conditioner-ir.svg
77

88
This climate component allows you to control compatible AC units by sending an infrared (IR)
99
control signal, just as the unit's handheld remote controller would.

‎components/climate/midea.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Midea Air Conditioner
33

44
.. seo::
55
:description: Instructions for setting up a Midea climate device
6-
:image: air-conditioner.png
6+
:image: air-conditioner.svg
77

88
The ``midea`` component creates a Midea air conditioner climate device.
99

‎components/climate/pid.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ PID Climate
33

44
.. seo::
55
:description: Instructions for setting up PID climate controllers with ESPHome.
6-
:image: function.png
6+
:image: function.svg
77

88
The ``pid`` climate platform allows you to regulate a value with a
99
`PID controller <https://en.wikipedia.org/wiki/PID_controller>`__.

‎components/climate/thermostat.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Thermostat Climate Controller
33

44
.. seo::
55
:description: Instructions for setting up Thermostat climate controllers with ESPHome.
6-
:image: air-conditioner.png
6+
:image: air-conditioner.svg
77

88
The ``thermostat`` climate platform allows you to control a climate control system in much the same manner as a
99
physical thermostat. Its operation is similar to the :doc:`bang-bang <bang_bang>` controller; a sensor measures a value

‎components/climate/tuya.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Tuya Climate
33

44
.. seo::
55
:description: Instructions for setting up a Tuya climate device.
6-
:image: air-conditioner.png
6+
:image: air-conditioner.svg
77

88
The ``tuya`` climate platform creates a climate device from a tuya component.
99

‎components/cover/am43.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ AM43 Cover
33

44
.. seo::
55
:description: Setting up AM43/BLE covers in ESPHome.
6-
:image: am43.png
6+
:image: am43.jpg
77

88
The ``am43`` cover platform allows you to control an AM43 based
99
BLE cover motor. These devices are sold under various brands, such

‎components/cover/current_based.rst

+31-35
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@ Current Based Cover
33

44
.. seo::
55
:description: Instructions for setting up current-based covers in ESPHome.
6-
:image: window-open.jpg
6+
:image: window-open.svg
77

88
The ``current_based`` cover platform allows you to create covers with position control by using current
9-
sensors to detect the fully-open and fully-closed states. This is pretty useful when using motors with
10-
integrated mechanical endstops. During cover operation, the component monitors the current consumption
11-
to detect when the motor has stopped.
9+
sensors to detect the fully-open and fully-closed states. This is pretty useful when using motors with
10+
integrated mechanical endstops. During cover operation, the component monitors the current consumption
11+
to detect when the motor has stopped.
1212

13-
When fully open or close is requested, the corresponding relay will stay on until the current the motor is
13+
When fully open or close is requested, the corresponding relay will stay on until the current the motor is
1414
consuming goes below a certain amount. The amount of current needs to be specified in the configuration.
1515

1616
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
1919
:align: center
2020
:width: 75.0%
2121

22-
This type of cover also provides safety features like current-based obstacle detection with automatic configurable
23-
rollback as well as relay malfunction detection: operation cancels if there's a current flowing in the opposite
24-
operation circuit (typically caused by welded relays).
22+
This type of cover also provides safety features like current-based obstacle detection with automatic configurable
23+
rollback as well as relay malfunction detection: operation cancels if there's a current flowing in the opposite
24+
operation circuit (typically caused by welded relays).
2525

2626
.. warning::
2727

28-
Depending on the cover and motor type, obstacles can physically damage the cover before being detectable.
29-
Verify your setup to ensure the current consumption will increase enough to be detectable before causing
28+
Depending on the cover and motor type, obstacles can physically damage the cover before being detectable.
29+
Verify your setup to ensure the current consumption will increase enough to be detectable before causing
3030
any physical damage. Use it at your own risk.
3131

3232
.. code-block:: yaml
@@ -56,7 +56,7 @@ operation circuit (typically caused by welded relays).
5656
5757
obstacle_rollback: 30%
5858
start_sensing_delay: 0.8s
59-
59+
6060
6161
6262
Configuration variables:
@@ -68,58 +68,54 @@ Configuration variables:
6868
be performed when the remote requests the cover to be opened.
6969
- **open_duration** (**Required**, :ref:`config-time`): The amount of time it takes the cover
7070
to open up from the fully-closed state.
71-
- **open_moving_current_threshold** (**Required**, float): The amount of current in Amps the motor
72-
should drain to consider the cover is opening.
73-
- **open_obstacle_current_threshold** (**Required**, float): The amount of current in Amps the motor
71+
- **open_moving_current_threshold** (**Required**, float): The amount of current in Amps the motor
72+
should drain to consider the cover is opening.
73+
- **open_obstacle_current_threshold** (**Required**, float): The amount of current in Amps the motor
7474
should drain to consider the cover is blocked during opening.
7575
- **close_sensor** (**Required**, :ref:`config-id`): The close current sensor.
7676
- **close_action** (*Optional*, :ref:`Action <config-action>`): The action that should
7777
be performed when the remote requests the cover to be closed.
7878
- **close_duration** (**Required**, :ref:`config-time`): The amount of time it takes the cover
7979
to close from the fully-open state.
80-
- **close_moving_current_threshold** (**Required**, float): The amount of current in Amps the motor
80+
- **close_moving_current_threshold** (**Required**, float): The amount of current in Amps the motor
8181
should drain to consider the cover is closing.
82-
- **close_obstacle_current_threshold** (**Required**, float): The amount of current in Amps the motor
82+
- **close_obstacle_current_threshold** (**Required**, float): The amount of current in Amps the motor
8383
should drain to consider the cover is blocked during closing.
8484
- **stop_action** (**Required**, :ref:`Action <config-action>`): The action that should
8585
be performed to stop the cover.
8686
- **max_duration** (*Optional*, :ref:`config-time`): The maximum duration the cover should be opening
8787
or closing. Useful for protecting from dysfunctional motor integrated endstops.
88-
- **start_sensing_delay** (*Optional*, :ref:`config-time`): The amount of time the current sensing will be
89-
disabled when the movement starts. Motors can take some time before reaching their average consumption.
90-
Low values can cause an immediate stop because of the first current reading happening in the current-rising period.
88+
- **start_sensing_delay** (*Optional*, :ref:`config-time`): The amount of time the current sensing will be
89+
disabled when the movement starts. Motors can take some time before reaching their average consumption.
90+
Low values can cause an immediate stop because of the first current reading happening in the current-rising period.
9191
Defaults to ``500ms``.
92-
- **obstacle_rollback** (*Optional*, percentage): The percentage of rollback the cover will perform in case of
92+
- **obstacle_rollback** (*Optional*, percentage): The percentage of rollback the cover will perform in case of
9393
obstacle detection. Defaults to ``10%``.
9494
- **malfunction_detection** (*Optional*, boolean): Enable to detect malfunction detection (Tipically welded realys). Defaults to ``True``.
9595
- **malfunction_action** (*Optional*, :ref:`Action <config-action>`): The action that should
96-
be performed when relay malfunction is detected. Malfunction may require device servicing. You can use this action
96+
be performed when relay malfunction is detected. Malfunction may require device servicing. You can use this action
9797
to notify other systems about this situation
9898
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
9999
- All other options from :ref:`Cover <config-cover>`.
100100

101101
Use with Shelly 2.5
102102
-------------------
103103

104-
.. seo::
105-
:description: Instructions for setting up current-based covers in ESPHome using a Shelly 2.5.
106-
:image: shelly2.5.png
107-
108104
The Shelly 2.5 is the perfect hardware for this platform. It features two outputs with current monitoring
109-
(thanks to an embedded :doc:`ADE7953 </components/sensor/ade7953>`) in a very small form factor (39mm x 36mm x 17 mm).
105+
(thanks to an embedded :doc:`ADE7953 </components/sensor/ade7953>`) in a very small form factor (39mm x 36mm x 17 mm).
110106
It also features an :doc:`NTC temperature sensor </components/sensor/ntc>`.
111107

112108
.. figure:: images/shelly2.5.png
113109
:align: center
114110
:width: 30.0%
115111

116-
These devices typically run hot (~55Cº at 20ºC room temperature). Long-term heavy loads (near to its rated limit) can overheat the device.
117-
It is strongly recommended to monitor the device temperature using the NTC temperature sensor, shutting down the device if it exceeds 90ºC.
112+
These devices typically run hot (~55Cº at 20ºC room temperature). Long-term heavy loads (near to its rated limit) can overheat the device.
113+
It is strongly recommended to monitor the device temperature using the NTC temperature sensor, shutting down the device if it exceeds 90ºC.
118114
This safety feature is also present in the original firmware.
119115

120116
.. warning::
121117

122-
The ADE7953 IRQ line is connected to the GPIO16. The ``irq_pin`` parameter for the :doc:`ADE7953 </components/sensor/ade7953>` MUST be
118+
The ADE7953 IRQ line is connected to the GPIO16. The ``irq_pin`` parameter for the :doc:`ADE7953 </components/sensor/ade7953>` MUST be
123119
set to GPIO16 to prevent device overheat (>70ºC idling).
124120

125121
Configuration example:
@@ -135,7 +131,7 @@ Configuration example:
135131
i2c:
136132
sda: GPIO12
137133
scl: GPIO14
138-
134+
139135
sensor:
140136
- platform: ade7953
141137
irq_pin: GPIO16
@@ -153,7 +149,7 @@ Configuration example:
153149
id: close_current
154150
internal: true
155151
update_interval: 0.5s
156-
152+
157153
# NTC Temperature
158154
- platform: ntc
159155
sensor: temp_resistance_reading
@@ -164,7 +160,7 @@ Configuration example:
164160
b_constant: 3350
165161
reference_resistance: 10kOhm
166162
reference_temperature: 298.15K
167-
on_value_range:
163+
on_value_range:
168164
above: 90
169165
then: # Security shutdown by overheating
170166
- switch.turn_on: _shutdown
@@ -182,7 +178,7 @@ Configuration example:
182178
internal: true
183179
184180
binary_sensor:
185-
- platform: gpio
181+
- platform: gpio
186182
pin:
187183
number: GPIO13
188184
name: Shelly 2.5 Open Button
@@ -243,8 +239,8 @@ Configuration example:
243239
malfunction_detection: true
244240
malfunction_action:
245241
then:
246-
- logger.log: "Malfunction detected. Relay welded."
247-
242+
- logger.log: "Malfunction detected. Relay welded."
243+
248244
249245
250246
status_led:

‎components/cover/endstop.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Endstop Cover
33

44
.. seo::
55
:description: Instructions for setting up time-based covers in ESPHome.
6-
:image: electric-switch.png
6+
:image: electric-switch.svg
77

88
The ``endstop`` cover platform allows you to create covers with position control that have
99
endstops at both ends of the cover to detect the fully-open and fully-closed states.

‎components/cover/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Cover Component
33

44
.. seo::
55
:description: Instructions for setting up base covers in ESPHome.
6-
:image: folder-opn.png
6+
:image: folder-open.svg
77

88
The ``cover`` component is a generic representation of covers in ESPHome.
99
A cover can (currently) either be *closed* or *open* and supports three types of

‎components/cover/template.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Template Cover
33

44
.. seo::
55
:description: Instructions for setting up template covers in ESPHome.
6-
:image: description.png
6+
:image: description.svg
77

88
The ``template`` cover platform allows you to create simple covers out of just a few
99
actions and a value lambda. Once defined, it will automatically appear in Home Assistant

‎components/cover/time_based.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Time-Based Cover
33

44
.. seo::
55
:description: Instructions for setting up time-based covers in ESPHome.
6-
:image: timer.png
6+
:image: timer.svg
77

88
The ``time_based`` cover platform allows you to create covers with position control that do not
99
have any position feedback. The state of the cover is thus always an assumed one, the current

‎components/debug.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Debug Component
33

44
.. seo::
55
:description: Instructions for setting up the debug component in ESPHome
6-
:image: bug-report.png
6+
:image: bug-report.svg
77

88
The ``debug`` component can be used to debug problems with ESPHome. At startup, it prints
99
a bunch of useful information like reset reason, free heap size, ESPHome version and so on.

‎components/deep_sleep.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Deep Sleep Component
55

66
.. seo::
77
:description: Instructions for setting up the deep sleep support for minimizing power consumption on ESPs.
8-
:image: hotel.png
8+
:image: hotel.svg
99

1010
The ``deep_sleep`` component can be used to automatically enter a deep sleep mode on the
1111
ESP8266/ESP32 after a certain amount of time. This is especially useful with nodes that operate

‎components/demo.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Demo Integration
33

44
.. seo::
55
:description: Instructions for setting up the demo integration in ESPHome
6-
:image: description.png
6+
:image: description.svg
77

88
The ``demo`` integration can be used for testing to generate sample instances of many
99
different integrations (sensors, lights, ...)

0 commit comments

Comments
 (0)