mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-10 10:56:49 +00:00
Update configuration description style (#3994)
This commit is contained in:
parent
8dba93493a
commit
85fcddbf17
@ -27,29 +27,58 @@ sensor:
|
||||
- trade_volume_btc
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **currency** (*Optional*): The currency to exchange to, eg. CHF, USD, EUR, etc. Default is USD.
|
||||
- **display_options** array (*Required*): Options to display in the frontend.
|
||||
- **exchangerate**: Exchange rate of 1 BTC
|
||||
- **trade_volume_btc**: Trade volume
|
||||
- **miners_revenue_usd**: Miners revenue
|
||||
- **btc_mined**: BTC mined
|
||||
- **trade_volume_usd**: Trade volume in USD
|
||||
- **difficulty**: Difficulty
|
||||
- **minutes_between_blocks**: Time between blocks in minutes
|
||||
- **number_of_transactions**: Number of transactions
|
||||
- **hash_rate**: Hash rate in PH/s
|
||||
- **timestamp**: Timestamp
|
||||
- **mined_blocks**: Minded Blocks
|
||||
- **blocks_size**: Block size
|
||||
- **total_fees_btc**: Total fees in BTC
|
||||
- **total_btc_sent**: Total sent in BTC
|
||||
- **estimated_btc_sent**: Estimated sent in BTC
|
||||
- **total_btc**: Total of BTC
|
||||
- **total_blocks**: Total Blocks
|
||||
- **next_retarget**: Next retarget
|
||||
- **estimated_transaction_volume_usd**: Estimated transaction volume in BTC
|
||||
- **miners_revenue_btc**: Miners revenue in BTC
|
||||
- **market_price_usd**: Market price in USD
|
||||
{% configuration %}
|
||||
currency:
|
||||
description: The currency to exchange to, eg. CHF, USD, EUR, etc.
|
||||
required: false
|
||||
type: string
|
||||
default: USD
|
||||
display_options:
|
||||
description: Options to display in the frontend.
|
||||
required: true
|
||||
type: map
|
||||
keys:
|
||||
exchangerate:
|
||||
description: Exchange rate of 1 BTC
|
||||
trade_volume_btc:
|
||||
description: Trade volume
|
||||
miners_revenue_usd:
|
||||
description: Miners revenue
|
||||
btc_mined:
|
||||
description: BTC mined
|
||||
trade_volume_usd:
|
||||
description: Trade volume in USD
|
||||
difficulty:
|
||||
description: Difficulty
|
||||
minutes_between_blocks:
|
||||
description: Time between blocks in minutes
|
||||
number_of_transactions:
|
||||
description: Number of transactions
|
||||
hash_rate:
|
||||
description: Hash rate in PH/s
|
||||
timestamp:
|
||||
description: Timestamp
|
||||
mined_blocks:
|
||||
description: Minded Blocks
|
||||
blocks_size:
|
||||
description: Block size
|
||||
total_fees_btc:
|
||||
description: Total fees in BTC
|
||||
total_btc_sent:
|
||||
description: Total sent in BTC
|
||||
estimated_btc_sent:
|
||||
description: Estimated sent in BTC
|
||||
total_btc:
|
||||
description: Total of BTC
|
||||
total_blocks:
|
||||
description: Total Blocks
|
||||
next_retarget:
|
||||
description: Next retarget
|
||||
estimated_transaction_volume_usd:
|
||||
description: Estimated transaction volume in BTC
|
||||
miners_revenue_btc:
|
||||
description: Miners revenue in BTC
|
||||
market_price_usd:
|
||||
description: Market price in USD
|
||||
{% endconfiguration %}
|
||||
|
||||
|
@ -27,7 +27,10 @@ sensor:
|
||||
- '183J5pXWqYYsxZ7inTVw9tEpejDXyMFroe'
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **addresses** (*Required*): List of bitcoin wallet addresses to watch.
|
||||
{% configuration %}
|
||||
addresses:
|
||||
description: List of bitcoin wallet addresses to watch.
|
||||
required: true
|
||||
type: string, list
|
||||
{% endconfiguration %}
|
||||
|
||||
|
@ -24,7 +24,18 @@ sensor:
|
||||
- platform: coinmarketcap
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
{% configuration %}
|
||||
currency:
|
||||
description: The cryptocurrency to use.
|
||||
required: false
|
||||
type: string, list
|
||||
default: Bitcoin
|
||||
display_currency:
|
||||
description: The currency to display.
|
||||
required: false
|
||||
type: string, list
|
||||
default: USD
|
||||
{% endconfiguration %}
|
||||
|
||||
All supported currencies can be found [here](https://coinmarketcap.com/api/).
|
||||
|
||||
- **currency** (*Optional*): The cryptocurrency to use, eg. `bitcoin`, `litecoin`, `steem`, etc. Default is `bitcoin`.
|
||||
- **display_currency** (*Optional*): The currency to display, eg. `USD`, `EUR`, `GBP`, etc. Default is `USD`. All supported currencies can be found [here](https://coinmarketcap.com/api/).
|
||||
|
@ -31,8 +31,20 @@ sensor:
|
||||
- INR
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
{% configuration %}
|
||||
api_key:
|
||||
description: "The API Key from [Currencylayer](https://currencylayer.com/)."
|
||||
required: true
|
||||
type: string
|
||||
quote:
|
||||
description: The symbol(s) of the quote or target currencies.
|
||||
required: false
|
||||
type: string, list
|
||||
default: Exchange rate
|
||||
base:
|
||||
description: The symbol of the base currency.
|
||||
required: false
|
||||
type: string
|
||||
default: USD
|
||||
{% endconfiguration %}
|
||||
|
||||
- **api_key** (*Required*): API Key from [Currencylayer](https://currencylayer.com/).
|
||||
- **base** (*Optional*): The symbol of the base currency. Defaults to USD.
|
||||
- **quote** (*Required*): The symbol(s) of the quote or target currencies.
|
||||
|
@ -25,7 +25,15 @@ sensor:
|
||||
address: '0xfB6916095ca1df60bB79Ce92cE3Ea74c37c5d359'
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
{% configuration %}
|
||||
address:
|
||||
description: Ethereum wallet address to watch.
|
||||
required: true
|
||||
type: string
|
||||
name:
|
||||
description: The name of the sensor used in the frontend.
|
||||
required: false
|
||||
type: string
|
||||
default: Ethereum Balance
|
||||
{% endconfiguration %}
|
||||
|
||||
- **address** (*Required*): Ethereum wallet address to watch.
|
||||
- **name** (*Optional*): The name of the sensor used in the frontend.
|
||||
|
@ -27,9 +27,19 @@ sensor:
|
||||
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
|
||||
|
||||
{% configuration %}
|
||||
target:
|
||||
description: The symbol of the target currency.
|
||||
required: true
|
||||
type: string
|
||||
name:
|
||||
description: Name to use in the frontend.
|
||||
required: false
|
||||
type: string
|
||||
default: Exchange rate
|
||||
base:
|
||||
description: The symbol of the base currency.
|
||||
required: false
|
||||
type: string
|
||||
default: USD
|
||||
{% endconfiguration %}
|
||||
|
@ -28,9 +28,24 @@ sensor:
|
||||
quote: EUR
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
{% configuration %}
|
||||
name:
|
||||
description: The name of the sensor.
|
||||
required: false
|
||||
type: string
|
||||
default: Exchange Rate Sensor
|
||||
api_key:
|
||||
description: "The API Key for [Open Exchange Rates](https://openexchangerates.org)."
|
||||
required: true
|
||||
type: string
|
||||
quote:
|
||||
description: The symbol of the quote or target currency.
|
||||
required: true
|
||||
type: string
|
||||
base:
|
||||
description: The symbol of the base currency.
|
||||
required: false
|
||||
type: string
|
||||
default: USD
|
||||
{% endconfiguration %}
|
||||
|
||||
- **api_key** (*Required*): API Key for [Open Exchange Rates](https://openexchangerates.org).
|
||||
- **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.
|
||||
|
@ -25,7 +25,15 @@ sensor:
|
||||
address: 'r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV'
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
{% configuration %}
|
||||
address:
|
||||
description: Ripple wallet address to watch.
|
||||
required: true
|
||||
type: string
|
||||
name:
|
||||
description: Name for the sensor to use in the frontend.
|
||||
required: false
|
||||
type: string
|
||||
default: Ripple Balance
|
||||
{% endconfiguration %}
|
||||
|
||||
- **address** (*Required*): Ripple wallet address to watch
|
||||
- **name** (*Optional*): Name for the sensor to use in the frontend.
|
||||
|
@ -24,10 +24,18 @@ sensor:
|
||||
- platform: yahoo_finance
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **name** (*Optional*): The name of the sensor. If not specified, it defaults to *Yahoo Stock*.
|
||||
- **symbols** array (*Optional*): List of stock market symbols for given companies. If not specified, it defaults to *Yahoo (YHOO)*.
|
||||
{% configuration %}
|
||||
name:
|
||||
description: The name of the sensor.
|
||||
required: false
|
||||
type: string
|
||||
default: Yahoo Stock
|
||||
symbols:
|
||||
description: List of stock market symbols for given companies.
|
||||
required: false
|
||||
type: string, list
|
||||
default: YHOO
|
||||
{% endconfiguration %}
|
||||
|
||||
## {% linkable_title Examples %}
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user