La Marzocco add Bluetooth offline mode (home-assistant#157011)

Author: zweckj

homeassistant/components/lamarzocco/__init__.py

@@ -35,6 +35,7 @@
 
 from .const import CONF_INSTALLATION_KEY, CONF_USE_BLUETOOTH, DOMAIN
 from .coordinator import (
+    LaMarzoccoBluetoothUpdateCoordinator,
     LaMarzoccoConfigEntry,
     LaMarzoccoConfigUpdateCoordinator,
     LaMarzoccoRuntimeData,
@@ -72,38 +73,10 @@ async def async_setup_entry(hass: HomeAssistant, entry: LaMarzoccoConfigEntry) -
         client=create_client_session(hass),
     )
 
-    try:
-        settings = await cloud_client.get_thing_settings(serial)
-    except AuthFail as ex:
-        raise ConfigEntryAuthFailed(
-            translation_domain=DOMAIN, translation_key="authentication_failed"
-        ) from ex
-    except (RequestNotSuccessful, TimeoutError) as ex:
-        _LOGGER.debug(ex, exc_info=True)
-        raise ConfigEntryNotReady(
-            translation_domain=DOMAIN, translation_key="api_error"
-        ) from ex
-
-    gateway_version = version.parse(
-        settings.firmwares[FirmwareType.GATEWAY].build_version
-    )
-
-    if gateway_version < version.parse("v5.0.9"):
-        # incompatible gateway firmware, create an issue
-        ir.async_create_issue(
-            hass,
-            DOMAIN,
-            "unsupported_gateway_firmware",
-            is_fixable=False,
-            severity=ir.IssueSeverity.ERROR,
-            translation_key="unsupported_gateway_firmware",
-            translation_placeholders={"gateway_version": str(gateway_version)},
-        )
-
     # initialize Bluetooth
     bluetooth_client: LaMarzoccoBluetoothClient | None = None
     if entry.options.get(CONF_USE_BLUETOOTH, True) and (
-        token := (entry.data.get(CONF_TOKEN) or settings.ble_auth_token)
+        token := entry.data.get(CONF_TOKEN)
     ):
         if CONF_MAC not in entry.data:
             for discovery_info in async_discovered_service_info(hass):
@@ -145,6 +118,44 @@ async def disconnect_bluetooth(_: Event) -> None:
                 _LOGGER.info(
                     "Bluetooth device not found during lamarzocco setup, continuing with cloud only"
                 )
+    try:
+        settings = await cloud_client.get_thing_settings(serial)
+    except AuthFail as ex:
+        raise ConfigEntryAuthFailed(
+            translation_domain=DOMAIN, translation_key="authentication_failed"
+        ) from ex
+    except (RequestNotSuccessful, TimeoutError) as ex:
+        _LOGGER.debug(ex, exc_info=True)
+        if not bluetooth_client:
+            raise ConfigEntryNotReady(
+                translation_domain=DOMAIN, translation_key="api_error"
+            ) from ex
+        _LOGGER.debug("Cloud failed, continuing with Bluetooth only", exc_info=True)
+    else:
+        gateway_version = version.parse(
+            settings.firmwares[FirmwareType.GATEWAY].build_version
+        )
+
+        if gateway_version < version.parse("v5.0.9"):
+            # incompatible gateway firmware, create an issue
+            ir.async_create_issue(
+                hass,
+                DOMAIN,
+                "unsupported_gateway_firmware",
+                is_fixable=False,
+                severity=ir.IssueSeverity.ERROR,
+                translation_key="unsupported_gateway_firmware",
+                translation_placeholders={"gateway_version": str(gateway_version)},
+            )
+        # Update BLE Token if exists
+        if settings.ble_auth_token:
+            hass.config_entries.async_update_entry(
+                entry,
+                data={
+                    **entry.data,
+                    CONF_TOKEN: settings.ble_auth_token,
+                },
+            )
 
     device = LaMarzoccoMachine(
         serial_number=entry.unique_id,
@@ -153,7 +164,7 @@ async def disconnect_bluetooth(_: Event) -> None:
     )
 
     coordinators = LaMarzoccoRuntimeData(
-        LaMarzoccoConfigUpdateCoordinator(hass, entry, device, cloud_client),
+        LaMarzoccoConfigUpdateCoordinator(hass, entry, device),
         LaMarzoccoSettingsUpdateCoordinator(hass, entry, device),
         LaMarzoccoScheduleUpdateCoordinator(hass, entry, device),
         LaMarzoccoStatisticsUpdateCoordinator(hass, entry, device),
@@ -166,6 +177,16 @@ async def disconnect_bluetooth(_: Event) -> None:
         coordinators.statistics_coordinator.async_config_entry_first_refresh(),
     )
 
+    # bt coordinator only if bluetooth client is available
+    # and after the initial refresh of the config coordinator
+    # to fetch only if the others failed
+    if bluetooth_client:
+        bluetooth_coordinator = LaMarzoccoBluetoothUpdateCoordinator(
+            hass, entry, device
+        )
+        await bluetooth_coordinator.async_config_entry_first_refresh()
+        coordinators.bluetooth_coordinator = bluetooth_coordinator
+
     entry.runtime_data = coordinators
 
     await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)

