Merge pull request #6733 from esphome/bump-2024.5.0b4

2024.5.0b4

.github/actions/build-image/action.yaml

@@ -57,14 +57,6 @@ runs:
         digest="${{ steps.build-ghcr.outputs.digest }}"
         touch "/tmp/digests/${{ inputs.target }}/ghcr/${digest#sha256:}"
 
-    - name: Upload ghcr digest
-      uses: actions/upload-artifact@v3.1.3
-      with:
-        name: digests-${{ inputs.target }}-ghcr
-        path: /tmp/digests/${{ inputs.target }}/ghcr/*
-        if-no-files-found: error
-        retention-days: 1
-
     - name: Build and push to dockerhub by digest
       id: build-dockerhub
       uses: docker/build-push-action@v5.3.0
@@ -87,11 +79,3 @@ runs:
         mkdir -p /tmp/digests/${{ inputs.target }}/dockerhub
         digest="${{ steps.build-dockerhub.outputs.digest }}"
         touch "/tmp/digests/${{ inputs.target }}/dockerhub/${digest#sha256:}"
-
-    - name: Upload dockerhub digest
-      uses: actions/upload-artifact@v3.1.3
-      with:
-        name: digests-${{ inputs.target }}-dockerhub
-        path: /tmp/digests/${{ inputs.target }}/dockerhub/*
-        if-no-files-found: error
-        retention-days: 1

.github/workflows/release.yml

@@ -132,6 +132,19 @@ jobs:
           suffix: lint
           version: ${{ needs.init.outputs.tag }}
 
+      - name: Sanitize platform name
+        id: sanitize
+        run: |
+          echo "${{ matrix.platform }}" | sed 's|/|-|g' > /tmp/platform
+          echo name=$(cat /tmp/platform) >> $GITHUB_OUTPUT
+
+      - name: Upload digests
+        uses: actions/upload-artifact@v4.3.3
+        with:
+          name: digests-${{ steps.sanitize.outputs.name }}
+          path: /tmp/digests
+          retention-days: 1
+
   deploy-manifest:
     name: Publish ESPHome ${{ matrix.image.title }} to ${{ matrix.registry }}
     runs-on: ubuntu-latest
@@ -160,11 +173,14 @@ jobs:
           - dockerhub
     steps:
       - uses: actions/checkout@v4.1.5
+
       - name: Download digests
-        uses: actions/download-artifact@v3.0.2
+        uses: actions/download-artifact@v4.1.7
         with:
-          name: digests-${{ matrix.image.target }}-${{ matrix.registry }}
+          pattern: digests-*
           path: /tmp/digests
+          merge-multiple: true
+
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3.3.0
 
@@ -195,7 +211,7 @@ jobs:
           done
 
       - name: Create manifest list and push
-        working-directory: /tmp/digests
+        working-directory: /tmp/digests/${{ matrix.image.target }}/${{ matrix.registry }}
         run: |
           docker buildx imagetools create $(jq -Rcnr 'inputs | . / "," | map("-t " + .) | join(" ")' <<< "${{ steps.tags.outputs.tags}}") \
             $(printf '${{ steps.tags.outputs.image }}@sha256:%s ' *)

esphome/components/color/__init__.py

@@ -14,15 +14,41 @@ CONF_HEX = "hex"
 
 
 def hex_color(value):
+    if isinstance(value, int):
+        value = str(value)
+    if not isinstance(value, str):
+        raise cv.Invalid("Invalid value for hex color")
     if len(value) != 6:
-        raise cv.Invalid("Color must have six digits")
+        raise cv.Invalid("Hex color must have six digits")
     try:
-        return (int(value[0:2], 16), int(value[2:4], 16), int(value[4:6], 16))
+        return int(value[0:2], 16), int(value[2:4], 16), int(value[4:6], 16)
     except ValueError as exc:
         raise cv.Invalid("Color must be hexadecimal") from exc
 
 
-CONFIG_SCHEMA = cv.Any(
+components = {
+    CONF_RED,
+    CONF_RED_INT,
+    CONF_GREEN,
+    CONF_GREEN_INT,
+    CONF_BLUE,
+    CONF_BLUE_INT,
+    CONF_WHITE,
+    CONF_WHITE_INT,
+}
+
+
+def validate_color(config):
+    has_components = set(config) & components
+    has_hex = CONF_HEX in config
+    if has_hex and has_components:
+        raise cv.Invalid("Hex color value may not be combined with component values")
+    if not has_hex and not has_components:
+        raise cv.Invalid("Must provide at least one color option")
+    return config
+
+
+CONFIG_SCHEMA = cv.All(
     cv.Schema(
         {
             cv.Required(CONF_ID): cv.declare_id(ColorStruct),
@@ -34,14 +60,10 @@ CONFIG_SCHEMA = cv.Any(
             cv.Exclusive(CONF_BLUE_INT, "blue"): cv.uint8_t,
             cv.Exclusive(CONF_WHITE, "white"): cv.percentage,
             cv.Exclusive(CONF_WHITE_INT, "white"): cv.uint8_t,
+            cv.Optional(CONF_HEX): hex_color,
         }
     ).extend(cv.COMPONENT_SCHEMA),
-    cv.Schema(
-        {
-            cv.Required(CONF_ID): cv.declare_id(ColorStruct),
-            cv.Required(CONF_HEX): hex_color,
-        }
-    ).extend(cv.COMPONENT_SCHEMA),
+    validate_color,
 )
 
 

esphome/components/esp32/__init__.py

@@ -227,7 +227,7 @@ ARDUINO_PLATFORM_VERSION = cv.Version(5, 4, 0)
 # The default/recommended esp-idf framework version
 #  - https://github.com/espressif/esp-idf/releases
 #  - https://api.registry.platformio.org/v3/packages/platformio/tool/framework-espidf
-RECOMMENDED_ESP_IDF_FRAMEWORK_VERSION = cv.Version(4, 4, 6)
+RECOMMENDED_ESP_IDF_FRAMEWORK_VERSION = cv.Version(4, 4, 7)
 # The platformio/espressif32 version to use for esp-idf frameworks
 #  - https://github.com/platformio/platform-espressif32/releases
 #  - https://api.registry.platformio.org/v3/packages/platformio/platform/espressif32

esphome/components/ethernet/ethernet_component.cpp

@@ -1,12 +1,12 @@
 #include "ethernet_component.h"
+#include "esphome/core/application.h"
 #include "esphome/core/log.h"
 #include "esphome/core/util.h"
-#include "esphome/core/application.h"
 
 #ifdef USE_ESP32
 
-#include <cinttypes>
 #include <lwip/dns.h>
+#include <cinttypes>
 #include "esp_event.h"
 
 #ifdef USE_ETHERNET_SPI
@@ -184,6 +184,10 @@ void EthernetComponent::setup() {
     // KSZ8081RNA default is incorrect. It expects a 25MHz clock instead of the 50MHz we provide.
     this->ksz8081_set_clock_reference_(mac);
   }
+  if (this->type_ == ETHERNET_TYPE_RTL8201 && this->clk_mode_ == EMAC_CLK_EXT_IN) {
+    // Change in default behavior of RTL8201FI may require register setting to enable external clock
+    this->rtl8201_set_rmii_mode_(mac);
+  }
 #endif
 
   // use ESP internal eth mac
@@ -554,9 +558,10 @@ bool EthernetComponent::powerdown() {
 }
 
 #ifndef USE_ETHERNET_SPI
-void EthernetComponent::ksz8081_set_clock_reference_(esp_eth_mac_t *mac) {
-#define KSZ80XX_PC2R_REG_ADDR (0x1F)
 
+constexpr uint8_t KSZ80XX_PC2R_REG_ADDR = 0x1F;
+
+void EthernetComponent::ksz8081_set_clock_reference_(esp_eth_mac_t *mac) {
   esp_err_t err;
 
   uint32_t phy_control_2;
@@ -581,9 +586,47 @@ void EthernetComponent::ksz8081_set_clock_reference_(esp_eth_mac_t *mac) {
     ESPHL_ERROR_CHECK(err, "Read PHY Control 2 failed");
     ESP_LOGVV(TAG, "KSZ8081 PHY Control 2: %s", format_hex_pretty((u_int8_t *) &phy_control_2, 2).c_str());
   }
-
-#undef KSZ80XX_PC2R_REG_ADDR
 }
+constexpr uint8_t RTL8201_RMSR_REG_ADDR = 0x10;
+void EthernetComponent::rtl8201_set_rmii_mode_(esp_eth_mac_t *mac) {
+  esp_err_t err;
+  uint32_t phy_rmii_mode;
+  err = mac->write_phy_reg(mac, this->phy_addr_, 0x1f, 0x07);
+  ESPHL_ERROR_CHECK(err, "Setting Page 7 failed");
+
+  /*
+   * RTL8201 RMII Mode Setting Register (RMSR)
+   * Page 7 Register 16
+   *
+   * bit 0      Reserved            0
+   * bit 1      Rg_rmii_rxdsel      1 (default)
+   * bit 2      Rg_rmii_rxdv_sel:   0 (default)
+   * bit 3      RMII Mode:          1 (RMII Mode)
+   * bit 4~7    Rg_rmii_rx_offset:  1111 (default)
+   * bit 8~11   Rg_rmii_tx_offset:  1111 (default)
+   * bit 12     Rg_rmii_clkdir:     1 (Input)
+   * bit 13~15  Reserved            000
+   *
+   * Binary: 0001 1111 1111 1010
+   * Hex: 0x1FFA
+   *
+   */
+
+  err = mac->read_phy_reg(mac, this->phy_addr_, RTL8201_RMSR_REG_ADDR, &(phy_rmii_mode));
+  ESPHL_ERROR_CHECK(err, "Read PHY RMSR Register failed");
+  ESP_LOGV(TAG, "Hardware default RTL8201 RMII Mode Register is: 0x%04X", phy_rmii_mode);
+
+  err = mac->write_phy_reg(mac, this->phy_addr_, RTL8201_RMSR_REG_ADDR, 0x1FFA);
+  ESPHL_ERROR_CHECK(err, "Setting Register 16 RMII Mode Setting failed");
+
+  err = mac->read_phy_reg(mac, this->phy_addr_, RTL8201_RMSR_REG_ADDR, &(phy_rmii_mode));
+  ESPHL_ERROR_CHECK(err, "Read PHY RMSR Register failed");
+  ESP_LOGV(TAG, "Setting RTL8201 RMII Mode Register to: 0x%04X", phy_rmii_mode);
+
+  err = mac->write_phy_reg(mac, this->phy_addr_, 0x1f, 0x0);
+  ESPHL_ERROR_CHECK(err, "Setting Page 0 failed");
+}
+
 #endif
 
 }  // namespace ethernet

