Add weekly & yearly summaries

mytoyota/models/endpoints/trips.py

@@ -1,4 +1,6 @@
 """Toyota Connected Services API - Trips Models."""
+from __future__ import annotations
+
 from datetime import date, datetime
 from typing import Any, List, Optional
 from uuid import UUID
@@ -8,6 +10,19 @@
 from mytoyota.models.endpoints.common import StatusModel
 
 
+def add_with_none(this, that):
+    """Add two items.
+
+    First checking if either item is None.
+    """
+    if this is None:
+        return that
+    if that is None:
+        return this
+
+    return this + that
+
+
 class _SummaryBaseModel(BaseModel):
     length: int
     duration: int
@@ -23,6 +38,30 @@
         alias="fuelConsumption", default=None
     )  # Electric cars might not use fuel. Milliliters.
 
+    def __add__(self, other: _SummaryBaseModel):
+        """Add together two SummaryBaseModel's.
+
+        Handles Min/Max/Average fields correctly.
+
+        Args:
+        ----
+        other: _SummaryBaseModel: to be added
+        """
+        if other is not None:
+            self.length += other.length
+            self.duration += other.duration
+            self.duration_idle += other.duration_idle
+            self.countries.extend(x for x in other.countries if x not in self.countries)
+            self.max_speed = max(self.max_speed, other.max_speed)
+            self.average_speed = (self.average_speed + other.average_speed) / 2.0
+            self.length_overspeed += other.length_overspeed
+            self.duration_overspeed += other.duration_overspeed
+            self.length_highway += other.length_highway
+            self.duration_highway += other.duration_highway
+            self.fuel_consumption = add_with_none(self.fuel_consumption, other.fuel_consumption)
+
+        return self
+
 
 class _SummaryModel(_SummaryBaseModel):
     start_lat: float = Field(alias="startLat")
@@ -66,6 +105,27 @@
     power_time: Optional[int] = Field(alias="powerTime", default=None)
     power_dist: Optional[int] = Field(alias="powerDist", default=None)
 
+    def __add__(self, other: _HDCModel):
+        """Add together two HDCModel's.
+
+        Handles Min/Max/Average fields correctly.
+
+        Args:
+        ----
+        other: _SummaryBaseModel: to be added
+        """
+        if other is not None:
+            self.ev_time = add_with_none(self.ev_time, other.ev_time)
+            self.ev_distance = add_with_none(self.ev_distance, other.ev_distance)
+            self.charge_time = add_with_none(self.charge_time, other.charge_time)
+            self.charge_dist = add_with_none(self.charge_dist, other.charge_dist)
+            self.eco_time = add_with_none(self.eco_time, other.eco_time)
+            self.eco_dist = add_with_none(self.eco_dist, other.eco_dist)
+            self.power_time = add_with_none(self.power_time, other.power_time)
+            self.power_dist = add_with_none(self.power_dist, other.power_dist)
+
+        return self
+
 
 class _RouteModel(BaseModel):
     lat: float = Field(repr=False)

mytoyota/models/vehicle.py

@@ -6,6 +6,7 @@
 import logging
 from datetime import date, timedelta
 from functools import partial
+from operator import attrgetter
 from typing import Any, Dict, List, Optional, Tuple
 
 from mytoyota.api import Api
@@ -226,19 +227,27 @@
             self._endpoint_data["status"] if "status" in self._endpoint_data else None
         )
 
-    async def get_summary(
+    async def get_summary(  # noqa: PLR0912, PLR0915
         self,
         from_date: date,
         to_date: date,
         summary_type: SummaryType = SummaryType.MONTHLY,
     ) -> Optional[List[Summary]]:
-        """Return a Daily, Monthly or Yearly summary between the provided dates.
+        """Return a Daily, Weekly, Monthly or Yearly summary between the provided dates.
+
+        All but Daily can return a partial time range. For example if the summary_type is weekly
+        and the date ranges selected include partial weeks these partial weeks will be returned.
+        The dates contained in the summary will indicate the range of dates that made up the
+        partial week.
+
+        Note: Weekly and yearly summaries lose a small amount of accuracy due to rounding issues
 
         Args:
         ----
             from_date (date, required): The inclusive from date to report summaries.
             to_date (date, required): The inclusive to date to report summaries.
-            summary_type (???, optional): Daily, Monthly or Yearly summary. Monthly by default.
+            summary_type (SummaryType, optional): Daily, Monthly or Yearly summary.
+                                                  Monthly by default.
 
         Returns:
         -------
@@ -255,11 +264,18 @@
         if resp.payload is None:
             return None
 
+        # Sort payload as code requires data in date order. Sorts the monthly summaries only
+        resp.payload.summary.sort(key=attrgetter("year", "month"))
+
         # Convert to response
         ret: List[Summary] = []
         if summary_type == SummaryType.DAILY:
-            for summary in resp.payload.summary:
-                for histogram in summary.histograms:
+            # Convert all the daily responses from the payload to a summary response
+            for summary in resp.payload.summary:  # Loop the months
+                # Ensure daily data is in date order
+                for histogram in sorted(
+                    summary.histograms, key=attrgetter("day")
+                ):  # Loop the days
                     summary_date = date(
                         day=histogram.day, month=histogram.month, year=histogram.year
                     )
@@ -273,8 +289,51 @@
                         )
                     )
         elif summary_type == SummaryType.WEEKLY:
