mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-18 23:06:58 +00:00
Add documentation of Neato OAuth flow (#15846)
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
parent
b750c2dc74
commit
16c8ff031e
@ -13,6 +13,7 @@ ha_codeowners:
|
|||||||
- '@dshokouhi'
|
- '@dshokouhi'
|
||||||
- '@Santobert'
|
- '@Santobert'
|
||||||
ha_domain: neato
|
ha_domain: neato
|
||||||
|
ha_quality_scale: gold
|
||||||
---
|
---
|
||||||
|
|
||||||
The `neato` integration allows you to control your [Neato Botvac Connected Robots][botvac-connected].
|
The `neato` integration allows you to control your [Neato Botvac Connected Robots][botvac-connected].
|
||||||
@ -24,40 +25,44 @@ There is support for the following platform types within Home Assistant:
|
|||||||
- **Switch** - allows you to enable or disable the schedule.
|
- **Switch** - allows you to enable or disable the schedule.
|
||||||
- [**Vacuum**](#vacuum)
|
- [**Vacuum**](#vacuum)
|
||||||
|
|
||||||
To activate `neato` in your installation, you can set it up from the integration screen or add it to your `configuration.yaml` file.
|
## Configuration
|
||||||
|
|
||||||
## Setup the integration via the integrations screen
|
1. Visit [the Neato Developer Network](https://developers.neatorobotics.com/applications) and create a new app.
|
||||||
|
|
||||||
Menu: *Configuration* -> *Integrations*
|
<div class='note'>
|
||||||
|
|
||||||
Search for or select **Neato** from the list and configure the integration. You will need to enter your username and password and whether you are using a Neato or Vorwerk device.
|
You will have to enter a name, a description and your redirect URL.
|
||||||
After that, all the entities will automatically show up in Home Assistant.
|
|
||||||
|
|
||||||
## Setup the integration via `configuration.yaml`
|
If Home Assistant runs on `https://hass.example.com` your redirect URL would be `https://hass.example.com/auth/external/callback`.
|
||||||
|
|
||||||
Add the following to your configuration.yaml:
|
Please note that your instance must be accessible via HTTPS. However, your instance does not need to be exposed to the Internet.
|
||||||
|
|
||||||
|
You have to select all three scopes (`public_profile`, `control_robots` and `maps`).
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
2. Add the newly created `client_id` and `client_secret` to your configuration.yaml:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
neato:
|
neato:
|
||||||
username: YOUR_USERNAME
|
client_id: YOUR_CLIENT_ID
|
||||||
password: YOUR_PASSWORD
|
client_secret: YOUR_CLIENT_SECRET
|
||||||
```
|
```
|
||||||
|
|
||||||
|
3. Restart Home Assistant
|
||||||
|
4. Add Neato Botvac via *Configuration* -> *Integrations*
|
||||||
|
5. Follow the instructions. After that, all the entities will automatically show up in Home Assistant.
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
username:
|
client_id:
|
||||||
description: Username for the Neato account.
|
description: Client ID for the Neato account.
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
password:
|
client_secret:
|
||||||
description: Password for the Neato account.
|
description: Client Secret for the Neato account.
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
vendor:
|
|
||||||
description: Support for additional vendors. Set to `vorwerk` for Vorwerk robots.
|
|
||||||
required: false
|
|
||||||
type: string
|
|
||||||
default: neato
|
|
||||||
{% endconfiguration %}
|
{% endconfiguration %}
|
||||||
|
|
||||||
<div class='note'>
|
<div class='note'>
|
||||||
|
Loading…
x
Reference in New Issue
Block a user