Merge pull request #79 from CoMPaTech/trip_switch

Add reset-trip button

Author: CoMPaTech

CHANGELOG.md

@@ -2,15 +2,24 @@
 
 ## Changelog
 
-### JAN 2024 [no release, just an update]
+### Ongoing
+
+- Add multibike support (see 0.4 beta progress)
+
+### JUN 2024 [0.3.2]
+
+- Added trip_reset button
+- Released v0.3(.2) as new stable version
+
+### JAN 2024
 
 - Added to HACS default repository (yay!)
 
 ### DEC 2023 [0.3.1 (alpha/beta]
 
 - Released version 0.3
 
-### DEC 2023 [0.3.0 (alpha/beta]
+### DEC 2023 [0.3.0 (alpha/beta)]
 
 - Introduce Lock and Light switches
 - Fix UnitOf[X] for future HA compatibility (e.g. TEMP_CELSIUS => UnitOfTemperature.CELSIUS)

README.md

@@ -36,6 +36,8 @@ Do note that the switches do not immediately reflect the status (i.e. they will
 After your 'switch' command we do request an API update to check on the status, pending that update the switch might toggle back-n-forth some time.
 The light-switch is called 'Light mode' as depending on your bike type it will switch on/off or between 'dim and bright'.
 
+**BETA** As with the `switch` implementation a `button` is added to reset your trip_data.
+
 ## If you want more frequent updates
 
 Basically you'll have to trigger (through automations) the updates yourself. But it's the correct way to learn Home Assistant and the method shown below also saves some API calls to Stromer. Basically this will determine if the bike is **unlocked** and if so start frequent updates. The example will also show you how to add a button to immediately start the more frequent updates. And yes, I'm aware we can make blueprints of this, but I'll leave that for now until we have a broader user base and properly tested integration.

custom_components/stromer/__init__.py

@@ -16,6 +16,7 @@
 
 PLATFORMS: list[Platform] = [
     Platform.BINARY_SENSOR,
+    Platform.BUTTON,
     Platform.DEVICE_TRACKER,
     Platform.SENSOR,
     Platform.SWITCH,

custom_components/stromer/button.py

@@ -0,0 +1,67 @@
+"""Stromer Button component for Home Assistant."""
+from __future__ import annotations
+
+from homeassistant.components.button import (
+    ButtonDeviceClass,
+    ButtonEntity,
+    ButtonEntityDescription,
+)
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers.entity_platform import AddEntitiesCallback
+
+from .const import DOMAIN, LOGGER
+from .coordinator import StromerDataUpdateCoordinator
+from .entity import StromerEntity
+
+BUTTONS: tuple[ButtonEntityDescription, ...] = (
+    ButtonEntityDescription(
+        key="trip_distance",  # (ab)use trip_distance from the bike data to trigger adding button
+        translation_key="reset_trip_data",
+        icon="mdi:map-marker-distance",
+        device_class=ButtonDeviceClass.RESTART,
+    ),
+)
+
+async def async_setup_entry(hass: HomeAssistant, config_entry: ConfigEntry, async_add_entities: AddEntitiesCallback) -> None:
+    """Set up the Stromer Buttons from a config entry."""
+    coordinator = hass.data[DOMAIN][config_entry.entry_id]
+
+    entities = []
+    for idx, data in enumerate(coordinator.data.bikedata.items()):
+        for description in BUTTONS:
+            if data[0] == description.key:
+                entities.append(StromerButton(coordinator, idx, data, description))
+                LOGGER.debug("Add %s %s button", data, description.translation_key)
+
+    async_add_entities(entities, update_before_add=False)
+
+
+class StromerButton(StromerEntity, ButtonEntity):  # type: ignore[misc]
+    """Representation of a Button."""
+
+    _attr_has_entity_name = True
+
+    entity_description: ButtonEntityDescription
+
+    def __init__(
+        self,
+        coordinator: StromerDataUpdateCoordinator,
+        idx: int,
+        data: dict,
+        description: ButtonEntityDescription,
+    ):
+        """Initialize the sensor."""
+        super().__init__(coordinator)
+        self._ent = data[0]
+        self._coordinator = coordinator
+
+        device_id = coordinator.data.bike_id
+
+        self.entity_description = description
+        self._attr_unique_id = f"{device_id}-{description.key}-bu"
+
+    async def async_press(self) -> None:
+        """Handle the button press."""
+        if self.entity_description.key == "trip_distance":
+            await self._coordinator.stromer.stromer_reset_trip_data()

custom_components/stromer/manifest.json

@@ -8,5 +8,5 @@
   "iot_class": "cloud_polling",
   "issue_tracker": "https://github.com/CoMPaTech/stromer/issues",
   "requirements": [],
-  "version": "0.3.1"
+  "version": "0.3.2"
 }

custom_components/stromer/strings.json

@@ -23,6 +23,11 @@
     }
   },
   "entity": {
+    "button": {
+      "reset_trip_data": {
+        "name": "Reset trip data"
+      }
+    },
     "switch": {
       "lock": {
         "name": "Lock"

custom_components/stromer/stromer.py

@@ -1,6 +1,6 @@
 """Stromer module for Home Assistant Core."""
 
-__version__ = "0.1.0"
+__version__ = "0.1.1"
 
 import json
 import logging
@@ -194,6 +194,18 @@ async def stromer_call_light(self, state: str) -> None:
         log = "API call light returns: %s" % ret
         LOGGER.debug(log)
 
+    async def stromer_reset_trip_data(self) -> None:
+        """Reset the trip data through the API."""
+        endpoint = f"bike/id/{self.bike_id}/trip_data/"
+        url = f"{self.base_url}/rapi/mobile/v4.1/{endpoint}"
+        if self._api_version == "v3":
+            url = f"{self.base_url}/rapi/mobile/v2/{endpoint}"
+
+        headers = {"Authorization": f"Bearer {self._token}"}
+        res = await self._websession.delete(url, headers=headers)
+        if res.status != 204:
+            raise ApiError
+
     async def stromer_call_api(self, endpoint: str) -> Any:
         """Retrieve data from the API."""
         url = f"{self.base_url}/rapi/mobile/v4.1/{endpoint}"

custom_components/stromer/translations/en.json

@@ -23,6 +23,11 @@
     }
   },
   "entity": {
+    "button": {
+      "reset_trip_data": {
+        "name": "Reset trip data"
+      }
+    },
     "switch": {
       "lock": {
         "name": "Lock"

custom_components/stromer/translations/nl.json

@@ -23,6 +23,11 @@
     }
   },
   "entity": {
+    "button": {
+      "reset_trip_data": {
+        "name": "Reset trip data"
+      }
+    },
     "switch": {
       "lock": {
         "name": "Slot"