6.0 KiB
title, description, ha_category, ha_iot_class, ha_release, ha_domain, ha_platforms, ha_integration_type, ha_codeowners, ha_config_flow
| title | description | ha_category | ha_iot_class | ha_release | ha_domain | ha_platforms | ha_integration_type | ha_codeowners | ha_config_flow | ||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Garmin Connect | Instructions on how to integrate Garmin Connect health data within Home Assistant. |
|
Cloud Polling | 2025.2 | garmin_connect |
|
integration |
|
true |
The Garmin Connect {% term integration %} allows you to expose health and fitness data from Garmin Connect to Home Assistant.
Prerequisites
You need a Garmin Connect account with at least one Garmin device that syncs data to Garmin Connect.
{% include integrations/config_flow.md %}
Sensors
This integration provides 110+ sensors covering various health and fitness metrics. Sensors are grouped into the following categories:
Activity & Steps
- Total Steps - Daily step count
- Daily Step Goal - Your configured step target
- Yesterday Steps/Distance - Previous day's complete totals
- Weekly Step/Distance Avg - 7-day averages
- Total Distance - Distance walked/run
- Floors Ascended/Descended - Floors climbed
Calories
- Total Calories - Total daily calorie burn
- Active Calories - Calories burned through activity
- BMR Calories - Basal metabolic rate calories
Heart Rate
- Resting Heart Rate - Daily resting HR
- Min/Max Heart Rate - Daily HR range
- Last 7 Days Avg HR - Weekly average
- HRV Weekly Average - 7-day HRV average (ms)
- HRV Last Night Average - Last night's HRV (ms)
- HRV Baseline - Personal HRV baseline with range
Stress & Recovery
- Avg/Max Stress Level - Stress measurements (0-100)
- Stress Durations - Time in rest/activity/low/medium/high stress
Sleep
- Sleep Score - Overall sleep quality score
- Sleep Duration - Time asleep
- Awake Duration - Time awake during sleep
- Deep Sleep - Time in deep sleep
- Light Sleep - Time in light sleep
- REM Sleep - Time in REM sleep
Body Battery
- Body Battery - Current energy level (0-100)
- Charged/Drained - Energy gained/spent
Body Composition
- Weight - Body weight
- BMI - Body Mass Index
- Body Fat/Water - Percentage measurements
- Muscle/Bone Mass - Mass measurements
Hydration
- Hydration - Daily water intake
- Hydration Goal - Target intake
- Sweat Loss - Estimated fluid loss
Blood Pressure
- Systolic - Systolic blood pressure (mmHg)
- Diastolic - Diastolic blood pressure (mmHg)
- Pulse - Pulse from blood pressure reading (bpm)
- Measurement Time - When the BP was measured
Health Monitoring
- SpO2 - Blood oxygen levels (average, lowest, latest)
- HRV Status - Heart rate variability
- Respiration Rate - Breathing measurements
Fitness & Performance
- Fitness Age - Estimated fitness age
- Endurance Score - Overall endurance rating
Workouts
- Last Workout - Name of most recent scheduled workout
- Last Workouts - Count of recent workouts (details in attributes)
Menstrual Cycle Tracking
- Cycle Phase - Current menstrual phase
- Cycle Day - Day of the current cycle
- Period Day - Day of the period
- Cycle/Period Length - Cycle and period lengths in days
Note: Menstrual cycle sensors are only available if tracking is enabled in your Garmin Connect account.
Gear Tracking
Gear sensors are dynamically created for each piece of equipment registered in Garmin Connect (shoes, bikes, etc.). They track total distance and usage statistics.
Actions
Add body composition
Add body composition metrics to Garmin Connect.
| Data attribute | Required | Description |
|---|---|---|
weight |
Yes | Weight in kilograms |
timestamp |
No | ISO format timestamp |
bmi |
No | Body Mass Index |
percent_fat |
No | Body fat percentage |
muscle_mass |
No | Muscle mass in kg |
bone_mass |
No | Bone mass in kg |
body_water |
No | Body water percentage |
physique_rating |
No | Physique rating (1-9) |
visceral_fat |
No | Visceral fat rating |
metabolic_age |
No | Metabolic age |
Add blood pressure
Add blood pressure measurements to Garmin Connect.
| Data attribute | Required | Description |
|---|---|---|
systolic |
Yes | Systolic pressure (mmHg) |
diastolic |
Yes | Diastolic pressure (mmHg) |
pulse |
Yes | Pulse rate (bpm) |
timestamp |
No | ISO format timestamp |
notes |
No | Notes about the measurement |
Set active gear
Set a gear item as the default for an activity type.
| Data attribute | Required | Description |
|---|---|---|
activity_type |
Yes | Activity type (e.g., running, cycling) |
setting |
Yes | Setting option (set as default, unset default, set this as default unset others) |
Create activity
Create an activity in Garmin Connect.
| Data attribute | Required | Description |
|---|---|---|
activity_name |
Yes | Name of the activity |
activity_type |
Yes | Activity type (e.g., running, cycling, walking) |
start_datetime |
Yes | Start time (ISO format) |
duration_min |
Yes | Duration in minutes |
distance_km |
No | Distance in kilometers |
time_zone |
No | Time zone (defaults to HA timezone) |
Upload activity
Upload an activity file (FIT, GPX, TCX) to Garmin Connect.
| Data attribute | Required | Description |
|---|---|---|
file_path |
Yes | Path to activity file on HA system |
Data updates
Data is polled from Garmin Connect every 5 minutes. Due to API rate limits, more frequent polling is not recommended.
MFA Support
If your Garmin account has Multi-Factor Authentication (MFA) enabled, you will be prompted to enter your MFA code during setup.
Known limitations
- Not all sensors will have data depending on your Garmin devices and connected apps.
- API rate limits may cause temporary unavailability during high-traffic periods.