2023-09-27 18:46:52 +02:00

2.1 KiB

title, description, ha_category, ha_release, ha_iot_class, ha_config_flow, ha_codeowners, ha_domain, ha_platforms, ha_integration_type
title description ha_category ha_release ha_iot_class ha_config_flow ha_codeowners ha_domain ha_platforms ha_integration_type
Withings Instructions on how to integrate Withings health products within Home Assistant.
Health
Sensor
0.99 Cloud Polling true
@vangorra
@joostlek
withings
binary_sensor
sensor
integration

The Withings integration consumes data from various health products produced by Withings.

Create a Withings developer account

You must have a developer account to distribute the data. Create a free developer account.

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://my.home-assistant.io/redirect/oauth.
  • Company: Home Assistant

Once saved, the "Client Id" and "Consumer Secret" fields will be populated. You will need these in the next step.

{% details "I have manually disabled My Home Assistant" %}

If you don't have My Home Assistant on your installation, you can use <HOME_ASSISTANT_URL>/auth/external/callback as the redirect URI instead.

The <HOME_ASSISTANT_URL> must be the same as used during the configuration/ authentication process.

Withings will validate (with HTTP HEAD) these requirements each time you save your Withings developer account. When these checks fail, the Withings UI is not always clear about why.

  • Home Assistant (For create/update of Withings developer account):
    • Publicly accessible.
    • Running on a fully qualified domain name.
    • Running over HTTPS signed by a globally recognized Certificate Authority. Let's Encrypt will work.

{% enddetails %}

{% include integrations/config_flow.md %}

Data updates

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.