Withings


The withings sensor platform consumes data from various health products produced by Withings.

Create a Withings Account

You must have a developer account to distribute the data. Create a free development 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.

Configuration

To add the Withings integration to your Home Assistant instance, use this My button:

The integration configuration will ask for the Client ID and Client Secret created above. See Application Credentials for more details.

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:

# Example configuration.yaml entry
withings:
    use_webhook: true

Configuration Variables

use_webhook boolean (Optional, default: false)

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.

Bonus: Template Sensors to Convert Kilograms to Pounds

In a text editor, replace USER_PROFILE_NAME in the template sensors below with your Withings User Profile Name defined in the Withings integration configuration.

# Example configuration.yaml entry
template:
  - sensor:
    - name: Withings weight lbs USER_PROFILE_NAME
      unit_of_measurement: "lbs"
      state: >-
        {{
          (states('sensor.withings_weight_kg_USER_PROFILE_NAME') | float(0) * 2.20462262185)
          | round(2, default=0)
        }}
      icon: "mdi:weight-pound"

    - name: Withings bone mass lbs USER_PROFILE_NAME
      unit_of_measurement: "lbs"
      state: >-
        {{
          (states('sensor.withings_bone_mass_kg_USER_PROFILE_NAME') | float(0) * 2.20462262185)
          | round(2, default=0)
        }}
      icon: "mdi:weight-pound"

    - name: Withings fat free mass lbs USER_PROFILE_NAME
      unit_of_measurement: "lbs"
      state: >- 
        {{
          (states('sensor.withings_fat_free_mass_kg_USER_PROFILE_NAME') | float(0) * 2.20462262185)
          | round(2, default=0)
         }}
      icon: "mdi:weight-pound"

    - name: Withings fat mass lbs USER_PROFILE_NAME
      unit_of_measurement: "lbs"
      state: >-
        {{
          (states('sensor.withings_fat_mass_kg_USER_PROFILE_NAME') | float(0) * 2.20462262185)
          | round(2, default=0)
        }}
      icon: "mdi:weight-pound"

    - name: Withings muscle mass lbs USER_PROFILE_NAME
      unit_of_measurement: "lbs"
      state: >-
        {{
          (states('sensor.withings_muscle_mass_kg_USER_PROFILE_NAME') | float(0) * 2.20462262185)
          | round(2, default=0)
        }}
      icon: "mdi:weight-pound"