esphome 2024.10.2__py3-none-any.whl → 2024.11.0__py3-none-any.whl

esphome/dashboard/core.py

@@ -5,10 +5,14 @@ from collections.abc import Coroutine
 import contextlib
 from dataclasses import dataclass
 from functools import partial
+import json
 import logging
+from pathlib import Path
 import threading
 from typing import TYPE_CHECKING, Any, Callable
 
+from esphome.storage_json import ignored_devices_storage_path
+
 from ..zeroconf import DiscoveredImport
 from .dns import DNSCache
 from .entries import DashboardEntries
@@ -20,6 +24,8 @@ if TYPE_CHECKING:
 
 _LOGGER = logging.getLogger(__name__)
 
+IGNORED_DEVICES_STORAGE_PATH = "ignored-devices.json"
+
 
 @dataclass
 class Event:
@@ -74,6 +80,7 @@ class ESPHomeDashboard:
         "settings",
         "dns_cache",
         "_background_tasks",
+        "ignored_devices",
     )
 
     def __init__(self) -> None:
@@ -89,12 +96,30 @@ class ESPHomeDashboard:
         self.settings = DashboardSettings()
         self.dns_cache = DNSCache()
         self._background_tasks: set[asyncio.Task] = set()
+        self.ignored_devices: set[str] = set()
 
     async def async_setup(self) -> None:
         """Setup the dashboard."""
         self.loop = asyncio.get_running_loop()
         self.ping_request = asyncio.Event()
         self.entries = DashboardEntries(self)
+        self.load_ignored_devices()
+
+    def load_ignored_devices(self) -> None:
+        storage_path = Path(ignored_devices_storage_path())
+        try:
+            with storage_path.open("r", encoding="utf-8") as f_handle:
+                data = json.load(f_handle)
+                self.ignored_devices = set(data.get("ignored_devices", set()))
+        except FileNotFoundError:
+            pass
+
+    def save_ignored_devices(self) -> None:
+        storage_path = Path(ignored_devices_storage_path())
+        with storage_path.open("w", encoding="utf-8") as f_handle:
+            json.dump(
+                {"ignored_devices": sorted(self.ignored_devices)}, indent=2, fp=f_handle
+            )
 
     async def async_run(self) -> None:
         """Run the dashboard."""

esphome/dashboard/status/mdns.py

@@ -26,7 +26,7 @@ class MDNSStatus:
         self.host_mdns_state: dict[str, bool | None] = {}
         self._loop = asyncio.get_running_loop()
 
-    async def async_resolve_host(self, host_name: str) -> str | None:
+    async def async_resolve_host(self, host_name: str) -> list[str] | None:
         """Resolve a host name to an address in a thread-safe manner."""
         if aiozc := self.aiozc:
             return await aiozc.async_resolve_host(host_name)
@@ -50,13 +50,12 @@ class MDNSStatus:
                 poll_names.setdefault(entry.name, set()).add(entry)
             elif (online := host_mdns_state.get(entry.name, SENTINEL)) != SENTINEL:
                 entries.async_set_state(entry, bool_to_entry_state(online))
-
         if poll_names and self.aiozc:
             results = await asyncio.gather(
                 *(self.aiozc.async_resolve_host(name) for name in poll_names)
             )
-            for name, address in zip(poll_names, results):
-                result = bool(address)
+            for name, address_list in zip(poll_names, results):
+                result = bool(address_list)
                 host_mdns_state[name] = result
                 for entry in poll_names[name]:
                     entries.async_set_state(entry, bool_to_entry_state(result))

esphome/dashboard/web_server.py

@@ -7,6 +7,7 @@ import datetime
 import functools
 import gzip
 import hashlib
+import importlib
 import json
 import logging
 import os
@@ -319,12 +320,12 @@ class EsphomePortCommandWebSocket(EsphomeCommandWebSocket):
             and "api" in entry.loaded_integrations
         ):
             if (mdns := dashboard.mdns_status) and (
-                address := await mdns.async_resolve_host(entry.name)
+                address_list := await mdns.async_resolve_host(entry.name)
             ):
                 # Use the IP address if available but only
                 # if the API is loaded and the device is online
                 # since MQTT logging will not work otherwise
