esphome 2024.9.1__py3-none-any.whl → 2024.10.0__py3-none-any.whl

esphome/const.py

@@ -1,6 +1,6 @@
 """Constants used by esphome."""
 
-__version__ = "2024.9.1"
+__version__ = "2024.10.0"
 
 ALLOWED_NAME_CHARS = "abcdefghijklmnopqrstuvwxyz0123456789-_"
 VALID_SUBSTITUTIONS_CHARACTERS = (
@@ -53,6 +53,7 @@ CONF_ALLOW_OTHER_USES = "allow_other_uses"
 CONF_ALPHA = "alpha"
 CONF_ALTITUDE = "altitude"
 CONF_AMBIENT_LIGHT = "ambient_light"
+CONF_AMMONIA = "ammonia"
 CONF_ANALOG = "analog"
 CONF_AND = "and"
 CONF_ANGLE = "angle"
@@ -110,6 +111,7 @@ CONF_CALIBRATE_LINEAR = "calibrate_linear"
 CONF_CALIBRATION = "calibration"
 CONF_CAPACITANCE = "capacitance"
 CONF_CAPACITY = "capacity"
+CONF_CARBON_MONOXIDE = "carbon_monoxide"
 CONF_CARRIER_DUTY_PERCENT = "carrier_duty_percent"
 CONF_CARRIER_FREQUENCY = "carrier_frequency"
 CONF_CERTIFICATE = "certificate"
@@ -120,6 +122,7 @@ CONF_CHANNELS = "channels"
 CONF_CHARACTERISTIC_UUID = "characteristic_uuid"
 CONF_CHECK = "check"
 CONF_CHIPSET = "chipset"
+CONF_CLEAN_SESSION = "clean_session"
 CONF_CLEAR_IMPEDANCE = "clear_impedance"
 CONF_CLIENT_CERTIFICATE = "client_certificate"
 CONF_CLIENT_CERTIFICATE_KEY = "client_certificate_key"
@@ -262,6 +265,7 @@ CONF_ENUM_DATAPOINT = "enum_datapoint"
 CONF_EQUATION = "equation"
 CONF_ESP8266_DISABLE_SSL_SUPPORT = "esp8266_disable_ssl_support"
 CONF_ESPHOME = "esphome"
+CONF_ETHANOL = "ethanol"
 CONF_ETHERNET = "ethernet"
 CONF_EVENT = "event"
 CONF_EVENT_TYPE = "event_type"
@@ -360,6 +364,7 @@ CONF_HOURS = "hours"
 CONF_HSYNC_PIN = "hsync_pin"
 CONF_HUMIDITY = "humidity"
 CONF_HUMIDITY_SENSOR = "humidity_sensor"
+CONF_HYDROGEN = "hydrogen"
 CONF_HYSTERESIS = "hysteresis"
 CONF_I2C = "i2c"
 CONF_I2C_ID = "i2c_id"
@@ -375,6 +380,7 @@ CONF_IDLE_ACTION = "idle_action"
 CONF_IDLE_LEVEL = "idle_level"
 CONF_IDLE_TIME = "idle_time"
 CONF_IF = "if"
+CONF_IGNORE_EFUSE_CUSTOM_MAC = "ignore_efuse_custom_mac"
 CONF_IGNORE_EFUSE_MAC_CRC = "ignore_efuse_mac_crc"
 CONF_IGNORE_OUT_OF_RANGE = "ignore_out_of_range"
 CONF_IGNORE_PIN_VALIDATION_ERROR = "ignore_pin_validation_error"
@@ -475,6 +481,7 @@ CONF_MEDIA_PLAYER = "media_player"
 CONF_MEDIUM = "medium"
 CONF_MEMORY_BLOCKS = "memory_blocks"
 CONF_MESSAGE = "message"
+CONF_METHANE = "methane"
 CONF_METHOD = "method"
 CONF_MICROPHONE = "microphone"
 CONF_MIN_BRIGHTNESS = "min_brightness"
@@ -521,6 +528,7 @@ CONF_NBITS = "nbits"
 CONF_NEC = "nec"
 CONF_NETWORKS = "networks"
 CONF_NEW_PASSWORD = "new_password"
+CONF_NITROGEN_DIOXIDE = "nitrogen_dioxide"
 CONF_NOISE_LEVEL = "noise_level"
 CONF_NUM_ATTEMPTS = "num_attempts"
 CONF_NUM_CHANNELS = "num_channels"
@@ -926,7 +934,6 @@ CONF_WARM_WHITE_COLOR_TEMPERATURE = "warm_white_color_temperature"
 CONF_WATCHDOG_THRESHOLD = "watchdog_threshold"
 CONF_WEB_SERVER = "web_server"
 CONF_WEB_SERVER_ID = "web_server_id"
-CONF_WEB_SERVER_SORTING_WEIGHT = "web_server_sorting_weight"
 CONF_WEIGHT = "weight"
 CONF_WHILE = "while"
 CONF_WHITE = "white"
@@ -954,6 +961,7 @@ ICON_ACCELERATION_Y = "mdi:axis-y-arrow"
 ICON_ACCELERATION_Z = "mdi:axis-z-arrow"
 ICON_ACCOUNT = "mdi:account"
 ICON_ACCOUNT_CHECK = "mdi:account-check"
+ICON_AIR_FILTER = "mdi:air-filter"
 ICON_ARROW_EXPAND_VERTICAL = "mdi:arrow-expand-vertical"
 ICON_BATTERY = "mdi:battery"
 ICON_BLUETOOTH = "mdi:bluetooth"
@@ -975,6 +983,7 @@ ICON_FINGERPRINT = "mdi:fingerprint"
 ICON_FLASH = "mdi:flash"
 ICON_FLASK = "mdi:flask"
 ICON_FLASK_OUTLINE = "mdi:flask-outline"
+ICON_FLASK_ROUND_BOTTOM = "mdi:flask-round-bottom"
 ICON_FLOWER = "mdi:flower"
 ICON_GAS_CYLINDER = "mdi:gas-cylinder"
 ICON_GAUGE = "mdi:gauge"
@@ -987,6 +996,7 @@ ICON_KEY_PLUS = "mdi:key-plus"
 ICON_LIGHTBULB = "mdi:lightbulb"
 ICON_MAGNET = "mdi:magnet"
 ICON_MEMORY = "mdi:memory"
+ICON_MOLECULE_CO = "mdi:molecule-co"
 ICON_MOLECULE_CO2 = "mdi:molecule-co2"
 ICON_MOTION_SENSOR = "mdi:motion-sensor"
 ICON_NEW_BOX = "mdi:new-box"

esphome/core/defines.h

@@ -29,6 +29,7 @@
 #define USE_DATETIME_TIME
 #define USE_DEEP_SLEEP
 #define USE_DISPLAY
+#define USE_ESP32_IMPROV_STATE_CALLBACK
 #define USE_EVENT
 #define USE_FAN
 #define USE_GRAPH
@@ -45,10 +46,11 @@
 #define USE_LVGL_BUTTONMATRIX
 #define USE_LVGL_FONT
 #define USE_LVGL_IMAGE
-#define USE_LVGL_KEYBOARD
 #define USE_LVGL_KEY_LISTENER
-#define USE_LVGL_TOUCHSCREEN
+#define USE_LVGL_KEYBOARD
 #define USE_LVGL_ROTARY_ENCODER
+#define USE_LVGL_TOUCHSCREEN
+#define USE_MD5
 #define USE_MDNS
 #define USE_MEDIA_PLAYER
 #define USE_MQTT

esphome/core/helpers.cpp

@@ -44,9 +44,7 @@
 #endif
 #ifdef USE_ESP32
 #include "esp32/rom/crc.h"
-#endif
 
-#if defined(CONFIG_SOC_IEEE802154_SUPPORTED) || defined(USE_ESP32_IGNORE_EFUSE_MAC_CRC)
 #include "esp_efuse.h"
 #include "esp_efuse_table.h"
 #endif
@@ -664,16 +662,20 @@ void get_mac_address_raw(uint8_t *mac) {  // NOLINT(readability-non-const-parame
   static const uint8_t esphome_host_mac_address[6] = USE_ESPHOME_HOST_MAC_ADDRESS;
   memcpy(mac, esphome_host_mac_address, sizeof(esphome_host_mac_address));
 #elif defined(USE_ESP32)
-#if defined(CONFIG_SOC_IEEE802154_SUPPORTED) || defined(USE_ESP32_IGNORE_EFUSE_MAC_CRC)
+#if defined(CONFIG_SOC_IEEE802154_SUPPORTED)
   // When CONFIG_SOC_IEEE802154_SUPPORTED is defined, esp_efuse_mac_get_default
-  // returns the 802.15.4 EUI-64 address. Read directly from eFuse instead.
-  // On some devices, the MAC address that is burnt into EFuse does not
-  // match the CRC that goes along with it. For those devices, this
-  // work-around reads and uses the MAC address as-is from EFuse,
-  // without doing the CRC check.
-  esp_efuse_read_field_blob(ESP_EFUSE_MAC_FACTORY, mac, 48);
+  // returns the 802.15.4 EUI-64 address, so we read directly from eFuse instead.
+  if (has_custom_mac_address()) {
+    esp_efuse_read_field_blob(ESP_EFUSE_MAC_CUSTOM, mac, 48);
+  } else {
+    esp_efuse_read_field_blob(ESP_EFUSE_MAC_FACTORY, mac, 48);
+  }
 #else
-  esp_efuse_mac_get_default(mac);
+  if (has_custom_mac_address()) {
+    esp_efuse_mac_get_custom(mac);
+  } else {
+    esp_efuse_mac_get_default(mac);
+  }
 #endif
 #elif defined(USE_ESP8266)
   wifi_get_macaddr(STATION_IF, mac);
@@ -685,20 +687,54 @@ void get_mac_address_raw(uint8_t *mac) {  // NOLINT(readability-non-const-parame
 // this should be an error, but that messes with CI checks. #error No mac address method defined
 #endif
 }
+
 std::string get_mac_address() {
   uint8_t mac[6];
   get_mac_address_raw(mac);
   return str_snprintf("%02x%02x%02x%02x%02x%02x", 12, mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]);
 }
+
 std::string get_mac_address_pretty() {
   uint8_t mac[6];
   get_mac_address_raw(mac);
   return str_snprintf("%02X:%02X:%02X:%02X:%02X:%02X", 17, mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]);
 }
