mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-16 05:46:52 +00:00
Update configuration describtion style (#3991)
This commit is contained in:
parent
7d2980bbe6
commit
d40b9ff36f
@ -26,7 +26,10 @@ binary_sensor:
|
||||
- 'coreos-512mb-nyc3-01'
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **droplets** (*Required*): List of droplets you want to control.
|
||||
{% configuration %}
|
||||
droplets:
|
||||
description: List of droplets you want to monitor.
|
||||
required: true
|
||||
type: list
|
||||
{% endconfiguration %}
|
||||
|
||||
|
@ -25,9 +25,13 @@ binary_sensor:
|
||||
- platform: iss
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **show_on_map** (*Optional*): Option to show the position of the ISS on the map. Defaults to `False`.
|
||||
{% configuration %}
|
||||
show_on_map:
|
||||
description: Option to show the position of the ISS on the map.
|
||||
required: optionsl
|
||||
default: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
<p class='note warning'>
|
||||
If you set `show_on_map` `True` then the location attributes are named `latitude` and `longitude`. The default name of the location attributes is `lat` and `long` to avoid showing them on the map.
|
||||
|
@ -25,10 +25,10 @@ binary_sensor:
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
name:
|
||||
description: Name to use in the frontend.
|
||||
required: false
|
||||
type: string
|
||||
name:
|
||||
description: Name to use in the frontend.
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
See the [entity component options](/docs/configuration/platform_options/) to control how often the main component polls the random binary sensor. The default is 30 seconds.
|
||||
|
@ -26,6 +26,10 @@ digital_ocean:
|
||||
access_token: YOUR_API_KEY
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
{% configuration %}
|
||||
access_token:
|
||||
description: Your Digital Ocean API access token.
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
- **access_token** (*Required*): Your Digital Ocean API access token.
|
||||
|
@ -24,12 +24,27 @@ sensor:
|
||||
- platform: random
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **name** (*Optional*): Name of the sensor to use in the frontend. Defaults to `Random Sensor`.
|
||||
- **minimum** (*Optional*): Lower limit for the values. Defaults to `0`.
|
||||
- **maximum** (*Optional*): Upper limit for the values. Defaults to `20`.
|
||||
- **unit_of_measurement** (*Optional*): Defines the units of measurement of the sensor, if any.
|
||||
{% configuration %}
|
||||
name:
|
||||
description: Name to use in the frontend.
|
||||
required: false
|
||||
type: string
|
||||
default: Random Sensor
|
||||
minimum:
|
||||
description: Lower limit for the values.
|
||||
required: false
|
||||
type: string
|
||||
default: 0
|
||||
maximum:
|
||||
description: Upper limit for the values.
|
||||
required: false
|
||||
type: int
|
||||
default: 20
|
||||
unit_of_measurement:
|
||||
description: Defines the units of measurement of the sensor, if any.
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
See the [entity component options][entity-docs] to control how often the main component polls the random sensor. The default is 30 seconds.
|
||||
|
||||
|
@ -26,7 +26,10 @@ switch:
|
||||
- 'coreos-512mb-nyc3-01'
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **droplets** (*Required*): List of droplets you want to control.
|
||||
{% configuration %}
|
||||
droplets:
|
||||
description: List of droplets you want to control.
|
||||
required: true
|
||||
type: list
|
||||
{% endconfiguration %}
|
||||
|
||||
|
@ -22,10 +22,17 @@ weather:
|
||||
- platform: bom
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **name** (*Optional*): The name you would like to give to the weather station.
|
||||
- **station** (*Optional*): The station ID string; defaults to the closest station. See the [`sensor.bom` docs](/components/sensor.bom/) for details on how to find the ID of a station.
|
||||
{% configuration %}
|
||||
name:
|
||||
description: The name you would like to give to the weather station.
|
||||
required: optional
|
||||
type: string
|
||||
station:
|
||||
description: "The station ID string. See the [`sensor.bom` docs](/components/sensor.bom/) for details on how to find the ID of a station."
|
||||
required: optional
|
||||
default: The closest station
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
<p class='note'>
|
||||
This platform is an alternative to the [`bom`](/components/sensor.bom/) sensor.
|
||||
|
Loading…
x
Reference in New Issue
Block a user