-                port = address
+                port = address_list[0]
             elif (
                 entry.address
                 and (
@@ -541,6 +542,46 @@ class ImportRequestHandler(BaseHandler):
         self.finish()
 
 
+class IgnoreDeviceRequestHandler(BaseHandler):
+    @authenticated
+    def post(self) -> None:
+        dashboard = DASHBOARD
+        try:
+            args = json.loads(self.request.body.decode())
+            device_name = args["name"]
+            ignore = args["ignore"]
+        except (json.JSONDecodeError, KeyError):
+            self.set_status(400)
+            self.set_header("content-type", "application/json")
+            self.write(json.dumps({"error": "Invalid payload"}))
+            return
+
+        ignored_device = next(
+            (
+                res
+                for res in dashboard.import_result.values()
+                if res.device_name == device_name
+            ),
+            None,
+        )
+
+        if ignored_device is None:
+            self.set_status(404)
+            self.set_header("content-type", "application/json")
+            self.write(json.dumps({"error": "Device not found"}))
+            return
+
+        if ignore:
+            dashboard.ignored_devices.add(ignored_device.device_name)
+        else:
+            dashboard.ignored_devices.discard(ignored_device.device_name)
+
+        dashboard.save_ignored_devices()
+
+        self.set_status(204)
+        self.finish()
+
+
 class DownloadListRequestHandler(BaseHandler):
     @authenticated
     @bind_config
@@ -555,26 +596,18 @@ class DownloadListRequestHandler(BaseHandler):
 
         downloads = []
         platform: str = storage_json.target_platform.lower()
-        if platform == const.PLATFORM_RP2040:
-            from esphome.components.rp2040 import get_download_types as rp2040_types
 
-            downloads = rp2040_types(storage_json)
-        elif platform == const.PLATFORM_ESP8266:
-            from esphome.components.esp8266 import get_download_types as esp8266_types
-
-            downloads = esp8266_types(storage_json)
-        elif platform.upper() in ESP32_VARIANTS:
-            from esphome.components.esp32 import get_download_types as esp32_types
-
-            downloads = esp32_types(storage_json)
+        if platform.upper() in ESP32_VARIANTS:
+            platform = "esp32"
         elif platform in (const.PLATFORM_RTL87XX, const.PLATFORM_BK72XX):
-            from esphome.components.libretiny import (
-                get_download_types as libretiny_types,
-            )
+            platform = "libretiny"
 
-            downloads = libretiny_types(storage_json)
-        else:
-            raise ValueError(f"Unknown platform {platform}")
+        try:
+            module = importlib.import_module(f"esphome.components.{platform}")
+            get_download_types = getattr(module, "get_download_types")
+        except AttributeError as exc:
+            raise ValueError(f"Unknown platform {platform}") from exc
+        downloads = get_download_types(storage_json)
 
         self.set_status(200)
         self.set_header("content-type", "application/json")
@@ -688,6 +721,7 @@ class ListDevicesHandler(BaseHandler):
                             "project_name": res.project_name,
                             "project_version": res.project_version,
                             "network": res.network,
+                            "ignored": res.device_name in dashboard.ignored_devices,
                         }
                         for res in dashboard.import_result.values()
                         if res.device_name not in configured
@@ -1156,6 +1190,7 @@ def make_app(debug=get_bool_env(ENV_DEV)) -> tornado.web.Application:
             (f"{rel}prometheus-sd", PrometheusServiceDiscoveryHandler),
             (f"{rel}boards/([a-z0-9]+)", BoardsRequestHandler),
             (f"{rel}version", EsphomeVersionHandler),
+            (f"{rel}ignore-device", IgnoreDeviceRequestHandler),
         ],
         **app_settings,
     )

esphome/espota2.py

@@ -10,7 +10,7 @@ import sys
 import time
 
 from esphome.core import EsphomeError
