mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-27 11:16:54 +00:00
Update application credentials documentation for remaining integrations (#23044)
This commit is contained in:
Allen Porter
GitHub
parent
6d4cfd9ac3
commit
aeccb306ef
@ -56,25 +56,6 @@ Internal examples: `http://192.168.0.2:8123/auth/external/callback`, `http://hom
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
Next, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
||||
home_connect:
|
||||
client_id: CLIENT_ID
|
||||
client_secret: CLIENT_SECRET
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
client_id:
|
||||
description: Your Home Connect client ID.
|
||||
required: true
|
||||
type: string
|
||||
client_secret:
|
||||
description: Your Home Connect client secret.
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
{% 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.
|
||||
|
||||
@ -42,21 +42,12 @@ Internal examples: `http://192.168.0.2:8123/auth/external/callback`, `http://hom
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
Once your app is created, copy the `Consumer Key` and `Consumer Secret`. These will be your `client_id` and `client_secret` to add to your `configuration.yaml`:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
lyric:
|
||||
client_id: MY_CONSUMER_KEY
|
||||
client_secret: MY_CONSUMER_SECRET
|
||||
```
|
||||
|
||||
You should now restart the server.
|
||||
|
||||
You can then add the integration in the frontend via the steps below.
|
||||
|
||||
{% 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.
|
||||
|
||||
## Sensors
|
||||
|
||||
This integration provides the following sensors:
|
||||
|
||||
@ -32,7 +32,7 @@ There is support for the following platform types within Home Assistant:
|
||||
|
||||
## Prerequisites
|
||||
|
||||
1. Visit [the Neato Developer Network](https://developers.neatorobotics.com/applications) and create a new app.
|
||||
Visit [the Neato Developer Network](https://developers.neatorobotics.com/applications) and create a new app.
|
||||
|
||||
<div class='note'>
|
||||
|
||||
@ -60,30 +60,10 @@ instance does not need to be exposed to the Internet.
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
2. Add the newly created `client_id` and `client_secret` to your configuration.yaml:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
neato:
|
||||
client_id: YOUR_CLIENT_ID
|
||||
client_secret: YOUR_CLIENT_SECRET
|
||||
```
|
||||
|
||||
3. Restart Home Assistant
|
||||
|
||||
{% configuration %}
|
||||
client_id:
|
||||
description: Client ID for the Neato account.
|
||||
required: true
|
||||
type: string
|
||||
client_secret:
|
||||
description: Client Secret for the Neato account.
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
{% 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.
|
||||
|
||||
<div class='note'>
|
||||
|
||||
After the update to firmware 4.0 (which adds cleaning maps) there is also support for displaying the maps of the Botvac D3 Connected and Botvac D5 Connected robots. More information on how to update can be found [here](https://support.neatorobotics.com/hc/en-us/articles/115004320694-Software-Update-4-0-for-Neato-Botvac-Connected-D3-D5-).
|
||||
|
||||
@ -18,11 +18,7 @@ ha_integration_type: integration
|
||||
|
||||
The `withings` sensor platform consumes data from various health products produced by [Withings](https://www.withings.com).
|
||||
|
||||
## Setup
|
||||
|
||||
For simplicity, these instructions assume your installation uses Home Assistant Cloud.
|
||||
|
||||
### Step 1 - Create a Withings Account
|
||||
## 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).
|
||||
|
||||
@ -54,51 +50,31 @@ Withings will validate (with HTTP HEAD) these requirements each time you save yo
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
### Step 2 - Configure Home Assistant
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
- Add the Withings configuration YAML.
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
withings:
|
||||
client_id: CLIENT_ID
|
||||
client_secret: CONSUMER_SECRET
|
||||
```
|
||||
- Confirm your YAML configuration is valid by using the `Check Config` tool (see note).
|
||||
- Note: In order for "Check Configuration" to be visible, you must enable "Advanced Mode" on your user profile. The "Check Configuration" tool can be found by clicking "Configuration" from the sidebar (cog icon) and then clicking "Server Control".
|
||||
- Restart Home Assistant.
|
||||
The integration configuration will ask for the *Client ID* and *Client Secret* created above. See [Application Credentials](/integrations/application_credentials) for more details.
|
||||
|
||||
|
||||
### Step 3 - Authorize Home Assistant
|
||||
|
||||
- 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.
|
||||
- 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.
|
||||
|
||||
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:
|
||||
client_id: CLIENT_ID
|
||||
client_secret: CONSUMER_SECRET
|
||||
use_webhook: true
|
||||
```
|
||||
|
||||
{% 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
|
||||
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
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user