Skip to content

Commit 85fcddb

Browse files
fabafffabaff
authored
Update configuration description style (home-assistant#3994)
1 parent 8dba934 commit 85fcddb

9 files changed

+160
-56
lines changed

‎source/_components/sensor.bitcoin.markdown

Lines changed: 54 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -27,29 +27,58 @@ sensor:
2727
- trade_volume_btc
2828
```
2929
30-
Configuration variables:
31-
32-
- **currency** (*Optional*): The currency to exchange to, eg. CHF, USD, EUR, etc. Default is USD.
33-
- **display_options** array (*Required*): Options to display in the frontend.
34-
- **exchangerate**: Exchange rate of 1 BTC
35-
- **trade_volume_btc**: Trade volume
36-
- **miners_revenue_usd**: Miners revenue
37-
- **btc_mined**: BTC mined
38-
- **trade_volume_usd**: Trade volume in USD
39-
- **difficulty**: Difficulty
40-
- **minutes_between_blocks**: Time between blocks in minutes
41-
- **number_of_transactions**: Number of transactions
42-
- **hash_rate**: Hash rate in PH/s
43-
- **timestamp**: Timestamp
44-
- **mined_blocks**: Minded Blocks
45-
- **blocks_size**: Block size
46-
- **total_fees_btc**: Total fees in BTC
47-
- **total_btc_sent**: Total sent in BTC
48-
- **estimated_btc_sent**: Estimated sent in BTC
49-
- **total_btc**: Total of BTC
50-
- **total_blocks**: Total Blocks
51-
- **next_retarget**: Next retarget
52-
- **estimated_transaction_volume_usd**: Estimated transaction volume in BTC
53-
- **miners_revenue_btc**: Miners revenue in BTC
54-
- **market_price_usd**: Market price in USD
30+
{% configuration %}
31+
currency:
32+
description: The currency to exchange to, eg. CHF, USD, EUR, etc.
33+
required: false
34+
type: string
35+
default: USD
36+
display_options:
37+
description: Options to display in the frontend.
38+
required: true
39+
type: map
40+
keys:
41+
exchangerate:
42+
description: Exchange rate of 1 BTC
43+
trade_volume_btc:
44+
description: Trade volume
45+
miners_revenue_usd:
46+
description: Miners revenue
47+
btc_mined:
48+
description: BTC mined
49+
trade_volume_usd:
50+
description: Trade volume in USD
51+
difficulty:
52+
description: Difficulty
53+
minutes_between_blocks:
54+
description: Time between blocks in minutes
55+
number_of_transactions:
56+
description: Number of transactions
57+
hash_rate:
58+
description: Hash rate in PH/s
59+
timestamp:
60+
description: Timestamp
61+
mined_blocks:
62+
description: Minded Blocks
63+
blocks_size:
64+
description: Block size
65+
total_fees_btc:
66+
description: Total fees in BTC
67+
total_btc_sent:
68+
description: Total sent in BTC
69+
estimated_btc_sent:
70+
description: Estimated sent in BTC
71+
total_btc:
72+
description: Total of BTC
73+
total_blocks:
74+
description: Total Blocks
75+
next_retarget:
76+
description: Next retarget
77+
estimated_transaction_volume_usd:
78+
description: Estimated transaction volume in BTC
79+
miners_revenue_btc:
80+
description: Miners revenue in BTC
81+
market_price_usd:
82+
description: Market price in USD
83+
{% endconfiguration %}
5584

‎source/_components/sensor.blockchain.markdown

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,10 @@ sensor:
2727
- '183J5pXWqYYsxZ7inTVw9tEpejDXyMFroe'
2828
```
2929
30-
Configuration variables:
31-
32-
- **addresses** (*Required*): List of bitcoin wallet addresses to watch.
30+
{% configuration %}
31+
addresses:
32+
description: List of bitcoin wallet addresses to watch.
33+
required: true
34+
type: string, list
35+
{% endconfiguration %}
3336

‎source/_components/sensor.coinmarketcap.markdown

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,18 @@ sensor:
2424
- platform: coinmarketcap
2525
```
2626
27-
Configuration variables:
27+
{% configuration %}
28+
currency:
29+
description: The cryptocurrency to use.
30+
required: false
31+
type: string, list
32+
default: Bitcoin
33+
display_currency:
34+
description: The currency to display.
35+
required: false
36+
type: string, list
37+
default: USD
38+
{% endconfiguration %}
39+
40+
All supported currencies can be found [here](https://coinmarketcap.com/api/).
2841
29-
- **currency** (*Optional*): The cryptocurrency to use, eg. `bitcoin`, `litecoin`, `steem`, etc. Default is `bitcoin`.
30-
- **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/).

‎source/_components/sensor.currencylayer.markdown

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,20 @@ sensor:
3131
- INR
3232
```
3333
34-
Configuration variables:
34+
{% configuration %}
35+
api_key:
36+
description: "The API Key from [Currencylayer](https://currencylayer.com/)."
37+
required: true
38+
type: string
39+
quote:
40+
description: The symbol(s) of the quote or target currencies.
41+
required: false
42+
type: string, list
43+
default: Exchange rate
44+
base:
45+
description: The symbol of the base currency.
46+
required: false
47+
type: string
48+
default: USD
49+
{% endconfiguration %}
3550
36-
- **api_key** (*Required*): API Key from [Currencylayer](https://currencylayer.com/).
37-
- **base** (*Optional*): The symbol of the base currency. Defaults to USD.
38-
- **quote** (*Required*): The symbol(s) of the quote or target currencies.

‎source/_components/sensor.etherscan.markdown

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,15 @@ sensor:
2525
address: '0xfB6916095ca1df60bB79Ce92cE3Ea74c37c5d359'
2626
```
2727
28-
Configuration variables:
28+
{% configuration %}
29+
address:
30+
description: Ethereum wallet address to watch.
31+
required: true
32+
type: string
33+
name:
34+
description: The name of the sensor used in the frontend.
35+
required: false
36+
type: string
37+
default: Ethereum Balance
38+
{% endconfiguration %}
2939
30-
- **address** (*Required*): Ethereum wallet address to watch.
31-
- **name** (*Optional*): The name of the sensor used in the frontend.

‎source/_components/sensor.fixer.markdown

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,19 @@ sensor:
2727
target: CHF
2828
```
2929
30-
Configuration variables:
31-
32-
- **target** (*Required*): The symbol of the target currency.
33-
- **name** (*Optional*): Name to use in the frontend.
34-
- **base** (*Optional*): The symbol of the base currency. Default to USD
35-
30+
{% configuration %}
31+
target:
32+
description: The symbol of the target currency.
33+
required: true
34+
type: string
35+
name:
36+
description: Name to use in the frontend.
37+
required: false
38+
type: string
39+
default: Exchange rate
40+
base:
41+
description: The symbol of the base currency.
42+
required: false
43+
type: string
44+
default: USD
45+
{% endconfiguration %}

‎source/_components/sensor.openexchangerates.markdown

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,24 @@ sensor:
2828
quote: EUR
2929
```
3030
31-
Configuration variables:
31+
{% configuration %}
32+
name:
33+
description: The name of the sensor.
34+
required: false
35+
type: string
36+
default: Exchange Rate Sensor
37+
api_key:
38+
description: "The API Key for [Open Exchange Rates](https://openexchangerates.org)."
39+
required: true
40+
type: string
41+
quote:
42+
description: The symbol of the quote or target currency.
43+
required: true
44+
type: string
45+
base:
46+
description: The symbol of the base currency.
47+
required: false
48+
type: string
49+
default: USD
50+
{% endconfiguration %}
3251
33-
- **api_key** (*Required*): API Key for [Open Exchange Rates](https://openexchangerates.org).
34-
- **quote** (*Required*): The symbol of the quote or target currency.
35-
- **name** (*Optional*): Name to use in the frontend.
36-
- **base** (*Optional*): The symbol of the base currency. Defaults to USD.

‎source/_components/sensor.ripple.markdown

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,15 @@ sensor:
2525
address: 'r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV'
2626
```
2727
28-
Configuration variables:
28+
{% configuration %}
29+
address:
30+
description: Ripple wallet address to watch.
31+
required: true
32+
type: string
33+
name:
34+
description: Name for the sensor to use in the frontend.
35+
required: false
36+
type: string
37+
default: Ripple Balance
38+
{% endconfiguration %}
2939
30-
- **address** (*Required*): Ripple wallet address to watch
31-
- **name** (*Optional*): Name for the sensor to use in the frontend.

‎source/_components/sensor.yahoo_finance.markdown

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,18 @@ sensor:
2424
- platform: yahoo_finance
2525
```
2626
27-
Configuration variables:
28-
29-
- **name** (*Optional*): The name of the sensor. If not specified, it defaults to *Yahoo Stock*.
30-
- **symbols** array (*Optional*): List of stock market symbols for given companies. If not specified, it defaults to *Yahoo (YHOO)*.
27+
{% configuration %}
28+
name:
29+
description: The name of the sensor.
30+
required: false
31+
type: string
32+
default: Yahoo Stock
33+
symbols:
34+
description: List of stock market symbols for given companies.
35+
required: false
36+
type: string, list
37+
default: YHOO
38+
{% endconfiguration %}
3139
3240
## {% linkable_title Examples %}
3341

0 commit comments

Comments
 (0)