-from esphome.helpers import is_ip_address, resolve_ip_address
+from esphome.helpers import resolve_ip_address
 
 RESPONSE_OK = 0x00
 RESPONSE_REQUEST_AUTH = 0x01
@@ -311,44 +311,45 @@ def perform_ota(
 
 
 def run_ota_impl_(remote_host, remote_port, password, filename):
-    if is_ip_address(remote_host):
-        _LOGGER.info("Connecting to %s", remote_host)
-        ip = remote_host
-    else:
-        _LOGGER.info("Resolving IP address of %s", remote_host)
-        try:
-            ip = resolve_ip_address(remote_host)
-        except EsphomeError as err:
-            _LOGGER.error(
-                "Error resolving IP address of %s. Is it connected to WiFi?",
-                remote_host,
-            )
-            _LOGGER.error(
-                "(If this error persists, please set a static IP address: "
-                "https://esphome.io/components/wifi.html#manual-ips)"
-            )
-            raise OTAError(err) from err
-        _LOGGER.info(" -> %s", ip)
-
-    sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
-    sock.settimeout(10.0)
     try:
-        sock.connect((ip, remote_port))
-    except OSError as err:
-        sock.close()
-        _LOGGER.error("Connecting to %s:%s failed: %s", remote_host, remote_port, err)
-        return 1
+        res = resolve_ip_address(remote_host, remote_port)
+    except EsphomeError as err:
+        _LOGGER.error(
+            "Error resolving IP address of %s. Is it connected to WiFi?",
+            remote_host,
+        )
+        _LOGGER.error(
+            "(If this error persists, please set a static IP address: "
+            "https://esphome.io/components/wifi.html#manual-ips)"
+        )
+        raise OTAError(err) from err
 
-    with open(filename, "rb") as file_handle:
+    for r in res:
+        af, socktype, _, _, sa = r
+        _LOGGER.info("Connecting to %s port %s...", sa[0], sa[1])
+        sock = socket.socket(af, socktype)
+        sock.settimeout(10.0)
         try:
-            perform_ota(sock, password, file_handle, filename)
-        except OTAError as err:
-            _LOGGER.error(str(err))
-            return 1
-        finally:
+            sock.connect(sa)
+        except OSError as err:
             sock.close()
-
-    return 0
+            _LOGGER.error("Connecting to %s port %s failed: %s", sa[0], sa[1], err)
+            continue
+
+        _LOGGER.info("Connected to %s", sa[0])
+        with open(filename, "rb") as file_handle:
+            try:
+                perform_ota(sock, password, file_handle, filename)
+            except OTAError as err:
+                _LOGGER.error(str(err))
+                return 1
+            finally:
+                sock.close()
+
+        return 0
+
+    _LOGGER.error("Connection failed.")
+    return 1
 
 
 def run_ota(remote_host, remote_port, password, filename):

esphome/helpers.py

@@ -1,5 +1,6 @@
 import codecs
 from contextlib import suppress
+import ipaddress
 import logging
 import os
 from pathlib import Path
@@ -91,12 +92,8 @@ def mkdir_p(path):
 
 
 def is_ip_address(host):
-    parts = host.split(".")
-    if len(parts) != 4:
-        return False
     try:
-        for p in parts:
-            int(p)
+        ipaddress.ip_address(host)
         return True
     except ValueError:
         return False
@@ -127,25 +124,80 @@ def _resolve_with_zeroconf(host):
     return info
 
 
-def resolve_ip_address(host):
+def addr_preference_(res):
+    # Trivial alternative to RFC6724 sorting. Put sane IPv6 first, then
+    # Legacy IP, then IPv6 link-local addresses without an actual link.
+    sa = res[4]
+    ip = ipaddress.ip_address(sa[0])
+    if ip.version == 4:
+        return 2
+    if ip.is_link_local and sa[3] == 0:
+        return 3
+    return 1
+
+
+def resolve_ip_address(host, port):
     import socket
 
     from esphome.core import EsphomeError
 
-    errs = []
+    # There are five cases here. The host argument could be one of:
+    #  • a *list* of IP addresses discovered by MQTT,
+    #  • a single IP address specified by the user,
+    #  • a .local hostname to be resolved by mDNS,
+    #  • a normal hostname to be resolved in DNS, or
+    #  • A URL from which we should extract the hostname.
+    #
+    # In each of the first three cases, we end up with IP addresses in
+    # string form which need to be converted to a 5-tuple to be used
+    # for the socket connection attempt. The easiest way to construct
+    # those is to pass the IP address string to getaddrinfo(). Which,
+    # coincidentally, is how we do hostname lookups in the other cases
+    # too. So first build a list which contains either IP addresses or
+    # a single hostname, then call getaddrinfo() on each element of
+    # that list.
 
-    if host.endswith(".local"):
+    errs = []
+    if isinstance(host, list):
+        addr_list = host
+    elif is_ip_address(host):
+        addr_list = [host]
+    else:
+        url = urlparse(host)
+        if url.scheme != "":
+            host = url.hostname
+
+        addr_list = []
+        if host.endswith(".local"):
+            try:
+                _LOGGER.info("Resolving IP address of %s in mDNS", host)
+                addr_list = _resolve_with_zeroconf(host)
+            except EsphomeError as err:
+                errs.append(str(err))
+
+        # If not mDNS, or if mDNS failed, use normal DNS
+        if not addr_list:
+            addr_list = [host]
+
+    # Now we have a list containing either IP addresses or a hostname
+    res = []
+    for addr in addr_list:
+        if not is_ip_address(addr):
+            _LOGGER.info("Resolving IP address of %s", host)
         try:
-            return _resolve_with_zeroconf(host)
-        except EsphomeError as err:
+            r = socket.getaddrinfo(addr, port, proto=socket.IPPROTO_TCP)
+        except OSError as err:
             errs.append(str(err))
+            raise EsphomeError(
+                f"Error resolving IP address: {', '.join(errs)}"
+            ) from err
 
-    try:
-        host_url = host if (urlparse(host).scheme != "") else "http://" + host
-        return socket.gethostbyname(urlparse(host_url).hostname)
-    except OSError as err:
-        errs.append(str(err))
-        raise EsphomeError(f"Error resolving IP address: {', '.join(errs)}") from err
+        res = res + r
+
+    # Zeroconf tends to give us link-local IPv6 addresses without specifying
+    # the link. Put those last in the list to be attempted.
+    res.sort(key=addr_preference_)
+    return res
 
 
 def get_bool_env(var, default=False):

esphome/mqtt.py

@@ -175,8 +175,15 @@ def get_esphome_device_ip(
                 _LOGGER.Warn("Wrong device answer")
                 return
 
-            if "ip" in data:
-                dev_ip = data["ip"]
+            dev_ip = []
+            key = "ip"
+            n = 0
+            while key in data:
+                dev_ip.append(data[key])
+                n = n + 1
+                key = "ip" + str(n)
+
+            if dev_ip:
                 client.disconnect()
 
     def on_connect(client, userdata, flags, return_code):

esphome/storage_json.py

@@ -28,6 +28,10 @@ def esphome_storage_path() -> str:
     return os.path.join(CORE.data_dir, "esphome.json")
 
 
+def ignored_devices_storage_path() -> str:
+    return os.path.join(CORE.data_dir, "ignored-devices.json")
+
+
 def trash_storage_path() -> str:
     return CORE.relative_config_path("trash")
 

esphome/writer.py

@@ -1,3 +1,4 @@
+import importlib
 import logging
 import os
 from pathlib import Path
@@ -299,25 +300,13 @@ def copy_src_tree():
         CORE.relative_src_path("esphome", "core", "version.h"), generate_version_h()
     )
 
-    if CORE.is_esp32:
-        from esphome.components.esp32 import copy_files
-
-        copy_files()
-
-    elif CORE.is_esp8266:
-        from esphome.components.esp8266 import copy_files
-
+    platform = "esphome.components." + CORE.target_platform
+    try:
+        module = importlib.import_module(platform)
+        copy_files = getattr(module, "copy_files")
         copy_files()
-
-    elif CORE.is_rp2040:
-        from esphome.components.rp2040 import copy_files
-
-        (pio) = copy_files()
-        if pio:
-            write_file_if_changed(
-                CORE.relative_src_path("esphome.h"),
-                ESPHOME_H_FORMAT.format(include_s + '\n#include "pio_includes.h"'),
-            )
+    except AttributeError:
+        pass
 
 
 def generate_defines_h():

esphome/zeroconf.py

@@ -176,24 +176,26 @@ def _make_host_resolver(host: str) -> HostResolver:
 
 
 class EsphomeZeroconf(Zeroconf):
-    def resolve_host(self, host: str, timeout: float = 3.0) -> str | None:
+    def resolve_host(self, host: str, timeout: float = 3.0) -> list[str] | None:
         """Resolve a host name to an IP address."""
         info = _make_host_resolver(host)
         if (
             info.load_from_cache(self)
             or (timeout and info.request(self, timeout * 1000))
-        ) and (addresses := info.ip_addresses_by_version(IPVersion.V4Only)):
-            return str(addresses[0])
+        ) and (addresses := info.parsed_scoped_addresses(IPVersion.All)):
+            return addresses
         return None
 
 
 class AsyncEsphomeZeroconf(AsyncZeroconf):
