Clarify which name to put in devices (#11715)

* Clarify which name to but in devices

When setting up Automatic, I found it confusing which name to put in the `devices` section, and put the nickname in, which broke the integration. Added a note to clarify for future users.

* Resolve @frenck suggestions.

Yeah, I figured the tone was a bit too playful. Figured I'd give it a go though.

Co-Authored-By: Franck Nijhof <frenck@frenck.nl>

* Resolve @frenck suggestions.

Co-Authored-By: Franck Nijhof <frenck@frenck.nl>

Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
heytcass 2020-01-13 08:48:41 -05:00 committed by Franck Nijhof
parent 12f0edd892
commit 46dfa1f959

View File

@ -53,6 +53,12 @@ devices:
type: list
{% endconfiguration %}
<div class='note'>
The device name must be the name given by Automatic automatically. This is typically the model year, make and model. This is *not* the nickname you have to give the vehicle in the `vehicles` section of the app's settings.
</div>
Home Assistant will also fire events when an update is received from Automatic. These can be used to trigger automations, as shown in the example below. A list of available event types can be found in the [Automatic Real-Time Events documentation](https://developer.automatic.com/api-reference/#real-time-events).
```yaml