-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
Add documentation for Garmin Connect #11752
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
dc13271
Added documentation for the Garmin Connect integration
cyberjunky e519de0
Added logo
cyberjunky ac0e561
Applied suggested changes
cyberjunky 405c61c
Renamed config option to reflect code
cyberjunky 54c0005
Updated to reflect code changes
cyberjunky File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
||
cyberjunky marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
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 | ||
``` |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.