homeassistant/components/lamarzocco/binary_sensor.py

@@ -6,7 +6,7 @@
 
 from pylamarzocco import LaMarzoccoMachine
 from pylamarzocco.const import BackFlushStatus, MachineState, ModelName, WidgetType
-from pylamarzocco.models import BackFlush, MachineStatus
+from pylamarzocco.models import BackFlush, MachineStatus, NoWater
 
 from homeassistant.components.binary_sensor import (
     BinarySensorDeviceClass,
@@ -39,8 +39,15 @@ class LaMarzoccoBinarySensorEntityDescription(
         key="water_tank",
         translation_key="water_tank",
         device_class=BinarySensorDeviceClass.PROBLEM,
-        is_on_fn=lambda machine: WidgetType.CM_NO_WATER in machine.dashboard.config,
+        is_on_fn=(
+            lambda machine: cast(
+                NoWater, machine.dashboard.config[WidgetType.CM_NO_WATER]
+            ).allarm
+            if WidgetType.CM_NO_WATER in machine.dashboard.config
+            else False
+        ),
         entity_category=EntityCategory.DIAGNOSTIC,
+        bt_offline_mode=True,
     ),
     LaMarzoccoBinarySensorEntityDescription(
         key="brew_active",
@@ -93,7 +100,9 @@ async def async_setup_entry(
     coordinator = entry.runtime_data.config_coordinator
 
     async_add_entities(
-        LaMarzoccoBinarySensorEntity(coordinator, description)
+        LaMarzoccoBinarySensorEntity(
+            coordinator, description, entry.runtime_data.bluetooth_coordinator
+        )
         for description in ENTITIES
         if description.supported_fn(coordinator)
     )

homeassistant/components/lamarzocco/coordinator.py

@@ -10,8 +10,12 @@
 import logging
 from typing import Any
 
-from pylamarzocco import LaMarzoccoCloudClient, LaMarzoccoMachine
-from pylamarzocco.exceptions import AuthFail, RequestNotSuccessful
+from pylamarzocco import LaMarzoccoMachine
+from pylamarzocco.exceptions import (
+    AuthFail,
+    BluetoothConnectionFailed,
+    RequestNotSuccessful,
+)
 
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import EVENT_HOMEASSISTANT_STOP
@@ -36,6 +40,7 @@ class LaMarzoccoRuntimeData:
     settings_coordinator: LaMarzoccoSettingsUpdateCoordinator
     schedule_coordinator: LaMarzoccoScheduleUpdateCoordinator
     statistics_coordinator: LaMarzoccoStatisticsUpdateCoordinator
+    bluetooth_coordinator: LaMarzoccoBluetoothUpdateCoordinator | None = None
 
 
 type LaMarzoccoConfigEntry = ConfigEntry[LaMarzoccoRuntimeData]
@@ -46,14 +51,13 @@ class LaMarzoccoUpdateCoordinator(DataUpdateCoordinator[None]):
 
     _default_update_interval = SCAN_INTERVAL
     config_entry: LaMarzoccoConfigEntry
-    _websocket_task: Task | None = None
+    update_success = False
 
     def __init__(
         self,
         hass: HomeAssistant,
         entry: LaMarzoccoConfigEntry,
         device: LaMarzoccoMachine,
-        cloud_client: LaMarzoccoCloudClient | None = None,
     ) -> None:
         """Initialize coordinator."""
         super().__init__(
@@ -64,7 +68,7 @@ def __init__(
             update_interval=self._default_update_interval,
         )
         self.device = device
-        self.cloud_client = cloud_client
+        self._websocket_task: Task | None = None
 
     @property
     def websocket_terminated(self) -> bool:
@@ -81,14 +85,28 @@ async def __handle_internal_update(
             await func()
         except AuthFail as ex:
             _LOGGER.debug("Authentication failed", exc_info=True)
+            self.update_success = False
             raise ConfigEntryAuthFailed(
                 translation_domain=DOMAIN, translation_key="authentication_failed"
             ) from ex
         except RequestNotSuccessful as ex:
             _LOGGER.debug(ex, exc_info=True)
+            self.update_success = False
+            # if no bluetooth coordinator, this is a fatal error
+            # otherwise, bluetooth may still work
+            if not self.device.bluetooth_client_available:
+                raise UpdateFailed(
+                    translation_domain=DOMAIN, translation_key="api_error"
+                ) from ex
+        except BluetoothConnectionFailed as err:
+            self.update_success = False
             raise UpdateFailed(
-                translation_domain=DOMAIN, translation_key="api_error"
-            ) from ex
+                translation_domain=DOMAIN,
+                translation_key="bluetooth_connection_failed",
+            ) from err
+        else:
+            self.update_success = True
+        _LOGGER.debug("Current status: %s", self.device.dashboard.to_dict())
 
     async def _async_setup(self) -> None:
         """Set up coordinator."""
@@ -109,19 +127,17 @@ async def _internal_async_update_data(self) -> None:
 class LaMarzoccoConfigUpdateCoordinator(LaMarzoccoUpdateCoordinator):
     """Class to handle fetching data from the La Marzocco API centrally."""
 
-    cloud_client: LaMarzoccoCloudClient
-
     async def _internal_async_setup(self) -> None:
         """Set up the coordinator."""
-        await self.cloud_client.async_get_access_token()
+        await self.device.ensure_token_valid()
         await self.device.get_dashboard()
         _LOGGER.debug("Current status: %s", self.device.dashboard.to_dict())
 
     async def _internal_async_update_data(self) -> None:
         """Fetch data from API endpoint."""
 
         # ensure token stays valid; does nothing if token is still valid
-        await self.cloud_client.async_get_access_token()
+        await self.device.ensure_token_valid()
 
         # Only skip websocket reconnection if it's currently connected and the task is still running
         if self.device.websocket.connected and not self.websocket_terminated:
@@ -193,3 +209,19 @@ async def _internal_async_update_data(self) -> None:
         """Fetch data from API endpoint."""
         await self.device.get_coffee_and_flush_counter()
         _LOGGER.debug("Current statistics: %s", self.device.statistics.to_dict())
+
+
+class LaMarzoccoBluetoothUpdateCoordinator(LaMarzoccoUpdateCoordinator):
+    """Class to handle fetching data from the La Marzocco Bluetooth API centrally."""
+
+    async def _internal_async_setup(self) -> None:
+        """Initial setup for Bluetooth coordinator."""
+        await self.device.get_model_info_from_bluetooth()
+
+    async def _internal_async_update_data(self) -> None:
+        """Fetch data from Bluetooth endpoint."""
+        # if the websocket is connected and the machine is connected to the cloud
+        # skip bluetooth update, because we get push updates
+        if self.device.websocket.connected and self.device.dashboard.connected:
+            return
+        await self.device.get_dashboard_from_bluetooth()

homeassistant/components/lamarzocco/entity.py

@@ -17,7 +17,10 @@
 from homeassistant.helpers.update_coordinator import CoordinatorEntity
 
 from .const import DOMAIN
-from .coordinator import LaMarzoccoUpdateCoordinator
+from .coordinator import (
+    LaMarzoccoBluetoothUpdateCoordinator,
+    LaMarzoccoUpdateCoordinator,
+)
 
 
 @dataclass(frozen=True, kw_only=True)
@@ -26,6 +29,7 @@ class LaMarzoccoEntityDescription(EntityDescription):
 
     available_fn: Callable[[LaMarzoccoUpdateCoordinator], bool] = lambda _: True
     supported_fn: Callable[[LaMarzoccoUpdateCoordinator], bool] = lambda _: True
+    bt_offline_mode: bool = False
 
 
 class LaMarzoccoBaseEntity(
@@ -45,14 +49,19 @@ def __init__(
         super().__init__(coordinator)
         device = coordinator.device
         self._attr_unique_id = f"{device.serial_number}_{key}"
+        sw_version = (
+            device.settings.firmwares[FirmwareType.MACHINE].build_version
+            if FirmwareType.MACHINE in device.settings.firmwares
+            else None
+        )
         self._attr_device_info = DeviceInfo(
             identifiers={(DOMAIN, device.serial_number)},
-            name=device.dashboard.name,
+            name=device.dashboard.name or self.coordinator.config_entry.title,
             manufacturer="La Marzocco",
             model=device.dashboard.model_name.value,
             model_id=device.dashboard.model_code.value,
             serial_number=device.serial_number,
-            sw_version=device.settings.firmwares[FirmwareType.MACHINE].build_version,
+            sw_version=sw_version,
         )
         connections: set[tuple[str, str]] = set()
         if coordinator.config_entry.data.get(CONF_ADDRESS):
@@ -77,8 +86,12 @@ def available(self) -> bool:
             if WidgetType.CM_MACHINE_STATUS in self.coordinator.device.dashboard.config
             else MachineState.OFF
         )
-        return super().available and not (
-            self._unavailable_when_machine_off and machine_state is MachineState.OFF
+        return (
+            super().available
+            and not (
+                self._unavailable_when_machine_off and machine_state is MachineState.OFF
+            )
+            and self.coordinator.update_success
         )
 
 
@@ -90,6 +103,11 @@ class LaMarzoccoEntity(LaMarzoccoBaseEntity):
     @property
     def available(self) -> bool:
         """Return True if entity is available."""
+        if (
+            self.entity_description.bt_offline_mode
+            and self.bluetooth_coordinator is not None
+        ):
+            return self.bluetooth_coordinator.last_update_success
         if super().available:
             return self.entity_description.available_fn(self.coordinator)
         return False
@@ -98,7 +116,17 @@ def __init__(
         self,
         coordinator: LaMarzoccoUpdateCoordinator,
         entity_description: LaMarzoccoEntityDescription,
+        bluetooth_coordinator: LaMarzoccoBluetoothUpdateCoordinator | None = None,
     ) -> None:
         """Initialize the entity."""
         super().__init__(coordinator, entity_description.key)
         self.entity_description = entity_description
+        self.bluetooth_coordinator = bluetooth_coordinator
+
+    async def async_added_to_hass(self) -> None:
+        """Handle when entity is added to hass."""
+        await super().async_added_to_hass()
+        if self.bluetooth_coordinator is not None:
+            self.async_on_remove(
+                self.bluetooth_coordinator.async_add_listener(self.async_write_ha_state)
+            )