From 8a386143a4a1a688cac51f7cf8f564e80bdad0fa Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Fri, 30 Sep 2016 20:56:33 +0200 Subject: [PATCH] Minimizing of the configuration sample (#1017) --- source/_components/sensor.bitcoin.markdown | 1 - source/_components/sensor.coinmarketcap.markdown | 1 - source/_components/sensor.fixer.markdown | 8 +++----- .../_components/sensor.openexchangerates.markdown | 6 ++---- source/_components/sensor.yahoo_finance.markdown | 15 +++++++++++---- 5 files changed, 16 insertions(+), 15 deletions(-) diff --git a/source/_components/sensor.bitcoin.markdown b/source/_components/sensor.bitcoin.markdown index 610f8b3ecae..23aba6ca31f 100644 --- a/source/_components/sensor.bitcoin.markdown +++ b/source/_components/sensor.bitcoin.markdown @@ -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 diff --git a/source/_components/sensor.coinmarketcap.markdown b/source/_components/sensor.coinmarketcap.markdown index 32c521a62d8..38bbf0a1efa 100644 --- a/source/_components/sensor.coinmarketcap.markdown +++ b/source/_components/sensor.coinmarketcap.markdown @@ -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: diff --git a/source/_components/sensor.fixer.markdown b/source/_components/sensor.fixer.markdown index 7cedf440926..ce9071e4bcd 100644 --- a/source/_components/sensor.fixer.markdown +++ b/source/_components/sensor.fixer.markdown @@ -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. diff --git a/source/_components/sensor.openexchangerates.markdown b/source/_components/sensor.openexchangerates.markdown index ad86aa02ddb..63e94b74a85 100644 --- a/source/_components/sensor.openexchangerates.markdown +++ b/source/_components/sensor.openexchangerates.markdown @@ -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. diff --git a/source/_components/sensor.yahoo_finance.markdown b/source/_components/sensor.yahoo_finance.markdown index 99411c3ff41..022be8804cd 100644 --- a/source/_components/sensor.yahoo_finance.markdown +++ b/source/_components/sensor.yahoo_finance.markdown @@ -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 ``` +