From bfef45e5db6fd9f319f06ef33d6646bd91edf01e Mon Sep 17 00:00:00 2001 From: Robert Van Gorkom Date: Mon, 9 Sep 2019 12:12:40 -0700 Subject: [PATCH] Adding withings sensor platform documentation. (#8816) * Adding withings documentation. * Updating docs. * Updating docs. * Fixing compile errors * Correct docs to match updated component. * Updating docs for up-tp-date withings information. * Updating docs to meet new options. * :pencil2: Tweak * Update source/_components/withings.markdown Co-Authored-By: Klaas Schoute * Update source/_components/withings.markdown Co-Authored-By: Klaas Schoute * Update source/_components/withings.markdown Co-Authored-By: Klaas Schoute * :pencil2: Tweaks * Updating documentation to match the updated parent PR. * Adjusting according to PR feedback. * :pencil2: Tweaks * Fixing incorrect documentation. * Removing measures as this is no longer allowed. * :pencil2: Tweak * :pencil2: Tweaks --- source/_components/withings.markdown | 87 ++++++++++++++++++++ source/images/supported_brands/withings.png | Bin 0 -> 5596 bytes 2 files changed, 87 insertions(+) create mode 100644 source/_components/withings.markdown create mode 100644 source/images/supported_brands/withings.png diff --git a/source/_components/withings.markdown b/source/_components/withings.markdown new file mode 100644 index 00000000000..8833a78a5a4 --- /dev/null +++ b/source/_components/withings.markdown @@ -0,0 +1,87 @@ +--- +title: "Withings" +description: "Instructions on how to integrate Withings health products within Home Assistant." +logo: withings.png +ha_category: + - Health + - Sensor +ha_release: 0.99 +ha_iot_class: Cloud Polling +--- + +The `withings` sensor platform consumes data from various health products produced by [Withings](https://www.withings.com). + +## Setup + +### Step 1 - Create a Withings Account + +You must have a developer account to distribute the data. [Create a free development account](https://account.withings.com/partner/add_oauth2). + +Values for your account: + +- Logo: Any reasonable picture will do. +- Description: Personal app for collecting my data. +- Contact Email: Your email address +- Callback Uri: `https://your-domain-name/` - Withings will check if this URL is accessible (HTTP HEAD) upon submitting the form. +- Company: Home Assistant + +Once saved, the "Client Id" and "Consumer Secret" fields will be populated. You will need these in the next step. + +### Step 2 - Configure Home Assistant + +```yaml +# Example configuration.yaml entry +withings: + client_id: CLIENT_ID + client_secret: CLIENT_SECRET + profiles: + - USER_PROFILE_NAME +``` + +Withings supports multiple profiles per account. Each profile has a person's name to help distinguish whose data you're looking at. While the profile provided here can be arbitrary, it is recommended you use the same name from the Withings profile. This will make it easier to distinguish whose data you're looking at. + +### Step 3 - Authorize Home Assistant + +- Confirm your YAML configuration is valid by using the `Check Config` tool. +- Restart Home Assistant. +- Go to the integrations page. +- Add a Withings integration. +- Select the profile you intend to pull data. This will take you to the Withings site. +- On the Withings site, choose the profile you selected in the previous step (if prompted). + - Note: It's important you select the same profile from the previous step. Choosing a different one will result in Home Assistant displaying data for profile 2, but it will be labeled as profile 1. +- Authorize the application. Your browser will redirect you to your Home Assistant URL. + - Note: If you get a browser error saying the site is inaccessible, you can modify the + `http://domain` portion of the URL to something you know is accessible, locally or publically. For example, `http://localhost:8123`. + This occurs when the base URL provided by Home Assistant to Withings is not accessible to the outside world. + Changing the domain will not affect how data is synchronized. +- Data will synchronize immediately and update every 5 minutes. + +## Configuration + +```yaml +# Example configuration.yaml entry +withings: + client_id: CLIENT_ID + client_secret: CLIENT_SECRET + profiles: + - USER_PROFILE_NAME +``` +{% configuration %} +client_id: + description: The OAuth client id (get from https://account.withings.com/partner/add_oauth2) + required: true + type: string +client_secret: + description: The OAuth secret (get from https://account.withings.com/partner/add_oauth2) + required: true + type: string +profiles: + description: Withings supports multiple profiles per account. Provide the person's name whom you want Home Assistant entities to will be associated with (just a name, it doesn't have to be perfect). During the authorization step, you will be asked to select this user from the Withings website. + required: true + type: map +base_url: + description: Overrides Home Assistant's default base URL to use when authorizing with Withings. + required: false + type: string + default: The base URL provided in the Home Assistant `api` component. +{% endconfiguration %} diff --git a/source/images/supported_brands/withings.png b/source/images/supported_brands/withings.png new file mode 100644 index 0000000000000000000000000000000000000000..51b690f7cab6874555edf92f4dabeec411f565b9 GIT binary patch literal 5596 zcmd5=`8yO2&|g;WBNpXMDrYFNZkr=#?i3=6qOV=bO_sGKN3O^%mfX1(xvy1Nl9hF= z`_7TDag*i#YewnHkSD z5#pS1ZWvun4fO%E|Ku4ol@gs$K3s@G`S zr)Umq66WVZJ$7WAS&<0-P`lqVQ3Xle0G2KH519_?7JQ z;>HP2|CV8Lp5;wo!wHw;t*XM0~N9Zji2A zMRy+~_vPbY3p4*EdMlq-_4;N)&BFIA{CeqW#d{uyp_M5`k0hueb>9K{sdPr6V*tff zCy5lY$4hg8h!{n{CPg4(@Z^YwFA-Z;Y`rD^9Z*zLpMn%zSM(?2p`|m%`T}>^23=|$ z96u!HGO1^iwW`W|y1pQ7XI~Ib3$yB?hCmv=^FC^ZoF1Td#J+htXGU-G3Ni}aqG=(q z9V0 z!3x>_HOj9Dky2 zp|8MK0`$?M_n_%@K$(%I8WmKTUG^F4*NkI5pN23w=6Ytm3!os6E}YQnwmb z@?Nq{e3zi1rs%fc$tAX1Co4P^x-U<8IRDJX``7i_4a*VXkh;O#LCrgUtL9B`l~DeA z1FuJ$nqayoab9iwsy7?GY@mM7>zMT6I~oy5n5hv3p1hWsvZ@HZvw%*H=9<2zeSve%1^Q>wFfXHL5o}VSv3%o0_0wqzoSkkmPR(1$QIy@8xP) z0;CroF4i(=kE&BcX5Zu01Oa}v1tT?XeyY>jPYpkt;rA?|4o_#sv3pnoLn2Lz)X+aH z8&Qw)<54}5T6DSjRg#JlWNLrp(v^&z!@5(~e^IZVnI1b}ZzKEL4*oe21v;IgUhykN z>JC7<>OiV6&^Oi_;lA1{{bY9WOPdP)DM3?V?g`V>9hqvKVs>cIBKow2^IuljtRjun zMeoQwoA$FqnLUT4y^$7j8v`QwbKshpCYAo~yHHQD68pJy@rS$0Vi+V7DOO?9@i!aG zoQuVxKYFh^)=ZV%epP8{{ZxrN_eO_0DQcKu?`_?lc73(V5`=4V2w7qaM6N^}YhP<- zA!h{Q0n;v%28@%Ejoa^eR1B-axlK>mhLk-h1jE9>#OqYD^>U`n(aea4=*U|6ZpO?~ ze+aG$9h4=q9NQHqNlkV~YZmlCJZ1(Zsj3-XPm=|i*uV0(w_M3wtTChUAQy%u32iPu zuXgquA`P}V;$u!Vu?vsK1>d|)OH`kth4PUYNM1-Tb}2t(%`Y}aB84GvPD0zl`7d!- z6gfv!_&{Dk*K?eOXtK=yfw4fjZKDmSfvTh`bqMh`Rs+k8Wqg*mn~EHki$ES_b*rS( z9XN$J`zA^P*K8ru(z};}G`zXjRDjmr3rg!@ZFa<@pPA_ zoLGByoKSe&$Kq`7(DY3QeueM2{{ATo@skhp%=@D;0uF7eOIT2R(>{3oh~IFc>gI79 zJ_YH)n7lO|{WFWaux;c_z&1>&qpWvMu>K30lQxdA?p?V;n%)rjP~-~F$wz7UVSRak z#7`d>K!wa+Y_%@&U{XCAA0Rv}QDWQnV>V^X+$A%OIrBZ%xkT+2FT6rV$)26&%_ zseM6gQU3mpsA(MC;?|~QL!#4m`>!Tb7-k{tN zYf6=#Ca1;e=5zOzBRbdT@8ZMla&glm9`shjCrr0~Z&8;j$8SNSCmV;)^u`3YJ(IJr zvNNYnP3E%Fh>Ue$sEZ!QV92~md9Dz7?vYUQrR>cnJ4mk{A9cs6a{o>$scJa~{5xa< z2ld+WVZ%s_b!@bX>b3}e-NBZ#Jjtn@#4LPbl>_sXr6|=FEEN>wd;FA`mIjjDpfe@@ zBF}6R!m%nq;tm}Cz+|k?Hub(9C$lh34&Lu*8k2ZrKh-_cvCnFQ-NjtZAN)M)5sM`0 z!HycI)jMraqh($K!)z>Eka-+2!qZF$Pcl=s66uUmEACqf0A!HeE3P91gp_#$Zh$lL z9fH!zY`H8MfBtLN+tbe2L#?%MRj*37r~xsB&n)_v!W zxt{>dKi99lyxQw_$OPT)s`9PLTUV-dIOBm4-Z_ATnw(AjR?~U8bOAz?h5nR`(XhUW z=W7r}%-K8j#DHrrMRLtT_9GUgfEzjCLX;K=*rzmo3!^g8Efmn9u%wwVq@Iwm7CrXz z^pLqp#~fD9E_MqKS?K6qG=BkI2$@u+1joc*Y1IG4>fP;LF(G^BWIbO{DI!d2=TZwB zIf()9qX^z=NoE(j6XE8ai__p0N=N)NCP*Dt2yC9hQtA>w2uO1)ALK94@t~P zs^!o6H=jFqBxG-bs?x1IKO$8^a{KhI%nCn$GSx$54OItbPA}e`FKX_39_lIdRp2-1 z_&?qCW@a{AT_p;32Z9NkVbmUNz}~~!Y^RDfK4!#R%mH0gPG4^9vF-yn$9hpri_{8$ z7%L2tO;hTxY9v3YP8K*(3n!tQgHkGi;J zLYUMNlR~*5_LChPo!CAozuDMiQ7tV_)jHf=GNs(p#o3$eVb;5q$NUS`dA?`r4!d4! zz=i^6a4undT+lG}Evc+Wj290@!R`=GC7C25`mT@72*P=}rbMO{m?pU@EIJwJtXn*% zua?mwBRC^z5!iTb|G7#>*yrBF(Rb?;{rjTBQt2RXKZ|91cux}ZaJ;if4rEV=CR*cm zt*dV&YA-yM&i{~QDKT$F*0Gd@H;GGLS$tXTouLohG2&c!r>Rd_q_6GllAXs3#P{Hq5j{gjDz#4W#`_Ue7g8jL&#|H;`Ze=^*2`B| zFZh`0;_`$wc33^x))ChSqF-mG{cI5dk>Q4qT6VdlIh%ZZL7g*kWe{HdF=phPQ$o!! zf`d{PXvRG1^=kf~rKYvy81)H;4_u+*$@nYUeSXK3WEGv(vR2>{G)#zGd@=O*M^sM5 z^AVMvZ=OX6Y4y#uawm{Fo(T(qZgDz3`W9Z{@^$SMUEJs-MePoZWPeHeZJJ`Xaddr8djS2?#vh@d@Huc#B0ZTm+9ifb__6u=G<{mTPB3ZV&ji%X4_F9`$mD(QJZMcT((6P7b2x9As0 zw1xO(Wft!nEmPG)JlSJM0ps*1sm?rkfWX_}$a?-W1ZwM)0pbjCwtjJt$9AD*rdfo5 z3mgXU1Cn|gt58Fig`*M>F%_j@q`#BHZ^VnKKmROjc8CFkl`-3o@6@tSiQQs{jl!!@>?D7C*_QXsV7<{>qT|V$(?{hdQuJcA13%D zl$?EV!45JxH`e+0iJBVR)vX{TuvsBBY@Hyf5G)*^}P za_f5Vk5ruie#ez>B|*K}zWBXiFS#WfT^H#5&V`1T;{YDgGggzA3_ah!5>H zQnkW{pwO()liNtHS##prkin-}d|x)go8xrn5jF^;{W;6dXoF9C#Q9Rr8;lb8;x#^s zrZjw;bi94uT;MGW=+NC_6AtuGa`UO~X1Ik3*W<0KTBP|m^+jE;at$)kRb4VcYXy|l z+j{t_YW;M}_vZZ*X1LM5B|0X2!*t_{OWf>D&#xZM976W~0a=tCHg%$?xtm!k&_r0_ z?IFy}D?`Cb;4U%ckA=zU&V`i!K<#u}*X3*-vS)ktVQaeAWDy+sSHP@N{>~gRn!#;k zSXiQWoA-EpD6{|>c7Km2C#{lu@+c$$ml>5%(iTtp^bc6By+#}QG9?8*r1O_)BE7P% z)ma1OIkAu=1{yTv*&fv7bU3ak-mE@JD)X))dKSvd%j`Wdwi7lI%b38>2zNg@45lQS z(o-Y@yhTuihrH8v_=+i88B3}EB%$xrD%N@EN++xx^#%Og?PyCw4U z7u;eM_#~e-ca<0Jj^x(jiQRpPUB;Wesz=pJ!S$|`oeU^Fuhx#H=i{rM?-kArlB{4c zE0EqJ3z?675>x~$&dF%Yj1a0ExHE{ET0J~TQHX3e3t;=&9?j7!TE1$*dW4(if5Fr_ zRrJs9f+}$9Q8NKjY5Z6SHvG|in6XiC`$`?HPrdm{w*<>LLHPFNt;{x1j%{{P)tPd( z!7<#(QBLs*eG z4z>;uEc;dOLMV|Q!r1w#$Xx&W$MSoy7b+=;_)?nG0%$P53|858p*bGvpUvzn!5KOp3u zzQfE3R)j_3)D$xi!FunSIKlMe>kF{QR)(L@xM|9Z8!byk1hGT97$dody%O*Q+*inp zyPIWS2WyqZ<^iI(iRfVC49oMs(Si3_Z9&dA%unuX8;+@GY*0@Avp`Y)%$Ei7Suy_~ d$Vg#Nr7S3=s>CO;>--N3FurH5U#$y${XdBJ^|Sy0 literal 0 HcmV?d00001