Remove deprecated YAML config from bmw_connected_drive (#21714)

Co-authored-by: rikroe <rikroe@users.noreply.github.com>
This commit is contained in:
rikroe 2022-03-14 09:15:51 +01:00 committed by GitHub
parent 329d2a8d2c
commit f2fa5d4ee4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -46,54 +46,20 @@ This integration provides the following platforms:
## Configuration ## Configuration
The preferred way to enable the `bmw_connected_drive` integration is via **Configuration** > **Devices & Services**. After connecting to your account, you can set the following settings in the integration's options: Enable the `BMW Connected Drive` integration via **Configuration** > **Devices & Services**.
<div class='note'>
For `china`, it is mandatory to prefix your username/phone number with `86`, i.e. `8612345678`.
</div>
After connecting to your account, you can set the following settings in the integration's options:
| Setting | Description | | Setting | Description |
|---------|-------------| |---------|-------------|
| Read-only | No execution of services to the vehicle. Still possible to send messages and POIs via `notify` and to request a status update via `bmw_connected_drive.update_state`. | Read-only | No execution of services to the vehicle. Still possible to send messages and POIs via `notify` and to request a status update via `bmw_connected_drive.update_state`.
The following settings in your `configuration.yaml` file are considered legacy. They will be imported into **Configuration** > **Devices & Services** and you can set the options from above. Changes to `configuration.yaml` after the first import will be ignored.
### Legacy configuration
```yaml
# Example configuration.yaml entry
bmw_connected_drive:
name:
username: USERNAME_BMW_CONNECTED_DRIVE
password: PASSWORD_BMW_CONNECTED_DRIVE
region: one of "north_america", "china", "rest_of_world"
```
{% configuration %}
bmw_connected_drive:
description: configuration
required: true
type: map
keys:
name:
description: Name of your account in Home Assistant.
required: true
type: string
username:
description: Your BMW Connected Drive username.
required: true
type: string
password:
description: Your BMW Connected Drive password.
required: true
type: string
region:
description: "The region of your Connected Drive account. Please use one of these values: `north_america`, `china`, `rest_of_world`"
required: true
type: string
read_only:
description: In read only mode, all services including the lock of the vehicle are disabled.
required: false
type: boolean
default: false
{% endconfiguration %}
## Notifications ## Notifications
The `bmw_connected_drive` integration offers a notification service. Using this service you can send Points of Interest (POI) to your vehicle. In your vehicle you can select this POI and the navigation will automatically start using the POI as a destination. The `bmw_connected_drive` integration offers a notification service. Using this service you can send Points of Interest (POI) to your vehicle. In your vehicle you can select this POI and the navigation will automatically start using the POI as a destination.