diff --git a/components/api.rst b/components/api.rst index 50bec505f..474b06fad 100644 --- a/components/api.rst +++ b/components/api.rst @@ -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 diff --git a/components/binary_sensor/ble_presence.rst b/components/binary_sensor/ble_presence.rst index 93fe5393f..ec531b8dd 100644 --- a/components/binary_sensor/ble_presence.rst +++ b/components/binary_sensor/ble_presence.rst @@ -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. diff --git a/components/binary_sensor/esp32_touch.rst b/components/binary_sensor/esp32_touch.rst index 5f137ba40..30b301d9b 100644 --- a/components/binary_sensor/esp32_touch.rst +++ b/components/binary_sensor/esp32_touch.rst @@ -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: diff --git a/components/binary_sensor/gpio.rst b/components/binary_sensor/gpio.rst index 7c869459f..96bbca3be 100644 --- a/components/binary_sensor/gpio.rst +++ b/components/binary_sensor/gpio.rst @@ -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. diff --git a/components/binary_sensor/homeassistant.rst b/components/binary_sensor/homeassistant.rst index db99d7637..f98924abd 100644 --- a/components/binary_sensor/homeassistant.rst +++ b/components/binary_sensor/homeassistant.rst @@ -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 `. diff --git a/components/binary_sensor/index.rst b/components/binary_sensor/index.rst index 30a6cec8b..133c1be10 100644 --- a/components/binary_sensor/index.rst +++ b/components/binary_sensor/index.rst @@ -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 diff --git a/components/binary_sensor/status.rst b/components/binary_sensor/status.rst index 9a873e58e..cdaac910a 100644 --- a/components/binary_sensor/status.rst +++ b/components/binary_sensor/status.rst @@ -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. diff --git a/components/binary_sensor/template.rst b/components/binary_sensor/template.rst index f83745c7b..55e62fd5f 100644 --- a/components/binary_sensor/template.rst +++ b/components/binary_sensor/template.rst @@ -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 ` and construct a binary sensor out if it. diff --git a/components/canbus.rst b/components/canbus.rst index 2a32675cd..d53d6ffeb 100644 --- a/components/canbus.rst +++ b/components/canbus.rst @@ -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 diff --git a/components/captive_portal.rst b/components/captive_portal.rst index cefd84933..f41324a96 100644 --- a/components/captive_portal.rst +++ b/components/captive_portal.rst @@ -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 ` fails. diff --git a/components/climate/bang_bang.rst b/components/climate/bang_bang.rst index 91555e84b..cbe696c9f 100644 --- a/components/climate/bang_bang.rst +++ b/components/climate/bang_bang.rst @@ -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 `__ (also called hysteresis controller). diff --git a/components/climate/index.rst b/components/climate/index.rst index 3a130a4da..3551fcf64 100644 --- a/components/climate/index.rst +++ b/components/climate/index.rst @@ -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 diff --git a/components/climate/ir_climate.rst b/components/climate/ir_climate.rst index 62db46695..6d4f05d01 100755 --- a/components/climate/ir_climate.rst +++ b/components/climate/ir_climate.rst @@ -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. diff --git a/components/climate/midea.rst b/components/climate/midea.rst index 33093243e..8525e0c50 100644 --- a/components/climate/midea.rst +++ b/components/climate/midea.rst @@ -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. diff --git a/components/climate/pid.rst b/components/climate/pid.rst index 23f57295d..a20de5579 100644 --- a/components/climate/pid.rst +++ b/components/climate/pid.rst @@ -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 `__. diff --git a/components/climate/thermostat.rst b/components/climate/thermostat.rst index 239ab383c..27a8a1102 100644 --- a/components/climate/thermostat.rst +++ b/components/climate/thermostat.rst @@ -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 ` controller; a sensor measures a value diff --git a/components/climate/tuya.rst b/components/climate/tuya.rst index 6a2843dc6..cbc00eba7 100644 --- a/components/climate/tuya.rst +++ b/components/climate/tuya.rst @@ -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. diff --git a/components/cover/am43.rst b/components/cover/am43.rst index c096fb221..c1f05f505 100644 --- a/components/cover/am43.rst +++ b/components/cover/am43.rst @@ -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 diff --git a/components/cover/current_based.rst b/components/cover/current_based.rst index ee4581dc1..dd6d09c97 100644 --- a/components/cover/current_based.rst +++ b/components/cover/current_based.rst @@ -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 `): 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 `): 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 `): 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 `. @@ -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 `) in a very small form factor (39mm x 36mm x 17 mm). +(thanks to an embedded :doc:`ADE7953 `) in a very small form factor (39mm x 36mm x 17 mm). It also features an :doc:`NTC temperature sensor `. .. 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 ` MUST be + The ADE7953 IRQ line is connected to the GPIO16. The ``irq_pin`` parameter for the :doc:`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: diff --git a/components/cover/endstop.rst b/components/cover/endstop.rst index 9f7e6c502..1637f8d72 100644 --- a/components/cover/endstop.rst +++ b/components/cover/endstop.rst @@ -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. diff --git a/components/cover/index.rst b/components/cover/index.rst index 33d5471b4..cc418a643 100644 --- a/components/cover/index.rst +++ b/components/cover/index.rst @@ -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 diff --git a/components/cover/template.rst b/components/cover/template.rst index face67eea..e93b54c61 100644 --- a/components/cover/template.rst +++ b/components/cover/template.rst @@ -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 diff --git a/components/cover/time_based.rst b/components/cover/time_based.rst index dcbfa07ba..a2da02d76 100644 --- a/components/cover/time_based.rst +++ b/components/cover/time_based.rst @@ -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 diff --git a/components/debug.rst b/components/debug.rst index 182326a03..c632ff41a 100644 --- a/components/debug.rst +++ b/components/debug.rst @@ -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. diff --git a/components/deep_sleep.rst b/components/deep_sleep.rst index 7f886e296..97e152605 100644 --- a/components/deep_sleep.rst +++ b/components/deep_sleep.rst @@ -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 diff --git a/components/demo.rst b/components/demo.rst index 8fe294d11..faccce99f 100644 --- a/components/demo.rst +++ b/components/demo.rst @@ -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, ...) diff --git a/components/dfplayer.rst b/components/dfplayer.rst index 830829faa..30a5bdb2f 100644 --- a/components/dfplayer.rst +++ b/components/dfplayer.rst @@ -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 `__), component allows you to play sound and music stored in an SD card or USB flash drive. diff --git a/components/display/ili9341.rst b/components/display/ili9341.rst index e48bf31f4..04229e353 100644 --- a/components/display/ili9341.rst +++ b/components/display/ili9341.rst @@ -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: diff --git a/components/display/index.rst b/components/display/index.rst index b312ba18c..8ee67ce04 100644 --- a/components/display/index.rst +++ b/components/display/index.rst @@ -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: diff --git a/components/display/st7735.rst b/components/display/st7735.rst index 39897a3ab..70bd055ee 100644 --- a/components/display/st7735.rst +++ b/components/display/st7735.rst @@ -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. diff --git a/components/display/st7789v.rst b/components/display/st7789v.rst index a0b52a5ee..fd47c065a 100644 --- a/components/display/st7789v.rst +++ b/components/display/st7789v.rst @@ -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: diff --git a/components/esp32.rst b/components/esp32.rst index 9d70e2b05..84bfcf7da 100644 --- a/components/esp32.rst +++ b/components/esp32.rst @@ -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 `__. + `this list `__. *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 `__. 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 `__. 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 diff --git a/components/esp32_ble_beacon.rst b/components/esp32_ble_beacon.rst index 220ce9830..57bca25da 100644 --- a/components/esp32_ble_beacon.rst +++ b/components/esp32_ble_beacon.rst @@ -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 diff --git a/components/esp32_ble_tracker.rst b/components/esp32_ble_tracker.rst index fca8d51f2..22882bdc1 100644 --- a/components/esp32_ble_tracker.rst +++ b/components/esp32_ble_tracker.rst @@ -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. diff --git a/components/esp32_camera.rst b/components/esp32_camera.rst index abf273817..1e88b339c 100644 --- a/components/esp32_camera.rst +++ b/components/esp32_camera.rst @@ -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. diff --git a/components/esp32_camera_web_server.rst b/components/esp32_camera_web_server.rst index 48e345e08..6cc560258 100644 --- a/components/esp32_camera_web_server.rst +++ b/components/esp32_camera_web_server.rst @@ -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 diff --git a/components/esp8266.rst b/components/esp8266.rst index be11a4b5d..2e0f7f936 100644 --- a/components/esp8266.rst +++ b/components/esp8266.rst @@ -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 `__. + `this list `__. *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 `__. Defaults to ``recommended``. Additional values - ``dev``: Use the latest commit from https://github.com/esp8266/Arduino, note this may break at any time diff --git a/components/esphome.rst b/components/esphome.rst index 43d3dcfbb..38ac55417 100644 --- a/components/esphome.rst +++ b/components/esphome.rst @@ -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 diff --git a/components/ethernet.rst b/components/ethernet.rst index 74127a50f..1a296c886 100644 --- a/components/ethernet.rst +++ b/components/ethernet.rst @@ -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. diff --git a/components/fan/binary.rst b/components/fan/binary.rst index 62bccd49c..78e967d09 100644 --- a/components/fan/binary.rst +++ b/components/fan/binary.rst @@ -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. diff --git a/components/fan/hbridge.rst b/components/fan/hbridge.rst index f0f827748..cf04d1f7c 100644 --- a/components/fan/hbridge.rst +++ b/components/fan/hbridge.rst @@ -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). diff --git a/components/fan/index.rst b/components/fan/index.rst index 33e2df0e4..4809f2432 100644 --- a/components/fan/index.rst +++ b/components/fan/index.rst @@ -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 diff --git a/components/fan/speed.rst b/components/fan/speed.rst index b9080022d..9969d0cdc 100644 --- a/components/fan/speed.rst +++ b/components/fan/speed.rst @@ -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. diff --git a/components/fingerprint_grow.rst b/components/fingerprint_grow.rst index 9a5813a1c..6edddd3ff 100644 --- a/components/fingerprint_grow.rst +++ b/components/fingerprint_grow.rst @@ -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. diff --git a/components/gps.rst b/components/gps.rst index 648080349..d219b7d34 100644 --- a/components/gps.rst +++ b/components/gps.rst @@ -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. diff --git a/components/http_request.rst b/components/http_request.rst index 107580cdb..f69091c99 100644 --- a/components/http_request.rst +++ b/components/http_request.rst @@ -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 diff --git a/components/i2c.rst b/components/i2c.rst index 5f1bfcb8c..0ae58c066 100644 --- a/components/i2c.rst +++ b/components/i2c.rst @@ -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 diff --git a/components/light/binary.rst b/components/light/binary.rst index 42bff3c7b..43e1ee7bc 100644 --- a/components/light/binary.rst +++ b/components/light/binary.rst @@ -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 `. diff --git a/components/light/color_temperature.rst b/components/light/color_temperature.rst index 4689b9653..b66a94248 100644 --- a/components/light/color_temperature.rst +++ b/components/light/color_temperature.rst @@ -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 `. One channel controls the LED temperature, diff --git a/components/light/cwww.rst b/components/light/cwww.rst index 6c008644e..66fb02edb 100644 --- a/components/light/cwww.rst +++ b/components/light/cwww.rst @@ -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 ` (one for each channel). The two channels diff --git a/components/light/fastled.rst b/components/light/fastled.rst index 271e7ffad..a7a1e8171 100644 --- a/components/light/fastled.rst +++ b/components/light/fastled.rst @@ -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: diff --git a/components/light/hbridge.rst b/components/light/hbridge.rst index 5b5f0236d..6dcd095d6 100644 --- a/components/light/hbridge.rst +++ b/components/light/hbridge.rst @@ -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 `. diff --git a/components/light/index.rst b/components/light/index.rst index 6c8e8af7a..277c76c88 100644 --- a/components/light/index.rst +++ b/components/light/index.rst @@ -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 diff --git a/components/light/monochromatic.rst b/components/light/monochromatic.rst index 65b850246..2b86555d2 100644 --- a/components/light/monochromatic.rst +++ b/components/light/monochromatic.rst @@ -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 `. diff --git a/components/light/neopixelbus.rst b/components/light/neopixelbus.rst index 1354d69c2..33ea9257b 100644 --- a/components/light/neopixelbus.rst +++ b/components/light/neopixelbus.rst @@ -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. diff --git a/components/light/partition.rst b/components/light/partition.rst index 960681d36..7198c6145 100644 --- a/components/light/partition.rst +++ b/components/light/partition.rst @@ -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. diff --git a/components/light/status_led.rst b/components/light/status_led.rst index c6157e4e4..7dc670a90 100644 --- a/components/light/status_led.rst +++ b/components/light/status_led.rst @@ -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 ` and a -:doc:`binary light component ` over a single shared GPIO led. +It provides the combined functionality of :doc:`status_led component ` and a +:doc:`binary light component ` 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. diff --git a/components/light/tuya.rst b/components/light/tuya.rst index 59c197aaf..01df5ebae 100644 --- a/components/light/tuya.rst +++ b/components/light/tuya.rst @@ -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. diff --git a/components/logger.rst b/components/logger.rst index 80d93023c..243202470 100644 --- a/components/logger.rst +++ b/components/logger.rst @@ -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 diff --git a/components/mcp230xx.rst b/components/mcp230xx.rst index bd6b00dc4..0ee71a343 100644 --- a/components/mcp230xx.rst +++ b/components/mcp230xx.rst @@ -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. diff --git a/components/mcp23Sxx.rst b/components/mcp23Sxx.rst index 88aa2853f..655c81343 100644 --- a/components/mcp23Sxx.rst +++ b/components/mcp23Sxx.rst @@ -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 diff --git a/components/number/index.rst b/components/number/index.rst index c386efb32..6a64463c0 100644 --- a/components/number/index.rst +++ b/components/number/index.rst @@ -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 diff --git a/components/number/modbus_controller.rst b/components/number/modbus_controller.rst index 905839a40..e669ff8c9 100644 --- a/components/number/modbus_controller.rst +++ b/components/number/modbus_controller.rst @@ -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. diff --git a/components/number/template.rst b/components/number/template.rst index d07f1e9a1..13cbef2f7 100644 --- a/components/number/template.rst +++ b/components/number/template.rst @@ -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 `. diff --git a/components/ota.rst b/components/ota.rst index a0412e962..d58ac023f 100644 --- a/components/ota.rst +++ b/components/ota.rst @@ -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: diff --git a/components/output/gpio.rst b/components/output/gpio.rst index 0f269617c..ba946b971 100644 --- a/components/output/gpio.rst +++ b/components/output/gpio.rst @@ -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 diff --git a/components/output/index.rst b/components/output/index.rst index 05c77ec6d..12ab21389 100644 --- a/components/output/index.rst +++ b/components/output/index.rst @@ -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 diff --git a/components/output/mcp4725.rst b/components/output/mcp4725.rst index 71749d428..c337bc892 100644 --- a/components/output/mcp4725.rst +++ b/components/output/mcp4725.rst @@ -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 `__ diff --git a/components/output/modbus_controller.rst b/components/output/modbus_controller.rst index 9196ff178..baec36459 100644 --- a/components/output/modbus_controller.rst +++ b/components/output/modbus_controller.rst @@ -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. diff --git a/components/output/my9231.rst b/components/output/my9231.rst index 568d572e4..0b162dff6 100644 --- a/components/output/my9231.rst +++ b/components/output/my9231.rst @@ -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: diff --git a/components/output/sm16716.rst b/components/output/sm16716.rst index 88b2d22ff..655f20951 100644 --- a/components/output/sm16716.rst +++ b/components/output/sm16716.rst @@ -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: diff --git a/components/output/template.rst b/components/output/template.rst index 5edda1d9c..6a60c249a 100644 --- a/components/output/template.rst +++ b/components/output/template.rst @@ -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. diff --git a/components/output/tlc5947.rst b/components/output/tlc5947.rst index 40022ea52..64439d035 100644 --- a/components/output/tlc5947.rst +++ b/components/output/tlc5947.rst @@ -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: diff --git a/components/power_supply.rst b/components/power_supply.rst index 5a33a2e38..b08311ee5 100644 --- a/components/power_supply.rst +++ b/components/power_supply.rst @@ -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 diff --git a/components/prometheus.rst b/components/prometheus.rst index e49480ac9..acc4b5fbc 100644 --- a/components/prometheus.rst +++ b/components/prometheus.rst @@ -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 `__ installation. diff --git a/components/remote_receiver.rst b/components/remote_receiver.rst index 9e2c21dce..ef0ad8a79 100644 --- a/components/remote_receiver.rst +++ b/components/remote_receiver.rst @@ -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 diff --git a/components/remote_transmitter.rst b/components/remote_transmitter.rst index 47837be50..8461c3a45 100644 --- a/components/remote_transmitter.rst +++ b/components/remote_transmitter.rst @@ -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 diff --git a/components/rtttl.rst b/components/rtttl.rst index cc6b88fa6..1b71b8b76 100644 --- a/components/rtttl.rst +++ b/components/rtttl.rst @@ -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 diff --git a/components/select/index.rst b/components/select/index.rst index 8ef140408..450d4bac1 100644 --- a/components/select/index.rst +++ b/components/select/index.rst @@ -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. diff --git a/components/select/template.rst b/components/select/template.rst index 23cb9126d..c6d011cb1 100644 --- a/components/select/template.rst +++ b/components/select/template.rst @@ -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 `. diff --git a/components/sensor/adc.rst b/components/sensor/adc.rst index d50736681..51a8feacd 100644 --- a/components/sensor/adc.rst +++ b/components/sensor/adc.rst @@ -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 diff --git a/components/sensor/ade7953.rst b/components/sensor/ade7953.rst index 94f661596..e9fb99ac9 100644 --- a/components/sensor/ade7953.rst +++ b/components/sensor/ade7953.rst @@ -3,7 +3,7 @@ ADE7953 Power Sensor .. seo:: :description: Instructions for setting up ADE7953 power sensors - :image: ade7953.png + :image: ade7953.svg .. note:: diff --git a/components/sensor/am43.rst b/components/sensor/am43.rst index e0fcc6192..108c75f5e 100644 --- a/components/sensor/am43.rst +++ b/components/sensor/am43.rst @@ -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 diff --git a/components/sensor/as3935.rst b/components/sensor/as3935.rst index d4ade816a..d1fa71886 100644 --- a/components/sensor/as3935.rst +++ b/components/sensor/as3935.rst @@ -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 diff --git a/components/sensor/atm90e32.rst b/components/sensor/atm90e32.rst index 07509a624..84ac5ede2 100644 --- a/components/sensor/atm90e32.rst +++ b/components/sensor/atm90e32.rst @@ -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 diff --git a/components/sensor/ble_rssi.rst b/components/sensor/ble_rssi.rst index 7c8a9f665..3e880aec4 100644 --- a/components/sensor/ble_rssi.rst +++ b/components/sensor/ble_rssi.rst @@ -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 diff --git a/components/sensor/cse7761.rst b/components/sensor/cse7761.rst index 999047aa8..64bb889c0 100644 --- a/components/sensor/cse7761.rst +++ b/components/sensor/cse7761.rst @@ -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 diff --git a/components/sensor/cse7766.rst b/components/sensor/cse7766.rst index 642ea7ca6..0d2108051 100644 --- a/components/sensor/cse7766.rst +++ b/components/sensor/cse7766.rst @@ -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 diff --git a/components/sensor/custom.rst b/components/sensor/custom.rst index 7e26b97d0..6fa2d7eb4 100644 --- a/components/sensor/custom.rst +++ b/components/sensor/custom.rst @@ -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:: diff --git a/components/sensor/dsmr.rst b/components/sensor/dsmr.rst index a8f2ad0fc..5a5612216 100644 --- a/components/sensor/dsmr.rst +++ b/components/sensor/dsmr.rst @@ -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 ************* diff --git a/components/sensor/duty_cycle.rst b/components/sensor/duty_cycle.rst index eb691c216..9bed5b9c2 100644 --- a/components/sensor/duty_cycle.rst +++ b/components/sensor/duty_cycle.rst @@ -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. diff --git a/components/sensor/esp32_hall.rst b/components/sensor/esp32_hall.rst index e49bb0884..00cf7a13d 100644 --- a/components/sensor/esp32_hall.rst +++ b/components/sensor/esp32_hall.rst @@ -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 diff --git a/components/sensor/havells_solar.rst b/components/sensor/havells_solar.rst index 7cfb0d496..9e6992007 100644 --- a/components/sensor/havells_solar.rst +++ b/components/sensor/havells_solar.rst @@ -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 diff --git a/components/sensor/hlw8012.rst b/components/sensor/hlw8012.rst index ada0e1bd3..48f38b0a1 100644 --- a/components/sensor/hlw8012.rst +++ b/components/sensor/hlw8012.rst @@ -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 diff --git a/components/sensor/hm3301.rst b/components/sensor/hm3301.rst index 544e75476..d6f71e7f5 100644 --- a/components/sensor/hm3301.rst +++ b/components/sensor/hm3301.rst @@ -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 `__) diff --git a/components/sensor/homeassistant.rst b/components/sensor/homeassistant.rst index 67bb02a34..35f8c5d44 100644 --- a/components/sensor/homeassistant.rst +++ b/components/sensor/homeassistant.rst @@ -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 `. diff --git a/components/sensor/hx711.rst b/components/sensor/hx711.rst index 0cb322d43..22f17c39d 100644 --- a/components/sensor/hx711.rst +++ b/components/sensor/hx711.rst @@ -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 diff --git a/components/sensor/index.rst b/components/sensor/index.rst index 8e1f7a681..d2fb72363 100644 --- a/components/sensor/index.rst +++ b/components/sensor/index.rst @@ -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 diff --git a/components/sensor/integration.rst b/components/sensor/integration.rst index 15f22b323..5b6ef472d 100644 --- a/components/sensor/integration.rst +++ b/components/sensor/integration.rst @@ -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 diff --git a/components/sensor/ltr390.rst b/components/sensor/ltr390.rst index 3af449cde..b466f35d8 100644 --- a/components/sensor/ltr390.rst +++ b/components/sensor/ltr390.rst @@ -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 diff --git a/components/sensor/max31856.rst b/components/sensor/max31856.rst index cf966fa02..24669e62f 100644 --- a/components/sensor/max31856.rst +++ b/components/sensor/max31856.rst @@ -3,7 +3,7 @@ MAX31856 Thermocouple Temperature Sensor .. seo:: :description: Instructions for setting up MAX31856 Thermocouple temperature sensors. - :image: max31865.png + :image: max31865.jpg The ``MAX31856`` temperature sensor allows you to use your MAX31856 Thermocouple temperature sensor (`datasheet `__) with ESPHome diff --git a/components/sensor/mcp3008.rst b/components/sensor/mcp3008.rst index ccb8f0976..0b05680b0 100644 --- a/components/sensor/mcp3008.rst +++ b/components/sensor/mcp3008.rst @@ -4,7 +4,7 @@ MCP3008 I/O Expander .. seo:: :description: Instructions for setting up MCP3008 10 Bit Analog to Digital Converter in ESPHome. :keywords: MCP3008 - :image: images/mcp3008.jpg + :image: mcp3008.jpg The Microchip Technology Inc. MCP3008 devices are successive approximation 10-bit Analog-to-Digital (A/D) converters with on-board sample and diff --git a/components/sensor/pmsa003i.rst b/components/sensor/pmsa003i.rst index 87b34a78c..ca828dce2 100644 --- a/components/sensor/pmsa003i.rst +++ b/components/sensor/pmsa003i.rst @@ -3,7 +3,7 @@ PMSA003I Particulate Matter Sensor .. seo:: :description: Instructions for setting up PMSX003 Particulate matter sensors - :image: images/pmsa003i-full.jpg + :image: pmsa003i-full.jpg The ``pmsa003i`` sensor platform allows you to use your Plantower PMSA003I particulate matter sensor diff --git a/components/sensor/pmsx003.rst b/components/sensor/pmsx003.rst index 741362297..e7fb05fa9 100644 --- a/components/sensor/pmsx003.rst +++ b/components/sensor/pmsx003.rst @@ -3,7 +3,7 @@ PMSX003 Particulate Matter Sensor .. seo:: :description: Instructions for setting up PMSX003 Particulate matter sensors - :image: pmsx003.png + :image: pmsx003.svg The ``pmsx003`` sensor platform allows you to use your PMS5003, PMS7003, ... particulate matter (`datasheet `__) diff --git a/components/sensor/pulse_counter.rst b/components/sensor/pulse_counter.rst index 48c50d5a1..3acba1982 100644 --- a/components/sensor/pulse_counter.rst +++ b/components/sensor/pulse_counter.rst @@ -3,7 +3,7 @@ Pulse Counter Sensor .. seo:: :description: Instructions for setting up pulse counter sensors. - :image: pulse.png + :image: pulse.svg The pulse counter sensor allows you to count the number of pulses and the frequency of a signal on any pin. diff --git a/components/sensor/pulse_meter.rst b/components/sensor/pulse_meter.rst index 21d47212b..b8fcdb9b7 100644 --- a/components/sensor/pulse_meter.rst +++ b/components/sensor/pulse_meter.rst @@ -3,7 +3,7 @@ Pulse Meter Sensor .. seo:: :description: Instructions for setting up pulse meter sensors. - :image: pulse.png + :image: pulse.svg The pulse meter sensor allows you to count the number and frequency of pulses on any pin. It is intended to be a drop-in replacement for :doc:`integration sensor `, but offering better resolution. diff --git a/components/sensor/pulse_width.rst b/components/sensor/pulse_width.rst index 67d9bc2a4..38bff673f 100644 --- a/components/sensor/pulse_width.rst +++ b/components/sensor/pulse_width.rst @@ -3,7 +3,7 @@ Pulse Width Sensor .. seo:: :description: Instructions for setting up pulse width sensors in ESPHome - :image: pulse.png + :image: pulse.svg The ``pulse_width`` sensor allows you to measure how long a given digital signal is HIGH. For example this can be used to measure PWM signals to transmit some diff --git a/components/sensor/pzem004t.rst b/components/sensor/pzem004t.rst index a87af2a34..2e339e37a 100644 --- a/components/sensor/pzem004t.rst +++ b/components/sensor/pzem004t.rst @@ -3,7 +3,7 @@ Peacefair PZEM-004T Energy Monitor .. seo:: :description: Instructions for setting up PZEM-004 and PZEM-004T V1 power monitors. - :image: pzem-004.jpg + :image: pzem004t.svg :keywords: PZEM-004T, PZEM-004 .. note:: @@ -20,7 +20,7 @@ ESPHome. .. warning:: - This page refers to version V1 of the PZEM-004T, which has been out of stock for a while. + This page refers to version V1 of the PZEM-004T, which has been out of stock for a while. The PZEM-004, however, is still working (and selling) with this protocol and does not use modbus. For using the newer V3 variant of this sensor please see :doc:`pzemac `. @@ -64,14 +64,14 @@ Configuration variables: Hardware considerations: ------------------------ -These devices have optocouplers on the UART port and the resistors mounted on the board have been designed to work with 5V devices. -ESPs need a `Level Shifter `__ to be compatible with TTL levels. +These devices have optocouplers on the UART port and the resistors mounted on the board have been designed to work with 5V devices. +ESPs need a `Level Shifter `__ to be compatible with TTL levels. .. note:: You need a IC level shifter and not a `Mosfet-based `__ level shifter, because you need to power the optocoupler's LEDs without an additional resistor in the path. - + If prefer, you could change the value of the optocoupler's resistors by following `this `__ or `this `__ guide. Your ESP shall be powered by an external power supply and cannot be connected to the PZEM for power. diff --git a/components/sensor/pzemac.rst b/components/sensor/pzemac.rst index ebec5df7a..90f8a8896 100644 --- a/components/sensor/pzemac.rst +++ b/components/sensor/pzemac.rst @@ -3,7 +3,7 @@ Peacefair PZEM-004T V3 Energy Monitor .. seo:: :description: Instructions for setting up PZEM-004T power monitors. - :image: pzemac.png + :image: pzem-ac.png :keywords: PZEM-004T V3 .. note:: diff --git a/components/sensor/pzemdc.rst b/components/sensor/pzemdc.rst index b89343e96..9e76a1fa4 100644 --- a/components/sensor/pzemdc.rst +++ b/components/sensor/pzemdc.rst @@ -3,7 +3,7 @@ Peacefair PZEM-00X DC Energy Monitor .. seo:: :description: Instructions for setting up DC PZEM power monitors. - :image: pzemdc.png + :image: pzem-dc.png .. note:: diff --git a/components/sensor/resistance.rst b/components/sensor/resistance.rst index 0f132be72..21d42c2c4 100644 --- a/components/sensor/resistance.rst +++ b/components/sensor/resistance.rst @@ -3,7 +3,7 @@ Resistance Sensor .. seo:: :description: Instructions for setting up resistance sensors in ESPHome - :image: omega.png + :image: omega.svg The ``resistance`` platform is a helper sensor that allows you to convert readings from a voltage sensor (such as the :doc:`ADC Sensor `) into resistance readings diff --git a/components/sensor/sdm_meter.rst b/components/sensor/sdm_meter.rst index f47bd9adc..8a5338229 100644 --- a/components/sensor/sdm_meter.rst +++ b/components/sensor/sdm_meter.rst @@ -3,7 +3,7 @@ Eastron SDM Energy Monitor .. seo:: :description: Instructions for setting up SDM power monitors. - :image: images/sdm220m-full.png + :image: sdm220m.png :keywords: SDM220M, SDM220, SDM630 The ``sdm_meter`` sensor platform allows you to use Eastron SDM modbus energy monitors diff --git a/components/sensor/sdp3x.rst b/components/sensor/sdp3x.rst index 3e09ea7b5..0ff717b27 100644 --- a/components/sensor/sdp3x.rst +++ b/components/sensor/sdp3x.rst @@ -3,7 +3,7 @@ SDP3x Differential Pressure Sensor .. seo:: :description: Instructions for setting up the SDP3x Differential Pressure sensor. - :image: images/sdp31.jpg + :image: sdp31.jpg :keywords: SDP3x, SDP31, SDP32 The SDP3x Differential Pressure sensor allows you to use your SDP3x @@ -20,7 +20,7 @@ sensors with ESPHome. .. _Sparkfun: https://www.sparkfun.com/products/17874 -To use the sensor, set up an :ref:`I²C Bus ` and connect the sensor to the specified pins. +To use the sensor, set up an :ref:`I²C Bus ` and connect the sensor to the specified pins. .. code-block:: yaml diff --git a/components/sensor/selec_meter.rst b/components/sensor/selec_meter.rst index 70ad1aa64..392583905 100644 --- a/components/sensor/selec_meter.rst +++ b/components/sensor/selec_meter.rst @@ -3,7 +3,7 @@ Selec Energy Monitor .. seo:: :description: Instructions for setting up Selec power monitors. - :image: images/selec_meter_em2m.jpg + :image: selec_meter_em2m.jpg :keywords: EM2M The ``selec_meter`` sensor platform allows you to use Selec Modbus energy monitors diff --git a/components/sensor/sgp30.rst b/components/sensor/sgp30.rst index 06100a5fb..448b8431e 100644 --- a/components/sensor/sgp30.rst +++ b/components/sensor/sgp30.rst @@ -3,7 +3,7 @@ SGP30 CO₂ and Volatile Organic Compound Sensor .. seo:: :description: Instructions for setting up SGP30 CO₂eq and Volatile Organic Compound sensor - :image: sgp30.png + :image: sgp30.jpg The ``sgp30`` sensor platform allows you to use your Sensirion SGP30 multi-pixel gas (`datasheet `__) sensors or the SVM30 breakout-boards (`product page `__) with ESPHome. diff --git a/components/sensor/sht4x.rst b/components/sensor/sht4x.rst index 92fb76643..60205edd2 100644 --- a/components/sensor/sht4x.rst +++ b/components/sensor/sht4x.rst @@ -3,7 +3,7 @@ SHT4X Temperature and Humidity Sensor .. seo:: :description: Instructions for setting up SHT4X temperature and humidity sensor - :image: images/sht4x-full.jpg + :image: sht4x.jpg The ``sht4x`` sensor platform allows you to use your SHT4X temperature and humidity sensor (`datasheet `__, `Adafruit`_) with ESPHome. diff --git a/components/sensor/sm300d2.rst b/components/sensor/sm300d2.rst index 286dd9953..2a2d1dc71 100644 --- a/components/sensor/sm300d2.rst +++ b/components/sensor/sm300d2.rst @@ -3,7 +3,7 @@ SM300D2 7-in-1 Air Quality Sensor .. seo:: :description: Instructions for setting up SM300D2 sensor to work with ESPHome - :image: sm300d2-full.jpg + :image: sm300d2.jpg :keywords: sm300d2 The ``sm300d2`` sensor platform allows you to use the SM300D2 7-in-1 Air Quality Sensor with ESPHome. diff --git a/components/sensor/t6615.rst b/components/sensor/t6615.rst index e03b21172..a49e98ebc 100644 --- a/components/sensor/t6615.rst +++ b/components/sensor/t6615.rst @@ -3,7 +3,7 @@ T6613/15 CO2 Sensors .. seo:: :description: Instructions for setting up T6613 and T6615 sensors for ESPHome - :image: images/t6615.png + :image: t6615.png :keywords: t6613 t6615 The ``t6615`` sensor platform allows you to use T6613 and T6615 family sensors diff --git a/components/sensor/template.rst b/components/sensor/template.rst index 342f5d93a..a962f86b7 100644 --- a/components/sensor/template.rst +++ b/components/sensor/template.rst @@ -3,7 +3,7 @@ Template Sensor .. seo:: :description: Instructions for setting up template sensors with ESPHome. - :image: description.png + :image: description.svg The ``template`` sensor platform allows you to create a sensor with templated values using :ref:`lambdas `. diff --git a/components/sensor/total_daily_energy.rst b/components/sensor/total_daily_energy.rst index f55271d47..8dcd7f32a 100644 --- a/components/sensor/total_daily_energy.rst +++ b/components/sensor/total_daily_energy.rst @@ -3,7 +3,7 @@ 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.png + :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 `, :doc:`CSE7766 `, :doc:`ATM90E32 `, etc and integrate diff --git a/components/sensor/tx20.rst b/components/sensor/tx20.rst index 8790d75e9..566e8ca8b 100644 --- a/components/sensor/tx20.rst +++ b/components/sensor/tx20.rst @@ -3,7 +3,7 @@ TX20/TX23 Wind Speed/Direction Sensor .. seo:: :description: Instructions for setting up TX20/TX23 wind speed and direction sensors - :image: images/tx20.jpg + :image: tx20.jpg :keywords: TX20 The ``tx20`` sensor platform allows you to use your TX20/TX23 diff --git a/components/sensor/uptime.rst b/components/sensor/uptime.rst index 58fbff2d0..c8ea1a9e6 100644 --- a/components/sensor/uptime.rst +++ b/components/sensor/uptime.rst @@ -3,7 +3,7 @@ Uptime Sensor .. seo:: :description: Instructions for setting up a sensor that tracks the uptime of the ESP. - :image: timer.png + :image: timer.svg The ``uptime`` sensor allows you to track the time the ESP has stayed up for in seconds. Time rollovers are automatically handled. diff --git a/components/sensor/wifi_signal.rst b/components/sensor/wifi_signal.rst index f2a5b57f5..1fa639678 100644 --- a/components/sensor/wifi_signal.rst +++ b/components/sensor/wifi_signal.rst @@ -3,7 +3,7 @@ WiFi Signal Sensor .. seo:: :description: Instructions for setting up WiFi signal sensors that track the RSSI connection strength value to the network. - :image: network-wifi.png + :image: network-wifi.svg The ``wifi_signal`` sensor platform allows you to read the signal strength of the currently connected :doc:`WiFi Access Point `. diff --git a/components/servo.rst b/components/servo.rst index b125e6958..341eae970 100644 --- a/components/servo.rst +++ b/components/servo.rst @@ -3,7 +3,7 @@ Servo Component .. seo:: :description: Instructions for setting up servos in ESPHome - :image: servo.png + :image: servo.svg The ``servo`` component allows you to use servo motors with ESPHome. Servos are motor controllers that contain all the electronics necessary for driving the motor and provide diff --git a/components/spi.rst b/components/spi.rst index 5839b0547..d6a433ced 100644 --- a/components/spi.rst +++ b/components/spi.rst @@ -5,7 +5,7 @@ SPI Bus .. seo:: :description: Instructions for setting up an SPI bus in ESPHome - :image: spi.png + :image: spi.svg :keywords: SPI SPI is a very common high-speed protocol for a lot of devices. The SPI bus usually consists of 4 wires: diff --git a/components/status_led.rst b/components/status_led.rst index b0711bab8..28af3bd75 100644 --- a/components/status_led.rst +++ b/components/status_led.rst @@ -3,7 +3,7 @@ Status LED .. seo:: :description: Instructions for setting up status LEDs in ESPHome to monitor the status of an ESP. - :image: led-on.png + :image: led-on.svg The ``status_led`` hooks into all ESPHome components and can indicate the status of the device. Specifically, it will: diff --git a/components/stepper/index.rst b/components/stepper/index.rst index 78dfbfc80..d31208c17 100644 --- a/components/stepper/index.rst +++ b/components/stepper/index.rst @@ -3,7 +3,7 @@ Stepper Component .. seo:: :description: Instructions for setting up stepper motor drivers in ESPHome - :image: folder-open.png + :image: folder-open.svg :keywords: stepper motor, stepper driver, a4988 The ``stepper`` component allows you to use stepper motors with ESPHome. diff --git a/components/sun.rst b/components/sun.rst index dda62a5a3..614f070a8 100644 --- a/components/sun.rst +++ b/components/sun.rst @@ -3,7 +3,7 @@ Sun .. seo:: :description: Instructions for setting up tracking the sun position in ESPHome. - :image: weather-sunny.png + :image: weather-sunny.svg The ``sun`` component allows you to track the sun's position in the sky. diff --git a/components/switch/gpio.rst b/components/switch/gpio.rst index e9b0c8291..56361bb74 100644 --- a/components/switch/gpio.rst +++ b/components/switch/gpio.rst @@ -3,7 +3,7 @@ GPIO Switch .. seo:: :description: Instructions for setting up GPIO pin switches in ESPHome that control GPIO outputs. - :image: pin.png + :image: pin.svg The ``gpio`` switch platform allows you to use any pin on your node as a switch. You can for example hook up a relay to a GPIO pin and use it diff --git a/components/switch/index.rst b/components/switch/index.rst index 9d7d36215..531c57623 100644 --- a/components/switch/index.rst +++ b/components/switch/index.rst @@ -3,7 +3,7 @@ Switch Component .. seo:: :description: Instructions for setting up generic switches in ESPHome. - :image: folder-open.png + :image: folder-open.svg The ``switch`` domain includes all platforms that should show up like a switch and can only be turned ON or OFF. diff --git a/components/switch/modbus_controller.rst b/components/switch/modbus_controller.rst index bf9e8e1d0..1e2545fc5 100644 --- a/components/switch/modbus_controller.rst +++ b/components/switch/modbus_controller.rst @@ -3,7 +3,6 @@ Modbus Switch .. seo:: :description: Instructions for setting up a modbus_controller device sensor. - :image: modbus_controller.png The ``modbus_controller`` sensor platform creates a sensor from a modbus_controller component and requires :doc:`/components/modbus_controller` to be configured. diff --git a/components/switch/output.rst b/components/switch/output.rst index b846feb86..a5b600578 100644 --- a/components/switch/output.rst +++ b/components/switch/output.rst @@ -3,7 +3,7 @@ Generic Output Switch .. seo:: :description: Instructions for setting up generic output switches in ESPHome that control an output component. - :image: upload.png + :image: upload.svg The ``output`` switch platform allows you to use any output component as a switch. diff --git a/components/switch/restart.rst b/components/switch/restart.rst index 57f243c09..5ab846890 100644 --- a/components/switch/restart.rst +++ b/components/switch/restart.rst @@ -3,7 +3,7 @@ Restart Switch .. seo:: :description: Instructions for setting up switches that can remotely reboot the ESP in ESPHome. - :image: restart.png + :image: restart.svg The ``restart`` switch platform allows you to restart your node remotely through Home Assistant. diff --git a/components/switch/safe_mode.rst b/components/switch/safe_mode.rst index c3168e191..17ad39c44 100644 --- a/components/switch/safe_mode.rst +++ b/components/switch/safe_mode.rst @@ -3,7 +3,7 @@ Safe Mode Switch .. seo:: :description: Instructions for setting up switches that can remotely reboot the ESP in ESPHome into safe mode. - :image: restart.png + :image: restart.svg The ``safe_mode`` switch allows you to remotely reboot your node into :ref:`Safe Mode `. This is useful in certain situations where a misbehaving component is preventing Over-The-Air updates from completing successfully. diff --git a/components/switch/shutdown.rst b/components/switch/shutdown.rst index e843b4c65..814ba446e 100644 --- a/components/switch/shutdown.rst +++ b/components/switch/shutdown.rst @@ -3,7 +3,7 @@ Shutdown Switch .. seo:: :description: Instructions for setting up switches that can remotely shut down the ESP. - :image: power_settings.png + :image: power_settings.svg The ``shutdown`` switch platform allows you to shutdown your node remotely through Home Assistant. It does this by putting the node into deep sleep mode with no diff --git a/components/switch/template.rst b/components/switch/template.rst index b47b30324..fe39a3c69 100644 --- a/components/switch/template.rst +++ b/components/switch/template.rst @@ -3,7 +3,7 @@ Template Switch .. seo:: :description: Instructions for setting up template switches that can execute arbitrary actions when turned on or off. - :image: description.png + :image: description.svg The ``template`` switch platform allows you to create simple switches out of just actions and an optional value lambda. Once defined, it will automatically appear in Home Assistant diff --git a/components/switch/uart.rst b/components/switch/uart.rst index 4aefa9344..cf1518a03 100644 --- a/components/switch/uart.rst +++ b/components/switch/uart.rst @@ -3,7 +3,7 @@ UART Switch .. seo:: :description: Instructions for setting up UART switches in ESPHome that can output arbitrary UART sequences when activated. - :image: uart.png + :image: uart.svg The ``uart`` switch platform allows you to send a pre-defined sequence of bytes on a :doc:`UART bus ` when triggered. diff --git a/components/text_sensor/ble_scanner.rst b/components/text_sensor/ble_scanner.rst index 4fccf2d37..3d21c3df1 100644 --- a/components/text_sensor/ble_scanner.rst +++ b/components/text_sensor/ble_scanner.rst @@ -3,7 +3,7 @@ ESP32 Bluetooth Low Energy Scanner .. seo:: :description: Instructions for setting up BLE text sensors for the ESP32. - :image: bluetooth.png + :image: bluetooth.svg :keywords: ESP32 The ``ble_scanner`` text sensor platform lets you track reachable BLE devices. diff --git a/components/text_sensor/homeassistant.rst b/components/text_sensor/homeassistant.rst index 08ab13580..ed9ce523b 100644 --- a/components/text_sensor/homeassistant.rst +++ b/components/text_sensor/homeassistant.rst @@ -3,7 +3,7 @@ Home Assistant Text Sensor .. seo:: :description: Instructions for setting up Home Assistant text sensors with ESPHome that import states from your Home Assistant instance. - :image: home-assistant.png + :image: home-assistant.svg The ``homeassistant`` text sensor platform allows you to create a sensors that import states from your Home Assistant instance using the :doc:`native API `. diff --git a/components/text_sensor/index.rst b/components/text_sensor/index.rst index 5a23856b5..c2a643442 100644 --- a/components/text_sensor/index.rst +++ b/components/text_sensor/index.rst @@ -3,7 +3,7 @@ Text Sensor Component .. seo:: :description: Instructions for setting up text sensors that represent their state as a string of text. - :image: folder-open.png + :image: folder-open.svg Text sensors are a lot like normal :doc:`sensors `. But where the "normal" sensors only represent sensors that output **numbers**, this diff --git a/components/text_sensor/modbus_controller.rst b/components/text_sensor/modbus_controller.rst index 9d918ddd9..51ef36880 100644 --- a/components/text_sensor/modbus_controller.rst +++ b/components/text_sensor/modbus_controller.rst @@ -3,7 +3,6 @@ Modbus Text Sensor .. seo:: :description: Instructions for setting up a modbus_controller modbus text sensor. - :image: modbus_controller.png The ``modbus_controller`` sensor platform creates a text sensor from a modbus_controller component and requires :doc:`/components/modbus_controller` to be configured. diff --git a/components/text_sensor/template.rst b/components/text_sensor/template.rst index 3f50cd28d..60994ed8c 100644 --- a/components/text_sensor/template.rst +++ b/components/text_sensor/template.rst @@ -3,7 +3,7 @@ Template Text Sensor .. seo:: :description: Instructions for setting up template text sensors in ESPHome - :image: description.png + :image: description.svg The ``template`` text sensor platform allows you to create a text sensor with templated values using :ref:`lambdas `. diff --git a/components/text_sensor/version.rst b/components/text_sensor/version.rst index 3d9a44c1d..606de874a 100644 --- a/components/text_sensor/version.rst +++ b/components/text_sensor/version.rst @@ -3,7 +3,7 @@ Version Text Sensor .. seo:: :description: Instructions for setting up version text sensors. - :image: new-box.png + :image: new-box.svg The ``version`` text sensor platform exposes the ESPHome version the firmware was compiled against as a text sensor. diff --git a/components/text_sensor/wifi_info.rst b/components/text_sensor/wifi_info.rst index 28ea7f6ce..127c98a04 100644 --- a/components/text_sensor/wifi_info.rst +++ b/components/text_sensor/wifi_info.rst @@ -3,7 +3,7 @@ WiFi Info Text Sensor .. seo:: :description: Instructions for setting up WiFi info text sensors. - :image: network-wifi.png + :image: network-wifi.svg The ``wifi_info`` text sensor platform exposes different WiFi information via text sensors. diff --git a/components/time.rst b/components/time.rst index 36be7588f..6e418db43 100644 --- a/components/time.rst +++ b/components/time.rst @@ -5,7 +5,7 @@ Time .. seo:: :description: Instructions for setting up real time clock sources in ESPHome like network based time. - :image: clock-outline.png + :image: clock-outline.svg :keywords: GPS, NTP, RTC, SNTP The ``time`` component allows you to set up real time clock time sources for ESPHome. diff --git a/components/uart.rst b/components/uart.rst index beb68c4da..214842b34 100644 --- a/components/uart.rst +++ b/components/uart.rst @@ -5,7 +5,7 @@ UART Bus .. seo:: :description: Instructions for setting up a UART serial bus on ESPs - :image: uart.png + :image: uart.svg :keywords: UART, serial bus UART is a common serial protocol for a lot of devices. For example, when uploading a binary to your ESP diff --git a/components/web_server.rst b/components/web_server.rst index ebe569eef..fdc4ff25a 100644 --- a/components/web_server.rst +++ b/components/web_server.rst @@ -3,7 +3,7 @@ Web Server Component .. seo:: :description: Instructions for setting up a web server in ESPHome. - :image: http.png + :image: http.svg :keywords: web server, http, REST API The ``web_server`` component creates a simple web server on the node that can be accessed diff --git a/components/wifi.rst b/components/wifi.rst index fb2570a0b..7468c9412 100644 --- a/components/wifi.rst +++ b/components/wifi.rst @@ -3,7 +3,7 @@ WiFi Component .. seo:: :description: Instructions for setting up the WiFi configuration for your ESP node in ESPHome. - :image: network-wifi.png + :image: network-wifi.svg :keywords: WiFi, WLAN, ESP8266, ESP32 This core ESPHome component sets up WiFi connections to access points diff --git a/cookbook/arduino_port_extender.rst b/cookbook/arduino_port_extender.rst index 03c49d73e..3635b5d89 100644 --- a/cookbook/arduino_port_extender.rst +++ b/cookbook/arduino_port_extender.rst @@ -3,7 +3,7 @@ Arduino Port Expander .. seo:: :description: Instructions on using an Arduino board, like the Pro Mini for expanding ports of an ESPHome node - :image: arduino_pro_mini.jpg + :image: arduino_logo.svg :keywords: Arduino port expander extender ESPHome With this sketch you can control pins of a remote Arduino board through ESPHome. The Arduino acts as a port diff --git a/cookbook/display_time_temp_oled.rst b/cookbook/display_time_temp_oled.rst index e8ea37642..ea3317f12 100644 --- a/cookbook/display_time_temp_oled.rst +++ b/cookbook/display_time_temp_oled.rst @@ -3,7 +3,6 @@ Time & Temperature on OLED Display .. seo:: :description: Instructions for setting up a display in ESPHome to show sensor values from Home Assistant - :image: display_time_temp_oled_1.jpg :keywords: Display .. figure:: images/display_time_temp_oled_1.jpg diff --git a/cookbook/endstop-cover.rst b/cookbook/endstop-cover.rst index 501c15155..eafc4c86e 100644 --- a/cookbook/endstop-cover.rst +++ b/cookbook/endstop-cover.rst @@ -3,7 +3,7 @@ Template Cover with Endstops .. seo:: :description: An example of how to integrate covers with endstops in ESPHome. - :image: window-open.jpg + :image: window-open.svg The following is an example configuration for controlling covers (like window blinds etc) with ESPHome. This guide assumes that the cover is set up with two endstops at the top diff --git a/cookbook/garage-door.rst b/cookbook/garage-door.rst index 319cb8683..542bf4d14 100644 --- a/cookbook/garage-door.rst +++ b/cookbook/garage-door.rst @@ -3,7 +3,7 @@ Simple Garage Door .. seo:: :description: Instructions for setting up a simple garage door in ESPHome. - :image: window-open.png + :image: window-open.svg The following is a possible configuration file for garage doors that are controlled by two relays: One for opening and another one for closing the garage door. When either one of them is turned on diff --git a/cookbook/infostrip.rst b/cookbook/infostrip.rst index ec6c1d9a3..323a97114 100644 --- a/cookbook/infostrip.rst +++ b/cookbook/infostrip.rst @@ -3,7 +3,7 @@ Infostripe .. seo:: :description: Simple visualisation of Home Assistant states using a Neopixel stripe - :image: infostrip-detai.jpg + :image: /cookbook/images/infostrip-detail.jpg :keywords: Neopixel Showing the current status of sensor states using a Neopixel (WS2812B) strip is a simple way to communicate states to the user. diff --git a/cookbook/leak-detector-m5stickC.rst b/cookbook/leak-detector-m5stickC.rst index f42a737f3..378cbe518 100644 --- a/cookbook/leak-detector-m5stickC.rst +++ b/cookbook/leak-detector-m5stickC.rst @@ -4,7 +4,6 @@ ESP32 Water Leak Detector (with notification) .. seo:: :description: Water leak detector with ESPHome on an M5StickC ESP32 - :image: images/leak-detector-m5stickC_dry.jpg :keywords: Leak Detector M5StickC M5Stack M5Atom Using the ESP32's capacitive touch GPIOs, it's relatively easy to build a water leak detector using ESPHome. M5StickC was chosen as a platform due to the integrated Grove connector for clean connections and the fact it's well housed. The built-in display is a bonus, but not strictly necessary. Notifications are performed via HomeAssistant's 'alert' and 'notify' facilities, which send via Pushover to iOS & Android. diff --git a/cookbook/sonoff-basic-light-switch.rst b/cookbook/sonoff-basic-light-switch.rst index 6fa6bab26..f1de674cf 100644 --- a/cookbook/sonoff-basic-light-switch.rst +++ b/cookbook/sonoff-basic-light-switch.rst @@ -3,7 +3,6 @@ DIY Light switch using a Sonoff Basic .. seo:: :description: An example of how to integrate a light switch into Home Assistant using ESPHome - :image: sonoff_light_switch.png :keywords: Relay, Sonoff Basic, Sonoff Dual Dual R1, Light, HASS, Home Assistant, ESPHome .. note:: diff --git a/cookbook/sonoff-dual-light-switch.rst b/cookbook/sonoff-dual-light-switch.rst index 60a224058..3612fccac 100644 --- a/cookbook/sonoff-dual-light-switch.rst +++ b/cookbook/sonoff-dual-light-switch.rst @@ -3,7 +3,6 @@ DIY Light switch using a Sonoff Dual .. seo:: :description: An example of how to integrate a dual light switch into Home Assistant using ESPHome - :image: sonoff_light_switch.png :keywords: Relay, Sonoff Dual Dual R1, Light, HASS, Home Assistant, ESPHome .. note:: diff --git a/cookbook/sonoff-fishpond-pump.rst b/cookbook/sonoff-fishpond-pump.rst index 8091a8228..0a9a63a00 100644 --- a/cookbook/sonoff-fishpond-pump.rst +++ b/cookbook/sonoff-fishpond-pump.rst @@ -3,7 +3,7 @@ Sonoff Fish Pond Pump .. seo:: :description: Making an automated fish pond pump with timing and auto stop safety with Sonoff Basic ESP8266 chip - :image: images/sonoff-fishpond-pump-installed.jpg + :image: cookbook-sonoff-fishpond-pump.jpg :keywords: sonoff, esp8266, home automation, ESPHome, hass, home assistant .. figure:: images/sonoff-fishpond.jpg diff --git a/cookbook/sonoff-light-switch.rst b/cookbook/sonoff-light-switch.rst index c5e72a171..e6cf29a9a 100644 --- a/cookbook/sonoff-light-switch.rst +++ b/cookbook/sonoff-light-switch.rst @@ -3,7 +3,6 @@ Sonoff Light switch options .. seo:: :description: A series of options on using Sonoff devices as a light switch within ESPHome - :image: sonoff_light_switch.jpg :keywords: Relay, Sonoff Basic, Sonoff Dual Dual R1, Light, HASS, Home Assistant, ESPHome There are a number of options for using Sonoff Devices as light switches, including purpose built ones diff --git a/cookbook/teckin_sb50.rst b/cookbook/teckin_sb50.rst index acdbb379e..53133dba8 100644 --- a/cookbook/teckin_sb50.rst +++ b/cookbook/teckin_sb50.rst @@ -3,7 +3,7 @@ TECKIN SB50 LED Bulb .. seo:: :description: ESPHome configuration for Teckin SB50 LED Bulb. - :image: images/teckin_sb50.jpg + :image: teckin_sb50.jpg :keywords: Teckin SB50 .. figure:: images/teckin_sb50.jpg diff --git a/cookbook/tracer-an.rst b/cookbook/tracer-an.rst index 3ccb1ea41..9828a30e2 100644 --- a/cookbook/tracer-an.rst +++ b/cookbook/tracer-an.rst @@ -2,7 +2,7 @@ EPEVER® MPPT Solar Charge Controller Tracer-AN Series ===================================================== .. seo:: :description: ESPHome configuration for EPEVER® MPPT Solar Charge Controller Tracer-AN Series - :image: images/mages/tracer-an.jpg + :image: tracer-an.jpg :keywords: EPEVER Tracer .. figure:: images/tracer-an.jpg @@ -33,7 +33,7 @@ Below is the ESPHome configuration file that will get you up and running. This a arduino_version: latest platformio_options: ## larger stack size required with all registers enable_load_test - ## reduce registers or wait for integration of 2.0.0 arduinoespressif32 + ## reduce registers or wait for integration of 2.0.0 arduinoespressif32 ## not yet working needs 2.0 build_flags: - -DCONFIG_ARDUINO_LOOP_STACK_SIZE=32768 @@ -136,7 +136,7 @@ Below is the ESPHome configuration file that will get you up and running. This a mqtt: id: mqtt_client - + uart: id: mod_bus tx_pin: 19 @@ -163,7 +163,7 @@ Below is the ESPHome configuration file that will get you up and running. This a tracer-real-time: !include tracer-real-time.yaml tracer-stats: !include tracer-stats.yaml #tracer-settings: !include tracer-settings.yaml - + sensor: - platform: template accuracy_decimals: 0 @@ -305,7 +305,7 @@ Below is the ESPHome configuration file that will get you up and running. This a The definitions for most sensors is included using Packages -Rated Datum registers +Rated Datum registers tracer-rated-datum.yaml @@ -624,7 +624,7 @@ tracer-real-time.yaml Statistic registers tracer-stats.yaml - + .. code-block:: yaml sensor: diff --git a/cookbook/uart_text_sensor.rst b/cookbook/uart_text_sensor.rst index 5a578aa29..5278d8fb5 100644 --- a/cookbook/uart_text_sensor.rst +++ b/cookbook/uart_text_sensor.rst @@ -3,7 +3,7 @@ Custom UART Text Sensor .. seo:: :description: Instructions for setting up a custom uart text sensor. - :image: language-cpp.png + :image: language-cpp.svg Lots of devices communicate using the UART protocol. If you want to read lines from uart to a Text Sensor you can do so using this code example. diff --git a/devices/esp32.rst b/devices/esp32.rst index 0ecaafb1e..2e236bc04 100644 --- a/devices/esp32.rst +++ b/devices/esp32.rst @@ -3,7 +3,7 @@ Generic ESP32 .. seo:: :description: Information about how to use generic ESP32 boards in ESPHome. - :image: esp32.png + :image: esp32.svg :keywords: ESP32 All devices based on the original ESP32 are supported by ESPHome. Simply select ``ESP32`` when diff --git a/devices/esp8266.rst b/devices/esp8266.rst index a2cf4c7d2..92045866d 100644 --- a/devices/esp8266.rst +++ b/devices/esp8266.rst @@ -3,7 +3,7 @@ Generic ESP8266 .. seo:: :description: Instructions for using generic ESP8266s with ESPHome. - :image: esp8266.png + :image: esp8266.svg :keywords: ESP8266 All ESP8266-based devices are supported by ESPHome. Simply select ``ESP8266`` when diff --git a/devices/sonoff.rst b/devices/sonoff.rst index 9bb2eca46..e0ec5fe0e 100644 --- a/devices/sonoff.rst +++ b/devices/sonoff.rst @@ -3,7 +3,7 @@ Generic Sonoff .. seo:: :description: Instructions for using generic Sonoff devices with ESPHome. - :image: sonoff.png + :image: sonoff.svg In principle ESPHome supports all Sonoff devices, but as these devices are quite cheap and shipping from China takes a long time, I've only set up dedicated guides for the diff --git a/guides/automations.rst b/guides/automations.rst index 9f88b36a0..7e737147e 100644 --- a/guides/automations.rst +++ b/guides/automations.rst @@ -5,7 +5,7 @@ Automations and Templates .. seo:: :description: Getting started guide for automations in ESPHome. - :image: auto-fix.png + :image: auto-fix.svg Automations and templates are two very powerful aspects of ESPHome. Automations allow you to perform actions under certain conditions and templates are a way to easily diff --git a/guides/configuration-types.rst b/guides/configuration-types.rst index c75032db6..16b63c774 100644 --- a/guides/configuration-types.rst +++ b/guides/configuration-types.rst @@ -3,7 +3,7 @@ Configuration Types .. seo:: :description: Documentation of different configuration types in ESPHome - :image: settings.png + :image: settings.svg ESPHome’s configuration files have several configuration types. This page describes them. diff --git a/guides/contributing.rst b/guides/contributing.rst index 75e8be922..336cae91f 100644 --- a/guides/contributing.rst +++ b/guides/contributing.rst @@ -3,7 +3,7 @@ Contributing .. seo:: :description: Getting started guide for contributing to the ESPHome project - :image: github-circle.png + :image: github-circle.svg Contributions to the ESPHome suite are very welcome! All the code for the projects is hosted on GitHub and you can find the sources here: diff --git a/guides/diy.rst b/guides/diy.rst index 2126c8560..0aff2efe5 100644 --- a/guides/diy.rst +++ b/guides/diy.rst @@ -3,7 +3,7 @@ DIY Examples .. seo:: :description: Community curated list of DIY creations and custom code for ESPHome. - :image: earth.png + :image: earth.svg This is a curated list of awesome creations with ESPHome containing various custom components, blog posts, videos and sample configurations. It should serve as a means of diff --git a/guides/faq.rst b/guides/faq.rst index cddaad5c1..9947f4ade 100644 --- a/guides/faq.rst +++ b/guides/faq.rst @@ -3,7 +3,7 @@ Frequently Asked Questions .. seo:: :description: Frequently asked questions in ESPHome. - :image: question_answer.png + :image: question_answer.svg Tips for using ESPHome ---------------------- diff --git a/guides/getting_started_command_line.rst b/guides/getting_started_command_line.rst index 525696804..cd574c44f 100644 --- a/guides/getting_started_command_line.rst +++ b/guides/getting_started_command_line.rst @@ -3,7 +3,7 @@ Getting Started with ESPHome .. seo:: :description: Getting Started guide for installing ESPHome using the command line and creating a basic configuration. - :image: console.png + :image: console.svg ESPHome is the perfect solution for creating custom firmwares for your ESP8266/ESP32 boards. In this guide we’ll go through how to set up a diff --git a/guides/getting_started_hassio.rst b/guides/getting_started_hassio.rst index 00f8643ab..2569063d9 100644 --- a/guides/getting_started_hassio.rst +++ b/guides/getting_started_hassio.rst @@ -3,7 +3,7 @@ Getting Started with ESPHome and Home Assistant .. seo:: :description: Getting Started guide for installing ESPHome Dashboard as a Home Assistant add-on and creating a basic configuration. - :image: home-assistant.png + :image: home-assistant.svg ESPHome is the perfect solution for creating custom firmware for your ESP8266/ESP32 boards. In this guide we’ll go through how to setup a diff --git a/guides/migrate_espeasy.rst b/guides/migrate_espeasy.rst index bfc61a8ec..6eba19454 100644 --- a/guides/migrate_espeasy.rst +++ b/guides/migrate_espeasy.rst @@ -3,7 +3,7 @@ Migrating from ESPEasy .. seo:: :description: Migration guide for installing ESPHome on ESPs running ESPEasy. - :image: espeasy.png + :image: espeasy.svg Migrating from previous ESPEasy setups is very easy. You just need to have ESPHome create a binary for you and then upload that in the ESPEasy web interface. diff --git a/guides/migrate_espurna.rst b/guides/migrate_espurna.rst index 6de6d808c..3d5b82a44 100644 --- a/guides/migrate_espurna.rst +++ b/guides/migrate_espurna.rst @@ -3,7 +3,7 @@ Migrating from ESPurna .. seo:: :description: Migration guide for installing ESPHome on ESPs running ESPurna. - :image: espurna.png + :image: espurna.svg Migrating from previous ESPurna setups is very easy. You just need to have ESPHome create a binary for you and then upload that in the ESPurna web interface. diff --git a/guides/migrate_sonoff_tasmota.rst b/guides/migrate_sonoff_tasmota.rst index d7b7c9172..a0ada06e4 100644 --- a/guides/migrate_sonoff_tasmota.rst +++ b/guides/migrate_sonoff_tasmota.rst @@ -3,7 +3,7 @@ Migrating from Sonoff Tasmota .. seo:: :description: Migration guide for installing ESPHome on ESPs running Sonoff Tasmota. - :image: tasmota.png + :image: tasmota.svg Migrating from previous Sonoff Tasmota setups is very easy. You just need to have ESPHome create a binary for you and then upload that in the Tasmota web interface. diff --git a/images/pmsa003i-full.jpg b/images/pmsa003i-full.jpg new file mode 100644 index 000000000..9adbd3bbb Binary files /dev/null and b/images/pmsa003i-full.jpg differ diff --git a/index.rst b/index.rst index 636519e82..b368c5883 100644 --- a/index.rst +++ b/index.rst @@ -7,7 +7,7 @@ :description: ESPHome Homepage - Reimagining DIY Home Automation. ESPHome is a framework that tries to provide the best possible use experience for using ESP8266 and ESP32 microcontrollers for Home Automation. Just write a simple YAML configuration file and get your own customized firmware. - :image: logo.png + :image: logo.svg .. image:: /images/logo-text.svg diff --git a/seo.py b/seo.py index 1255a66cf..f8efb19f4 100644 --- a/seo.py +++ b/seo.py @@ -1,4 +1,5 @@ import re +from pathlib import Path from docutils import nodes from docutils.parsers.rst import Directive, directives @@ -124,8 +125,16 @@ class SEODirective(Directive): image = self.options.get("image") if image is not None: + local_img = image if not image.startswith("/"): + local_img = f"/images/{image}" image = "/_images/" + image + p = Path(__file__).parent / local_img[1:] + if not p.is_file(): + raise ValueError(f"File {p} for seo tag does not exist {self.state.document}") + + if image.endswith(".svg"): + image = image[:-len(".svg")] + ".png" self.options["image"] = env.config.html_baseurl + image return [SEONode(**self.options)] diff --git a/svg2png.py b/svg2png.py index fe5165aeb..95c31e5e8 100644 --- a/svg2png.py +++ b/svg2png.py @@ -9,8 +9,6 @@ import sys to_p = Path("svg2png") to_p.mkdir(exist_ok=True) -for f in to_p.glob("*.png"): - f.unlink() images = [ f @@ -27,23 +25,19 @@ def worker(): break to = to_p / item.with_suffix(".png").name + if to.is_file(): + q.task_done() + continue args = [ "inkscape", - "-z", - "-e", - str(to.absolute()), + f"--export-filename={to.absolute()}", "-w", "800", - "-background", - "white", + "--export-background=white", str(item.absolute()), ] print("Running: {}".format(" ".join(shlex.quote(x) for x in args))) - proc = subprocess.run(args, stdout=subprocess.PIPE, stderr=subprocess.STDOUT) - if b"Bitmap saved as" not in proc.stdout: - print("Error!") - print(proc.stdout) - sys.exit(1) + subprocess.check_call(args) q.task_done() diff --git a/svg2png/canbus.png b/svg2png/canbus.png new file mode 100644 index 000000000..6257437b0 Binary files /dev/null and b/svg2png/canbus.png differ diff --git a/svg2png/dsmr.png b/svg2png/dsmr.png new file mode 100644 index 000000000..8fb3bd434 Binary files /dev/null and b/svg2png/dsmr.png differ diff --git a/svg2png/external_components.png b/svg2png/external_components.png new file mode 100644 index 000000000..91ff7f773 Binary files /dev/null and b/svg2png/external_components.png differ diff --git a/svg2png/fingerprint.png b/svg2png/fingerprint.png new file mode 100644 index 000000000..3f5524f72 Binary files /dev/null and b/svg2png/fingerprint.png differ diff --git a/svg2png/improv.png b/svg2png/improv.png new file mode 100644 index 000000000..2ac6dac8b Binary files /dev/null and b/svg2png/improv.png differ diff --git a/svg2png/made-for-esphome-black-on-transparent.png b/svg2png/made-for-esphome-black-on-transparent.png new file mode 100644 index 000000000..967538bd7 Binary files /dev/null and b/svg2png/made-for-esphome-black-on-transparent.png differ diff --git a/svg2png/made-for-esphome-black-on-white.png b/svg2png/made-for-esphome-black-on-white.png new file mode 100644 index 000000000..06edeec48 Binary files /dev/null and b/svg2png/made-for-esphome-black-on-white.png differ diff --git a/svg2png/made-for-esphome-white-on-black.png b/svg2png/made-for-esphome-white-on-black.png new file mode 100644 index 000000000..44d61983a Binary files /dev/null and b/svg2png/made-for-esphome-white-on-black.png differ diff --git a/svg2png/made-for-esphome-white-on-transparent.png b/svg2png/made-for-esphome-white-on-transparent.png new file mode 100644 index 000000000..f6713d636 Binary files /dev/null and b/svg2png/made-for-esphome-white-on-transparent.png differ diff --git a/svg2png/midea.png b/svg2png/midea.png new file mode 100644 index 000000000..04f7026ca Binary files /dev/null and b/svg2png/midea.png differ diff --git a/svg2png/restart-alert.png b/svg2png/restart-alert.png new file mode 100644 index 000000000..d1d12de9f Binary files /dev/null and b/svg2png/restart-alert.png differ diff --git a/svg2png/sm2135.png b/svg2png/sm2135.png new file mode 100644 index 000000000..a91a8701e Binary files /dev/null and b/svg2png/sm2135.png differ diff --git a/web-api/index.rst b/web-api/index.rst index e09e4d538..4136fd079 100644 --- a/web-api/index.rst +++ b/web-api/index.rst @@ -3,7 +3,7 @@ Web Server API .. seo:: :description: Migration guide for installing ESPHome on ESPs running ESPEasy. - :image: espeasy.png + :image: espeasy.svg Since version 1.3, ESPHome includes a built-in web server that can be used to view states and send commands. In addition to the web-frontend available under the root index of the