Updated version

Use local time zone for alarms

custom_components/garmin_connect/__init__.py

@@ -93,10 +93,13 @@ class GarminConnectDataUpdateCoordinator(DataUpdateCoordinator):
             summary = await self.hass.async_add_executor_job(
                 self._api.get_user_summary, date.today().isoformat()
             )
+            _LOGGER.debug(summary)
             body = await self.hass.async_add_executor_job(
                 self._api.get_body_composition, date.today().isoformat()
             )
+            _LOGGER.debug(body)
             alarms = await self.hass.async_add_executor_job(self._api.get_device_alarms)
+            _LOGGER.debug(alarms)
         except (
             GarminConnectAuthenticationError,
             GarminConnectTooManyRequestsError,

custom_components/garmin_connect/const.py

@@ -8,25 +8,29 @@ from homeassistant.const import (
     TIME_MINUTES,
     TIME_YEARS,
 )
-from homeassistant.components.sensor import SensorDeviceClass
+from homeassistant.components.sensor import (
+    SensorDeviceClass,
+    SensorStateClass,
+)
 
 DOMAIN = "garmin_connect"
 DATA_COORDINATOR = "coordinator"
 DEFAULT_UPDATE_INTERVAL = timedelta(minutes=5)
 
 GARMIN_ENTITY_LIST = {
-    "totalSteps": ["Total Steps", "steps", "mdi:walk", None, True],
-    "dailyStepGoal": ["Daily Step Goal", "steps", "mdi:walk", None, True],
-    "totalKilocalories": ["Total KiloCalories", "kcal", "mdi:food", None, True],
-    "activeKilocalories": ["Active KiloCalories", "kcal", "mdi:food", None, True],
-    "bmrKilocalories": ["BMR KiloCalories", "kcal", "mdi:food", None, True],
-    "consumedKilocalories": ["Consumed KiloCalories", "kcal", "mdi:food", None, False],
-    "burnedKilocalories": ["Burned KiloCalories", "kcal", "mdi:food", None, True],
+    "totalSteps": ["Total Steps", "steps", "mdi:walk", None, SensorStateClass.TOTAL, True],
+    "dailyStepGoal": ["Daily Step Goal", "steps", "mdi:walk", None, SensorStateClass.TOTAL, True],
+    "totalKilocalories": ["Total KiloCalories", "kcal", "mdi:food", None, SensorStateClass.TOTAL, True],
+    "activeKilocalories": ["Active KiloCalories", "kcal", "mdi:food", None, SensorStateClass.TOTAL, True],
+    "bmrKilocalories": ["BMR KiloCalories", "kcal", "mdi:food", None, SensorStateClass.TOTAL, True],
+    "consumedKilocalories": ["Consumed KiloCalories", "kcal", "mdi:food", None, SensorStateClass.TOTAL, False],
+    "burnedKilocalories": ["Burned KiloCalories", "kcal", "mdi:food", None, SensorStateClass.TOTAL, True],
     "remainingKilocalories": [
         "Remaining KiloCalories",
         "kcal",
         "mdi:food",
         None,
+        SensorStateClass.TOTAL,
         False,
     ],
     "netRemainingKilocalories": [
@@ -34,14 +38,16 @@ GARMIN_ENTITY_LIST = {
         "kcal",
         "mdi:food",
         None,
+        SensorStateClass.TOTAL,
         False,
     ],
-    "netCalorieGoal": ["Net Calorie Goal", "kcal", "mdi:food", None, False],
+    "netCalorieGoal": ["Net Calorie Goal", "kcal", "mdi:food", None, SensorStateClass.TOTAL, False],
     "totalDistanceMeters": [
         "Total Distance Mtr",
         LENGTH_METERS,
         "mdi:walk",
         SensorDeviceClass.DISTANCE,
+        SensorStateClass.TOTAL,
         True,
     ],
     "wellnessStartTimeLocal": [
@@ -49,6 +55,7 @@ GARMIN_ENTITY_LIST = {
         None,
         "mdi:clock",
         SensorDeviceClass.TIMESTAMP,
+        None,
         False,
     ],
     "wellnessEndTimeLocal": [
@@ -56,14 +63,16 @@ GARMIN_ENTITY_LIST = {
         None,
         "mdi:clock",
         SensorDeviceClass.TIMESTAMP,
+        None,
         False,
     ],
-    "wellnessDescription": ["Wellness Description", "", "mdi:clock", None, False],
+    "wellnessDescription": ["Wellness Description", "", "mdi:clock", None, SensorStateClass.TOTAL, False],
     "wellnessDistanceMeters": [
         "Wellness Distance Mtr",
         LENGTH_METERS,
         "mdi:walk",
         SensorDeviceClass.DISTANCE,
+        SensorStateClass.TOTAL,
         False,
     ],
     "wellnessActiveKilocalories": [
@@ -71,31 +80,35 @@ GARMIN_ENTITY_LIST = {
         "kcal",
         "mdi:food",
         None,
+        SensorStateClass.TOTAL,
         False,
     ],
-    "wellnessKilocalories": ["Wellness KiloCalories", "kcal", "mdi:food", None, False],
+    "wellnessKilocalories": ["Wellness KiloCalories", "kcal", "mdi:food", None, SensorStateClass.TOTAL, False],
     "highlyActiveSeconds": [
         "Highly Active Time",
         TIME_MINUTES,
         "mdi:fire",
-        None,
+        SensorDeviceClass.DURATION,
+        SensorStateClass.TOTAL,
         False,
     ],
-    "activeSeconds": ["Active Time", TIME_MINUTES, "mdi:fire", None, True],
-    "sedentarySeconds": ["Sedentary Time", TIME_MINUTES, "mdi:seat", None, True],
-    "sleepingSeconds": ["Sleeping Time", TIME_MINUTES, "mdi:sleep", None, True],
+    "activeSeconds": ["Active Time", TIME_MINUTES, "mdi:fire", None, SensorStateClass.TOTAL, True],
+    "sedentarySeconds": ["Sedentary Time", TIME_MINUTES, "mdi:seat", None, SensorStateClass.TOTAL, True],
+    "sleepingSeconds": ["Sleeping Time", TIME_MINUTES, "mdi:sleep", None, SensorStateClass.TOTAL, True],
     "measurableAwakeDuration": [
         "Awake Duration",
         TIME_MINUTES,
         "mdi:sleep",
-        None,
+        SensorDeviceClass.DURATION,
+        SensorStateClass.TOTAL,
         True,
     ],
     "measurableAsleepDuration": [
         "Sleep Duration",
         TIME_MINUTES,
         "mdi:sleep",
-        None,
+        SensorDeviceClass.DURATION,
+        SensorStateClass.TOTAL,
         True,
     ],
     "floorsAscendedInMeters": [
@@ -103,6 +116,7 @@ GARMIN_ENTITY_LIST = {
         LENGTH_METERS,
         "mdi:stairs",
         SensorDeviceClass.DISTANCE,
+        SensorStateClass.TOTAL,
         False,
     ],
     "floorsDescendedInMeters": [
@@ -110,27 +124,30 @@ GARMIN_ENTITY_LIST = {
         LENGTH_METERS,
         "mdi:stairs",
         SensorDeviceClass.DISTANCE,
+        SensorStateClass.TOTAL,
         False,
     ],
-    "floorsAscended": ["Floors Ascended", "floors", "mdi:stairs", None, True],
-    "floorsDescended": ["Floors Descended", "floors", "mdi:stairs", None, True],
+    "floorsAscended": ["Floors Ascended", "floors", "mdi:stairs", None, SensorStateClass.TOTAL, True],
+    "floorsDescended": ["Floors Descended", "floors", "mdi:stairs", None, SensorStateClass.TOTAL, True],
     "userFloorsAscendedGoal": [
         "Floors Ascended Goal",
         "floors",
         "mdi:stairs",
         None,
+        SensorStateClass.TOTAL,
         True,
     ],
-    "minHeartRate": ["Min Heart Rate", "bpm", "mdi:heart-pulse", None, True],
-    "maxHeartRate": ["Max Heart Rate", "bpm", "mdi:heart-pulse", None, True],
-    "restingHeartRate": ["Resting Heart Rate", "bpm", "mdi:heart-pulse", None, True],
-    "minAvgHeartRate": ["Min Avg Heart Rate", "bpm", "mdi:heart-pulse", None, False],
-    "maxAvgHeartRate": ["Max Avg Heart Rate", "bpm", "mdi:heart-pulse", None, False],
+    "minHeartRate": ["Min Heart Rate", "bpm", "mdi:heart-pulse", None, SensorStateClass.TOTAL, True],
+    "maxHeartRate": ["Max Heart Rate", "bpm", "mdi:heart-pulse", None, SensorStateClass.TOTAL, True],
+    "restingHeartRate": ["Resting Heart Rate", "bpm", "mdi:heart-pulse", None, SensorStateClass.TOTAL, True],
+    "minAvgHeartRate": ["Min Avg Heart Rate", "bpm", "mdi:heart-pulse", None, SensorStateClass.TOTAL, False],
+    "maxAvgHeartRate": ["Max Avg Heart Rate", "bpm", "mdi:heart-pulse", None, SensorStateClass.TOTAL, False],
     "abnormalHeartRateAlertsCount": [
         "Abnormal HR Counts",
         None,
         "mdi:heart-pulse",
         None,
+        SensorStateClass.TOTAL,
         False,
     ],
     "lastSevenDaysAvgRestingHeartRate": [
@@ -138,52 +155,59 @@ GARMIN_ENTITY_LIST = {
         "bpm",
         "mdi:heart-pulse",
         None,
+        SensorStateClass.TOTAL,
         False,
     ],
-    "averageStressLevel": ["Avg Stress Level", "lvl", "mdi:flash-alert", None, True],
-    "maxStressLevel": ["Max Stress Level", "lvl", "mdi:flash-alert", None, True],
-    "stressQualifier": ["Stress Qualifier", None, "mdi:flash-alert", None, False],
-    "stressDuration": ["Stress Duration", TIME_MINUTES, "mdi:flash-alert", None, False],
+    "averageStressLevel": ["Avg Stress Level", "lvl", "mdi:flash-alert", None, SensorStateClass.TOTAL, True],
+    "maxStressLevel": ["Max Stress Level", "lvl", "mdi:flash-alert", None, SensorStateClass.TOTAL, True],
+    "stressQualifier": ["Stress Qualifier", None, "mdi:flash-alert", None, SensorStateClass.TOTAL, False],
+    "stressDuration": ["Stress Duration", TIME_MINUTES, "mdi:flash-alert", None, SensorStateClass.TOTAL, False],
     "restStressDuration": [
         "Rest Stress Duration",
         TIME_MINUTES,
         "mdi:flash-alert",
-        None,
+        SensorDeviceClass.DURATION,
+        SensorStateClass.TOTAL,
         True,
     ],
     "activityStressDuration": [
         "Activity Stress Duration",
         TIME_MINUTES,
         "mdi:flash-alert",
-        None,
+        SensorDeviceClass.DURATION,
+        SensorStateClass.TOTAL,
         True,
     ],
     "uncategorizedStressDuration": [
         "Uncat. Stress Duration",
         TIME_MINUTES,
         "mdi:flash-alert",
-        None,
+        SensorDeviceClass.DURATION,
+        SensorStateClass.TOTAL,
         True,
     ],
     "totalStressDuration": [
         "Total Stress Duration",
         TIME_MINUTES,
         "mdi:flash-alert",
-        None,
+        SensorDeviceClass.DURATION,
+        SensorStateClass.TOTAL,
         True,
     ],
     "lowStressDuration": [
         "Low Stress Duration",
         TIME_MINUTES,
         "mdi:flash-alert",
-        None,
+        SensorDeviceClass.DURATION,
+        SensorStateClass.TOTAL,
         True,
     ],
     "mediumStressDuration": [
         "Medium Stress Duration",
         TIME_MINUTES,
         "mdi:flash-alert",
-        None,
+        SensorDeviceClass.DURATION,
+        SensorStateClass.TOTAL,
         True,
     ],
     "highStressDuration": [
@@ -191,69 +215,79 @@ GARMIN_ENTITY_LIST = {
         TIME_MINUTES,
         "mdi:flash-alert",
         None,
+        SensorStateClass.TOTAL,
         True,
     ],
     "stressPercentage": [
         "Stress Percentage",
         PERCENTAGE,
         "mdi:flash-alert",
-        SensorDeviceClass.BATTERY,
+        None,
+        SensorStateClass.TOTAL,
         False,
     ],
     "restStressPercentage": [
         "Rest Stress Percentage",
         PERCENTAGE,
         "mdi:flash-alert",
-        SensorDeviceClass.BATTERY,
+        None,
+        SensorStateClass.TOTAL,
         False,
     ],
     "activityStressPercentage": [
         "Activity Stress Percentage",
         PERCENTAGE,
         "mdi:flash-alert",
-        SensorDeviceClass.BATTERY,
+        None,
+        SensorStateClass.TOTAL,
         False,
     ],
     "uncategorizedStressPercentage": [
         "Uncat. Stress Percentage",
         PERCENTAGE,
         "mdi:flash-alert",
-        SensorDeviceClass.BATTERY,
+        None,
+        SensorStateClass.TOTAL,
         False,
     ],
     "lowStressPercentage": [
         "Low Stress Percentage",
         PERCENTAGE,
         "mdi:flash-alert",
-        SensorDeviceClass.BATTERY,
+        None,
+        SensorStateClass.TOTAL,
         False,
     ],
     "mediumStressPercentage": [
         "Medium Stress Percentage",
         PERCENTAGE,
         "mdi:flash-alert",
-        SensorDeviceClass.BATTERY,
+        None,
+        SensorStateClass.TOTAL,
         False,
     ],
     "highStressPercentage": [
         "High Stress Percentage",
         PERCENTAGE,
         "mdi:flash-alert",
-        SensorDeviceClass.BATTERY,
+        None,
+        SensorStateClass.TOTAL,
         False,
     ],
     "moderateIntensityMinutes": [
         "Moderate Intensity",
         TIME_MINUTES,
         "mdi:flash-alert",
-        None,
+        SensorDeviceClass.DURATION,
+        SensorStateClass.TOTAL,
         False,
     ],
     "vigorousIntensityMinutes": [
         "Vigorous Intensity",
         TIME_MINUTES,
         "mdi:run-fast",
-        None,
+        SensorDeviceClass.DURATION,
+        SensorStateClass.TOTAL,
         False,
     ],
     "intensityMinutesGoal": [
@@ -261,51 +295,58 @@ GARMIN_ENTITY_LIST = {
         TIME_MINUTES,
         "mdi:run-fast",
         None,
+        SensorStateClass.TOTAL,
         False,
     ],
     "bodyBatteryChargedValue": [
         "Body Battery Charged",
         PERCENTAGE,
         "mdi:battery-charging-100",
-        SensorDeviceClass.BATTERY,
+        None,
+        SensorStateClass.TOTAL,
         True,
     ],
     "bodyBatteryDrainedValue": [
         "Body Battery Drained",
         PERCENTAGE,
         "mdi:battery-alert-variant-outline",
-        SensorDeviceClass.BATTERY,
+        None,
+        SensorStateClass.TOTAL,
         True,
     ],
     "bodyBatteryHighestValue": [
         "Body Battery Highest",
         PERCENTAGE,
         "mdi:battery-heart",
-        SensorDeviceClass.BATTERY,
+        None,
+        SensorStateClass.TOTAL,
         True,
     ],
     "bodyBatteryLowestValue": [
         "Body Battery Lowest",
         PERCENTAGE,
         "mdi:battery-heart-outline",
-        SensorDeviceClass.BATTERY,
+        None,
+        SensorStateClass.TOTAL,
         True,
     ],
     "bodyBatteryMostRecentValue": [
         "Body Battery Most Recent",
         PERCENTAGE,
         "mdi:battery-positive",
-        SensorDeviceClass.BATTERY,
+        None,
+        SensorStateClass.TOTAL,
         True,
     ],
-    "averageSpo2": ["Average SPO2", PERCENTAGE, "mdi:diabetes", None, True],
-    "lowestSpo2": ["Lowest SPO2", PERCENTAGE, "mdi:diabetes", None, True],
-    "latestSpo2": ["Latest SPO2", PERCENTAGE, "mdi:diabetes", None, True],
+    "averageSpo2": ["Average SPO2", PERCENTAGE, "mdi:diabetes", None, SensorStateClass.TOTAL, True],
+    "lowestSpo2": ["Lowest SPO2", PERCENTAGE, "mdi:diabetes", None, SensorStateClass.TOTAL, True],
+    "latestSpo2": ["Latest SPO2", PERCENTAGE, "mdi:diabetes", None, SensorStateClass.TOTAL, True],
     "latestSpo2ReadingTimeLocal": [
         "Latest SPO2 Time",
         None,
         "mdi:diabetes",
         SensorDeviceClass.TIMESTAMP,
+        None,
         False,
     ],
     "averageMonitoringEnvironmentAltitude": [
@@ -313,6 +354,7 @@ GARMIN_ENTITY_LIST = {
         PERCENTAGE,
         "mdi:image-filter-hdr",
         None,
+        SensorStateClass.TOTAL,
         False,
     ],
     "highestRespirationValue": [
@@ -320,6 +362,7 @@ GARMIN_ENTITY_LIST = {
         "brpm",
         "mdi:progress-clock",
         None,
+        SensorStateClass.TOTAL,
         False,
     ],
     "lowestRespirationValue": [
@@ -327,6 +370,7 @@ GARMIN_ENTITY_LIST = {
         "brpm",
         "mdi:progress-clock",
         None,
+        SensorStateClass.TOTAL,
         False,
     ],
     "latestRespirationValue": [
@@ -334,6 +378,7 @@ GARMIN_ENTITY_LIST = {
         "brpm",
         "mdi:progress-clock",
         None,
+        SensorStateClass.TOTAL,
         False,
     ],
     "latestRespirationTimeGMT": [
@@ -341,16 +386,17 @@ GARMIN_ENTITY_LIST = {
         None,
         "mdi:progress-clock",
         SensorDeviceClass.TIMESTAMP,
+        None,
         False,
     ],
-    "weight": ["Weight", MASS_KILOGRAMS, "mdi:weight-kilogram", SensorDeviceClass.WEIGHT, False],
-    "bmi": ["BMI", "bmi", "mdi:food", None, False],
-    "bodyFat": ["Body Fat", PERCENTAGE, "mdi:food", SensorDeviceClass.BATTERY, False],
-    "bodyWater": ["Body Water", PERCENTAGE, "mdi:water-percent", SensorDeviceClass.BATTERY, False],
-    "boneMass": ["Bone Mass", MASS_KILOGRAMS, "mdi:bone", SensorDeviceClass.BATTERY, False],
-    "muscleMass": ["Muscle Mass", MASS_KILOGRAMS, "mdi:dumbbell", SensorDeviceClass.WEIGHT, False],
-    "physiqueRating": ["Physique Rating", None, "mdi:numeric", None, False],
-    "visceralFat": ["Visceral Fat", PERCENTAGE, "mdi:food", SensorDeviceClass.BATTERY, False],
-    "metabolicAge": ["Metabolic Age", TIME_YEARS, "mdi:calendar-heart", None, False],
-    "nextAlarm": ["Next Alarm Time", None, "mdi:alarm", SensorDeviceClass.TIMESTAMP, True],
+    "weight": ["Weight", MASS_KILOGRAMS, "mdi:weight-kilogram", SensorDeviceClass.WEIGHT, SensorStateClass.TOTAL, False],
+    "bmi": ["BMI", "bmi", "mdi:food", None, SensorStateClass.TOTAL, False],
+    "bodyFat": ["Body Fat", PERCENTAGE, "mdi:food", None, SensorStateClass.TOTAL, False],
+    "bodyWater": ["Body Water", PERCENTAGE, "mdi:water-percent", None, SensorStateClass.TOTAL, False],
+    "boneMass": ["Bone Mass", MASS_KILOGRAMS, "mdi:bone", SensorDeviceClass.WEIGHT, SensorStateClass.TOTAL, False],
+    "muscleMass": ["Muscle Mass", MASS_KILOGRAMS, "mdi:dumbbell", SensorDeviceClass.WEIGHT, SensorStateClass.TOTAL, False],
+    "physiqueRating": ["Physique Rating", None, "mdi:numeric", None, SensorStateClass.TOTAL, False],
+    "visceralFat": ["Visceral Fat", PERCENTAGE, "mdi:food", None, SensorStateClass.TOTAL, False],
+    "metabolicAge": ["Metabolic Age", TIME_YEARS, "mdi:calendar-heart", None, SensorStateClass.TOTAL, False],
+    "nextAlarm": ["Next Alarm Time", None, "mdi:alarm", SensorDeviceClass.TIMESTAMP, None, True],
 }

custom_components/garmin_connect/manifest.json

@@ -3,9 +3,9 @@
   "name": "Garmin Connect",
   "documentation": "https://github.com/cyberjunky/home-assistant-garmin_connect",
   "issue_tracker": "https://github.com/cyberjunky/home-assistant-garmin_connect/issues",
-  "requirements": ["garminconnect==0.1.24"],
+  "requirements": ["garminconnect==0.1.50"],
   "codeowners": ["@cyberjunky"],
   "config_flow": true,
   "iot_class": "cloud_polling",
-  "version": "0.2.5"
+  "version": "0.2.9"
 }

custom_components/garmin_connect/sensor.py

@@ -4,10 +4,10 @@ from __future__ import annotations
 import logging
 import datetime
 import pytz
+from tzlocal import get_localzone
 
 from homeassistant.components.sensor import (
-    SensorEntity, 
-    SensorStateClass,
+    SensorEntity,
     SensorDeviceClass,
 )
 from homeassistant.config_entries import ConfigEntry
@@ -41,16 +41,17 @@ async def async_setup_entry(
     entities = []
     for (
         sensor_type,
-        (name, unit, icon, device_class, enabled_by_default),
+        (name, unit, icon, device_class, state_class, enabled_by_default),
     ) in GARMIN_ENTITY_LIST.items():
 
         _LOGGER.debug(
-            "Registering entity: %s, %s, %s, %s, %s, %s",
+            "Registering entity: %s, %s, %s, %s, %s, %s, %s",
             sensor_type,
             name,
             unit,
             icon,
             device_class,
+            state_class,
             enabled_by_default,
         )
         entities.append(
@@ -62,6 +63,7 @@ async def async_setup_entry(
                 unit,
                 icon,
                 device_class,
+                state_class,
                 enabled_by_default,
             )
         )
@@ -81,6 +83,7 @@ class GarminConnectSensor(CoordinatorEntity, SensorEntity):
         unit,
         icon,
         device_class,
+        state_class,
         enabled_default: bool = True,
     ):
         """Initialize a Garmin Connect sensor."""
@@ -89,6 +92,7 @@ class GarminConnectSensor(CoordinatorEntity, SensorEntity):
         self._unique_id = unique_id
         self._type = sensor_type
         self._device_class = device_class
+        self._state_class = state_class
         self._enabled_default = enabled_default
 
         self._attr_name = name
@@ -96,7 +100,7 @@ class GarminConnectSensor(CoordinatorEntity, SensorEntity):
         self._attr_icon = icon
         self._attr_native_unit_of_measurement = unit
         self._attr_unique_id = f"{self._unique_id}_{self._type}"
-        self._attr_state_class = SensorStateClass.TOTAL
+        self._attr_state_class = state_class
 
     @property
     def native_value(self):
@@ -115,7 +119,8 @@ class GarminConnectSensor(CoordinatorEntity, SensorEntity):
             )
             if active_alarms:
                 date_time_obj = datetime.datetime.strptime(active_alarms[0], "%Y-%m-%dT%H:%M:%S")
-                timezone = pytz.timezone('UTC')
+                tz = get_localzone()
+                timezone = pytz.timezone(tz.zone)
                 timezone_date_time_obj = timezone.localize(date_time_obj)
                 return timezone_date_time_obj
             else:
@@ -125,7 +130,8 @@ class GarminConnectSensor(CoordinatorEntity, SensorEntity):
 
         if self._device_class == SensorDeviceClass.TIMESTAMP:
             date_time_obj = datetime.datetime.strptime(value, "%Y-%m-%dT%H:%M:%S.%f")
-            timezone = pytz.timezone('UTC')
+            tz = get_localzone()
+            timezone = pytz.timezone(tz.zone)
             timezone_date_time_obj = timezone.localize(date_time_obj)
             return timezone_date_time_obj