Minimizing of the configuration sample (#1017)

This commit is contained in:
Fabian Affolter 2016-09-30 20:56:33 +02:00 committed by GitHub
parent 1abe7da82c
commit 8a386143a4
5 changed files with 16 additions and 15 deletions

View File

@ -22,7 +22,6 @@ To add the Bitcoin sensor to your installation, add a selection of the available
# Example configuration.yaml entry
sensor:
platform: bitcoin
currency: YOUR CURRENCY
display_options:
- exchangerate
- trade_volume_btc

View File

@ -21,7 +21,6 @@ To add the CoinMarketCap sensor to your installation, add the following lines to
# Example configuration.yaml entry
sensor:
- platform: coinmarketcap
currency: bitcoin
```
Configuration variables:

View File

@ -23,15 +23,13 @@ To enable this sensor, add the following lines to your `configuration.yaml` file
```yaml
# Example configuration.yaml entry
sensor:
platform: fixer
name: EUR
base: EUR
target: CHF
- platform: fixer
target: CHF
```
Configuration variables:
- **target** (*Required*): The symbol of the target currency.
- **name** (*Optional*): Name to use in the frontend.
- **base** (*Optional*): The symbol of the base currency. Default to USD
- **target** (*Required*): The symbol of the target currency.

View File

@ -25,14 +25,12 @@ To enable this sensor, add the following lines to your `configuration.yaml` file
sensor:
- platform: openexchangerates
api_key: YOUR_API_KEY
base: USD
quote: EUR
name: USDEUR
```
Configuration variables:
- **api_key** (*Required*): API Key for [Open Exchange Rates](https://openexchangerates.org).
- **name** (*Optional*): Name to use in the frontend.
- **base** (*Optional*): The symbol of the base currency. Defaults to USD
- **quote** (*Required*): The symbol of the quote or target currency.
- **name** (*Optional*): Name to use in the frontend.
- **base** (*Optional*): The symbol of the base currency. Defaults to USD.

View File

@ -22,8 +22,6 @@ To enable the `yahoo_finance` platform, add the following lines to your `configu
# Example configuration.yaml entry
sensor:
- platform: yahoo_finance
name: Red Hat Inc.
symbol: RHT
```
Configuration variables:
@ -31,16 +29,25 @@ Configuration variables:
- **name** (*Optional*): The name of the sensor. If not specified, it defaults to *Yahoo Stock*.
- **symbol** (*Optional*): The stock market symbol for a given company. If not specified, it defaults to *Yahoo (YHOO)*.
Example configuration:
## {% linkable_title Examples %}
In this section you find some real life examples of how to use this sensor.
### {% linkable_title Red Hat %}
```yaml
# Example configuration.yaml entry
sensor:
- platform: yahoo_finance
name: Red Hat Inc.
symbol: RHT
```
### {% linkable_title Google %}
```yaml
sensor:
- platform: yahoo_finance
name: Google
symbol: GOOGL
```