-    async def async_resolve_host(self, host: str, timeout: float = 3.0) -> str | None:
+    async def async_resolve_host(
+        self, host: str, timeout: float = 3.0
+    ) -> list[str] | None:
         """Resolve a host name to an IP address."""
         info = _make_host_resolver(host)
         if (
             info.load_from_cache(self.zeroconf)
             or (timeout and await info.async_request(self.zeroconf, timeout * 1000))
-        ) and (addresses := info.ip_addresses_by_version(IPVersion.V4Only)):
-            return str(addresses[0])
+        ) and (addresses := info.parsed_scoped_addresses(IPVersion.All)):
+            return addresses
         return None

{esphome-2024.10.2.dist-info → esphome-2024.11.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: esphome
-Version: 2024.10.2
+Version: 2024.11.0
 Summary: Make creating custom firmwares for ESP32/ESP8266 super easy.
 Author-email: The ESPHome Authors <esphome@nabucasa.com>
 License: MIT
@@ -25,7 +25,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: cryptography ==43.0.0
 Requires-Dist: voluptuous ==0.14.2
-Requires-Dist: PyYAML ==6.0.1
+Requires-Dist: PyYAML ==6.0.2
 Requires-Dist: paho-mqtt ==1.6.1
 Requires-Dist: colorama ==0.4.6
 Requires-Dist: icmplib ==3.0.4
@@ -33,14 +33,17 @@ Requires-Dist: tornado ==6.4
 Requires-Dist: tzlocal ==5.2
 Requires-Dist: tzdata >=2021.1
 Requires-Dist: pyserial ==3.5
-Requires-Dist: platformio ==6.1.15
+Requires-Dist: platformio ==6.1.16
 Requires-Dist: esptool ==4.7.0
 Requires-Dist: click ==8.1.7
-Requires-Dist: esphome-dashboard ==20240620.0
+Requires-Dist: esphome-dashboard ==20241120.0
 Requires-Dist: aioesphomeapi ==24.6.2
 Requires-Dist: zeroconf ==0.132.2
 Requires-Dist: puremagic ==1.27
 Requires-Dist: ruamel.yaml ==0.18.6
+Requires-Dist: glyphsets ==1.0.0
+Requires-Dist: pillow ==10.4.0
+Requires-Dist: freetype-py ==2.5.1
 Requires-Dist: kconfiglib ==13.7.1
 Requires-Dist: pyparsing >=3.0
 Requires-Dist: argcomplete >=2.0.0
@@ -50,7 +53,6 @@ Requires-Dist: clang-format ==13.0.1 ; extra == 'dev'
 Requires-Dist: clang-tidy ==14.0.6 ; extra == 'dev'
 Requires-Dist: yamllint ==1.35.1 ; extra == 'dev'
 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.2.7 ; extra == 'test'