esphome/components/ethernet/ethernet_component.h

@@ -86,6 +86,8 @@ class EthernetComponent : public Component {
   void dump_connect_params_();
   /// @brief Set `RMII Reference Clock Select` bit for KSZ8081.
   void ksz8081_set_clock_reference_(esp_eth_mac_t *mac);
+  /// @brief Set `RMII Mode Setting Register` for RTL8201.
+  void rtl8201_set_rmii_mode_(esp_eth_mac_t *mac);
 
   std::string use_address_;
 #ifdef USE_ETHERNET_SPI

esphome/components/ltr390/ltr390.cpp

@@ -8,6 +8,9 @@ namespace ltr390 {
 
 static const char *const TAG = "ltr390";
 
+static const uint8_t LTR390_WAKEUP_TIME = 10;
+static const uint8_t LTR390_SETTLE_TIME = 5;
+
 static const uint8_t LTR390_MAIN_CTRL = 0x00;
 static const uint8_t LTR390_MEAS_RATE = 0x04;
 static const uint8_t LTR390_GAIN = 0x05;
@@ -101,21 +104,27 @@ void LTR390Component::read_mode_(int mode_index) {
 
   std::bitset<8> ctrl = this->reg(LTR390_MAIN_CTRL).get();
   ctrl[LTR390_CTRL_MODE] = mode;
+  ctrl[LTR390_CTRL_EN] = true;
   this->reg(LTR390_MAIN_CTRL) = ctrl.to_ulong();
 
   // After the sensor integration time do the following
-  this->set_timeout(((uint32_t) RESOLUTIONVALUE[this->res_]) * 100, [this, mode_index]() {
-    // Read from the sensor
-    std::get<1>(this->mode_funcs_[mode_index])();
+  this->set_timeout(((uint32_t) RESOLUTIONVALUE[this->res_]) * 100 + LTR390_WAKEUP_TIME + LTR390_SETTLE_TIME,
+                    [this, mode_index]() {
+                      // Read from the sensor
+                      std::get<1>(this->mode_funcs_[mode_index])();
 
-    // If there are more modes to read then begin the next
-    // otherwise stop
-    if (mode_index + 1 < (int) this->mode_funcs_.size()) {
-      this->read_mode_(mode_index + 1);
-    } else {
-      this->reading_ = false;
-    }
-  });
+                      // If there are more modes to read then begin the next
+                      // otherwise stop
+                      if (mode_index + 1 < (int) this->mode_funcs_.size()) {
+                        this->read_mode_(mode_index + 1);
+                      } else {
+                        // put sensor in standby
+                        std::bitset<8> ctrl = this->reg(LTR390_MAIN_CTRL).get();
+                        ctrl[LTR390_CTRL_EN] = false;
+                        this->reg(LTR390_MAIN_CTRL) = ctrl.to_ulong();
+                        this->reading_ = false;
+                      }
+                    });
 }
 
 void LTR390Component::setup() {

esphome/components/nextion/nextion.h

@@ -12,7 +12,7 @@
 #include "esphome/components/display/display_color_utils.h"
 
 #ifdef USE_NEXTION_TFT_UPLOAD
-#ifdef ARDUINO
+#ifdef USE_ARDUINO
 #ifdef USE_ESP32
 #include <HTTPClient.h>
 #endif  // USE_ESP32
@@ -22,7 +22,7 @@
 #endif  // USE_ESP8266
 #elif defined(USE_ESP_IDF)
 #include <esp_http_client.h>
-#endif  // ARDUINO vs ESP-IDF
+#endif  // ARDUINO vs USE_ESP_IDF
 #endif  // USE_NEXTION_TFT_UPLOAD
 
 namespace esphome {
@@ -987,7 +987,7 @@ class Nextion : public NextionBase, public PollingComponent, public uart::UARTDe
 
 #ifdef USE_NEXTION_TFT_UPLOAD
   /**
-   * Set the tft file URL. https seems problematic with arduino..
+   * Set the tft file URL. https seems problematic with Arduino..
    */
   void set_tft_url(const std::string &tft_url) { this->tft_url_ = tft_url; }
 
@@ -1190,7 +1190,7 @@ class Nextion : public NextionBase, public PollingComponent, public uart::UARTDe
   uint32_t original_baud_rate_ = 0;
   bool upload_first_chunk_sent_ = false;
 
-#ifdef ARDUINO
+#ifdef USE_ARDUINO
   /**
    * will request chunk_size chunks from the web server
    * and send each to the nextion
@@ -1208,7 +1208,7 @@ class Nextion : public NextionBase, public PollingComponent, public uart::UARTDe
    * @return position of last byte transferred, -1 for failure.
    */
   int upload_by_chunks_(esp_http_client_handle_t http_client, uint32_t &range_start);
-#endif  // ARDUINO vs USE_ESP_IDF
+#endif  // USE_ARDUINO vs USE_ESP_IDF
 
   /**
    * Ends the upload process, restart Nextion and, if successful,

esphome/components/nextion/nextion_upload_arduino.cpp

@@ -1,7 +1,7 @@
 #include "nextion.h"
 
 #ifdef USE_NEXTION_TFT_UPLOAD
-#ifdef ARDUINO
+#ifdef USE_ARDUINO
 
 #include "esphome/core/application.h"
 #include "esphome/core/defines.h"
@@ -383,5 +383,5 @@ WiFiClient *Nextion::get_wifi_client_() {
 }  // namespace nextion
 }  // namespace esphome
 
-#endif  // ARDUINO
+#endif  // USE_ARDUINO
 #endif  // USE_NEXTION_TFT_UPLOAD

esphome/components/remote_receiver/remote_receiver.h

@@ -58,6 +58,7 @@ class RemoteReceiverComponent : public remote_base::RemoteReceiverBase,
   void decode_rmt_(rmt_item32_t *item, size_t len);
   RingbufHandle_t ringbuf_;
   esp_err_t error_code_{ESP_OK};
+  std::string error_string_{""};
 #endif
 
 #if defined(USE_ESP8266) || defined(USE_LIBRETINY)

esphome/components/remote_receiver/remote_receiver_esp32.cpp

@@ -29,6 +29,7 @@ void RemoteReceiverComponent::setup() {
   esp_err_t error = rmt_config(&rmt);
   if (error != ESP_OK) {
     this->error_code_ = error;
+    this->error_string_ = "in rmt_config";
     this->mark_failed();
     return;
   }
@@ -36,18 +37,25 @@ void RemoteReceiverComponent::setup() {
   error = rmt_driver_install(this->channel_, this->buffer_size_, 0);
   if (error != ESP_OK) {
     this->error_code_ = error;
+    if (error == ESP_ERR_INVALID_STATE) {
+      this->error_string_ = str_sprintf("RMT channel %i is already in use by another component", this->channel_);
+    } else {
+      this->error_string_ = "in rmt_driver_install";
+    }
     this->mark_failed();
     return;
   }
   error = rmt_get_ringbuf_handle(this->channel_, &this->ringbuf_);
   if (error != ESP_OK) {
     this->error_code_ = error;
+    this->error_string_ = "in rmt_get_ringbuf_handle";
     this->mark_failed();
     return;
   }
   error = rmt_rx_start(this->channel_, true);
   if (error != ESP_OK) {
     this->error_code_ = error;
+    this->error_string_ = "in rmt_rx_start";
     this->mark_failed();
     return;
   }
@@ -67,7 +75,8 @@ void RemoteReceiverComponent::dump_config() {
   ESP_LOGCONFIG(TAG, "  Filter out pulses shorter than: %" PRIu32 " us", this->filter_us_);
   ESP_LOGCONFIG(TAG, "  Signal is done after %" PRIu32 " us of no changes", this->idle_us_);
   if (this->is_failed()) {
-    ESP_LOGE(TAG, "Configuring RMT driver failed: %s", esp_err_to_name(this->error_code_));
+    ESP_LOGE(TAG, "Configuring RMT driver failed: %s (%s)", esp_err_to_name(this->error_code_),
+             this->error_string_.c_str());
   }
 }
 

esphome/components/remote_transmitter/remote_transmitter.h

@@ -53,6 +53,7 @@ class RemoteTransmitterComponent : public remote_base::RemoteTransmitterBase,
   bool initialized_{false};
   std::vector<rmt_item32_t> rmt_temp_;
   esp_err_t error_code_{ESP_OK};
+  std::string error_string_{""};
   bool inverted_{false};
 #endif
   uint8_t carrier_duty_percent_;

esphome/components/remote_transmitter/remote_transmitter_esp32.cpp

@@ -23,7 +23,8 @@ void RemoteTransmitterComponent::dump_config() {
   }
 
   if (this->is_failed()) {
-    ESP_LOGE(TAG, "Configuring RMT driver failed: %s", esp_err_to_name(this->error_code_));
+    ESP_LOGE(TAG, "Configuring RMT driver failed: %s (%s)", esp_err_to_name(this->error_code_),
+             this->error_string_.c_str());
   }
 }
 
@@ -56,6 +57,7 @@ void RemoteTransmitterComponent::configure_rmt_() {
   esp_err_t error = rmt_config(&c);
   if (error != ESP_OK) {
     this->error_code_ = error;
+    this->error_string_ = "in rmt_config";
     this->mark_failed();
     return;
   }
@@ -64,6 +66,11 @@ void RemoteTransmitterComponent::configure_rmt_() {
     error = rmt_driver_install(this->channel_, 0, 0);
     if (error != ESP_OK) {
       this->error_code_ = error;
+      if (error == ESP_ERR_INVALID_STATE) {
+        this->error_string_ = str_sprintf("RMT channel %i is already in use by another component", this->channel_);
+      } else {
+        this->error_string_ = "in rmt_driver_install";
+      }
       this->mark_failed();
       return;
     }

esphome/components/voice_assistant/voice_assistant.h

@@ -94,10 +94,10 @@ class VoiceAssistant : public Component {
   uint32_t get_feature_flags() const {
     uint32_t flags = 0;
     flags |= VoiceAssistantFeature::FEATURE_VOICE_ASSISTANT;
+    flags |= VoiceAssistantFeature::FEATURE_API_AUDIO;
 #ifdef USE_SPEAKER
     if (this->speaker_ != nullptr) {
       flags |= VoiceAssistantFeature::FEATURE_SPEAKER;
-      flags |= VoiceAssistantFeature::FEATURE_API_AUDIO;
     }
 #endif
     return flags;

esphome/const.py

@@ -1,6 +1,6 @@
 """Constants used by esphome."""
 
-__version__ = "2024.5.0b1"
+__version__ = "2024.5.0b4"
 
 ALLOWED_NAME_CHARS = "abcdefghijklmnopqrstuvwxyz0123456789-_"
 VALID_SUBSTITUTIONS_CHARACTERS = (

esphome/core/__init__.py

@@ -340,6 +340,8 @@ class ID:
 
         if self.id is None:
             base = str(self.type).replace("::", "_").lower()
+            if base == self.type:
+                base = base + "_id"
             name = "".join(c for c in base if c.isalnum() or c == "_")
             used = set(registered_ids) | set(RESERVED_IDS) | CORE.loaded_integrations
             self.id = ensure_unique_string(name, used)

esphome/core/config.py

@@ -394,7 +394,7 @@ async def to_code(config):
     if project_conf := config.get(CONF_PROJECT):
         cg.add_define("ESPHOME_PROJECT_NAME", project_conf[CONF_NAME])
         cg.add_define("ESPHOME_PROJECT_VERSION", project_conf[CONF_VERSION])
-        cg.add_define("ESPHOME_PROJECT_VERSION_30", project_conf[CONF_VERSION][:30])
+        cg.add_define("ESPHOME_PROJECT_VERSION_30", project_conf[CONF_VERSION][:29])
         for conf in project_conf.get(CONF_ON_UPDATE, []):
             trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID])
             await cg.register_component(trigger, conf)

platformio.ini

@@ -137,7 +137,7 @@ extra_scripts = post:esphome/components/esp32/post_build.py.script
 extends = common:idf
 platform = platformio/espressif32@5.4.0
 platform_packages =
-    platformio/framework-espidf@~3.40406.0
+    platformio/framework-espidf@~3.40407.0
 
 framework = espidf
 lib_deps =

requirements.txt

@@ -9,7 +9,7 @@ tornado==6.4
 tzlocal==5.2    # from time
 tzdata>=2021.1  # from time
 pyserial==3.5
-platformio==6.1.13  # When updating platformio, also update Dockerfile
+platformio==6.1.15  # When updating platformio, also update Dockerfile
 esptool==4.7.0
 click==8.1.7
 esphome-dashboard==20240412.0

tests/components/color/common.yaml

@@ -9,3 +9,12 @@ color:
     blue: 100%
   - id: kbx_green
     hex: "3DEC55"
+  - id: kbx_green_1
+    hex: 3DEC55
+  - id: cps_red
+    hex: 800000
+  - id: cps_green
+    hex: 008000
+  - id: cps_blue
+    hex: 000080
+