Minimizing of the configuration sample (#1043)

This commit is contained in:
Fabian Affolter 2016-10-02 17:14:35 +02:00 committed by GitHub
parent c840d6bb72
commit c72ec348e4
6 changed files with 33 additions and 26 deletions

View File

@ -21,7 +21,7 @@ To enable this sensor, add the following lines to your `configuration.yaml` file
```yaml
# Example configuration.yaml entry
sensor:
platform: deutsche_bahn
- platform: deutsche_bahn
from: NAME_OF_START_STATION
to: NAME_OF_FINAL_STATION
```

View File

@ -22,13 +22,10 @@ A free API Key allows 2500 requests per day. The sensor will update the travel t
```yaml
# Example entry for configuration.yaml
sensor:
platform: google_travel_time
name: Google Travel Time
- platform: google_travel_time
api_key: XXXX_XXXXX_XXXXX
origin: Trondheim, Norway
destination: Paris, France
options:
...
```
Configuration variables:

View File

@ -41,7 +41,7 @@ Your mileage may vary depending on the transit agency used. Most agencies respec
```yaml
# Example configuration.yaml entry
sensor:
platform: gtfs
- platform: gtfs
origin: STOP_ID
destination: STOP_ID
data: DATA_SOURCE

View File

@ -25,7 +25,7 @@ If the score is 100 ("score":"100" in the response), it is a perfect match. Then
```yaml
# Example configuration.yaml entry
sensor:
platform: swiss_public_transport
- platform: swiss_public_transport
from: STATION_ID
to: STATION_ID
```

View File

@ -40,8 +40,7 @@ Add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
platform: torque
name: Your Vehicle Name
- platform: torque
email: your_configured@email.com
```

View File

@ -24,7 +24,27 @@ To enable this sensor, add the following lines to your `configuration.yaml` file
```yaml
# Example configuration.yaml entry
sensor:
platform: uber
- platform: uber
server_token: 'BeAPPTDsWZSHLf7fd9OWjZkIezweRw18Q8NltY27'
start_latitude: 37.8116380
start_longitude: -122.2648050
```
Configuration variables:
- **server_token** (*Required*): A server token obtained from [developer.uber.com](https://developer.uber.com) after [creating an app](https://developer.uber.com/dashboard/create).
- **start_latitude** (*Required*): The starting latitude for a trip.
- **start_longitude** (*Required*): The starting longitude for a trip.
- **end_latitude** (*Optional*): The ending latitude for a trip. While `end_latitude` is optional, it is strongly recommended to provide an `end_latitude`/`end_longitude` when possible as you will get more accurate price and time estimates.
- **end_longitude** (*Optional*): The ending longitude for a trip. While `end_longitude` is optional, it is strongly recommended to provide an `end_latitude`/`end_longitude` when possible as you will get more accurate price and time estimates.
- **product_ids** (*Options*): A list of Uber product UUIDs. If provided, sensors will only be created for the given product IDs. Please note that product IDs are region and some times even more specific geographies based. The easiest way to find a UUID is to click on a sensor in the Home Assistant frontend and look for "Product ID" in the attributes.
A full configuration entry could look like the sample below:
```yaml
# Example configuration.yaml entry
sensor:
- platform: uber
start_latitude: 37.8116380
start_longitude: -122.2648050
end_latitude: 37.7768520
@ -33,12 +53,3 @@ sensor:
product_ids:
- '04a497f5-380d-47f2-bf1b-ad4cfdcb51f2'
```
Configuration variables:
- **start_latitude** (*Required*): The starting latitude for a trip.
- **start_longitude** (*Required*): The starting longitude for a trip.
- **end_latitude** (*Optional*): The ending latitude for a trip. While `end_latitude` is optional, it is strongly recommended to provide an `end_latitude`/`end_longitude` when possible as you will get more accurate price and time estimates.
- **end_longitude** (*Optional*): The ending longitude for a trip. While `end_longitude` is optional, it is strongly recommended to provide an `end_latitude`/`end_longitude` when possible as you will get more accurate price and time estimates.
- **server_token** (*Required*): A server token obtained from [developer.uber.com](https://developer.uber.com) after [creating an app](https://developer.uber.com/dashboard/create).
- **product_ids** (*Options*): A list of Uber product UUIDs. If provided, sensors will only be created for the given product IDs. Please note that product IDs are region and some times even more specific geographies based. The easiest way to find a UUID is to click on a sensor in the Home Assistant frontend and look for "Product ID" in the attributes.