Skip to content

Commit

Permalink
Add documentation for Garmin Connect (home-assistant#11752)
Browse files Browse the repository at this point in the history
* Added documentation for the Garmin Connect integration

* Added logo
Removed hyphens from text

* Applied suggested changes

Fixed wrongly documented resource variable

* Renamed config option to reflect code

* Updated to reflect code changes
  • Loading branch information
cyberjunky authored and frenck committed Jan 28, 2020
1 parent 705ec30 commit 2fd35a2
Show file tree
Hide file tree
Showing 2 changed files with 110 additions and 0 deletions.
110 changes: 110 additions & 0 deletions source/_integrations/garmin_connect.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
---
title: Garmin Connect
description: Instructions on how to configure the Garmin Connect integration for Home Assistant.
logo: garmin_connect.png
ha_category:
- Health
ha_iot_class: Cloud Polling
ha_release: 0.105
ha_codeowners:
- '@cyberjunky'
---

The Garmin Connect sensor allows you to expose data from [Garmin Connect](https://connect.garmin.com) to Home Assistant.

## Configuration


To add Garmin Connect to your installation, go to Configuration >> Integrations in the UI and enable the Garmin Connect integration by entering your credentials.

After succesful login a standard set of sensors are enabled.
You can enable more if needed by using the Integrations page.


Please be aware that Garmin Connect has very low rate limits, max. once every ~10 minutes.


## Available Sensors

Not every sensor holds meaningful values, it depends on the tracking device you use, and the apps you have connected.

Enabled by default:

```text
Total Steps
Daily Step Goal
Total KiloCalories
Active KiloCalories
BMR KiloCalories
Consumed KiloCalories
Burned KiloCalories
Total Distance Mtr
Active Time
Sedentary Time
Sleeping Time
Awake Duration
Sleep Duration
Floors Ascended
Floors Descended
Floors Ascended Goal
Min Heart Rate
Max Heart Rate
Resting Heart Rate
Avg Stress Level
Max Stress Level
Rest Stress Duration
Activity Stress Duration
Uncat. Stress Duration
Total Stress Duration
Low Stress Duration
Medium Stress Duration
High Stress Duration
Body Battery Charged
Body Battery Drained
Body Battery Highest
Body Battery Lowest
Body Battery Most Recent
Average SPO2
Lowest SPO2
Latest SPO2
Highest Respiration
Lowest Respiration
Latest Respiration
```


Disabled by default:

```text
Remaining KiloCalories
Net Remaining KiloCalories
Net Calorie Goal
Wellness Start Time
Wellness End Time
Wellness Description
Wellness Distance Mtr
Wellness Active KiloCalories
Wellness KiloCalories
Highly Active Time
Floors Ascended Mtr
Floors Descended Mtr
Min Avg Heart Rate
Max Avg Heart Rate
Abnormal HR Counts
Last 7 Days Avg Heart Rate
Stress Qualifier
Stress Duration
Stress Percentage
Rest Stress Percentage
Activity Stress Percentage
Uncat. Stress Percentage
Low Stress Percentage
Medium Stress Percentage
High Stress Percentage
Latest SPO2 Time
Average Altitude
Moderate Intensity
Vigorous Intensity
Intensity Goal
Latest Respiration Update
```
Binary file added source/images/supported_brands/garmin_connect.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2fd35a2

Please sign in to comment.