Skip to content

Commit debee58

Browse files
frenckfrenck
authored
Collection of configuration block fixes (home-assistant#9884)
1 parent 9cb8e24 commit debee58

Some content is hidden

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

71 files changed

+268
-260
lines changed

‎source/_addons/duckdns.markdown

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,13 @@ featured: true
2323
lets_encrypt:
2424
description: Let's Encrypt is a free, automated, and open certificate authority.
2525
required: true
26-
type: list
26+
type: map
2727
keys:
2828
accept_terms:
2929
description: If you accept the [Let's Encrypt Subscriber Agreement](https://letsencrypt.org/repository/), it will generate and update Let's Encrypt certificates for your DuckDNS domain.
3030
required: true
3131
type: boolean
32+
default: false
3233
token:
3334
description: Your Duck DNS API key, from your DuckDNS account page.
3435
required: true

‎source/_addons/homematic.markdown

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ rf_enable:
4444
description: Enable or disable BidCoS-RF.
4545
required: true
4646
type: boolean
47+
default: false
4748
rf:
4849
description: RF devices.
4950
required: true
@@ -61,6 +62,7 @@ wired_enable:
6162
description: Enable or disable BidCoS-Wired.
6263
required: true
6364
type: boolean
65+
default: false
6466
wired:
6567
description: Wired devices.
6668
required: true
@@ -82,6 +84,7 @@ hmip_enable:
8284
description: Enable or disable hmip.
8385
required: true
8486
type: boolean
87+
default: false
8588
hmip:
8689
description: HMIP devices.
8790
required: true

‎source/_addons/mosquitto.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ customize:
4141
description: If you enable it, it reads additional configuration files (`*.conf`) from `/share/mosquitto`.
4242
required: false
4343
type: [boolean, string]
44+
default: false
4445
{% endconfiguration %}
4546

4647
### Home Assistant user management

‎source/_addons/snips.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ language:
5757
custom_tts:
5858
description: Whether to use a TTS provider from Home Assistant for a variety of voices.
5959
type: boolean
60+
default: false
6061
tts_platform:
6162
description: Which TTS platform to use.
6263
type: string

‎source/_addons/tellstick.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ fade:
7979
description: Fade is either `true` or `false` and tells a dimmer if it should fade smooth or instant between values (only for IKEA protocol as it seems).
8080
required: false
8181
type: boolean
82+
default: false
8283
code:
8384
description: A number series based on ones and zeroes often used for dip-switch based devices.
8485
required: false

‎source/_components/light.knx.markdown

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -66,12 +66,7 @@ color_temperature_state_address:
6666
required: false
6767
type: string
6868
color_temperature_mode:
69-
description: Color temperature group address data type.
70-
keys:
71-
absolute:
72-
description: color temperature in Kelvin. *color_temperature_address -> DPT 7.600*
73-
relative:
74-
description: color temperature in percent cold white (0% warmest; 100% coldest). *color_temperature_address -> DPT 5.001*
69+
description: Color temperature group address data type. `absolute` color temperature in Kelvin. *color_temperature_address -> DPT 7.600*. `relative` color temperature in percent cold white (0% warmest; 100% coldest). *color_temperature_address -> DPT 5.001*
7570
required: false
7671
type: string
7772
default: absolute

‎source/_components/light.mqtt.markdown

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ effect_value_template:
109109
effect_list:
110110
description: The list of effects the light supports.
111111
required: false
112-
type: string list
112+
type: [string, list]
113113
hs_command_topic:
114114
description: "The MQTT topic to publish commands to change the light's color state in HS format (Hue Saturation).
115115
Range for Hue: 0° .. 360°, Range of Saturation: 0..100.
@@ -421,7 +421,7 @@ effect:
421421
effect_list:
422422
description: The list of effects the light supports.
423423
required: false
424-
type: string list
424+
type: [string, list]
425425
flash_time_long:
426426
description: The duration, in seconds, of a “long” flash.
427427
required: false
@@ -691,7 +691,7 @@ unique_id:
691691
effect_list:
692692
description: List of possible effects.
693693
required: false
694-
type: string list
694+
type: [string, list]
695695
command_topic:
696696
description: The MQTT topic to publish commands to change the light’s state.
697697
required: true
@@ -771,6 +771,7 @@ json_attributes_topic:
771771
json_attributes_template:
772772
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/components/sensor.mqtt/#json-attributes-template-configuration) documentation."
773773
required: false
774+
type: template
774775
device:
775776
description: 'Information about the device this light is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/docs/mqtt/discovery/) and when [`unique_id`](#unique_id) is set.'
776777
required: false

‎source/_components/logger.markdown

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,18 +57,18 @@ logger:
5757
5858
{% configuration %}
5959
default:
60-
description: Default log level.
60+
description: Default log level. See [log_level](#log-levels).
6161
required: false
62-
type: '[log_level](#log-levels)'
62+
type: string
6363
default: debug
6464
logs:
6565
description: List of integrations and their log level.
6666
required: false
6767
type: map
6868
keys:
6969
'<component_namespace>':
70-
description: Logger namespace of the component.
71-
type: '[log_level](#log-levels)'
70+
description: Logger namespace of the component. See [log_level](#log-levels).
71+
type: string
7272
{% endconfiguration %}
7373
7474
### Log Levels

‎source/_components/magicseaweed.markdown

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -78,17 +78,10 @@ monitored_conditions:
7878
max_breaking_swell:
7979
description: The maximum wave height as the state with a detailed list of forecast attributes.
8080
units:
81-
description: Specify the unit system.
81+
description: Specify the unit system. Either `uk`, `eu` or `us`.
8282
required: false
8383
default: Default to `uk` or `us` based on the temperature preference in Home Assistant.
8484
type: string
85-
keys:
86-
uk:
87-
description: Use UK units.
88-
eu:
89-
description: Use EU units.
90-
us:
91-
description: Use US units.
9285
{% endconfiguration %}
9386

9487
Details about the API are available in the [Magicseaweed documentation](https://magicseaweed.com/developer/forecast-api).

‎source/_components/manual.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ disarm_after_trigger:
6565
description: If true, the alarm will automatically disarm after it has been triggered instead of returning to the previous state.
6666
required: false
6767
type: boolean
68+
default: false
6869
armed_custom_bypass/armed_home/armed_away/armed_night/disarmed/triggered:
6970
description: State specific settings
7071
required: false

‎source/_components/manual_mqtt.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,7 @@ disarm_after_trigger:
8888
description: If true, the alarm will automatically disarm after it has been triggered instead of returning to the previous state.
8989
required: false
9090
type: boolean
91+
default: false
9192
armed_home/armed_away/armed_night/disarmed/triggered:
9293
description: State specific settings
9394
required: false

‎source/_components/met.markdown

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,23 +21,24 @@ The `met` platform uses the [Met.no](https://met.no/) web service as a source fo
2121
To add Met.no to your installation, go to Configuration >> Integrations in the UI and enable the Met.no integration. By default the values will be taken from the Home Assistant configuration.
2222

2323
{% configuration %}
24-
name:
25-
description: Manually specify Name.
24+
name:
25+
description: Manually specify Name.
2626
required: true
27+
type: string
2728
default: Provided by Home Assistant configuration
2829
latitude:
29-
description: Manually specify latitude.
30+
description: Manually specify latitude.
3031
required: true
31-
type: number
32+
type: float
3233
default: Provided by Home Assistant configuration
3334
longitude:
34-
description: Manually specify longitude.
35+
description: Manually specify longitude.
3536
required: true
36-
type: number
37+
type: float
3738
default: Provided by Home Assistant configuration
3839
altitude:
3940
description: Manually specify altitude.
4041
required: false
41-
type: number
42+
type: integer
4243
default: Provided by Home Assistant configuration
4344
{% endconfiguration %}

‎source/_components/miflora.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ force_update:
9191
description: Sends update events even if the value hasn't changed.
9292
required: false
9393
type: boolean
94+
default: false
9495
median:
9596
description: "Sometimes the sensor measurements show spikes. Using this parameter, the poller will report the median of the last 3 (you can also use larger values) measurements. This filters out single spikes. Median: 5 will also filter double spikes. If you never have problems with spikes, `median: 1` will work fine."
9697
required: false

‎source/_components/netdata.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ port:
9292
name:
9393
description: Name of the monitored Netdata instance.
9494
required: false
95-
type: number
95+
type: string
9696
default: Netdata
9797
resources:
9898
description: List of details to monitor.

‎source/_components/nilu.markdown

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -23,34 +23,34 @@ air_quality:
2323
```
2424
2525
{% configuration %}
26-
latitude:
27-
description: Manually specify latitude. By default, the value will be taken from the Home Assistant configuration.
28-
required: false
29-
type: number
30-
default: Provided by Home Assistant configuration.
31-
longitude:
32-
description: Manually specify longitude. By default, the value will be taken from the Home Assistant configuration.
33-
required: false
34-
type: number
35-
default: Provided by Home Assistant configuration.
36-
name:
37-
description: Name of the sensor to use in the frontend.
38-
required: false
39-
default: NILU
40-
type: string
41-
area:
42-
description: Name of an area to get sensor stations from. See available areas below.
43-
required: exclusive
44-
type: string
45-
stations:
46-
description: Name of a specific station to get measurements from.
47-
required: exclusive
48-
type: string
49-
show_on_map:
50-
description: Option to show the position of the sensor station on the map.
51-
required: false
52-
default: false
53-
type: boolean
26+
latitude:
27+
description: Manually specify latitude. By default, the value will be taken from the Home Assistant configuration.
28+
required: false
29+
type: float
30+
default: Provided by Home Assistant configuration.
31+
longitude:
32+
description: Manually specify longitude. By default, the value will be taken from the Home Assistant configuration.
33+
required: false
34+
type: float
35+
default: Provided by Home Assistant configuration.
36+
name:
37+
description: Name of the sensor to use in the frontend.
38+
required: false
39+
default: NILU
40+
type: string
41+
area:
42+
description: Name of an area to get sensor stations from. See available areas below.
43+
required: exclusive
44+
type: string
45+
stations:
46+
description: Name of a specific station to get measurements from.
47+
required: exclusive
48+
type: string
49+
show_on_map:
50+
description: Option to show the position of the sensor station on the map.
51+
required: false
52+
default: false
53+
type: boolean
5454
{% endconfiguration %}
5555
5656
## Health risk index explainations

‎source/_components/nissan_leaf.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ nissan_connect:
4747
description: If your car has the updated head unit (NissanConnect rather than Carwings) then the location can be aquired and exposed via a device tracker. If you have Carwings then this should be set to false. The easiest way to identify NissanConnect is if the T&C buttons are orange and blue, for CarWings they're both blue, or just look for anything saying "CarWings" in Settings area of the infotainment system.
4848
required: false
4949
type: boolean
50+
default: true
5051
update_interval:
5152
description: The interval between updates if the climate control is off and the car is not charging. Set in any time unit (e.g. minutes, hours, days!).
5253
required: false

‎source/_components/no_ip.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,6 @@ no_ip:
3737
timeout:
3838
description: Timeout (in seconds) for the API calls.
3939
required: false
40-
type: number
40+
type: integer
4141
default: 10
4242
{% endconfiguration %}

‎source/_components/noaa_tides.markdown

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,13 +49,8 @@ time_zone:
4949
lst_ldt:
5050
description: Local Standard/Local Daylight Time. The time local to the requested station.
5151
unit_system:
52-
description: Specify the unit system.
52+
description: Specify the unit system. Use `metric` (Celsius, meters, cm/s) or `english` (fahrenheit, feet, knots) units.
5353
required: false
5454
default: Defaults to `metric` or `imperial` based on the Home Assistant configuration.
5555
type: string
56-
keys:
57-
metric:
58-
description: Metric (Celsius, meters, cm/s) units.
59-
english:
60-
description: English (fahrenheit, feet, knots) units.
6156
{% endconfiguration %}

‎source/_components/norway_air.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,11 @@ forecast:
3131
latitude:
3232
description: Manually specify latitude.
3333
required: false
34-
type: number
34+
type: float
3535
default: Provided by Home Assistant configuration
3636
longitude:
3737
description: Manually specify longitude.
3838
required: false
39-
type: number
39+
type: float
4040
default: Provided by Home Assistant configuration
4141
{% endconfiguration %}

‎source/_components/nx584.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ exclude_zones:
7676
zone_types:
7777
description: This is a list of zone numbers mapped to zone types. Use this to designate zones as doors, motion sensors, smoke detectors, etc. See the list of available zone types relevant to alarm zones below.
7878
required: false
79-
type: map
79+
type: list
8080
keys:
8181
opening:
8282
description: Opening

0 commit comments

Comments
 (0)