Poll for pending HVAC states [fixes #21] (#22)

When setting mode=AUTO while the car is sleeping, the target state
might not be reached until more than 30 seconds later (the delay
we use after sending an HVAC command). In that case, what happens
is:

1. Set hvac_mode=AUTO -> send hvac command -> write state
2. After 30 seconds, poll TeslaFi
3. If the state has not been updated yet, this will write state=OFF
4. Some time later (3 min default), TeslaFi has the updated state
   and will report state=AUTO

The transition from 2->3->4 causes the climate entity to flip
states unexpectedly.

For `lock` and `alarm_control_panel` platforms, we retain a pending
or target state, and on the next refresh if the pending state has
not been met yet, we schedule another refresh, until the target
state is met. This adds the same technique for climate mode.

We only do this for mode, because it's the one that is most likely
to be set from a sleeping state.

In addition, we'll also ask TeslaFi to add the `wake=` parameter
which will cause the API to wake the car first and wait a few
seconds for the car to wake up before sending the real command.

Long term it would be great to have a better (and more reusable)
way of doing this. Ideally the HA service call should not return
until the target state is fully verified, but given the polling
nature of both the integration and TeslaFi itself, this could
cause problems in HA.

Author: jhansche

custom_components/teslafi/client.py

@@ -46,11 +46,12 @@ async def _request(self, command: str = "", **kwargs) -> dict:
         """
         :param command: The command to send. Can be empty string, `lastGood`, etc. See
         """
+        timeout = kwargs.get("wake", 0) + REQUEST_TIMEOUT
         response = await self._client.get(
             url="https://www.teslafi.com/feed.php",
             headers={"Authorization": "Bearer " + self._api_key},
             params={"command": command} | kwargs,
-            timeout=REQUEST_TIMEOUT,
+            timeout=timeout,
         )
         assert response.status_code < 400
 

custom_components/teslafi/climate.py

@@ -69,6 +69,8 @@ class TeslaFiClimate(TeslaFiEntity[TeslaFiClimateEntityDescription], ClimateEnti
     _attr_preset_mode = None
     _attr_is_aux_heat = False
 
+    _pending_mode = None
+
     def _handle_coordinator_update(self) -> None:
         # These are in Celsius, despite user settings
         self._attr_target_temperature = (
@@ -81,10 +83,19 @@ def _handle_coordinator_update(self) -> None:
         )
 
         is_on = _convert_to_bool(self.coordinator.data.get("is_climate_on"))
-        if not is_on:
-            self._attr_hvac_mode = HVACMode.OFF
+
+        new_mode = None if is_on is None else HVACMode.AUTO if is_on else HVACMode.OFF
+        want_mode = self._pending_mode
+
+        if want_mode is None:
+            self._attr_hvac_mode = new_mode
+        elif new_mode == want_mode:
+            self._attr_hvac_mode = new_mode
+            self._pending_mode = None
+            LOGGER.info("Target state succeeded: %s", want_mode)
         else:
-            self._attr_hvac_mode = HVACMode.AUTO
+            LOGGER.debug("Still waiting for %s", want_mode)
+            return self.coordinator.schedule_refresh_in(DELAY_WAKEUP)
 
         self._attr_fan_mode = (
             FAN_AUTO if self.coordinator.data.get("fan_status") == "2" else FAN_OFF
@@ -141,6 +152,7 @@ async def async_set_hvac_mode(self, hvac_mode: HVACMode) -> None:
         else:
             raise f"Mode '{hvac_mode}' not supported."
 
+        self._pending_mode = hvac_mode
         await self.coordinator.execute_command(cmd)
         self._attr_hvac_mode = hvac_mode
         self._attr_hvac_action = None

custom_components/teslafi/const.py

@@ -16,6 +16,7 @@
 POLLING_INTERVAL_SLEEPING = timedelta(minutes=10)
 
 DELAY_CLIMATE = timedelta(seconds=30)
+DELAY_CMD_WAKE = timedelta(seconds=10)
 DELAY_LOCKS = timedelta(seconds=15)
 DELAY_WAKEUP = timedelta(seconds=30)
 

custom_components/teslafi/coordinator.py

@@ -7,6 +7,7 @@
 
 from .client import TeslaFiClient
 from .const import (
+    DELAY_CMD_WAKE,
     DOMAIN,
     LOGGER,
     POLLING_INTERVAL_DEFAULT,
@@ -44,6 +45,8 @@ def __init__(
 
     async def execute_command(self, cmd: str, **kwargs) -> dict:
         """Execute the remote command."""
+        if self.data.is_sleeping:
+            kwargs["wake"] = DELAY_CMD_WAKE.seconds
         LOGGER.debug(">> executing command %s; args=%s", cmd, kwargs)
         result = await self._client.command(cmd, **kwargs)
         LOGGER.debug("<< command %s response: %s", cmd, result)