Skip to content

Commit 42842f6

Browse files
frenckfrenck
authored
Collection of configuration block fixes (home-assistant#9874)
1 parent 5902df1 commit 42842f6

File tree

105 files changed

+202
-179
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

105 files changed

+202
-179
lines changed

‎source/_components/airvisual.markdown

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -35,44 +35,44 @@ sensor:
3535
{% configuration %}
3636
api_key:
3737
description: Your AirVisual API key.
38-
required: required
38+
required: true
3939
type: string
4040
monitored_conditions:
4141
description: "The air quality standard(s) to use (`us` for U.S., `cn` for Chinese)."
42-
required: required
42+
required: true
4343
type: list
4444
default: ['us', 'cn']
4545
show_on_map:
4646
description: "Whether to show a marker on the map at the specified location."
47-
required: optional
47+
required: false
4848
type: boolean
4949
default: true
5050
scan_interval:
5151
description: "The rate in seconds at which AirVisual should be polled for new data."
52-
required: optional
52+
required: false
5353
type: integer
5454
default: 600
5555
latitude:
5656
description: The latitude of the location to monitor.
57-
required: optional
57+
required: false
5858
type: string
5959
default: "The latitude defined under the `homeassistant` key in `configuration.yaml`."
6060
longitude:
6161
description: The longitude of the location to monitor.
62-
required: optional
62+
required: false
6363
type: string
6464
default: "The longitude defined under the `homeassistant` key in `configuration.yaml`."
6565
city:
6666
description: The city to monitor.
67-
required: optional
67+
required: false
6868
type: string
6969
state:
7070
description: The state the city belongs to.
71-
required: optional
71+
required: false
7272
type: string
7373
country:
7474
description: The country the state belongs to.
75-
required: optional
75+
required: false
7676
type: string
7777
{% endconfiguration %}
7878

‎source/_components/alarm_control_panel.mqtt.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ device:
129129
identifiers:
130130
description: 'A list of IDs that uniquely identify the device. For example a serial number.'
131131
required: false
132-
type: list, string
132+
type: [list, string]
133133
connections:
134134
description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.'
135135
required: false

‎source/_components/alert.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ repeat:
6464
Number of minutes before the notification should be repeated.
6565
Can be either a number or a list of numbers.
6666
required: true
67-
type: [int, list]
67+
type: [integer, list]
6868
can_acknowledge:
6969
description: Allows the alert to be unacknowledgeable.
7070
required: false

‎source/_components/alpha_vantage.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ symbols:
5151
default: USD
5252
symbol:
5353
description: The stock market symbol for the given company.
54-
required: required
54+
required: true
5555
type: string
5656
foreign_exchange:
5757
description: List of currencies.
@@ -64,11 +64,11 @@ foreign_exchange:
6464
type: string
6565
from:
6666
description: The source currency.
67-
required: required
67+
required: true
6868
type: string
6969
to:
7070
description: The target currency.
71-
required: required
71+
required: true
7272
type: string
7373
{% endconfiguration %}
7474

‎source/_components/amazon_polly.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ profile_name:
4646
region_name:
4747
description: The region identifier to connect to.
4848
required: false
49-
type: string or list
49+
type: [string, list]
5050
default: us-east-1
5151
name:
5252
description: "Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`."

‎source/_components/ambient_station.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ app_key:
4242
type: string
4343
monitored_conditions:
4444
description: Weather conditions to track.
45-
required: optional
45+
required: false
4646
type: list
4747
keys:
4848
24hourrainin:

‎source/_components/android_ip_webcam.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,7 @@ motion_sensor:
122122
description: Activate motion sensor if `auto_discovery` is disabled.
123123
required: false
124124
type: boolean
125+
default: false
125126
{% endconfiguration %}
126127

127128
<div class='note'>

‎source/_components/androidtv.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ adb_server_port:
7676
description: The port for the ADB server.
7777
required: false
7878
default: 5037
79-
type: port
79+
type: integer
8080
get_sources:
8181
description: Whether or not to retrieve the running apps as the list of sources for Fire TV devices; not used for Android TV devices.
8282
required: false
@@ -86,7 +86,7 @@ apps:
8686
description: A dictionary where the keys are app IDs and the values are app names that will be displayed in the UI; see example below.
8787
required: false
8888
default: {}
89-
type: dict
89+
type: map
9090
device_class:
9191
description: "The type of device: `auto` (detect whether it is an Android TV or Fire TV device), `androidtv`, or `firetv`."
9292
required: false

‎source/_components/apple_tv.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ start_off:
6666
description: Set to true if the device should start in fake standby.
6767
required: false
6868
type: boolean
69+
default: false
6970
credentials:
7071
description: Credentials used for AirPlay playback.
7172
required: false

‎source/_components/aqualogic.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ host:
3939
port:
4040
description: The port provided by the RS-485 to Ethernet adapter.
4141
required: true
42-
type: int
42+
type: integer
4343
{% endconfiguration %}
4444
4545
## Sensor

‎source/_components/aquostv.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ port:
3232
description: The port of the Sharp Aquos TV.
3333
required: false
3434
default: 10002
35-
type: int
35+
type: integer
3636
username:
3737
description: The username of the Sharp Aquos TV.
3838
required: false

‎source/_components/arduino.markdown

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ pins:
9292
type: map
9393
keys:
9494
name:
95-
default: Name that will be used in the frontend for the pin.
95+
description: Name that will be used in the frontend for the pin.
9696
type: string
9797
{% endconfiguration %}
9898

@@ -129,16 +129,16 @@ pins:
129129
type: map
130130
keys:
131131
name:
132-
default: Name that will be used in the frontend for the pin.
132+
description: Name that will be used in the frontend for the pin.
133133
type: string
134134
required: false
135135
initial:
136-
default: The initial value for this port.
136+
description: The initial value for this port.
137137
type: boolean
138138
required: false
139139
default: false
140140
negate:
141-
default: If this pin should be inverted.
141+
description: If this pin should be inverted.
142142
type: boolean
143143
required: false
144144
default: false

‎source/_components/arest.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ resource:
214214
type: string
215215
name:
216216
description: Let you overwrite the name of the device. By default *name* from the device is used.
217-
required: optional
217+
required: false
218218
type: string
219219
pins:
220220
description: An array with all used pins.

‎source/_components/aws.markdown

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,12 @@ name:
4242
required: true
4343
type: string
4444
aws_access_key_id:
45-
description: Your AWS Access Key ID. If provided, you must also provide an `aws_secret_access_key` and must **not** provide a `profile_name`.
46-
required: Required if aws_secret_access_key is provided
45+
description: Your AWS Access Key ID. If provided, you must also provide an `aws_secret_access_key` and must **not** provide a `profile_name`. Required if `aws_secret_access_key` is provided.
46+
required: false
4747
type: string
4848
aws_secret_access_key:
49-
description: Your AWS Secret Access Key. If provided, you must also provide an `aws_access_key_id` and must **not** provide a `profile_name`.
50-
required: Required if aws_access_key_id is provided
49+
description: Your AWS Secret Access Key. If provided, you must also provide an `aws_access_key_id` and must **not** provide a `profile_name`. Required if `aws_access_key_id` is provided.
50+
required: false
5151
type: string
5252
profile_name:
5353
description: A credentials profile name.
@@ -80,8 +80,8 @@ aws_access_key_id:
8080
required: false
8181
type: string
8282
aws_secret_access_key:
83-
description: Your AWS Secret Access Key. If provided, you must also provide an `aws_access_key_id`.
84-
required: Required if aws_access_key_id is provided
83+
description: Your AWS Secret Access Key. If provided, you must also provide an `aws_access_key_id`. Required if aws_access_key_id is provided.
84+
required: false
8585
type: string
8686
profile_name:
8787
description: A credentials profile name.

‎source/_components/bayesian.markdown

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -62,12 +62,12 @@ observations:
6262
required: true
6363
type: string
6464
entity_id:
65-
description: Name of the entity to monitor.
66-
required: true (for `state` and `numeric_state`)
65+
description: Name of the entity to monitor. Required for `state` and `numeric_state`.
66+
required: false
6767
type: string
6868
value_template:
69-
description: Defines the template to be used.
70-
required: true (for `template`)
69+
description: Defines the template to be used. Required for `template`.
70+
required: false
7171
type: template
7272
prob_given_true:
7373
description: The probability of the observation occurring, given the event is `true`.
@@ -79,8 +79,8 @@ observations:
7979
type: float
8080
default: "`1 - prob_given_true` if `prob_given_false` is not set"
8181
to_state:
82-
description: The target state.
83-
required: true (for `state`)
82+
description: The target state. Required (for `state`).
83+
required: false
8484
type: string
8585
{% endconfiguration %}
8686

‎source/_components/binary_sensor.mqtt.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,11 +105,11 @@ device:
105105
identifiers:
106106
description: A list of IDs that uniquely identify the device. For example a serial number.
107107
required: false
108-
type: list, string
108+
type: [list, string]
109109
connections:
110110
description: "A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `'connections': ['mac', '02:5b:26:a8:dc:12']`."
111111
required: false
112-
type: list, tuple
112+
type: [list, map]
113113
manufacturer:
114114
description: The manufacturer of the device.
115115
required: false

‎source/_components/binary_sensor.rest.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ verify_ssl:
8888
timeout:
8989
description: Defines max time to wait data from the endpoint.
9090
required: false
91-
type: positive integer
91+
type: integer
9292
default: 10
9393
authentication:
9494
description: "Type of the HTTP authentication. `basic` or `digest`."
@@ -105,7 +105,7 @@ password:
105105
headers:
106106
description: The headers for the requests.
107107
required: false
108-
type: list, string
108+
type: [list, string]
109109
{% endconfiguration %}
110110

111111
<div class='note warning'>

‎source/_components/binary_sensor.rflink.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ devices:
5555
off_delay:
5656
description: For sensors that only sends 'On' state updates, this variable sets a delay after which the sensor state will be updated back to 'Off'.
5757
required: false
58-
type: int
58+
type: integer
5959
force_update:
6060
description: Sends update events even if the value has not changed. Useful for sensors that only sends `On`.
6161
required: false

‎source/_components/binary_sensor.template.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ sensors:
4848
entity_id:
4949
description: A list of entity IDs so the sensor only reacts to state changes of these entities. This can be used if the automatic analysis fails to find all relevant entities.
5050
required: false
51-
type: string, list
51+
type: [string, list]
5252
device_class:
5353
description: Sets the [class of the device](/components/binary_sensor/), changing the device state and icon that is displayed on the frontend.
5454
required: false

‎source/_components/bitcoin.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ currency:
3333
display_options:
3434
description: Options to display in the frontend.
3535
required: true
36-
type: map
36+
type: list
3737
keys:
3838
exchangerate:
3939
description: Exchange rate of 1 BTC

‎source/_components/blackbird.markdown

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,17 +39,19 @@ host:
3939
zones:
4040
description: This is the list of zones available. Valid zones are 1, 2, 3, 4, 5, 6, 7, 8. Each zone must have a name assigned to it.
4141
required: true
42-
type: integer
42+
type: map
4343
keys:
44-
name:
44+
ZONE_NUMBER:
4545
description: The name of the zone.
46+
type: string
4647
sources:
4748
description: The list of sources available. Valid source numbers are 1, 2, 3, 4, 5, 6, 7, 8. Each source number corresponds to the input number on the Blackbird matrix switch. Similar to zones, each source must have a name assigned to it.
4849
required: true
49-
type: integer
50+
type: map
5051
keys:
51-
name:
52+
ZONE_NUMBER:
5253
description: The name of the source.
54+
type: string
5355
{% endconfiguration %}
5456

5557
### Service `media_player.blackbird_set_all_zones`

‎source/_components/blockchain.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,6 @@ sensor:
2828
addresses:
2929
description: List of bitcoin wallet addresses to watch.
3030
required: true
31-
type: string, list
31+
type: [string, list]
3232
{% endconfiguration %}
3333

‎source/_components/bom.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,11 @@ weather:
3333
{% configuration %}
3434
name:
3535
description: The name you would like to give to the weather station.
36-
required: optional
36+
required: false
3737
type: string
3838
station:
3939
description: "The station ID string. See the [`sensor.bom` docs](#sensor) for details on how to find the ID of a station."
40-
required: optional
40+
required: false
4141
type: string
4242
default: The closest station
4343
{% endconfiguration %}

‎source/_components/broadlink.markdown

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ name:
4646
description: Sensor name.
4747
required: false
4848
default: Broadlink sensor
49-
type: String
49+
type: string
5050
scan_interval:
5151
description: Time in seconds to fetch data from sensors.
5252
required: false
@@ -155,12 +155,12 @@ friendly_name:
155155
type: string
156156
type:
157157
description: "Switch type. Choose one from: `rm`, `rm2`, `rm_mini`, `rm_pro_phicomm`, `rm2_home_plus`, `rm2_home_plus_gdt`, `rm2_pro_plus`, `rm2_pro_plus2`, `rm2_pro_plus_bl`, `rm_mini_shate`, `sp1`, `sp2`, `honeywell_sp2`, `sp3`, `spmini2`, `spminiplus` or `mp1`. `SC1` devices can be registered as `sp2`."
158-
required: true/false
158+
required: true
159159
type: string
160160
switches:
161161
description: The array that contains all switches.
162162
required: false
163-
type: array
163+
type: map
164164
keys:
165165
identifier:
166166
description: Name of the command switch as slug. Multiple entries are possible.
@@ -182,7 +182,7 @@ switches:
182182
slots:
183183
description: Friendly names of 4 slots of MP1 power strip. If not configured, slot name will be `switch's friendly_name + 'slot {slot_index}'`. e.g 'MP1 slot 1'
184184
required: false
185-
type: array
185+
type: map
186186
keys:
187187
slot_1:
188188
description: Friendly names of slot 1

0 commit comments

Comments
 (0)