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-16 05:46:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update withings info (#29048)

Browse Source
This commit is contained in:
Joost Lekkerkerker 2023-09-27 17:52:37 +02:00 committed by GitHub
parent ed6fd0a965
commit 2bea17bf9e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
source/_integrations/withings.markdown
View File

@ -16,11 +16,11 @@ ha_platforms:
ha_integration_type: integration
---
The `withings` sensor platform consumes data from various health products produced by [Withings](https://www.withings.com).
The Withings integration consumes data from various health products produced by [Withings](https://www.withings.com).
## Create a Withings Account
## Create a Withings developer account
You must have a developer account to distribute the data. [Create a free development account](https://account.withings.com/partner/add_oauth2).
You must have a developer account to distribute the data. [Create a free developer account](https://account.withings.com/partner/add_oauth2).
Values for your account:
@ -52,32 +52,7 @@ Withings will validate (with HTTP HEAD) these requirements each time you save yo
{% include integrations/config_flow.md %}
The integration configuration will ask for the *Client ID* and *Client Secret* created above. See [Application Credentials](/integrations/application_credentials) for more details.
## Data updates
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.
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.
## Configuration
There are additional configuration options available:
```yaml
# Example configuration.yaml entry
withings:
use_webhook: true
```
{% configuration %}
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
{% endconfiguration %}
The integration will automatically detect if you can use webhooks. This will enable the integration only to update when there is new data.
The binary sensor for sleep will only work if the integration can establish webhooks with Withings.