diff --git a/Doxygen b/Doxygen index 73c4f55546..15dff3273b 100644 --- a/Doxygen +++ b/Doxygen @@ -38,7 +38,7 @@ PROJECT_NAME = "ESPHome" # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 2023.7.0-dev +PROJECT_NUMBER = 2023.9.0-dev # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/_static/changelog-2023.4.0.png b/_static/changelog-2023.4.0.png index 38b1133009..a8417672ad 100644 Binary files a/_static/changelog-2023.4.0.png and b/_static/changelog-2023.4.0.png differ diff --git a/_static/changelog-2023.5.0.png b/_static/changelog-2023.5.0.png index 964b215e6c..ee7ca27fcc 100644 Binary files a/_static/changelog-2023.5.0.png and b/_static/changelog-2023.5.0.png differ diff --git a/_static/changelog-2023.6.0.png b/_static/changelog-2023.6.0.png index b7a75bd06b..807a8c6410 100644 Binary files a/_static/changelog-2023.6.0.png and b/_static/changelog-2023.6.0.png differ diff --git a/_static/changelog-2023.7.0.png b/_static/changelog-2023.7.0.png new file mode 100644 index 0000000000..b745b6f2a8 Binary files /dev/null and b/_static/changelog-2023.7.0.png differ diff --git a/_static/changelog-2023.8.0.png b/_static/changelog-2023.8.0.png new file mode 100644 index 0000000000..f043242443 Binary files /dev/null and b/_static/changelog-2023.8.0.png differ diff --git a/_static/custom.css b/_static/custom.css index 052882239f..b442b6a9e1 100644 --- a/_static/custom.css +++ b/_static/custom.css @@ -1,8 +1,10 @@ .row-odd { background-color: #f3f6f6; } + .table-center tr.row-even > td { text-align: center; + vertical-align: top; } div.document { @@ -26,6 +28,7 @@ img.component-image { height: 85px; object-fit: contain; border-radius: 10px; + max-width: 190px; } table.docutils { @@ -36,6 +39,7 @@ table.docutils { -webkit-animation: 2s linear infinite blink_effect; animation: 2s linear infinite blink_effect; } + @-webkit-keyframes blink_effect { 0% { visibility: hidden; @@ -47,6 +51,7 @@ table.docutils { visibility: visible; } } + @keyframes blink_effect { 0% { visibility: hidden; @@ -74,10 +79,12 @@ table.docutils { z-index: 9999; display: none; } + .footer-button-container { margin: 0 60px 0 10px; float: right; } + .footer-button { background-color: #b3b3b3; color: #4e4e4e; @@ -88,6 +95,7 @@ table.docutils { cursor: pointer; text-decoration: none; } + .not-hidden { display: block !important; } @@ -133,7 +141,6 @@ div.index-shields { } .guide-card { - color: #004b6b; display: block; height: auto; width: 300px; @@ -149,17 +156,20 @@ div.index-shields { margin: 16px !important; } -.guide-code { - padding: 8px 16px; - margin: 8px; - color: black; +.guide-card .example { + margin: 10px; +} + +.guide-card pre { white-space: pre-line; + padding: 15px; } -@media screen and (min-width: 870px) { +@media screen and (min-width: 875px) { .guide-card:first-child { z-index: 100; } + .guide-card:nth-child(2) { z-index: 50; } @@ -170,23 +180,163 @@ div.index-shields { } } -@media screen and (max-width: 870px) { +@media screen and (max-width: 875px) { + + div.sphinxsidebar { + width: 100%; + background: #fff; + color: #000; + border-bottom: 1px solid #444; + } + + div.sphinxsidebar p.logo { + display: initial; + } + + div.sphinxsidebar a, div.sphinxsidebar h3, div.sphinxsidebar h3 a { + color: #444; + } + .guide-container { flex-direction: column; } + .guide-card { width: 100%; margin: 8px 0; padding: 0px; } + .guide-card:not(:first-child) { margin-left: 0; } + .guide-card ul { margin-left: 32px; } + + img.component-image { + max-width: 80px; + } } .breadcrumbs li { display: inline; } + +a { + color: #004B6B; + text-decoration: none; + border-bottom: 1px dotted #004B6B; +} + +a:hover { + color: #999999; + text-decoration: none; + border-bottom: 1px dotted #999999; +} + +a:hover code { + background: none; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + hyphens: none; +} + +/* dark theme */ +@media (prefers-color-scheme: dark) { + + @media screen and (max-width: 875px) { + div.documentwrapper { + background-color: #212121; + } + + div.sphinxsidebar { + background: #212121; + color: #ececec; + } + + } + + body, div.body { + color: #ececec; + background-color: #212121; + } + + img.dark-invert, img.logo { + filter: invert(1); + } + + .row-odd { + background-color: #282828; + } + + table.docutils { + -webkit-box-shadow: 2px 2px 4px #3b3838; + box-shadow: 2px 2px 4px #3b3838; + } + + div.body { + color: #ececec; + background-color: #212121; + } + + a, a.reference, a:visited { + color: #00bfff; + border-bottom: 1px dotted #00bfff; + } + + a:hover { + color: #87ceeb; + border-bottom: 1px solid #87ceeb; + } + + .toctree-wrapper a code { + color: #00bfff; + } + + div.sphinxsidebar h3, div.sphinxsidebar h3 a { + color: #ececec; + } + + div.sphinxsidebar ul { + color: #ececec; + } + + div.sphinxsidebar a, .breadcrumbs a { + color: #ececec; + border-bottom: 1px dotted #ececec; + } + + div.sphinxsidebar a:hover, .breadcrumbs a:hover { + border-bottom: 1px solid #ececec; + } + + .guide-card { + background-color: #393939; + } + + pre { + background-color: #0d1117; + } + + code { + background-color: #424242; + color: #e2e2e2; + } + + div.note, div.tip { + background-color: #2d2c2c; + border: 1px solid #808080; + } + + div.warning, div.caution { + background-color: #5d1616; + } + + dt:target, span.highlighted { + background-color: #8e8129; + } + +} \ No newline at end of file diff --git a/_static/version b/_static/version index fbecf950ca..58a3878803 100644 --- a/_static/version +++ b/_static/version @@ -1 +1 @@ -2023.7.0-dev \ No newline at end of file +2023.9.0-dev \ No newline at end of file diff --git a/_themes/esphome/theme.conf b/_themes/esphome/theme.conf new file mode 100644 index 0000000000..2c74b63973 --- /dev/null +++ b/_themes/esphome/theme.conf @@ -0,0 +1,4 @@ +[theme] +inherit = alabaster +pygments_style = xcode +pygments_dark_style = github-dark diff --git a/changelog/2021.10.0.rst b/changelog/2021.10.0.rst index 0b9ca54c9d..28b1b2e0bc 100644 --- a/changelog/2021.10.0.rst +++ b/changelog/2021.10.0.rst @@ -11,12 +11,12 @@ ESPHome 2021.10.0 - 20th October 2021 :columns: 3 AirThings Wave Mini, components/sensor/airthings_ble, airthings_logo.png - Current-Based Cover, components/cover/current_based, flash.svg + Current-Based Cover, components/cover/current_based, flash.svg, dark-invert Daly BMS, components/sensor/daly_bms, daly_bms.jpg EPEVER Tracer, cookbook/tracer-an, tracer-an.jpg LTR390, components/sensor/ltr390, ltr390.jpg Modbus Controller, components/modbus_controller, modbus.png - Safe Mode Switch, components/switch/safe_mode, restart-alert.svg + Safe Mode Switch, components/switch/safe_mode, restart-alert.svg, dark-invert SCD4X, components/sensor/scd4x, scd4x.jpg Tuya Cover, components/cover/tuya, tuya.png diff --git a/changelog/2021.11.0.rst b/changelog/2021.11.0.rst index acb6ccdb9f..de6b1c2623 100644 --- a/changelog/2021.11.0.rst +++ b/changelog/2021.11.0.rst @@ -12,8 +12,8 @@ ESPHome 2021.11.0 - 17th November 2021 CSE7761, components/sensor/cse7761, cse7761.svg CAP1188 Capacitive Touch Sensor, components/binary_sensor/cap1188, cap1188.jpg - ESP32 Camera Web Server, components/esp32_camera_web_server, camera.svg - Improv via Serial, components/improv_serial, improv.svg + ESP32 Camera Web Server, components/esp32_camera_web_server, camera.svg, dark-invert + Improv via Serial, components/improv_serial, improv.svg, dark-invert State of the Open Smart Home diff --git a/changelog/2021.12.0.rst b/changelog/2021.12.0.rst index 80b87e8bea..5a3d61275b 100644 --- a/changelog/2021.12.0.rst +++ b/changelog/2021.12.0.rst @@ -10,10 +10,10 @@ ESPHome 2021.12.0 - 11th December 2021 .. imgtable:: :columns: 3 - Button Core, components/button/index, folder-open.svg - Template Button, components/button/template, description.svg - Restart Button, components/button/restart, restart.svg - BLE Binary Output, components/output/ble_client, bluetooth.svg + Button Core, components/button/index, folder-open.svg, dark-invert + Template Button, components/button/template, description.svg, dark-invert + Restart Button, components/button/restart, restart.svg, dark-invert + BLE Binary Output, components/output/ble_client, bluetooth.svg, dark-invert Tuya Text Sensor, components/text_sensor/tuya, tuya.png SDP800 Series, components/sensor/sdp3x, sdp31.jpg, Pressure diff --git a/changelog/2021.8.0.rst b/changelog/2021.8.0.rst index ae3577549a..9483cc315e 100644 --- a/changelog/2021.8.0.rst +++ b/changelog/2021.8.0.rst @@ -12,8 +12,8 @@ ESPHome 2021.8.0 - 18th August 2021 AM43, components/sensor/am43, am43.jpg AM43 Cover, components/cover/am43, am43.jpg - Color Temperature Light, components/light/color_temperature, brightness-medium.svg - Demo, components/demo, description.svg + Color Temperature Light, components/light/color_temperature, brightness-medium.svg, dark-invert + Demo, components/demo, description.svg, dark-invert DSMR, components/sensor/dsmr, dsmr.svg HRXL MaxSonar WR, components/sensor/hrxl_maxsonar_wr, hrxl_maxsonar_wr.jpg PipSolar - compatible PV Inverter, components/pipsolar, pipsolar.jpg @@ -24,8 +24,8 @@ ESPHome 2021.8.0 - 18th August 2021 Selec Meter, components/sensor/selec_meter, selec_meter_em2m.jpg T6613/15, components/sensor/t6615, t6615.jpg TLC5947, components/output/tlc5947, tlc5947.jpg - Select Core, components/select/index, folder-open.svg - Template Select, components/select/template, description.svg + Select Core, components/select/index, folder-open.svg, dark-invert + Template Select, components/select/template, description.svg, dark-invert TSL2591, components/sensor/tsl2591, tsl2591.jpg diff --git a/changelog/2021.9.0.rst b/changelog/2021.9.0.rst index 24ec3656c6..14af834dc4 100644 --- a/changelog/2021.9.0.rst +++ b/changelog/2021.9.0.rst @@ -11,7 +11,7 @@ ESPHome 2021.9.0 - 15th September 2021 :columns: 3 AirThings BLE, components/sensor/airthings_ble, airthings_logo.png - H-bridge Fan, components/fan/hbridge, fan.svg + H-bridge Fan, components/fan/hbridge, fan.svg, dark-invert ST7920, components/display/st7920, st7920.jpg diff --git a/changelog/2022.1.0.rst b/changelog/2022.1.0.rst index ee74aa0a4b..9d4295130f 100644 --- a/changelog/2022.1.0.rst +++ b/changelog/2022.1.0.rst @@ -17,12 +17,12 @@ ESPHome 2022.1.0 - 19th January 2022 Growatt Solar, components/sensor/growatt_solar, growatt.jpg INA260, components/sensor/ina260, ina260.jpg Inkplate 10, components/display/inkplate6, inkplate6.jpg - Kalman Combinator, components/sensor/kalman_combinator, function.svg + Kalman Combinator, components/sensor/kalman_combinator, function.svg, dark-invert MCP3204, components/sensor/mcp3204, mcp3204.jpg MCP47A1, components/output/mcp47a1, mcp47a1.svg - Midea IR Climate, components/climate/ir_climate, air-conditioner-ir.svg - Safe Mode Button, components/button/safe_mode, restart-alert.svg - Shutdown Button, components/button/shutdown, power_settings.svg + Midea IR Climate, components/climate/ir_climate, air-conditioner-ir.svg, dark-invert + Safe Mode Button, components/button/safe_mode, restart-alert.svg, dark-invert + Shutdown Button, components/button/shutdown, power_settings.svg, dark-invert Tuya Number, components/number/tuya, tuya.png diff --git a/changelog/2022.10.0.rst b/changelog/2022.10.0.rst index f1332badf7..2471c0928a 100644 --- a/changelog/2022.10.0.rst +++ b/changelog/2022.10.0.rst @@ -10,8 +10,8 @@ ESPHome 2022.10.0 - 19th October 2022 .. imgtable:: :columns: 2 - BLE Client RSSI Sensor, components/sensor/ble_client, bluetooth.svg - ZHLT01 IR Climate, components/climate/climate_ir, air-conditioner-ir.svg + BLE Client RSSI Sensor, components/sensor/ble_client, bluetooth.svg, dark-invert + ZHLT01 IR Climate, components/climate/climate_ir, air-conditioner-ir.svg, dark-invert diff --git a/changelog/2022.11.0.rst b/changelog/2022.11.0.rst index ca168fb39c..bb4331745f 100644 --- a/changelog/2022.11.0.rst +++ b/changelog/2022.11.0.rst @@ -11,12 +11,12 @@ ESPHome 2022.11.0 - 16th November 2022 :columns: 4 RP2040, components/rp2040, rp2040.svg - WL-134 Pet Tag Sensor , components/text_sensor/wl_134, fingerprint.svg - Ethernet Info, components/text_sensor/ethernet_info, ethernet.svg + WL-134 Pet Tag Sensor , components/text_sensor/wl_134, fingerprint.svg, dark-invert + Ethernet Info, components/text_sensor/ethernet_info, ethernet.svg, dark-invert Atlas Scientific Peristaltic Pump, components/ezo_pmp, ezo-pmp.jpg ADC128S102, components/sensor/adc128s102, adc128s102.png - Daikin BRC, components/climate/climate_ir, air-conditioner-ir.svg - Display Menu Core, components/display_menu/index, folder-open.svg + Daikin BRC, components/climate/climate_ir, air-conditioner-ir.svg, dark-invert + Display Menu Core, components/display_menu/index, folder-open.svg, dark-invert LCD Menu, components/display_menu/lcd_menu, lcd_menu.png diff --git a/changelog/2022.12.0.rst b/changelog/2022.12.0.rst index ebe6fb9404..7ed99d06c1 100644 --- a/changelog/2022.12.0.rst +++ b/changelog/2022.12.0.rst @@ -11,7 +11,7 @@ ESPHome 2022.12.0 - 14th December 2022 :columns: 3 ESP32, components/esp32, esp32.svg - Bluetooth Proxy, components/bluetooth_proxy, bluetooth.svg + Bluetooth Proxy, components/bluetooth_proxy, bluetooth.svg, dark-invert SN74HC165 I/O Expander, components/sn74hc165, sn74hc595.jpg The festive holidays are coming early and bring you an ESPHome release 1 week earlier than normal. diff --git a/changelog/2022.2.0.rst b/changelog/2022.2.0.rst index 5a0667e27d..5b11e14253 100644 --- a/changelog/2022.2.0.rst +++ b/changelog/2022.2.0.rst @@ -10,18 +10,18 @@ ESPHome 2022.2.0 - 16th February 2022 .. imgtable:: :columns: 4 - Lock Core, components/lock/index, folder-open.svg - Generic Output Lock, components/lock/output, upload.svg - Template Lock, components/lock/template, description.svg + Lock Core, components/lock/index, folder-open.svg, dark-invert + Generic Output Lock, components/lock/output, upload.svg, dark-invert + Template Lock, components/lock/template, description.svg, dark-invert QR Code, components/display/index, qr-code.svg - Touchscreen Core, components/touchscreen/index, folder-open.svg + Touchscreen Core, components/touchscreen/index, folder-open.svg, dark-invert EKTF2232, components/touchscreen/ektf2232, ektf2232.svg Lilygo T5 4.7", components/touchscreen/lilygo_t5_47, lilygo_t5_47_touch.jpg MLX90393, components/sensor/mlx90393, mlx90393.jpg - Wake-on-LAN Button, components/button/wake_on_lan, power_settings.svg - Generic Output Button, components/button/output, upload.svg + Wake-on-LAN Button, components/button/wake_on_lan, power_settings.svg, dark-invert + Generic Output Button, components/button/output, upload.svg, dark-invert Xiaomi MHOC303, components/sensor/xiaomi_ble, xiaomi_mijia_logo.jpg RadonEye BLE, components/sensor/radon_eye_ble, radon_eye_logo.png diff --git a/changelog/2022.3.0.rst b/changelog/2022.3.0.rst index bd4c001ab8..e877da1fde 100644 --- a/changelog/2022.3.0.rst +++ b/changelog/2022.3.0.rst @@ -10,9 +10,9 @@ ESPHome 2022.3.0 - 16th March 2022 .. imgtable:: :columns: 4 - Analog Threshold, components/binary_sensor/analog_threshold, analog_threshold.svg + Analog Threshold, components/binary_sensor/analog_threshold, analog_threshold.svg, dark-invert MAX44009, components/sensor/max44009, max44009.svg - Copy, components/copy, content-copy.svg + Copy, components/copy, content-copy.svg, dark-invert MPU6886, components/sensor/mpu6886, mpu6886.jpg MCP4728, components/output/mcp4728, mcp4728.jpg Honeywell ABP, components/sensor/honeywellabp, honeywellabp.jpg diff --git a/changelog/2022.5.0.rst b/changelog/2022.5.0.rst index 418bf656d3..61a20f6253 100644 --- a/changelog/2022.5.0.rst +++ b/changelog/2022.5.0.rst @@ -15,7 +15,7 @@ ESPHome 2022.5.0 - 18th May 2022 ENS210, components/sensor/ens210, ens210.jpg SEN5x, components/sensor/sen5x, sen54.jpg SML, components/sml, sml.svg - Delonghi Penguino PAC W120HP, components/climate/climate_ir, air-conditioner-ir.svg + Delonghi Penguino PAC W120HP, components/climate/climate_ir, air-conditioner-ir.svg, dark-invert Rename ------ diff --git a/changelog/2022.6.0.rst b/changelog/2022.6.0.rst index 0b0e7a00a1..d732468140 100644 --- a/changelog/2022.6.0.rst +++ b/changelog/2022.6.0.rst @@ -12,7 +12,7 @@ ESPHome 2022.6.0 - 15th June 2022 Tuya Select, components/select/tuya, tuya.png SGP41, components/sensor/sgp4x, sgp40.jpg - Media Player Core, components/media_player/index, folder-open.svg + Media Player Core, components/media_player/index, folder-open.svg, dark-invert I2S Audio, components/media_player/i2s_audio, i2s_audio.svg diff --git a/changelog/2022.8.0.rst b/changelog/2022.8.0.rst index 0ffbd59bc2..336a92210b 100644 --- a/changelog/2022.8.0.rst +++ b/changelog/2022.8.0.rst @@ -11,11 +11,11 @@ ESPHome 2022.8.0 - 17th August 2022 :columns: 3 DAC7678, components/output/dac7678, dac7678.svg - Sprinkler, components/sprinkler, sprinkler-variant.svg - Feedback Cover, components/cover/feedback, feedback_cover.svg + Sprinkler, components/sprinkler, sprinkler-variant.svg, dark-invert + Feedback Cover, components/cover/feedback, feedback_cover.svg, dark-invert SMT100, components/sensor/smt100, smt100.jpg, Moisture & Temperature - Whynter IR Climate, components/climate/climate_ir, air-conditioner-ir.svg - Bluetooth Proxy, components/bluetooth_proxy, bluetooth.svg + Whynter IR Climate, components/climate/climate_ir, air-conditioner-ir.svg, dark-invert + Bluetooth Proxy, components/bluetooth_proxy, bluetooth.svg, dark-invert Bluetooth Proxy diff --git a/changelog/2022.9.0.rst b/changelog/2022.9.0.rst index 79edc788f5..0bf235670f 100644 --- a/changelog/2022.9.0.rst +++ b/changelog/2022.9.0.rst @@ -16,8 +16,8 @@ ESPHome 2022.9.0 - 21st September 2022 MPL3115A2, components/sensor/mpl3115a2, mpl3115a2.jpg uFire EC sensor, components/sensor/ufire_ec, ufire_ec.png uFire ISE sensor, components/sensor/ufire_ise, ufire_ise.png - Factory Reset Switch, components/switch/factory_reset, restart-alert.svg - Factory Reset Button, components/button/factory_reset, restart-alert.svg + Factory Reset Switch, components/switch/factory_reset, restart-alert.svg, dark-invert + Factory Reset Button, components/button/factory_reset, restart-alert.svg, dark-invert TM1638, components/display/tm1638, tm1638.jpg BL0942, components/sensor/bl0942, bl0942.png diff --git a/changelog/2023.2.0.rst b/changelog/2023.2.0.rst index 1d8bbc6bee..b2a96e959f 100644 --- a/changelog/2023.2.0.rst +++ b/changelog/2023.2.0.rst @@ -15,13 +15,13 @@ ESPHome 2023.2.0 - 15th February 2023 BP5758D, components/output/bp5758d, bp5758d.svg SM2235, components/output/sm2235, sm2235.svg SM2335, components/output/sm2335, sm2335.svg - PCF85063 RTC, components/time/pcf85063, clock-outline.svg + PCF85063 RTC, components/time/pcf85063, clock-outline.svg, dark-invert Matrix Keypad, components/matrix_keypad, matrix_keypad.jpg X9C Potentiometer, components/output/x9c, x9c.jpg EE895, components/sensor/ee895, EE895.png HTE501, components/sensor/hte501, HTE501.png TEE501, components/sensor/tee501, TEE501.png - Sigma-Delta Output, components/output/sigma_delta, sigma-delta.svg + Sigma-Delta Output, components/output/sigma_delta, sigma-delta.svg, dark-invert Wiegand Reader, components/wiegand, wiegand.jpg MiCS-4514, components/sensor/mics_4514, mics_4514.jpg LD2410, components/sensor/ld2410, ld2410.jpg diff --git a/changelog/2023.3.0.rst b/changelog/2023.3.0.rst index 9924054b03..9b08367f6e 100644 --- a/changelog/2023.3.0.rst +++ b/changelog/2023.3.0.rst @@ -10,12 +10,12 @@ ESPHome 2023.3.0 - 15th March 2023 .. imgtable:: :columns: 4 - Internal Temperature, components/sensor/internal_temperature, thermometer.svg + Internal Temperature, components/sensor/internal_temperature, thermometer.svg, dark-invert Mopeka Standard Check LP, components/sensor/mopeka_std_check, mopeka_std_check.jpg Person Sensor (SEN21231), components/sensor/sen21231, sen21231.png Haier Climate, components/climate/haier, haier.svg FS3000, components/sensor/fs3000, fs3000.jpg - Absolute Humidity, components/sensor/absolute_humidity, water-drop.svg + Absolute Humidity, components/sensor/absolute_humidity, water-drop.svg, dark-invert AS7341, components/sensor/as7341, as7341.jpg, Spectral Color Sensor diff --git a/changelog/2023.4.0.rst b/changelog/2023.4.0.rst index 375fd8540a..9bcdefc88e 100644 --- a/changelog/2023.4.0.rst +++ b/changelog/2023.4.0.rst @@ -10,11 +10,11 @@ ESPHome 2023.4.0 - 19th April 2023 .. imgtable:: :columns: 3 - Voice Assistant, components/voice_assistant, voice-assistant.svg - Microphone Core, components/microphone/index, microphone.svg + Voice Assistant, components/voice_assistant, voice-assistant.svg, dark-invert + Microphone Core, components/microphone/index, microphone.svg, dark-invert I2S Microphone, components/microphone/i2s_audio, i2s_audio.svg MMC5603, components/sensor/mmc5603, mmc5603.jpg - KSZ8081 Ethernet, components/ethernet, ethernet.svg + KSZ8081 Ethernet, components/ethernet, ethernet.svg, dark-invert Voice Assistant diff --git a/changelog/2023.5.0.rst b/changelog/2023.5.0.rst index f2e8583dec..89acd71fd3 100644 --- a/changelog/2023.5.0.rst +++ b/changelog/2023.5.0.rst @@ -10,7 +10,7 @@ ESPHome 2023.5.0 - 17th May 2023 .. imgtable:: :columns: 4 - Speaker Core, components/speaker/index, speaker.svg + Speaker Core, components/speaker/index, speaker.svg, dark-invert I2S Speaker, components/speaker/i2s_audio, i2s_audio.svg MLX90614, components/sensor/mlx90614, mlx90614.jpg MAX6956 I/O expander - I²C Bus, components/max6956, max6956.jpg diff --git a/changelog/2023.6.0.rst b/changelog/2023.6.0.rst index 5b6115e1a1..fd2645d162 100644 --- a/changelog/2023.6.0.rst +++ b/changelog/2023.6.0.rst @@ -10,9 +10,9 @@ ESPHome 2023.6.0 - 21st June 2023 .. imgtable:: :columns: 2 - Alarm Control Panel Core, components/alarm_control_panel/index, alarm-panel.svg - Template Alarm Control Panel, components/alarm_control_panel/template, description.svg - RP2040 PIO LED Strip, components/light/rp2040_pio_led_strip, color_lens.svg + Alarm Control Panel Core, components/alarm_control_panel/index, alarm-panel.svg, dark-invert + Template Alarm Control Panel, components/alarm_control_panel/template, description.svg, dark-invert + RP2040 PIO LED Strip, components/light/rp2040_pio_led_strip, color_lens.svg, dark-invert TMP1075, components/sensor/tmp1075, tmp1075.jpg Dark Mode 😎 @@ -55,6 +55,34 @@ Release 2023.6.1 - June 23 - Make ethernet_info work with esp-idf framework :esphomepr:`4976` by :ghuser:`HeMan` - display: fix white screen on binary displays :esphomepr:`4991` by :ghuser:`ayufan` +Release 2023.6.2 - June 23 +-------------------------- + +- remove unused static declarations :esphomepr:`4993` by :ghuser:`ssieb` +- Fix rp2040 pio tool download :esphomepr:`4994` by :ghuser:`jesserockz` + +Release 2023.6.3 - June 28 +-------------------------- + +- Update webserver to 56d73b5 :esphomepr:`5007` by :ghuser:`jesserockz` +- Synchronise Device Classes from Home Assistant :esphomepr:`5018` by :ghuser:`esphomebot` +- Fixes compressed downloads :esphomepr:`5014` by :ghuser:`fdcastel` +- Add CONFIG_BT_BLE_42_FEATURES_SUPPORTED for ble :esphomepr:`5008` by :ghuser:`jesserockz` + +Release 2023.6.4 - July 4 +------------------------- + +- [SCD30] Disable negative temperature offset :esphomepr:`4850` by :ghuser:`ardichoke` +- fix template binary_sensor publish_initial_state option :esphomepr:`5033` by :ghuser:`dudanov` +- Add alarm to reserved ids :esphomepr:`5042` by :ghuser:`grahambrown11` +- Advertise noise is enabled :esphomepr:`5034` by :ghuser:`bdraco` +- Update webserver to ea86d81 :esphomepr:`5023` by :ghuser:`jesserockz` + +Release 2023.6.5 - July 10 +-------------------------- + +- Fix bulk and single Bluetooth parser coexistence :esphomepr:`5073` by :ghuser:`bdraco` +- binary_sensor: Validate max_length for on_click/on_double_click :esphomepr:`5068` by :ghuser:`kpfleming` Breaking Changes ---------------- diff --git a/changelog/2023.7.0.rst b/changelog/2023.7.0.rst new file mode 100644 index 0000000000..1ad66f454d --- /dev/null +++ b/changelog/2023.7.0.rst @@ -0,0 +1,221 @@ +ESPHome 2023.7.0 - 19th July 2023 +================================= + +.. seo:: + :description: Changelog for ESPHome 2023.7.0. + :image: /_static/changelog-2023.7.0.png + :author: Jesse Hills + :author_twitter: @jesserockz + +.. imgtable:: + :columns: 4 + + XL9535 I/O Expander, components/xl9535, xl9535.svg + Zio Ultrasonic Sensor, components/sensor/zio_ultrasonic, zio_ultrasonic.jpg + Alpha3, components/sensor/alpha3, alpha3.jpg + PCF8563 RTC, components/time/pcf8563, clock-outline.svg, dark-invert + TT21100, components/touchscreen/tt21100, esp32-s3-korvo-2-lcd.png + Grove TB6612FNG, components/grove_tb6612fng, motor.png + ATM90E26, components/sensor/atm90e26, atm90e26.jpg + Duty Time, components/sensor/duty_time, timer-play-outline.svg, dark-invert + +Webserver with ESP-IDF +---------------------- + +This releases adds support for the :doc:`Webserver ` and :doc:`/components/captive_portal` +when using the ``esp-idf`` framework on ESP32 boards. + +Display components +------------------ + +This release adds a few changes to the display core code to optimise and allow for future +improvements which are already in progress. This also may bring breaking changes to the internal APIs that ``external_components`` +may be relying on. + +A new warning in the logs +------------------------- + +.. code:: text + + [00:00:00][W][component:204]: Component xxxxxx took a long time for an operation (x.xx s). + [00:00:00][W][component:205]: Components should block for at most 20-30ms. + + +These 2 log lines may show up in the most recent version of ESPHome due to the log level being changed from `verbose` to `warning`. +I made this change because changing the device log level to verbose just to see if these lines show up significantly slowed down +the device due to all the extra logging it had to do. + +Please do not report new issues for this, but `comment on this issue `__ +if someone has not already commented for that specific component. + + +Full list of changes +-------------------- + +New Components +^^^^^^^^^^^^^^ + +- XL9535 I/O Expander :esphomepr:`4899` by :ghuser:`mreditor97` (new-integration) +- Add Zio Ultrasonic Distance Sensor Component :esphomepr:`5059` by :ghuser:`kahrendt` (new-integration) +- Add Alpha3 pump component :esphomepr:`3787` by :ghuser:`jan-hofmeier` (new-integration) +- RTC implementation of pcf8563 :esphomepr:`4998` by :ghuser:`KoenBreeman` (new-integration) +- web server esp idf suppport :esphomepr:`3500` by :ghuser:`dentra` (new-integration) +- Add TT21100 touchscreen component :esphomepr:`4793` by :ghuser:`kroimon` (new-integration) +- Add support for Grove tb6612 fng :esphomepr:`4797` by :ghuser:`max246` (new-integration) +- Add support for ATM90E26 :esphomepr:`4366` by :ghuser:`danieltwagner` (new-integration) +- New 'Duty Time' sensor component :esphomepr:`5069` by :ghuser:`dudanov` (new-integration) + +Breaking Changes +^^^^^^^^^^^^^^^^ + +- display: add `BaseFont` and introduce `Font::draw` methods :esphomepr:`4963` by :ghuser:`ayufan` (breaking-change) +- display: Rename `display.DisplayBufferRef` to `display.DisplayRef` used by lambda :esphomepr:`5002` by :ghuser:`ayufan` (breaking-change) +- Remove template switch restore_state :esphomepr:`5106` by :ghuser:`jesserockz` (breaking-change) + +Beta Changes +^^^^^^^^^^^^ + +- Dont do mqtt ip lookup if `use_address` has ip address :esphomepr:`5096` by :ghuser:`jesserockz` +- ESP32 enable ADC2 when wifi is disabled :esphomepr:`4381` by :ghuser:`pciavald` +- [Sprinkler] Resume fixes :esphomepr:`5100` by :ghuser:`hostcc` +- Remove template switch restore_state :esphomepr:`5106` by :ghuser:`jesserockz` (breaking-change) +- Add timeout filter :esphomepr:`5104` by :ghuser:`clydebarrow` +- P1 values for capacity tariff in Belgium :esphomepr:`5081` by :ghuser:`bwynants` +- airthings_wave: Silence compiler warnings :esphomepr:`5098` by :ghuser:`kpfleming` +- Sigma delta fix :esphomepr:`4911` by :ghuser:`PlainTechEnthusiast` +- [LD2410] Remove baud_rate check :esphomepr:`5112` by :ghuser:`voed` +- Fix silence detection flag on voice assistant :esphomepr:`5120` by :ghuser:`jesserockz` + +Release 2023.7.1 - August 1 +--------------------------- + +- Dashboard: use Popen() on Windows :esphomepr:`5110` by :ghuser:`kuba2k2` +- Swap ADC back to use 'int' because C3 :esphomepr:`5151` by :ghuser:`kbx81` +- wifi: handle WIFI_REASON_ROAMING reason in event :esphomepr:`5153` by :ghuser:`stintel` +- Slightly lower template switch setup priority :esphomepr:`5163` by :ghuser:`cvwillegen` +- update "Can't convert" warning to match others in homeassistant_sensor :esphomepr:`5162` by :ghuser:`PlainTechEnthusiast` +- Increase maximum number of BLE notifications :esphomepr:`5155` by :ghuser:`bdraco` +- invert min_rssi check :esphomepr:`5150` by :ghuser:`Jorre05` +- Fix graininess & streaks for 7.50inV2alt Waveshare e-paper :esphomepr:`5168` by :ghuser:`Egglestron` + +All changes +^^^^^^^^^^^ + +- Upgraded Haier climate component implementation :esphomepr:`4521` by :ghuser:`paveldn` +- display: add `BaseFont` and introduce `Font::draw` methods :esphomepr:`4963` by :ghuser:`ayufan` (breaking-change) +- display/font: optimise font rendering by about 25% :esphomepr:`4956` by :ghuser:`ayufan` +- display: move `Rect` into `rect.cpp/.h` :esphomepr:`4957` by :ghuser:`ayufan` +- Bump pytest from 7.3.1 to 7.3.2 :esphomepr:`4936` by :ghuser:`dependabot[bot]` +- Add read/write for 16bit registers :esphomepr:`4844` by :ghuser:`CarsonF` +- XL9535 I/O Expander :esphomepr:`4899` by :ghuser:`mreditor97` (new-integration) +- Fix python venv restoring :esphomepr:`4965` by :ghuser:`jesserockz` +- Preprocess away unused code when IPv6 is disabled :esphomepr:`4973` by :ghuser:`HeMan` +- Bump aioesphomeapi from 14.0.0 to 14.1.0 :esphomepr:`4972` by :ghuser:`dependabot[bot]` +- Add actions to animation :esphomepr:`4959` by :ghuser:`guillempages` +- Bump zeroconf from 0.63.0 to 0.69.0 :esphomepr:`4970` by :ghuser:`dependabot[bot]` +- mqtt: add ESP-IDF >= 5.0 support :esphomepr:`4854` by :ghuser:`stintel` +- display: move `Image`, `Font` and `Animation` code into components :esphomepr:`4967` by :ghuser:`ayufan` +- support empty schemas and one platform components :esphomepr:`4999` by :ghuser:`glmnet` +- update dsmr to 0.7 :esphomepr:`5011` by :ghuser:`Pvlerick` +- add water delivered to dsmr component :esphomepr:`4237` by :ghuser:`jerome992` +- Update sync workflow :esphomepr:`5017` by :ghuser:`jesserockz` +- Bump aioesphomeapi from 14.1.0 to 15.0.0 :esphomepr:`5012` by :ghuser:`dependabot[bot]` +- Bump pyupgrade from 3.4.0 to 3.7.0 :esphomepr:`4971` by :ghuser:`dependabot[bot]` +- Bump pytest from 7.3.2 to 7.4.0 :esphomepr:`5000` by :ghuser:`dependabot[bot]` +- Attempt to fix script parameters :esphomepr:`4627` by :ghuser:`jesserockz` +- Remove yaml test cache :esphomepr:`5019` by :ghuser:`jesserockz` +- Bump esptool from 4.6 to 4.6.2 :esphomepr:`4949` by :ghuser:`dependabot[bot]` +- Bump pytest-mock from 3.10.0 to 3.11.1 :esphomepr:`4977` by :ghuser:`dependabot[bot]` +- binary_sensor removed unused filter :esphomepr:`5039` by :ghuser:`dudanov` +- binary_sensor filters templatable delays :esphomepr:`5029` by :ghuser:`dudanov` +- Improve the gamma settings for the S3-Box-lite display :esphomepr:`5046` by :ghuser:`guillempages` +- Prepare ethernet to work with esp idf 5.0 :esphomepr:`5037` by :ghuser:`HeMan` +- Prepare debug and logger component to work with idf 5.0 :esphomepr:`5036` by :ghuser:`HeMan` +- Mopeka std fixes :esphomepr:`5041` by :ghuser:`Fabian-Schmidt` +- Adjust signature for on_disconnect :esphomepr:`5009` by :ghuser:`bdraco` +- Log component long time message at warning level :esphomepr:`5048` by :ghuser:`jesserockz` +- Log start of i2c setup :esphomepr:`5049` by :ghuser:`jesserockz` +- Initial debug component support for rp2040 :esphomepr:`5056` by :ghuser:`HeMan` +- Fix when idf component has broken symlinks :esphomepr:`5058` by :ghuser:`jesserockz` +- Some tests wasn't running (locally) :esphomepr:`5050` by :ghuser:`HeMan` +- [ILI9xxx] Add ili9488_a (alternative gamma configuration for ILI9488) :esphomepr:`5027` by :ghuser:`lnicolas83` +- [ili9xxx] Allow config of spi data rate. :esphomepr:`4701` by :ghuser:`Fabian-Schmidt` +- Make scheduler debuging work with idf >= 5 :esphomepr:`5052` by :ghuser:`HeMan` +- Adds 1.54" e-ink display (gdew0154m09) support to waveshare_epaper component :esphomepr:`4939` by :ghuser:`tobiasoort` +- display: split `DisplayBuffer` and `Display` :esphomepr:`5001` by :ghuser:`ayufan` +- Fixed ili9xxx_display update() method :esphomepr:`5013` by :ghuser:`nielsnl68` +- [Ethernet] ksz8081rna support :esphomepr:`4739` by :ghuser:`Fabian-Schmidt` +- Improve BME680 BSEC sensor device classes :esphomepr:`4859` by :ghuser:`trvrnrth` +- Update RP2040 Aruino framwork and platform to latest :esphomepr:`5025` by :ghuser:`HeMan` +- Allow pillow versions over 10 :esphomepr:`5071` by :ghuser:`HeMan` +- display: Rename `display.DisplayBufferRef` to `display.DisplayRef` used by lambda :esphomepr:`5002` by :ghuser:`ayufan` (breaking-change) +- Add Zio Ultrasonic Distance Sensor Component :esphomepr:`5059` by :ghuser:`kahrendt` (new-integration) +- Add Alpha3 pump component :esphomepr:`3787` by :ghuser:`jan-hofmeier` (new-integration) +- RTC implementation of pcf8563 :esphomepr:`4998` by :ghuser:`KoenBreeman` (new-integration) +- web server esp idf suppport :esphomepr:`3500` by :ghuser:`dentra` (new-integration) +- Add TT21100 touchscreen component :esphomepr:`4793` by :ghuser:`kroimon` (new-integration) +- tuya_light: fix float->int conversion while setting color temperature :esphomepr:`5067` by :ghuser:`kswt` +- Fix typo in mpu6050.cpp :esphomepr:`5086` by :ghuser:`stefanklug` +- airthings_wave: Battery level reporting :esphomepr:`4979` by :ghuser:`kpfleming` +- Add support for Grove tb6612 fng :esphomepr:`4797` by :ghuser:`max246` (new-integration) +- Add MCP2515 12MHz xtal support :esphomepr:`5089` by :ghuser:`clydebarrow` +- Correct message for standard transmission. :esphomepr:`5088` by :ghuser:`clydebarrow` +- Restrict pillow to versions before 10.0.0 :esphomepr:`5090` by :ghuser:`jesserockz` +- Bump esphome-dashboard to 20230711.0 :esphomepr:`5085` by :ghuser:`jesserockz` +- added uart final validate data bits :esphomepr:`5079` by :ghuser:`dudanov` +- Add support for ATM90E26 :esphomepr:`4366` by :ghuser:`danieltwagner` (new-integration) +- Grove amend name :esphomepr:`5093` by :ghuser:`max246` +- Fixing colon for tm1637 display if inverted set true :esphomepr:`5072` by :ghuser:`paveldn` +- Fix use of optional :esphomepr:`5091` by :ghuser:`dudanov` +- New 'Duty Time' sensor component :esphomepr:`5069` by :ghuser:`dudanov` (new-integration) +- Fix PIDController::in_deadband() to give correct result when error is zero :esphomepr:`5078` by :ghuser:`lewissbaker` +- Edit error message for pillow install to add version restrictions :esphomepr:`5094` by :ghuser:`jesserockz` +- Dont do mqtt ip lookup if `use_address` has ip address :esphomepr:`5096` by :ghuser:`jesserockz` +- ESP32 enable ADC2 when wifi is disabled :esphomepr:`4381` by :ghuser:`pciavald` +- [Sprinkler] Resume fixes :esphomepr:`5100` by :ghuser:`hostcc` +- Remove template switch restore_state :esphomepr:`5106` by :ghuser:`jesserockz` (breaking-change) +- Add timeout filter :esphomepr:`5104` by :ghuser:`clydebarrow` +- P1 values for capacity tariff in Belgium :esphomepr:`5081` by :ghuser:`bwynants` +- airthings_wave: Silence compiler warnings :esphomepr:`5098` by :ghuser:`kpfleming` +- Sigma delta fix :esphomepr:`4911` by :ghuser:`PlainTechEnthusiast` +- [LD2410] Remove baud_rate check :esphomepr:`5112` by :ghuser:`voed` +- Fix silence detection flag on voice assistant :esphomepr:`5120` by :ghuser:`jesserockz` + +Past Changelogs +--------------- + +- :doc:`2023.6.0` +- :doc:`2023.5.0` +- :doc:`2023.4.0` +- :doc:`2023.3.0` +- :doc:`2023.2.0` +- :doc:`2022.12.0` +- :doc:`2022.11.0` +- :doc:`2022.10.0` +- :doc:`2022.9.0` +- :doc:`2022.8.0` +- :doc:`2022.6.0` +- :doc:`2022.5.0` +- :doc:`2022.4.0` +- :doc:`2022.3.0` +- :doc:`2022.2.0` +- :doc:`2022.1.0` +- :doc:`2021.12.0` +- :doc:`2021.11.0` +- :doc:`2021.10.0` +- :doc:`2021.9.0` +- :doc:`2021.8.0` +- :doc:`v1.20.0` +- :doc:`v1.19.0` +- :doc:`v1.18.0` +- :doc:`v1.17.0` +- :doc:`v1.16.0` +- :doc:`v1.15.0` +- :doc:`v1.14.0` +- :doc:`v1.13.0` +- :doc:`v1.12.0` +- :doc:`v1.11.0` +- :doc:`v1.10.0` +- :doc:`v1.9.0` +- :doc:`v1.8.0` +- :doc:`v1.7.0` diff --git a/changelog/2023.8.0.rst b/changelog/2023.8.0.rst new file mode 100644 index 0000000000..06fe5cac67 --- /dev/null +++ b/changelog/2023.8.0.rst @@ -0,0 +1,192 @@ +ESPHome 2023.8.0 - 16th August 2023 +=================================== + +.. seo:: + :description: Changelog for ESPHome 2023.8.0. + :image: /_static/changelog-2023.8.0.png + :author: Jesse Hills + :author_twitter: @jesserockz + +.. imgtable:: + :columns: 2 + + A01NYUB, components/sensor/a01nyub, a01nyub.jpg + KMeterISO, components/sensor/kmeteriso, kmeteriso.jpg + BMP581, components/sensor/bmp581, bmp581.jpg + GCJA5, components/sensor/gcja5, gcja5.svg + +LD2410 +------ + +The LD2410 component has had a massive upgrade thanks to :ghuser:`regevbr`! +It now supports settings most if not all configuration parameters via ``switches`` / ``numbers`` and ``selects`` +and exposes more data via various ``sensors``. +This includes breaking changes that mean the existing gate configuration options have been moved to the ``number`` platform. + +Full list of changes +-------------------- + +New Components +^^^^^^^^^^^^^^ + +- Add support for a01nyub :esphomepr:`4863` by :ghuser:`MrSuicideParrot` (new-integration) +- Add KMeterISO component. :esphomepr:`5170` by :ghuser:`Rudd-O` (new-integration) +- New component: Add support for bmp581 pressure and temperature sensors :esphomepr:`4657` by :ghuser:`kahrendt` (new-integration) +- New PM sensor Panasonic SN-GCJA5 :esphomepr:`4988` by :ghuser:`gcormier` (new-integration) +- Add configuration flow abilites to the ld2410 component :esphomepr:`4434` by :ghuser:`regevbr` (new-integration) (notable-change) (breaking-change) + +Breaking Changes +^^^^^^^^^^^^^^^^ + +- Coolix IR protocol improvements :esphomepr:`5105` by :ghuser:`dudanov` (breaking-change) +- Speaker return bytes written and do not wait for queue :esphomepr:`5182` by :ghuser:`jesserockz` (breaking-change) +- Change device name in MQTT discovery messages to friendly names :esphomepr:`5205` by :ghuser:`pidpawel` (breaking-change) +- Add configuration flow abilites to the ld2410 component :esphomepr:`4434` by :ghuser:`regevbr` (new-integration) (notable-change) (breaking-change) + +Beta Changes +^^^^^^^^^^^^ + +- Read string of bool env and match against well known values :esphomepr:`5232` by :ghuser:`jesserockz` +- fix aeha data template :esphomepr:`5231` by :ghuser:`ssieb` +- Expose start to speaker interface :esphomepr:`5228` by :ghuser:`jesserockz` +- New features added for Haier integration :esphomepr:`5196` by :ghuser:`paveldn` +- pca9554 cache reads :esphomepr:`5137` by :ghuser:`hwstar` +- fix midea: undo approved PR#4053 :esphomepr:`5233` by :ghuser:`dudanov` +- Fixing smartair2 protocol implementation if no Wi-Fi :esphomepr:`5238` by :ghuser:`paveldn` +- tuya: add time sync callback only once to prevent memleak :esphomepr:`5234` by :ghuser:`afflux` +- Fix duplicate tuya time warning :esphomepr:`5243` by :ghuser:`jesserockz` +- Change XL9535 `setup_priority` to IO :esphomepr:`5246` by :ghuser:`mreditor97` +- rmt_base additional minor changes :esphomepr:`5245` by :ghuser:`dudanov` +- Fix 24 bit signed integer parsing in sml parser :esphomepr:`5250` by :ghuser:`mulder-fbi` +- Fix IDFI2CBus::writev ignoring stop parameter :esphomepr:`4840` by :ghuser:`CarsonF` +- Add configuration flow abilites to the ld2410 component :esphomepr:`4434` by :ghuser:`regevbr` (new-integration) (notable-change) (breaking-change) + +Notable Changes +^^^^^^^^^^^^^^^ + +- Change MQTT client for ESP32 Arduino :esphomepr:`5157` by :ghuser:`HeMan` (notable-change) +- Add configuration flow abilites to the ld2410 component :esphomepr:`4434` by :ghuser:`regevbr` (new-integration) (notable-change) (breaking-change) + +All changes +^^^^^^^^^^^ + +- Mk2 to prepare color.h for idf >= 5 :esphomepr:`5070` by :ghuser:`HeMan` +- display: Add helper methods to `Display::clip` and `Display::clamp_x/y_` :esphomepr:`5003` by :ghuser:`ayufan` +- Mark repo as safe directory to git config :esphomepr:`5102` by :ghuser:`davet2001` +- Bump click from 8.1.3 to 8.1.5 :esphomepr:`5099` by :ghuser:`dependabot[bot]` +- Bump pyyaml from 6.0 to 6.0.1 :esphomepr:`5117` by :ghuser:`dependabot[bot]` +- ignore components folder in root :esphomepr:`5130` by :ghuser:`jesserockz` +- Add size getter to CallbackManager :esphomepr:`5129` by :ghuser:`jesserockz` +- Make docker use pip installed pillow :esphomepr:`5074` by :ghuser:`HeMan` +- Change datatype in e131 addressable light :esphomepr:`5127` by :ghuser:`HeMan` +- Streamer mode :esphomepr:`5119` by :ghuser:`grahambrown11` +- Version bump for ESP32 IDF and Arduino :esphomepr:`5035` by :ghuser:`HeMan` +- Synchronise Device Classes from Home Assistant :esphomepr:`5136` by :ghuser:`esphomebot` +- Update known boards to 5.4.0 :esphomepr:`5134` by :ghuser:`jesserockz` +- Init colorama in ESPHome main :esphomepr:`5111` by :ghuser:`kuba2k2` +- Coolix IR protocol improvements :esphomepr:`5105` by :ghuser:`dudanov` (breaking-change) +- Allow esp32 idf components to specify submodules and specific components :esphomepr:`5128` by :ghuser:`jesserockz` +- Synchronise Device Classes from Home Assistant :esphomepr:`5147` by :ghuser:`esphomebot` +- Prepare some components for IDF >= 5 :esphomepr:`5061` by :ghuser:`HeMan` +- Bump clang-tidy from 11 to 14 :esphomepr:`5160` by :ghuser:`dudanov` +- climate triggers Climate and ClimateCall references :esphomepr:`5028` by :ghuser:`dudanov` +- remote_base changes :esphomepr:`5124` by :ghuser:`dudanov` +- Add 'map_linear' and 'clamp' sensor filters :esphomepr:`5040` by :ghuser:`Mat931` +- Adding Inkplate 6 v2 model variant :esphomepr:`5165` by :ghuser:`mullerdavid` +- duty_time: fix build without binary_sensor. Parented in automations. :esphomepr:`5156` by :ghuser:`dudanov` +- Add standardized CRC helper functions :esphomepr:`4798` by :ghuser:`Mat931` +- Enable IPv6 for ESP32 Arduino, wifi and ethernet :esphomepr:`4865` by :ghuser:`HeMan` +- Bump zeroconf from 0.69.0 to 0.71.4 :esphomepr:`5148` by :ghuser:`dependabot[bot]` +- Bump black from 23.3.0 to 23.7.0 :esphomepr:`5126` by :ghuser:`dependabot[bot]` +- Bump pylint from 2.17.4 to 2.17.5 :esphomepr:`5172` by :ghuser:`dependabot[bot]` +- Bump pyupgrade from 3.7.0 to 3.9.0 :esphomepr:`5083` by :ghuser:`dependabot[bot]` +- Vertical and horizontal airflow actions fix for Haier climate :esphomepr:`5164` by :ghuser:`paveldn` +- Microphone add is_stopped :esphomepr:`5183` by :ghuser:`jesserockz` +- Add get_board function to esp32 module :esphomepr:`5184` by :ghuser:`jesserockz` +- Speaker return bytes written and do not wait for queue :esphomepr:`5182` by :ghuser:`jesserockz` (breaking-change) +- Update components "if x in config" :esphomepr:`5181` by :ghuser:`jesserockz` +- Bump click from 8.1.5 to 8.1.6 :esphomepr:`5179` by :ghuser:`dependabot[bot]` +- PWM Output on RP2040 for high frequencies :esphomepr:`5204` by :ghuser:`matemaciek` +- Fix some configs after #5181 :esphomepr:`5209` by :ghuser:`jesserockz` +- Improved compensation sgp30 :esphomepr:`5208` by :ghuser:`arno1801` +- Add support for a01nyub :esphomepr:`4863` by :ghuser:`MrSuicideParrot` (new-integration) +- Change device name in MQTT discovery messages to friendly names :esphomepr:`5205` by :ghuser:`pidpawel` (breaking-change) +- Add ESP32-S2/S3 capacitive touch support :esphomepr:`5116` by :ghuser:`kbx81` +- Bump zeroconf from 0.71.4 to 0.74.0 :esphomepr:`5199` by :ghuser:`dependabot[bot]` +- Implemented Waveshare 7.5in B V3 :esphomepr:`5210` by :ghuser:`lucasprim` +- Refactor `pulse_meter` to better handle higher frequencies :esphomepr:`4231` by :ghuser:`TrentHouliston` +- Change MQTT client for ESP32 Arduino :esphomepr:`5157` by :ghuser:`HeMan` (notable-change) +- Add read interface to microphone :esphomepr:`5131` by :ghuser:`jesserockz` +- i2c: fix build on ESP-IDF >= 5.1 :esphomepr:`5200` by :ghuser:`stintel` +- Add socket define for rp2040 dev :esphomepr:`4968` by :ghuser:`jesserockz` +- core: read ESP32 MAC address from eFuse if IEEE802.15.4 is supported :esphomepr:`5176` by :ghuser:`stintel` +- esp32_ble_beacon: enable CONFIG_BT_BLE_42_FEATURES_SUPPORTED :esphomepr:`5211` by :ghuser:`stintel` +- Bump pytest-asyncio from 0.21.0 to 0.21.1 :esphomepr:`5187` by :ghuser:`dependabot[bot]` +- ledc: check SOC_LEDC_SUPPORT_APB_CLOCK :esphomepr:`5212` by :ghuser:`stintel` +- Add arm night to alarm control panel :esphomepr:`5186` by :ghuser:`primeroz` +- Bump pyupgrade from 3.9.0 to 3.10.1 :esphomepr:`5189` by :ghuser:`dependabot[bot]` +- Add KMeterISO component. :esphomepr:`5170` by :ghuser:`Rudd-O` (new-integration) +- Bump platformio from 6.1.7 to 6.1.9 :esphomepr:`5066` by :ghuser:`dependabot[bot]` +- New component: Add support for bmp581 pressure and temperature sensors :esphomepr:`4657` by :ghuser:`kahrendt` (new-integration) +- New PM sensor Panasonic SN-GCJA5 :esphomepr:`4988` by :ghuser:`gcormier` (new-integration) +- Daly BMS improvements :esphomepr:`3388` by :ghuser:`matthias882` +- Add missing `on_(arming|pending|armed_home|armed_night|armed_away|disarmed)` triggers to alarm_control_panel :esphomepr:`5219` by :ghuser:`primeroz` +- add value option to timeout filter :esphomepr:`5222` by :ghuser:`ssieb` +- Tweak Color init because IDF 5+ :esphomepr:`5221` by :ghuser:`kbx81` +- Read string of bool env and match against well known values :esphomepr:`5232` by :ghuser:`jesserockz` +- fix aeha data template :esphomepr:`5231` by :ghuser:`ssieb` +- Expose start to speaker interface :esphomepr:`5228` by :ghuser:`jesserockz` +- New features added for Haier integration :esphomepr:`5196` by :ghuser:`paveldn` +- pca9554 cache reads :esphomepr:`5137` by :ghuser:`hwstar` +- fix midea: undo approved PR#4053 :esphomepr:`5233` by :ghuser:`dudanov` +- Fixing smartair2 protocol implementation if no Wi-Fi :esphomepr:`5238` by :ghuser:`paveldn` +- tuya: add time sync callback only once to prevent memleak :esphomepr:`5234` by :ghuser:`afflux` +- Fix duplicate tuya time warning :esphomepr:`5243` by :ghuser:`jesserockz` +- Change XL9535 `setup_priority` to IO :esphomepr:`5246` by :ghuser:`mreditor97` +- rmt_base additional minor changes :esphomepr:`5245` by :ghuser:`dudanov` +- Fix 24 bit signed integer parsing in sml parser :esphomepr:`5250` by :ghuser:`mulder-fbi` +- Fix IDFI2CBus::writev ignoring stop parameter :esphomepr:`4840` by :ghuser:`CarsonF` +- Add configuration flow abilites to the ld2410 component :esphomepr:`4434` by :ghuser:`regevbr` (new-integration) (notable-change) (breaking-change) +- Add `libfreetype-dev` Debian package for armv7 Docker builds :esphomepr:`5262` by :ghuser:`pierlon` +- Add delay before enabling ipv6 :esphomepr:`5256` by :ghuser:`HeMan` +- Bump zeroconf from 0.74.0 to 0.80.0 :esphomepr:`5260` by :ghuser:`dependabot[bot]` + +Past Changelogs +--------------- + +- :doc:`2023.7.0` +- :doc:`2023.6.0` +- :doc:`2023.5.0` +- :doc:`2023.4.0` +- :doc:`2023.3.0` +- :doc:`2023.2.0` +- :doc:`2022.12.0` +- :doc:`2022.11.0` +- :doc:`2022.10.0` +- :doc:`2022.9.0` +- :doc:`2022.8.0` +- :doc:`2022.6.0` +- :doc:`2022.5.0` +- :doc:`2022.4.0` +- :doc:`2022.3.0` +- :doc:`2022.2.0` +- :doc:`2022.1.0` +- :doc:`2021.12.0` +- :doc:`2021.11.0` +- :doc:`2021.10.0` +- :doc:`2021.9.0` +- :doc:`2021.8.0` +- :doc:`v1.20.0` +- :doc:`v1.19.0` +- :doc:`v1.18.0` +- :doc:`v1.17.0` +- :doc:`v1.16.0` +- :doc:`v1.15.0` +- :doc:`v1.14.0` +- :doc:`v1.13.0` +- :doc:`v1.12.0` +- :doc:`v1.11.0` +- :doc:`v1.10.0` +- :doc:`v1.9.0` +- :doc:`v1.8.0` +- :doc:`v1.7.0` diff --git a/changelog/index.rst b/changelog/index.rst index 8911502147..dd73ab54e5 100644 --- a/changelog/index.rst +++ b/changelog/index.rst @@ -2,7 +2,7 @@ Changelog ========= .. redirect:: - :url: /changelog/2023.6.0.html + :url: /changelog/2023.8.0.html .. toctree:: :glob: diff --git a/changelog/v1.10.0.rst b/changelog/v1.10.0.rst index f82f675bb2..66bdd66904 100644 --- a/changelog/v1.10.0.rst +++ b/changelog/v1.10.0.rst @@ -9,17 +9,17 @@ Changelog - Version 1.10.0 .. imgtable:: - Native API, components/api, server-network.svg - Dashboard+Hass.io Add-On Updates, guides/getting_started_hassio, home-assistant.svg - Better Custom Components, components/sensor/custom, language-cpp.svg + Native API, components/api, server-network.svg, dark-invert + Dashboard+Hass.io Add-On Updates, guides/getting_started_hassio, home-assistant.svg, dark-invert + Better Custom Components, components/sensor/custom, language-cpp.svg, dark-invert APDS9960, components/sensor/apds9960, apds9960.jpg MAX31855, components/sensor/max31855, max31855.jpg ULN2003, components/stepper/index, stepper.svg - NeoPixelBus Light, components/light/neopixelbus, color_lens.svg - ESP32 Ethernet, components/ethernet, ethernet.svg - Home Assistant Sensor, components/sensor/homeassistant, home-assistant.svg + NeoPixelBus Light, components/light/neopixelbus, color_lens.svg, dark-invert + ESP32 Ethernet, components/ethernet, ethernet.svg, dark-invert + Home Assistant Sensor, components/sensor/homeassistant, home-assistant.svg, dark-invert Native API diff --git a/changelog/v1.11.0.rst b/changelog/v1.11.0.rst index c2f55a4fed..f76a750611 100644 --- a/changelog/v1.11.0.rst +++ b/changelog/v1.11.0.rst @@ -9,9 +9,9 @@ Changelog - Version 1.11.0 .. imgtable:: - Completed Rename, index, logo.svg - Home Assistant Binary Sensor, components/binary_sensor/homeassistant, home-assistant.svg - Light Partition, components/light/partition, color_lens.svg + Completed Rename, index, logo.svg, dark-invert + Home Assistant Binary Sensor, components/binary_sensor/homeassistant, home-assistant.svg, dark-invert + Light Partition, components/light/partition, color_lens.svg, dark-invert Release 1.11.0 is here, and it has been a busy few weeks :) diff --git a/changelog/v1.12.0.rst b/changelog/v1.12.0.rst index 4640cf72f3..67a2059dea 100644 --- a/changelog/v1.12.0.rst +++ b/changelog/v1.12.0.rst @@ -9,15 +9,15 @@ Changelog - Version 1.12.0 .. imgtable:: - User-Defined Services, components/api.html#user-defined-services, home-assistant.svg - ESP32 Camera, components/esp32_camera, camera.svg + User-Defined Services, components/api.html#user-defined-services, home-assistant.svg, dark-invert + ESP32 Camera, components/esp32_camera, camera.svg, dark-invert MPR121, components/binary_sensor/mpr121, mpr121.jpg SDS011, components/sensor/sds011, sds011.jpg MCP23017, components/mcp23017, mcp23017.svg Servo, components/servo, servo.svg - WiFi Info, components/text_sensor/wifi_info, network-wifi.svg + WiFi Info, components/text_sensor/wifi_info, network-wifi.svg, dark-invert It's release day! 🎉 Today I'm happy to release ESPHome 1.12.0. What's new? A lot of awesome stuff got added! Let me walk you through it: diff --git a/changelog/v1.13.0.rst b/changelog/v1.13.0.rst index eb7a72cc9d..e44094d350 100644 --- a/changelog/v1.13.0.rst +++ b/changelog/v1.13.0.rst @@ -10,30 +10,30 @@ Changelog - Version 1.13.0 - May 30th 2019 .. imgtable:: :columns: 4 - Climate Devices, components/climate/index, folder-open.svg - Endstop Cover, components/cover/endstop, electric-switch.svg - Time-Based Cover, components/cover/time_based, timer.svg - Bang Bang Controller, components/climate/bang_bang, air-conditioner.svg + Climate Devices, components/climate/index, folder-open.svg, dark-invert + Endstop Cover, components/cover/endstop, electric-switch.svg, dark-invert + Time-Based Cover, components/cover/time_based, timer.svg, dark-invert + Bang Bang Controller, components/climate/bang_bang, air-conditioner.svg, dark-invert AM2320, components/sensor/am2320, am2320.jpg CCS811, components/sensor/ccs811, ccs811.jpg - Integration, components/sensor/integration, sigma.svg - Pulse Width, components/sensor/pulse_width, pulse.svg + Integration, components/sensor/integration, sigma.svg, dark-invert + Pulse Width, components/sensor/pulse_width, pulse.svg, dark-invert - Resistance Sensor, components/sensor/resistance, omega.svg + Resistance Sensor, components/sensor/resistance, omega.svg, dark-invert NTC Thermistor, components/sensor/ntc, ntc.jpg CT Clamp, components/sensor/ct_clamp, ct_clamp.jpg Binary Sensor Map, components/sensor/binary_sensor_map, binary_sensor_map.jpg TTP229, components/binary_sensor/ttp229, ttp229.jpg - Coolix IR Remote, components/climate/coolix, air-conditioner.svg - Tcl112 IR Remote, components/climate/tcl112, air-conditioner.svg - Sun, components/sun, weather-sunny.svg - - GPS Time Source, components/gps, crosshairs-gps.svg - Custom Light, components/light/custom, language-cpp.svg - Custom Cover, components/cover/custom, language-cpp.svg - Custom Climate, components/climate/custom, language-cpp.svg + Coolix IR Remote, components/climate/coolix, air-conditioner.svg, dark-invert + Tcl112 IR Remote, components/climate/tcl112, air-conditioner.svg, dark-invert + Sun, components/sun, weather-sunny.svg, dark-invert + + GPS Time Source, components/gps, crosshairs-gps.svg, dark-invert + Custom Light, components/light/custom, language-cpp.svg, dark-invert + Custom Cover, components/cover/custom, language-cpp.svg, dark-invert + Custom Climate, components/climate/custom, language-cpp.svg, dark-invert Oh hi there! diff --git a/changelog/v1.14.0.rst b/changelog/v1.14.0.rst index 6fe862a40b..8d10732bad 100644 --- a/changelog/v1.14.0.rst +++ b/changelog/v1.14.0.rst @@ -10,10 +10,10 @@ Changelog - Version 1.14.0 - November 1 .. imgtable:: :columns: 5 - Captive Portal, components/captive_portal, wifi-strength-alert-outline.svg - Visual Studio Code Plugin, https://marketplace.visualstudio.com/items?itemName=ESPHome.esphome-vscode, visual-studio-code.svg + Captive Portal, components/captive_portal, wifi-strength-alert-outline.svg, dark-invert + Visual Studio Code Plugin, https://marketplace.visualstudio.com/items?itemName=ESPHome.esphome-vscode, visual-studio-code.svg, dark-invert SIM800L, components/sim800l, sim800l.jpg - DFPlayer, components/dfplayer, dfplayer.svg + DFPlayer, components/dfplayer, dfplayer.svg, dark-invert AS3935, components/sensor/as3935, as3935.jpg ATM90E32, components/sensor/atm90e32, atm90e32.jpg @@ -36,9 +36,9 @@ Changelog - Version 1.14.0 - November 1 TLC59208F, components/output/tlc59208f, tlc59208f.jpg SM16716, components/output/sm16716, sm16716.svg - Tuya Dimmer, components/light/tuya, brightness-medium.svg + Tuya Dimmer, components/light/tuya, brightness-medium.svg, dark-invert SSD1325, components/display/ssd1325, ssd1325.jpg - Yashima IR Remote, components/climate/yashima, air-conditioner.svg + Yashima IR Remote, components/climate/yashima, air-conditioner.svg, dark-invert MCP23008 I/O Expander, components/mcp230xx, mcp230xx.svg SX1509 I/O Expander, components/sx1509, sx1509.jpg diff --git a/changelog/v1.15.0.rst b/changelog/v1.15.0.rst index e314bcc5ec..4c95a4665e 100644 --- a/changelog/v1.15.0.rst +++ b/changelog/v1.15.0.rst @@ -22,7 +22,7 @@ Changelog - Version 1.15.0 - September 13, 2020 Xiaomi BLE, components/sensor/xiaomi_ble, xiaomi_mijia_logo.jpg Slow PWM, components/output/slow_pwm, pwm.png ESP32 DAC, components/output/esp32_dac, dac.svg - AC Dimmer, components/output/ac_dimmer, ac_dimmer.svg + AC Dimmer, components/output/ac_dimmer, ac_dimmer.svg, dark-invert Tuya Fan, components/fan/tuya, tuya.png Tuya Binary Sensor, components/binary_sensor/tuya, tuya.png Tuya Dimmer, components/light/tuya, tuya.png @@ -35,12 +35,12 @@ Changelog - Version 1.15.0 - September 13, 2020 ST7789V, components/display/st7789v, st7789v.jpg ILI9341, components/display/ili9341, ili9341.jpg PCD8544 (Nokia 5110/ 3310), components/display/pcd8544, pcd8544.jpg - BLE Scanner, components/text_sensor/ble_scanner, bluetooth.svg - Custom UART Text Sensor, components/text_sensor/uart, language-cpp.svg - Thermostat Controller, components/climate/thermostat, air-conditioner.svg - PID Controller, components/climate/pid, function.svg - IR Remote Climate, components/climate/ir_climate, air-conditioner-ir.svg - HTTP Request, components/http_request, connection.svg + BLE Scanner, components/text_sensor/ble_scanner, bluetooth.svg, dark-invert + Custom UART Text Sensor, components/text_sensor/uart, language-cpp.svg, dark-invert + Thermostat Controller, components/climate/thermostat, air-conditioner.svg, dark-invert + PID Controller, components/climate/pid, function.svg, dark-invert + IR Remote Climate, components/climate/ir_climate, air-conditioner-ir.svg, dark-invert + HTTP Request, components/http_request, connection.svg, dark-invert MCP3008 8-Channel 10-Bit A/D Converter, components/mcp3008, mcp3008.jpg SN74HC595 I/O Expander, components/sn74hc595, sn74hc595.jpg TM1651 Battery Display, components/tm1651, tm1651_battery_display.jpg diff --git a/changelog/v1.16.0.rst b/changelog/v1.16.0.rst index 1d3daed69f..6af304e119 100644 --- a/changelog/v1.16.0.rst +++ b/changelog/v1.16.0.rst @@ -13,7 +13,7 @@ Changelog - Version 1.16.0 - February 3, 2021 TMP102, components/sensor/tmp102, tmp102.jpg MCP9808, components/sensor/mcp9808, mcp9808.jpg RC522, components/binary_sensor/rc522, rc522.jpg - H-bridge Light, components/light/hbridge, brightness-medium.svg + H-bridge Light, components/light/hbridge, brightness-medium.svg, dark-invert ILI9341, components/display/ili9341, ili9341.jpg Teleinfo, components/sensor/teleinfo, teleinfo.jpg EZO sensor circuits, components/sensor/ezo, ezo-ph-circuit.png diff --git a/changelog/v1.17.0.rst b/changelog/v1.17.0.rst index 6b70bd96e8..951ba084ba 100644 --- a/changelog/v1.17.0.rst +++ b/changelog/v1.17.0.rst @@ -16,7 +16,7 @@ Changelog - Version 1.17.0 - 4th May 2021 Xiaomi Miscale2, components/sensor/xiaomi_miscale2, xiaomi_miscale2.jpg Midea Air Conditioner, components/climate/midea_ac, midea.svg Addressable Light Display, components/display/addressable_light, addressable_light.jpg - Pulse Meter, components/sensor/pulse_meter, pulse.svg + Pulse Meter, components/sensor/pulse_meter, pulse.svg, dark-invert So, ESPHome was acquired by Nabu Casa. That was big and unexpected, but awesome news for the project as now I have been hired diff --git a/changelog/v1.18.0.rst b/changelog/v1.18.0.rst index 92e0ce92ac..baf2cb68f1 100644 --- a/changelog/v1.18.0.rst +++ b/changelog/v1.18.0.rst @@ -16,13 +16,13 @@ Changelog - Version 1.18.0 - 19th May 2021 SHT4X, components/sensor/sht4x, sht4x.jpg TCA9548A I²C Multiplexer, components/tca9548a, tca9548a.jpg - Grow Fingerprint Reader, components/fingerprint_grow, fingerprint.svg + Grow Fingerprint Reader, components/fingerprint_grow, fingerprint.svg, dark-invert TOF10120, components/sensor/tof10120, tof10120.jpg SM2135, components/output/sm2135, sm2135.svg - ESP32 BLE Client, components/ble_client, bluetooth.svg - BLE Sensor, components/sensor/ble_sensor, bluetooth.svg - External Components, components/external_components, external_components.svg + ESP32 BLE Client, components/ble_client, bluetooth.svg, dark-invert + BLE Sensor, components/sensor/ble_sensor, bluetooth.svg, dark-invert + External Components, components/external_components, external_components.svg, dark-invert It feels like I was just writing the release notes for 1.17 not long ago, so here's to getting ESPHome going on a regular schedule. diff --git a/changelog/v1.19.0.rst b/changelog/v1.19.0.rst index 99cbec3ab9..f7e407a3ae 100644 --- a/changelog/v1.19.0.rst +++ b/changelog/v1.19.0.rst @@ -10,7 +10,7 @@ Changelog - Version 1.19.0 - 16th June 2021 .. imgtable:: :columns: 3 - Improv, components/esp32_improv, improv.svg + Improv, components/esp32_improv, improv.svg, dark-invert SM2135, components/output/sm2135, sm2135.svg XPT2046, components/binary_sensor/xpt2046, xpt2046.jpg SDM Meter, components/sensor/sdm_meter, sdm220m.jpg diff --git a/changelog/v1.20.0.rst b/changelog/v1.20.0.rst index d7448c0c8a..bf3581c4fa 100644 --- a/changelog/v1.20.0.rst +++ b/changelog/v1.20.0.rst @@ -10,8 +10,8 @@ Changelog - Version 1.20.0 - 21st July 2021 .. imgtable:: :columns: 2 - Number Core, components/number/index, folder-open.svg - Template Number, components/number/template, description.svg + Number Core, components/number/index, folder-open.svg, dark-invert + Template Number, components/number/template, description.svg, dark-invert Havells Inverter, components/sensor/havells_solar, havellsgti5000d_s.jpg Anova Cooker, components/climate/anova, anova.png diff --git a/changelog/v1.7.0.rst b/changelog/v1.7.0.rst index ba4587f12e..9dcef87e45 100644 --- a/changelog/v1.7.0.rst +++ b/changelog/v1.7.0.rst @@ -19,15 +19,15 @@ be travelling a lot (and enjoying my vacation 😎), so don't expect too many aw .. imgtable:: - ESP32 BLE Beacon, components/esp32_ble_beacon, bluetooth.svg - Status LED, components/status_led, led-on.svg - WiFi Signal Strength, components/sensor/wifi_signal, network-wifi.svg + ESP32 BLE Beacon, components/esp32_ble_beacon, bluetooth.svg, dark-invert + Status LED, components/status_led, led-on.svg, dark-invert + WiFi Signal Strength, components/sensor/wifi_signal, network-wifi.svg, dark-invert - Duty Cycle Sensor, components/sensor/duty_cycle, percent.svg - Pulse Counter for ESP8266, components/sensor/pulse_counter, pulse.svg - Remote Transmitter, components/remote_transmitter, remote.svg + Duty Cycle Sensor, components/sensor/duty_cycle, percent.svg, dark-invert + Pulse Counter for ESP8266, components/sensor/pulse_counter, pulse.svg, dark-invert + Remote Transmitter, components/remote_transmitter, remote.svg, dark-invert - Remote Receiver, components/remote_receiver, remote.svg + Remote Receiver, components/remote_receiver, remote.svg, dark-invert New Components ************** diff --git a/changelog/v1.8.0.rst b/changelog/v1.8.0.rst index 19e3964711..4aa1e1a4b3 100644 --- a/changelog/v1.8.0.rst +++ b/changelog/v1.8.0.rst @@ -14,17 +14,17 @@ Version 1.8.0 MAX7219, components/display/max7219, max7219.jpg LCD Display, components/display/lcd_display, lcd.jpg - RCSwitch Integration, components/remote_transmitter.html#rcswitch-remote-codes, remote.svg + RCSwitch Integration, components/remote_transmitter.html#rcswitch-remote-codes, remote.svg, dark-invert SPI Bus, components/spi, spi.svg UART Bus, components/uart, uart.svg - Real Time Clock, components/time, clock-outline.svg + Real Time Clock, components/time, clock-outline.svg, dark-invert - Uptime Sensor, components/sensor/uptime, timer.svg + Uptime Sensor, components/sensor/uptime, timer.svg, dark-invert PN532, components/binary_sensor/pn532, pn532.jpg RDM6300, components/binary_sensor/rdm6300, rdm6300.jpg - BLE RSSI, components/sensor/ble_rssi, bluetooth.svg + BLE RSSI, components/sensor/ble_rssi, bluetooth.svg, dark-invert Xiaomi HHCCJCY01, components/sensor/xiaomi_hhccjcy01, xiaomi_hhccjcy01.jpg Xiaomi LYWSDCGQ, components/sensor/xiaomi_lywsdcgq, xiaomi_lywsdcgq.jpg @@ -41,8 +41,8 @@ Version 1.8.0 TCS34725, components/sensor/tcs34725, tcs34725.jpg RGBWW Light, components/light/rgbww, rgbw.png - Cold+Warm White Light, components/light/cwww, brightness-medium.svg - Light Effects, components/light/index#light-effects, creation.svg + Cold+Warm White Light, components/light/cwww, brightness-medium.svg, dark-invert + Light Effects, components/light/index#light-effects, creation.svg, dark-invert Hi everyone, @@ -228,3 +228,8 @@ Changes in 1.8.2 - esphomedocs: WiFi: Add power save mode option `#41 `__ - esphomedocs: Add SSD1306 64x48 Display `#27 `__ - esphomeyaml: WiFi: Add power save mode option `#150 `__ + +Past Changelogs +--------------- + +- :doc:`v1.7.0` diff --git a/changelog/v1.9.0.rst b/changelog/v1.9.0.rst index 8f56cd199d..0ba2252604 100644 --- a/changelog/v1.9.0.rst +++ b/changelog/v1.9.0.rst @@ -9,8 +9,8 @@ Changelog - Version 1.9.0 .. imgtable:: - Beta Releases, guides/faq.html#how-do-i-update-to-the-latest-beta-release, new-box.svg - Text Sensors, components/text_sensor/index, folder-open.svg + Beta Releases, guides/faq.html#how-do-i-update-to-the-latest-beta-release, new-box.svg, dark-invert + Text Sensors, components/text_sensor/index, folder-open.svg, dark-invert MQTT Subscribe, components/sensor/mqtt_subscribe, mqtt.png Stepper, components/stepper/index, stepper.svg @@ -18,7 +18,7 @@ Changelog - Version 1.9.0 PMSX003, components/sensor/pmsx003, pmsx003.svg esphomeflasher, guides/faq.html#i-can-t-get-flashing-over-usb-to-work, logo.svg - Total Daily Energy, components/sensor/total_daily_energy, sigma.svg + Total Daily Energy, components/sensor/total_daily_energy, sigma.svg, dark-invert MY9231/MY9291 LED driver, components/output/my9231, my9231.svg diff --git a/components/alarm_control_panel/index.rst b/components/alarm_control_panel/index.rst index 4fe03ccbe2..6fe6b8656d 100644 --- a/components/alarm_control_panel/index.rst +++ b/components/alarm_control_panel/index.rst @@ -28,8 +28,20 @@ Configuration variables: - **on_state** (*Optional*, :ref:`Action `): An automation to perform when the alarm changes state. See :ref:`alarm_control_panel_on_state_trigger`. +- **on_arming** (*Optional*, :ref:`Action `): An automation to perform + when the alarm state changes to `arming`. See :ref:`alarm_control_panel_on_arming_trigger`. +- **on_pending** (*Optional*, :ref:`Action `): An automation to perform + when the alarm state changes to `pending`. See :ref:`alarm_control_panel_on_pending_trigger`. +- **on_armed_home** (*Optional*, :ref:`Action `): An automation to perform + when the alarm state changes to `armed_home`. See :ref:`alarm_control_panel_on_armed_home_trigger`. +- **on_armed_night** (*Optional*, :ref:`Action `): An automation to perform + when the alarm state changes to `armed_night`. See :ref:`alarm_control_panel_on_armed_night_trigger`. +- **on_armed_away** (*Optional*, :ref:`Action `): An automation to perform + when the alarm state changes to `armed_away`. See :ref:`alarm_control_panel_on_armed_away_trigger`. - **on_triggered** (*Optional*, :ref:`Action `): An automation to perform when the alarm triggers. See :ref:`alarm_control_panel_on_triggered_trigger`. +- **on_disarmed** (*Optional*, :ref:`Action `): An automation to perform + when the alarm state changes to `disarmed`. See :ref:`alarm_control_panel_on_disarmed_trigger`. - **on_cleared** (*Optional*, :ref:`Action `): An automation to perform when the alarm clears. See :ref:`alarm_control_panel_on_cleared_trigger`. @@ -52,6 +64,81 @@ This trigger is activated each time the alarm changes state. then: - logger.log: "Alarm Panel State Changed!" +.. _alarm_control_panel_on_pending_trigger: + +``on_pending`` Trigger +********************** + +This trigger is activated when the alarm changes to pending state. + +.. code-block:: yaml + + alarm_control_panel: + # ... + on_pending: + then: + - logger.log: "Alarm Pending!" + +.. _alarm_control_panel_on_arming_trigger: + +``on_arming`` Trigger +********************* + +This trigger is activated when the alarm changes to arming state. + +.. code-block:: yaml + + alarm_control_panel: + # ... + on_arming: + then: + - logger.log: "Alarm Arming!" + +.. _alarm_control_panel_on_armed_home_trigger: + +``on_armed_home`` Trigger +************************* + +This trigger is activated when the alarm changes to armed_home state. + +.. code-block:: yaml + + alarm_control_panel: + # ... + on_armed_home: + then: + - logger.log: "Alarm armed_home!" + +.. _alarm_control_panel_on_armed_night_trigger: + +``on_armed_night`` Trigger +************************** + +This trigger is activated when the alarm changes to armed_night state. + +.. code-block:: yaml + + alarm_control_panel: + # ... + on_armed_night: + then: + - logger.log: "Alarm armed_night!" + +.. _alarm_control_panel_on_armed_away_trigger: + +``on_armed_away`` Trigger +************************* + +This trigger is activated when the alarm changes to armed_away state. + +.. code-block:: yaml + + alarm_control_panel: + # ... + on_armed_away: + then: + - logger.log: "Alarm armed_away!" + .. _alarm_control_panel_on_triggered_trigger: ``on_triggered`` Trigger @@ -82,6 +169,21 @@ This trigger is activated when the alarm changes from triggered back to either t then: - logger.log: "Alarm Cleared!" +.. _alarm_control_panel_on_disarmed_trigger: + +``on_disarmed`` Trigger +*********************** + +This trigger is activated when the alarm changes from to disarmed. + +.. code-block:: yaml + + alarm_control_panel: + # ... + on_disarmed: + then: + - logger.log: "Alarm Disarmed!" + .. _alarm_control_panel_arm_away_action: ``arm_away`` Action @@ -94,7 +196,7 @@ This action arms the alarm in away mode. The ``code`` is required when *requires on_...: then: - alarm_control_panel.arm_away: - id: alarm + id: acp1 code: "1234" .. _alarm_control_panel_arm_home_action: @@ -109,7 +211,22 @@ This action arms the alarm in home mode. The ``code`` is required when *requires on_...: then: - alarm_control_panel.arm_home: - id: alarm + id: acp1 + code: "1234" + +.. _alarm_control_panel_arm_night_action: + +``arm_night`` Action +******************** + +This action arms the alarm in night mode. The ``code`` is required when *requires_code_to_arm* is *true*. + +.. code-block:: yaml + + on_...: + then: + - alarm_control_panel.arm_night: + id: acp1 code: "1234" .. _alarm_control_panel_disarm_action: @@ -124,7 +241,7 @@ This action disarms the alarm. The ``code`` is required when *codes* is not empt on_...: then: - alarm_control_panel.disarm: - id: alarm + id: acp1 code: "1234" .. _alarm_control_panel_pending_action: @@ -138,7 +255,7 @@ This action puts the alarm in pending state (the state before triggered after *p on_...: then: - - alarm_control_panel.pending: alarm + - alarm_control_panel.pending: acp1 .. _alarm_control_panel_triggered_action: @@ -151,7 +268,7 @@ This action puts the alarm in triggered state. on_...: then: - - alarm_control_panel.triggered: alarm + - alarm_control_panel.triggered: acp1 .. _alarm_control_panel_is_armed_condition: @@ -165,7 +282,7 @@ This :ref:`Condition ` checks if the alarm control panel is ar on_...: if: condition: - alarm_control_panel.is_armed: alarm + alarm_control_panel.is_armed: acp1 .. _alarm_control_panel_lambda_calls: @@ -177,13 +294,15 @@ From :ref:`lambdas `, you can call the following methods: - ``arm_away(code)`` - ``arm_home(code)`` +- ``arm_night(code)`` - ``disarm(code)`` .. code-block:: cpp - id(alarm).arm_away(); - id(alarm).arm_home(); - id(alarm).disarm("1234"); + id(acp1).arm_away(); + id(acp1).arm_home(); + id(acp1).arm_night(); + id(acp1).disarm(std::string("1234")); Platforms diff --git a/components/alarm_control_panel/template.rst b/components/alarm_control_panel/template.rst index 9a9d3bc778..71d214d469 100644 --- a/components/alarm_control_panel/template.rst +++ b/components/alarm_control_panel/template.rst @@ -26,13 +26,16 @@ Configuration variables: - **codes** (*Optional*, list of string): A list of codes for disarming the alarm, if *requires_code_to_arm* set to true then for arming the alarm too. - **requires_code_to_arm** (*Optional*, boolean): Code required for arming the alarm, *codes* must be provided. -- **arming_time** (*Optional*, :ref:`config-time`): The exit delay before the alarm is armed. -- **pending_time** (*Optional*, :ref:`config-time`): The entry delay before the alarm is triggered. -- **trigger_time** (*Optional*, :ref:`config-time`): The time after a triggered alarm before resetting to previous state if the sensors are cleared/off. +- **arming_away_time** (*Optional*, :ref:`config-time`): The exit delay before the alarm is armed to away mode. Defaults to ``0s``. +- **arming_home_time** (*Optional*, :ref:`config-time`): The exit delay before the alarm is armed to home mode. +- **arming_night_time** (*Optional*, :ref:`config-time`): The exit delay before the alarm is armed to night mode. +- **pending_time** (*Optional*, :ref:`config-time`): The entry delay before the alarm is triggered. Defaults to ``0s``. +- **trigger_time** (*Optional*, :ref:`config-time`): The time after a triggered alarm before resetting to previous state if the sensors are cleared/off. Defaults to ``0s``. - **binary_sensors** (*Optional*, *list*): A list of binary sensors the panel should use. Each consists of: - **input** (**Required**, string): The id of the binary sensor component - **bypass_armed_home** (*Optional*, boolean): This binary sensor will not trigger the alarm when in ``armed_home`` state. + - **bypass_armed_night** (*Optional*, boolean): This binary sensor will not trigger the alarm when in ``armed_night`` state. - **restore_mode** (*Optional*, enum): @@ -55,16 +58,24 @@ State Flow: 1. The alarm starts in ``DISARMED`` state 2. When the ``arm_...`` method is invoked - a. ``arming_time`` greater than 0 the state is ``ARMING`` - b. ``arming_time`` is 0 or after the ``arming_time`` delay the state is ``ARM_AWAY`` or ``ARM_HOME`` + a. ``arming_..._time`` is greater than 0 the state is ``ARMING`` + b. ``arming_..._time`` is 0 or after the delay the state is ``ARMED_...`` -3. When the alarm is tripped by a sensor state changing to ``on`` +3. When the alarm is tripped by a sensor state changing to ``on`` or ``alarm_control_panel_pending_action`` invoked a. ``pending_time`` greater than 0 the state is ``PENDING`` b. ``pending_time`` is 0 or after the ``pending_time`` delay the state is ``TRIGGERED`` 4. If ``trigger_time`` greater than 0 and no sensors are ``on`` after ``trigger_time`` delay - the state returns to ``ARM_AWAY`` or ``ARM_HOME`` + the state returns to ``ARM_...`` + +.. note:: + + Although the interface supports all arming modes only ``away`` and ``home`` have been implemented for now. + ``arm_...`` is for either ``arm_away`` or ``arm_home`` + ``arming_..._time`` is for either ``arming_away_time`` or ``arming_home_time`` + ``ARMED_...`` is for either ``ARMED_AWAY`` or ``ARMED_HOME`` + Example: -------- @@ -74,11 +85,13 @@ Example: alarm_control_panel: platform: template name: Alarm Panel + id: acp1 codes: - "1234" requires_code_to_arm: true - arming_time: 10s - pending_time: 15s + arming_away_time: 30s + arming_home_time: 5s + pending_time: 30s trigger_time: 5min binary_sensors: - input: zone_1 diff --git a/components/api.rst b/components/api.rst index 56cad2ccd3..7df6f8d6c7 100644 --- a/components/api.rst +++ b/components/api.rst @@ -16,7 +16,7 @@ the device manually by choosing "ESPHome" from the integration overview and ente ".local" or the IP address of the unit in the "Host" field. The ESPHome native API is based on a custom TCP protocol using protocol buffers. You can find -the protocol data structure definitions here: https://github.com/esphome/esphome/blob/dev/esphome/components/api/api.proto +the protocol data structure definitions here: `api.proto `__ A Python library that implements this protocol is `aioesphomeapi `__. .. code-block:: yaml @@ -35,7 +35,7 @@ Configuration variables: .. raw:: html - +