Automatic push documentation (home-assistant#2553)

emlove · balloob · commit ec26660cf6b3 · 2017-05-02T21:21:12.000-07:00
* Automatic push documentation

* Example event automation

* Use event trigger built-in checking
diff --git a/source/_components/device_tracker.automatic.markdown b/source/_components/device_tracker.automatic.markdown
@@ -10,12 +10,15 @@ footer: true
 logo: automatic.png
 ha_category: Presence Detection
 ha_release: 0.28
+ha_iot_class: "Cloud Push"
 ---
 
 
 The `automatic` platform offers presence detection by retrieving your car's information from the [Automatic](http://automatic.com/) cloud service.
 
-To use an Automatic ODB reader in your installation, add the following to your `configuration.yaml` file:
+To use Automatic with Home Assistant, first you must [create a free development account](https://developer.automatic.com/). Automatic will generate a Client ID and Secret for you to use in your Home Assistant configuration. You will also need to update your Event Delivery preferences to ensure Home Assistant can receive updates. On the developer page, under App Settings / Event Delivery, select "Websocket" for Event Delivery Preference.
+
+Once your developer account is created, add the following to your `configuration.yaml` file:
 
 ```yaml
 # Example configuration.yaml entry
@@ -38,4 +41,19 @@ Configuration variables:
 - **password** (*Required*): The password for your given ODB reader account.
 - **devices** (*Optional*): The list of vehicle display names you wish to track. If not provided, all vehicles will be tracked.
 
+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
+# Example automatic event automation
+automation:
+  - trigger: 
+      - platform: event
+        event_type: automatic_update
+        event_data:
+          type: "ignition:on"
+    action:
+      - service: light.turn_off
+```
+
 See the [device tracker component page](/components/device_tracker/) for instructions how to configure the cars to be tracked.
