From 2fd35a2b5f6fdfe7608ebc5ad4e825800259c5ba Mon Sep 17 00:00:00 2001 From: Ron Klinkien Date: Tue, 28 Jan 2020 15:50:44 +0100 Subject: [PATCH] Add documentation for Garmin Connect (#11752) * 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 --- source/_integrations/garmin_connect.markdown | 110 ++++++++++++++++++ .../supported_brands/garmin_connect.png | Bin 0 -> 5087 bytes 2 files changed, 110 insertions(+) create mode 100644 source/_integrations/garmin_connect.markdown create mode 100644 source/images/supported_brands/garmin_connect.png diff --git a/source/_integrations/garmin_connect.markdown b/source/_integrations/garmin_connect.markdown new file mode 100644 index 000000000000..506684efe37e --- /dev/null +++ b/source/_integrations/garmin_connect.markdown @@ -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 +``` \ No newline at end of file diff --git a/source/images/supported_brands/garmin_connect.png b/source/images/supported_brands/garmin_connect.png new file mode 100644 index 0000000000000000000000000000000000000000..1a95fdd46754d64b16a2981a084de6b85e16404c GIT binary patch literal 5087 zcmaJ_WmFW-+g)JEU3!sNngszRq`Nz$OF9$~5Gi5l#a&|QP9+4SODO??rIk|YMTwO-aE*0RR9fb#*jM0RRH2TWm~5a$9CT zv3YcBNL=)_H30bkQc2I-%v%rna~+!i06>`Mzf2HPq5R_3NgAkYs7bm(KuyKUTo+BJ z2>{T0>uRW)hb-;efA_(CpnDCxti##%TL@Yc3vwQJMawV@HuSw9PPx})hRCMa14O2_ z19+AwEUQ;{I}iaJ5(>_c8@;Uiye9=>v5;*-G9Y2;o8Ooa5a7+%k)J<1 zdMzUkGb&S5I0Ko8`rQ!+`WoIq!nMzc_+%AMnr7PD?zB+E|AFCs)VaxUXVz?GdA9R7 zB?I96Ip9Zop7>dS+`&8cBxk^S{qNJjL`Kii%S% z-`7Tbtdd=z1uO$pfa@oG3RHkJ!afmzOc8e4c=4e55Ycbt&pIFu*pr*a6G-C`YfLQ} z;IApn%F3@1{qu4aW`td2K&0`Uz#QJ*YGV!cUpHcgRPpk4l`doRU&0$&AB=Bt2WXIXaZa2T^GT_L(PM z1LY)4_TD|B4w9USlmKripX3iI%V}<52|bUR)o{A^NyYpneP#8|-(lsC@#1#hSAIK^ zoSp`$a6>06{qKNDFy$s2>VuIR1!<*kmJ;GIkoSx($$uX9?Wsn!L&0@Fyx53-);|mfgoCl>0of|a$)IP!LC#K1^A@jNb)IH#x^Sib`PorC zPo_K~r&gQk`UjIYrYdPf|IM90-luv!1*FeAK3x&)Z#l#%@Jy4cYBdUS9n74O2TMKl z&R&kr^Ga7Crkh9yx1jfHE$!ToS4Z7zk63Du>U^FAcl{rvX*`mynSGu>)>q=K8j^NyPt$E!Q!%K;QnH{ZE#=+>c7Bel z?bRb8GAs^swk#*7q^26lAncR;^eEO3HGxFM&TKVoxNuT?^{7D~c`ER`hoX>@=A+I4 zO5b>U7C~pU-cC4{)&6Uz3t{D*wKds)$|h-r*#JMVYUW>I6xh7sx@!H|pPK6M+^7Aj zZ%oHRpK@iY;8YEFk-HS|ojZm3nwd~WXJ<{>ay0R9TTyihY4k>#Dm>3rU&L zH&U8GTZp5+Z{%xc4Gazunk6hq=*f8gl=v{?rS98OL;JmT1}~4wZ4x!^OLqbL^w5@= zs$s=#&oic|8x&a+OxQ{mU^NQtr*q{dDrW3~p3RE_-BOvFQKdWhZsOau##c56MCY>b z8Z3q8(%&uFedjjb>(z|!bV0E(*EO_LaC>-x^IgD1U-pI2MJao}xzp@9=%KB)SO>%~ zPhii&MowZ}0_zrAn!0P;OA+~U$+$R&!_jci-ZaPB1d*NLlIFiDkj9N*{$7*p~y8AFR+3W#DfZj~$Kq zi8?aRsEHR$JI68a$z|UEmy9YCdmIrPS)#86L>K9pql%^^Nb>itKO|1%g9YnF*=J+m zDPb#a|H65=o-9_pu~`w`t=nxL!*qNE-!KmzR=uvk-_H97vmh0IwOBE<8Mu7dE!v>r zjTU#=?j}37Dcg>8bc=CV#JGSX+J9-q*GpUJwl@!0mKss#I5Nvne70W)%s$gh=S4=n zg5L*e3AIA<>%2DLb8$Q)A^o_RdIy`JFSK+L=vhrdaU zcu-4s8J-P!PJ~|8hBuiwl5mDiY!}I+?f2+Q={)0~2d5lIQYHM|4nA5iP4G(z6^j*u zc*= z*w!BSfisp=BneM@1!O>O;}m^-)GP?hM$cYTVyRtz&ccL3cH3b_-dxrmtcV9Gz~vYTQmzP_r*<&C2l= z(#GtBe-&G?fY;P)5jt1QJPo^td!tVvTb1;HFj_gNhXb;#r~Z`L`p0?dk956N5X`;z z3Emy>yT(TH?tA)wkGrMpWqSbthX)3%Gc)z0PW|s6`Z{R}W-B$YE^2L{j%q9MZJUh6 zkZ{=ENd=70inoh&=lZJuVx^KhC>nW2I-{-YU*#a>TSd#svzirp|Q|fi{x3{<;yz<2QT1R(ciBV(+t?_COfpYZao0Fju}UnJuz6O*M?OF6A>P}!wnX!v9h zvB!$kwNa_dk$<>_pO?qfyfWn8%peHo7^{}lH<5VKs+)|Wa$usSB;I**E`#H1_7{#- zXcal^hZDnU(d0|zITI&m1KY#O!vN~U&U&{Rw zyIi5_DnMakVbLWlVDNC{dOC>B7_!Pr-XP%b@WEV8&39DjR*%jb?;S`6Jxqst1{)Tk z2JPl0C9FDk0RSuER0Y3D%SVX|GBHk>O)p@h5c2&RPowR?Wscjy7+QKjF|G{5jkowE zQH8ut*1sZ}WC7{XOg4ztQtOd|{B*q}z;2B&R~80*0_}?R;n6(w*-2Za<2ThC;6vxQ z7B_x*jRFRnwE7ureUJHD37}sPhv;J8!DSdOC)HxyJxV;D!5M2nxuz5^hQ;VLhuBnC z&cY~DE0*7CZ7~HU^3E8Zcrml=h|JXQjh_r+<2>=ycK8$VKY#Cj3h`g7a{jm*2(#{) zYFH@HHQ|Me^S3Ps%)n-BSQmu36D^M$?mHFSyo)>msSkIXePAfKRqVIi_@8k9|BV{{ zxvH58=hfxY?@Z`8`&L9sIuk{q2%iZW?zYDIovT@s&M`^-3i(g|*xGz+;lZ=r zg0G6c)nnK8%NI(U_TE^Wzs&HI^ea%V&(p0`xHE=@>*DH`Qt2)DA8FoMK1a%#eXXVT znVXf>l`jsAk)r;m?b$t+tE+$- z2f7gX*==CA;U>&S&H>XAGnE?_S+h4Z94vPr(sVovNpKx&C>TD|(6q=Y`&H$)Z2RS; zv_s{T7%XVz*Q!iyY)AQVHhBz$!#gWCYG}NS2-D>0`Kl0=xVGK$sTHe3agWBzLEo4( zL@ZQg$~WHCNlc+A<&sO9L!V#pYqGx2!zQvxy^^=2{Mkzz#UpnN55yP6l^}_wthV_6 zEEMx1EB;X3WKf!hiH2v02r_@q$hb6uzs4)I)1uhkP?7FEPCs%x;0J@zQ(K87NtQ9z zvB20(c1^8ONNC@-eN(D!N}hF?ECkhTMYsN&I6!g${vJhrsM$L&le)Kib)3h31I<#wZ(rWc3}IrrC8ZS65rn=CeAQEArfvWM}^zq+$hAKA`P2+?ETKFW7s zQs!Dq?h(BiV&HNF^o@dWotzuc0QO8>rs6sN$GLFl`^PQ0{E4>>Dy#bc~3AVc&}$GC;;RKV^Xl`poO)=L$sp3`TUV>g=}o^!Q2BQo_f8RdH7pq9o(#(ySSHO@l_@FBu;EKa_Rt`$oEkQ`{qB=W7`}{TrQW9&b6ipqmhVDkn{m@ zmJOi{R^NE$Sik$MY~)E2t7^S@MumRPM5uEzjDT01DI2Q$m^j_AwMGJW7QRPTOt!2=67qyLH zquRgyT%(z5r_$LSsWTOW$#<8sJLAEyH35*1Y2w*UjZA6{YoRwgX@-)5pMxz1o*-qh zNG($=-lUK})kBrz+E7#Eo>($UJ;&$IEv3e0pbs;he0k(BHMk(%cMozi(mWmw5#_)Z5j=G-`*3n9=_RRYtNtkP zf*;Vs17k$9)~JfRjxZsgHoY#kslb%-=a>sBG!H9O zBR1D6Q9GbQI} zq=Y%FIhZ>&38byM6|ou+x1a?$gpwob8c7^Jr+t>r#&)e^al<{hVMUzIc{OI)-L8=5 z&H?7qmLtGWhP*?^JhYxH^>o?Kl_ekoP!zZJvqPkq7V3ZO_