+
 #ifdef USE_ESP32
 void set_mac_address(uint8_t *mac) { esp_base_mac_addr_set(mac); }
 #endif
 
+bool has_custom_mac_address() {
+#if defined(USE_ESP32) && !defined(USE_ESP32_IGNORE_EFUSE_CUSTOM_MAC)
+  uint8_t mac[6];
+  // do not use 'esp_efuse_mac_get_custom(mac)' because it drops an error in the logs whenever it fails
+#ifndef USE_ESP32_VARIANT_ESP32
+  return (esp_efuse_read_field_blob(ESP_EFUSE_USER_DATA_MAC_CUSTOM, mac, 48) == ESP_OK) && mac_address_is_valid(mac);
+#else
+  return (esp_efuse_read_field_blob(ESP_EFUSE_MAC_CUSTOM, mac, 48) == ESP_OK) && mac_address_is_valid(mac);
+#endif
+#else
+  return false;
+#endif
+}
+
+bool mac_address_is_valid(const uint8_t *mac) {
+  bool is_all_zeros = true;
+  bool is_all_ones = true;
+
+  for (uint8_t i = 0; i < 6; i++) {
+    if (mac[i] != 0) {
+      is_all_zeros = false;
+    }
+  }
+  for (uint8_t i = 0; i < 6; i++) {
+    if (mac[i] != 0xFF) {
+      is_all_ones = false;
+    }
+  }
+  return !(is_all_zeros || is_all_ones);
+}
+
 void delay_microseconds_safe(uint32_t us) {  // avoids CPU locks that could trigger WDT or affect WiFi/BT stability
   uint32_t start = micros();
 

esphome/core/helpers.h

@@ -635,6 +635,14 @@ std::string get_mac_address_pretty();
 void set_mac_address(uint8_t *mac);
 #endif
 
+/// Check if a custom MAC address is set (ESP32 & variants)
+/// @return True if a custom MAC address is set (ESP32 & variants), else false
+bool has_custom_mac_address();
+
+/// Check if the MAC address is not all zeros or all ones
+/// @return True if MAC is valid, else false
+bool mac_address_is_valid(const uint8_t *mac);
+
 /// Delay for the given amount of microseconds, possibly yielding to other processes during the wait.
 void delay_microseconds_safe(uint32_t us);
 

esphome/core/ring_buffer.cpp

@@ -11,16 +11,26 @@ namespace esphome {
 
 static const char *const TAG = "ring_buffer";
 
+RingBuffer::~RingBuffer() {
+  if (this->handle_ != nullptr) {
+    vStreamBufferDelete(this->handle_);
+    ExternalRAMAllocator<uint8_t> allocator(ExternalRAMAllocator<uint8_t>::ALLOW_FAILURE);
+    allocator.deallocate(this->storage_, this->size_);
+  }
+}
+
 std::unique_ptr<RingBuffer> RingBuffer::create(size_t len) {
   std::unique_ptr<RingBuffer> rb = make_unique<RingBuffer>();
 
+  rb->size_ = len + 1;
+
   ExternalRAMAllocator<uint8_t> allocator(ExternalRAMAllocator<uint8_t>::ALLOW_FAILURE);
-  rb->storage_ = allocator.allocate(len + 1);
+  rb->storage_ = allocator.allocate(rb->size_);
   if (rb->storage_ == nullptr) {
     return nullptr;
   }
 
-  rb->handle_ = xStreamBufferCreateStatic(len + 1, 1, rb->storage_, &rb->structure_);
+  rb->handle_ = xStreamBufferCreateStatic(rb->size_, 1, rb->storage_, &rb->structure_);
   ESP_LOGD(TAG, "Created ring buffer with size %u", len);
   return rb;
 }

esphome/core/ring_buffer.h

@@ -12,6 +12,8 @@ namespace esphome {
 
 class RingBuffer {
  public:
+  ~RingBuffer();
+
   /**
    * @brief Reads from the ring buffer, waiting up to a specified number of ticks if necessary.
    *
@@ -83,6 +85,7 @@ class RingBuffer {
   StreamBufferHandle_t handle_;
   StaticStreamBuffer_t structure_;
   uint8_t *storage_;
+  size_t size_{0};
 };
 
 }  // namespace esphome

esphome/voluptuous_schema.py

@@ -226,4 +226,6 @@ class _Schema(vol.Schema):
         if isinstance(schema, vol.Schema):
             schema = schema.schema
         ret = super().extend(schema, extra=extra)
-        return _Schema(ret.schema, extra=ret.extra, extra_schemas=self._extra_schemas)
+        return _Schema(
+            ret.schema, extra=ret.extra, extra_schemas=self._extra_schemas.copy()
+        )

esphome/wizard.py

@@ -90,9 +90,6 @@ esp32:
 RP2040_CONFIG = """
 rp2040:
   board: {board}
-  framework:
-    # Required until https://github.com/platformio/platform-raspberrypi/pull/36 is merged
-    platform_version: https://github.com/maxgerhardt/platform-raspberrypi.git
 """
 
 BK72XX_CONFIG = """

{esphome-2024.9.1.dist-info → esphome-2024.10.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: esphome
-Version: 2024.9.1
+Version: 2024.10.0
 Summary: Make creating custom firmwares for ESP32/ESP8266 super easy.
 Author-email: The ESPHome Authors <esphome@nabucasa.com>
 License: MIT
@@ -39,7 +39,7 @@ Requires-Dist: click ==8.1.7
 Requires-Dist: esphome-dashboard ==20240620.0
 Requires-Dist: aioesphomeapi ==24.6.2
 Requires-Dist: zeroconf ==0.132.2
-Requires-Dist: python-magic ==0.4.27
+Requires-Dist: puremagic ==1.27
 Requires-Dist: ruamel.yaml ==0.18.6
 Requires-Dist: kconfiglib ==13.7.1
 Requires-Dist: pyparsing >=3.0
@@ -53,7 +53,7 @@ Provides-Extra: displays
 Requires-Dist: pillow ==10.2.0 ; extra == 'displays'
 Requires-Dist: cairosvg ==2.7.1 ; extra == 'displays'
 Provides-Extra: test
-Requires-Dist: pylint ==3.1.0 ; extra == 'test'
+Requires-Dist: pylint ==3.2.7 ; extra == 'test'
 Requires-Dist: flake8 ==7.0.0 ; extra == 'test'
 Requires-Dist: black ==24.4.2 ; extra == 'test'
 Requires-Dist: pyupgrade ==3.15.2 ; extra == 'test'
@@ -74,3 +74,5 @@ Requires-Dist: hypothesis ==6.92.1 ; extra == 'test'
 For issues, please go to [the issue tracker](https://github.com/esphome/issues/issues).
 
 For feature requests, please see [feature requests](https://github.com/esphome/feature-requests/issues).
+
+[![ESPHome - A project from the Open Home Foundation](https://www.openhomefoundation.org/badges/esphome.png)](https://www.openhomefoundation.org/)