documentation for new component bmw_connected_drive (#4617)

* added first draft of documentation for bmw_connected_drive

* forgot to save...

* updated description of config file to latest implementation

* fixed reviews from @MartinHjelmare

* Minor changes

* Add periods

* Minor changes

* Minor changes

* Minor changes

* Fix

* It's a string
This commit is contained in:
ChristianKuehnel 2018-02-24 00:19:14 +01:00 committed by Fabian Affolter
parent 8729f5a024
commit 3c762ed166
3 changed files with 98 additions and 0 deletions

View File

@ -0,0 +1,58 @@
---
layout: page
title: "BMW connected drive"
description: "Instructions on how to setup your BMW connected drive account with Home Assistant."
date: 2018-01-10 23:00
sidebar: true
comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Other
ha_release: 0.64
---
This component lets you retrieve data on your BMW vehicle from the BMW Connected Drive portal. You need to have a working BMW Connected Drive account and a Connected Drive enabled vehicle for this to work.
For compatibility with your BMW vehicle check the (bimmer_connected page)[https://github.com/ChristianKuehnel/bimmer_connected] on github.
To enable this component in your installation, add the following to your
`configuration.yaml` file:
```yaml
# Example configuration.yaml entry
bmw_connected_drive:
mycar:
name: Car 1
username: USERNAME_BMW_CONNECTED_DRIVE
password: PASSWORD_BMW_CONNECTED_DRIVE
country: COUNTRY_BMW_CONNECTED_DRIVE
```
{% 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
country:
description: "The country of your Connected Drive account. Please use the exact names for the country as listed on the [Connected Drive website](https://www.bmw-connecteddrive.com/)."
required: true
type: string
{% endconfiguration %}
# {% linkable_title Disclaimer
This software is not affiliated with or endorsed by BMW Group.

View File

@ -0,0 +1,20 @@
---
layout: page
title: "BMW connected drive"
description: "Instructions on how to setup your BMW connected drive account with Home Assistant."
date: 2018-01-10 23:00
sidebar: true
comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Other
ha_release: 0.64
---
The `bmw_connected_drive` platform allows you to import data on your BMW into Home Assistant.
The device tracker platform will be automatically configured if the `bmw_connected_drive` component is configured.
For more configuration information see the [`bmw_connected_drive` component](/components/bmw_connected_drive/) documentation.

View File

@ -0,0 +1,20 @@
---
layout: page
title: "BMW connected drive"
description: "Instructions on how to setup your BMW connected drive account with Home Assistant."
date: 2018-01-10 23:00
sidebar: true
comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Other
ha_release: 0.64
---
The `bmw_connected_drive` platform allows you to import data on your BMW into Home Assistant.
The sensors will be automatically configured if the `bmw_connected_drive` component is configured.
For more configuration information see the [`bmw_connected_drive` component](/components/bmw_connected_drive/) documentation.