jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-21 00:06:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updating withings doc to use webhook feature (#13116)

Browse Source 
Co-authored-by: Tom Brien <TomBrien@users.noreply.github.com>
Co-authored-by: Klaas Schoute <klaas_schoute@hotmail.com>
This commit is contained in:
Robert Van Gorkom 2020-06-22 04:49:23 -07:00 committed by GitHub
parent 96ef9ccc83
commit 05cabb431e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
source/_integrations/withings.markdown
View File

@ -54,7 +54,12 @@ Once saved, the "Client Id" and "Consumer Secret" fields will be populated. You
- Add the Withings integration. - Add the Withings integration.
- Once authorized, the tab/window will close and the integration page will prompt to select a profile. Select the profile you chose while on the Withings site. - Once authorized, the tab/window will close and the integration page will prompt to select a profile. Select the profile you chose while on the Withings site.
- Note: It's important you select the same profile from the previous step. Choosing a different one will result in Home Assistant displaying the wrong data. - Note: It's important you select the same profile from the previous step. Choosing a different one will result in Home Assistant displaying the wrong data.
- Data will synchronize immediately and update every 5 minutes. - Data will synchronize immediately and update under the following conditions:
- If `use_webhook` is enabled:
- Each time Withings notifies Home Assistant of a data change.
- Every 120 minutes.
- If `use_webhook` is not enabled:
- Every 10 minutes.
## Setup (Advanced) ## Setup (Advanced)
For advanced users who are NOT using Home Assistant Cloud. This is not intended to be a complete step-by-step guide. For advanced users who are NOT using Home Assistant Cloud. This is not intended to be a complete step-by-step guide.
@ -94,6 +99,7 @@ Withings will validate (with HTTP HEAD) these requirements each time you save yo
withings: withings:
client_id: CLIENT_ID client_id: CLIENT_ID
client_secret: CONSUMER_SECRET client_secret: CONSUMER_SECRET
use_webhook: true
profiles: profiles:
- USER_PROFILE_NAME - USER_PROFILE_NAME
``` ```
@ -106,6 +112,11 @@ client_secret:
description: The OAuth secret (get from https://account.withings.com/partner/add_oauth2) description: The OAuth secret (get from https://account.withings.com/partner/add_oauth2)
required: true required: true
type: string type: string
use_webhook:
description: "Configure Withings to notify Home Assistant when data changes. This also required to populate the in_bed sensor. Note: In order for this to work, your Home Assistant install must be accessible to the internet."
required: false
default: false
type: boolean
profiles: 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. 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 required: true