-            raise NotImplementedError
+            # To build a weekly summary we need to add together all the daily summaries for the
+            # week. A week starts on a Monday so data is added into build_hdc & build_summary
+            # until the current day is Sunday(i.e. last day of the week). At this point the
+            # build_hdc & build_summary are added to the response and we start again.
+            build_hdc = None
+            build_summary = None
+            start_date = None
+
+            for summary in resp.payload.summary:
+                summary.histograms.sort(
+                    key=attrgetter("day")
+                )  # Code required days are in date order
+                for histogram in summary.histograms:
+                    today = date(day=histogram.day, month=histogram.month, year=histogram.year)
+                    if (
+                        start_date is None
+                    ):  # start_date is none if we are at the beginning of a new week
+                        start_date = today
+                        build_hdc = copy.copy(histogram.hdc)
+                        build_summary = copy.copy(histogram.summary)
+                    else:
+                        if build_hdc is None:
+                            build_hdc = copy.copy(histogram.hdc)
+                        else:
+                            build_hdc += histogram.hdc
+                        build_summary += histogram.summary
+
+                    # If current histogram is a Sunday then we have a full week of data so add it
+                    # to our response, also need to add to response if ts the last item in the
+                    # loops(otherwise partial week is lost)
+                    if today.weekday() == 6 or (
+                        summary == resp.payload.summary[-1] and histogram == summary.histograms[-1]
+                    ):
+                        ret.append(
+                            Summary(
+                                build_summary,
+                                self._metric,
+                                start_date,
+                                today,
+                                build_hdc,
+                            )
+                        )
+                        start_date = None  # Reset start date so we can start a new week
         elif summary_type == SummaryType.MONTHLY:
+            # Convert all the monthly responses from the payload to a summary response
             for summary in resp.payload.summary:
                 summary_from_date = date(day=1, month=summary.month, year=summary.year)
                 summary_to_date = date(
@@ -287,13 +346,40 @@
                     Summary(
                         summary.summary,
                         self._metric,
-                        summary_from_date if summary_from_date > from_date else from_date,
-                        summary_to_date if summary_to_date < to_date else to_date,
+                        # The data might not include an entire month so update start and end dates
+                        max(summary_from_date, from_date),
+                        min(summary_to_date, to_date),
                         summary.hdc,
                     )
                 )
         elif summary_type == SummaryType.YEARLY:
-            raise NotImplementedError
+            # TODO: Require confirmation that the endpoint can return data older than a year
+            build_hdc = None
+            build_summary = None
+            start_date = None
+
+            for summary in resp.payload.summary:
+                today = date(day=1, month=summary.month, year=summary.year)
+                if start_date is None or today < from_date:
+                    start_date = today
+                    build_hdc = copy.copy(summary.hdc)
+                    build_summary = copy.copy(summary.summary)
+                else:
+                    if build_hdc is None:
+                        build_hdc = summary.hdc
+                    else:
+                        build_hdc += summary.hdc
+                    build_summary += summary.summary
+
+                # If "today" is december then we have reached the end of the year so add it the
+                # response also need to add to response if last item in list to add the last
+                # partial year
+                if today.month == 12 or summary == resp.payload.summary[-1]:
+                    end_date = min(to_date, date(day=31, month=12, year=today.year))
+                    ret.append(
+                        Summary(build_summary, self._metric, start_date, end_date, build_hdc)
+                    )
+                    start_date = None
 
         return ret
 

simple_client_example.py

@@ -57,12 +57,22 @@ async def get_information():
         # Notifications
         pp.pprint(f"Notifications: {[[x] for x in car.notifications]}")
         # Summary
+        # pp.pprint(
+        #    f"Summary: {[[x] for x in await car.get_summary(date.today() - timedelta(days=7), date.today(), summary_type=SummaryType.DAILY)]}"  # noqa: E501 # pylint: disable=C0301
+        # )
+        # pp.pprint(
+        #    f"Summary: {[[x] for x in await car.get_summary(date.today() - timedelta(days=7 * 4), date.today(), summary_type=SummaryType.WEEKLY)]}"  # noqa: E501 # pylint: disable=C0301
+        # )
         pp.pprint(
             f"Summary: {[[x] for x in await car.get_summary(date.today() - timedelta(days=6 * 30), date.today(), summary_type=SummaryType.MONTHLY)]}"  # noqa: E501
         )
+        # pp.pprint(
+        #    f"Summary: {[[x] for x in await car.get_summary(date.today() - timedelta(days=365), date.today(), summary_type=SummaryType.YEARLY)]}"  # noqa: E501 # pylint: disable=C0301
+        # )
+
         # Trips
         pp.pprint(
-            f"Trips: f{await car.get_trips(date.today() - timedelta(days=2), date.today(), full_route=True)}"  # noqa: E501
+            f"Trips: f{await car.get_trips(date.today() - timedelta(days=7), date.today(), full_route=True)}"  # noqa: E501
         )
 
         # Dump all the information collected so far: