Add more TeslaFi commands [part of #28] (#35)

* Raise API errors

* Add charge port door cover

This is part of #28

* Add TURN_ON/TURN_OFF ClimateEntityFeatures

These were added in 2024.2, so they need to be recreated.

This adds to the fix for #30, which implemented the callbacks, but
did not add the supported feature.

* Add steering wheel heater switch

* Add charging configs

Adds charger SOC setting, and charger current

* Fix SOC number unit

NumberEntity does not support .unit_of_measurement, requires using
.native_unit_of_measurement (%).

* Add start/stop charge switch [part of #28] (#36)

* Add start/stop charge switch

This switch can take the place of the binary_sensor.charging entity,
where the switch can be toggled off/on in order to stop/start charging.

The command(s) must be enabled in TeslaFi for this to work, and the
way the entity appears in Home Assistant might be less desirable
for some - that is why the entity is disabled by default.

If you want to keep the binary_sensor, but also still have the
ability to stop/start charging, you can set the switch entity to
hidden, and use some other means to toggle the switch, like with
a Button or automation calling switch.* services.

* Set charging state optimistically

Author: jhansche

custom_components/teslafi/__init__.py

@@ -1,4 +1,5 @@
 """TeslaFi integration."""
+
 from __future__ import annotations
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import Platform, CONF_API_KEY
@@ -19,12 +20,13 @@
     Platform.BINARY_SENSOR,
     Platform.BUTTON,
     Platform.CLIMATE,
-    # TODO: Platform.COVER,
+    Platform.COVER,
     Platform.DEVICE_TRACKER,
     Platform.LOCK,
+    Platform.NUMBER,
     # Platform.SELECT,
     Platform.SENSOR,
-    # TODO: Platform.SWITCH,
+    Platform.SWITCH,
     Platform.UPDATE,
 ]
 

custom_components/teslafi/base.py

@@ -2,13 +2,17 @@
 
 from collections.abc import Callable
 from dataclasses import dataclass
+from numbers import Number
 from typing import Generic, TypeVar, cast
 from typing_extensions import override
 from homeassistant.components.binary_sensor import BinarySensorEntityDescription
 from homeassistant.components.button import ButtonEntityDescription
 from homeassistant.components.climate import ClimateEntityDescription
+from homeassistant.components.cover import CoverEntityDescription
 from homeassistant.components.lock import LockEntityDescription
+from homeassistant.components.number import NumberEntityDescription
 from homeassistant.components.sensor import SensorEntityDescription
+from homeassistant.components.switch import SwitchEntityDescription
 from homeassistant.components.update import UpdateEntityDescription
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.entity import DeviceInfo, EntityDescription
@@ -122,6 +126,18 @@ class TeslaFiClimateEntityDescription(
     """TeslaFi Climate EntityDescription"""
 
 
+@dataclass
+class TeslaFiCoverEntityDescription(
+    CoverEntityDescription,
+    TeslaFiBaseEntityDescription,
+):
+    """TeslaFi Cover"""
+
+    value: Callable[[TeslaFiVehicle, HomeAssistant], bool] = None
+    convert: Callable[[any], bool] = _convert_to_bool
+    cmd: Callable[[TeslaFiCoordinator, bool], dict] = None
+
+
 @dataclass
 class TeslaFiSensorEntityDescription(
     SensorEntityDescription,
@@ -133,6 +149,36 @@ class TeslaFiSensorEntityDescription(
     """Dictionary of state -> icon"""
 
 
+@dataclass
+class TeslaFiNumberEntityDescription(
+    NumberEntityDescription,
+    TeslaFiBaseEntityDescription,
+):
+    """TeslaFi Number EntityDescription"""
+
+    convert: Callable[[any], bool] = lambda v: int(v) if v else None
+    cmd: Callable[[TeslaFiCoordinator, Number], dict] = None
+
+    max_value_key: str = None
+    """
+    If specified, look up this key for the max value,
+    otherwise fall back to max_value.
+    """
+
+
+@dataclass(slots=True)
+class TeslaFiSwitchEntityDescription(
+    SwitchEntityDescription,
+    TeslaFiBaseEntityDescription,
+):
+    """TeslaFi Switch EntityDescription"""
+
+    cmd: Callable[[TeslaFiCoordinator, bool], bool] = None
+    """The command to send to TeslaFi on toggle."""
+
+    convert: Callable[[any], bool] = _convert_to_bool
+
+
 @dataclass
 class TeslaFiUpdateEntityDescription(
     UpdateEntityDescription,

custom_components/teslafi/binary_sensor.py

@@ -18,6 +18,7 @@
 SENSORS = [
     # region Charging
     TeslaFiBinarySensorEntityDescription(
+        # TODO: convert to switch?
         key="_is_charging",
         name="Charging",
         icon="mdi:ev-station",

custom_components/teslafi/client.py

@@ -1,10 +1,10 @@
 """TeslaFi API Client"""
 
 from json import JSONDecodeError
-import httpx
+from httpx import AsyncClient, Response
 import logging
 
-from .errors import VehicleNotReadyError
+from .errors import TeslaFiApiError, VehicleNotReadyError
 from .model import TeslaFiVehicle
 
 REQUEST_TIMEOUT = 5
@@ -15,12 +15,12 @@ class TeslaFiClient:
     """TeslaFi API Client"""
 
     _api_key: str
-    _client: httpx.AsyncClient
+    _client: AsyncClient
 
     def __init__(
         self,
         api_key: str,
-        client: httpx.AsyncClient,
+        client: AsyncClient,
     ) -> None:
         """
         Creates a new TeslaFi API Client.
@@ -47,13 +47,20 @@ async def _request(self, command: str = "", **kwargs) -> dict:
         """
         :param command: The command to send. Can be empty string, `lastGood`, etc. See
         """
+        _LOGGER.debug(">> executing command %s; args=%s", command, kwargs)
         timeout = kwargs.get("wake", 0) + REQUEST_TIMEOUT
-        response = await self._client.get(
+        response: Response = await self._client.get(
             url="https://www.teslafi.com/feed.php",
             headers={"Authorization": "Bearer " + self._api_key},
             params={"command": command} | kwargs,
             timeout=timeout,
         )
+        _LOGGER.debug(
+            "<< command %s response[%d]: %s",
+            command,
+            response.status_code,
+            response.text,
+        )
         assert response.status_code < 400
 
         try:
@@ -68,10 +75,18 @@ async def _request(self, command: str = "", **kwargs) -> dict:
 
         if isinstance(data, dict):
             if err := data.get("error"):
-                raise RuntimeError(f"{err}: {data.get('error_description')}")
-            if data.get("response", {}).get("result", None) == "unauthorized":
+                raise TeslaFiApiError(f"{err}: {data.get('error_description')}")
+            response: dict = data.get("response", {})
+            if response.get("result") == "unauthorized":
                 raise PermissionError(
                     f"TeslaFi response unauthorized for api key {self._api_key}: {data}"
                 )
+            if not response.get("result", True):
+                msg = (
+                    response.get("reason")
+                    or response.get("string")
+                    or f"Unexpected response: {data}"
+                )
+                raise TeslaFiApiError(msg)
 
         return data

custom_components/teslafi/climate.py

@@ -59,7 +59,11 @@ class TeslaFiClimate(TeslaFiEntity[TeslaFiClimateEntityDescription], ClimateEnti
     _attr_hvac_modes = [HVACMode.AUTO, HVACMode.OFF]
     _attr_temperature_unit = UnitOfTemperature.CELSIUS
     _attr_supported_features = ClimateEntityFeature(
-        ClimateEntityFeature.TARGET_TEMPERATURE | ClimateEntityFeature.PRESET_MODE
+        ClimateEntityFeature.TARGET_TEMPERATURE
+        | ClimateEntityFeature.PRESET_MODE
+        # FIXME: min 2024.2
+        | ClimateEntityFeature(128)
+        | ClimateEntityFeature(256)
     )
 
     _attr_fan_modes = [FAN_AUTO, FAN_OFF]

custom_components/teslafi/coordinator.py

@@ -14,7 +14,6 @@
     POLLING_INTERVAL_DRIVING,
     POLLING_INTERVAL_SLEEPING,
 )
-from .errors import VehicleNotReadyError
 from .model import TeslaFiVehicle
 
 
@@ -48,13 +47,8 @@ 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)
-        try:
-            result = await self._client.command(cmd, **kwargs)
-        except VehicleNotReadyError as e:
-            LOGGER.warning(f"Failed sending command to vehicle: {e}")
-        LOGGER.debug("<< command %s response: %s", cmd, result)
-        return result
+
+        return await self._client.command(cmd, **kwargs)
 
     def schedule_refresh_in(self, delta: timedelta):
         """Attempt to schedule a refresh"""

custom_components/teslafi/cover.py

@@ -0,0 +1,90 @@
+from typing import Any
+from homeassistant.components.cover import (
+    CoverDeviceClass,
+    CoverEntity,
+    CoverEntityFeature,
+)
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.const import EntityCategory
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers.entity_platform import AddEntitiesCallback
+
+from .base import TeslaFiEntity, TeslaFiCoverEntityDescription
+from .const import DOMAIN, LOGGER
+from .coordinator import TeslaFiCoordinator
+from .errors import TeslaFiApiError
+from .util import _convert_to_bool
+
+COVERS = [
+    TeslaFiCoverEntityDescription(
+        key="charge_port_door_open",
+        name="Charge Port Door",
+        device_class=CoverDeviceClass.DOOR,
+        icon="mdi:ev-plug-tesla",
+        value=lambda d, h: d.get("charge_port_door_open", False),
+        available=lambda u, d, h: u and d.car_state != "driving",
+        cmd=lambda c, v: c.execute_command(
+            "charge_port_door_open" if v else "charge_port_door_close"
+        ),
+    )
+]
+
+
+class TeslaFiCoverEntity(
+    TeslaFiEntity[TeslaFiCoverEntityDescription],
+    CoverEntity,
+):
+    """TeslaFi Cover Entity"""
+
+    _attr_supported_features = CoverEntityFeature.OPEN | CoverEntityFeature.CLOSE
+    _attr_is_closed = False
+    _attr_is_closing = False
+    _attr_is_opening = False
+
+    def _handle_coordinator_update(self) -> None:
+        self._attr_is_closed = self._get_value() == False
+        self._attr_is_opening = False
+        self._attr_is_closing = False
+        return super()._handle_coordinator_update()
+
+    async def async_close_cover(self, **kwargs: Any):
+        if self.coordinator.data.is_plugged_in:
+            LOGGER.warning("Cannot close charge port door while plugged in!")
+
+        try:
+            self._attr_is_opening = False
+            await self.entity_description.cmd(self.coordinator, False)
+            self._attr_is_closed = True
+        except TeslaFiApiError as e:
+            if "already closed" not in str(e):
+                raise e
+        self._attr_is_closed = True
+        return self.async_write_ha_state()
+
+    async def async_open_cover(self, **kwargs: Any) -> None:
+        if self.coordinator.data.shift_state != "park":
+            LOGGER.warning("Cannot open charge port door while driving!")
+        try:
+            self._attr_is_closing = False
+            await self.entity_description.cmd(self.coordinator, True)
+            self._attr_is_closed = False
+        except TeslaFiApiError as e:
+            if "already open" not in str(e):
+                raise e
+        self._attr_is_closed = False
+        return self.async_write_ha_state()
+
+
+async def async_setup_entry(
+    hass: HomeAssistant,
+    config_entry: ConfigEntry,
+    async_add_entities: AddEntitiesCallback,
+) -> None:
+    """Set up from config entry"""
+    coordinator: TeslaFiCoordinator
+    coordinator = hass.data[DOMAIN][config_entry.entry_id]["coordinator"]
+    entities: list[TeslaFiCoverEntity] = []
+    entities.extend(
+        [TeslaFiCoverEntity(coordinator, description) for description in COVERS]
+    )
+    async_add_entities(entities)

custom_components/teslafi/errors.py

@@ -1,2 +1,9 @@
+from dataclasses import dataclass
+
+
 class VehicleNotReadyError(Exception):
     """The vehicle is sleeping"""
+
+
+class TeslaFiApiError(Exception):
+    """API responded with an error reason"""