diff --git a/source/_addons/duckdns.markdown b/source/_addons/duckdns.markdown index c6e929ffaf1..2f38bf80bd2 100644 --- a/source/_addons/duckdns.markdown +++ b/source/_addons/duckdns.markdown @@ -23,12 +23,13 @@ featured: true lets_encrypt: description: Let's Encrypt is a free, automated, and open certificate authority. required: true - type: list + type: map keys: accept_terms: 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. required: true type: boolean + default: false token: description: Your Duck DNS API key, from your DuckDNS account page. required: true diff --git a/source/_addons/homematic.markdown b/source/_addons/homematic.markdown index 38c7de7a16d..a49432b7b8b 100644 --- a/source/_addons/homematic.markdown +++ b/source/_addons/homematic.markdown @@ -44,6 +44,7 @@ rf_enable: description: Enable or disable BidCoS-RF. required: true type: boolean + default: false rf: description: RF devices. required: true @@ -61,6 +62,7 @@ wired_enable: description: Enable or disable BidCoS-Wired. required: true type: boolean + default: false wired: description: Wired devices. required: true @@ -82,6 +84,7 @@ hmip_enable: description: Enable or disable hmip. required: true type: boolean + default: false hmip: description: HMIP devices. required: true diff --git a/source/_addons/mosquitto.markdown b/source/_addons/mosquitto.markdown index 98fae3a8f14..e56242f703c 100644 --- a/source/_addons/mosquitto.markdown +++ b/source/_addons/mosquitto.markdown @@ -41,6 +41,7 @@ customize: description: If you enable it, it reads additional configuration files (`*.conf`) from `/share/mosquitto`. required: false type: [boolean, string] + default: false {% endconfiguration %} ### Home Assistant user management diff --git a/source/_addons/snips.markdown b/source/_addons/snips.markdown index 035b27e3944..cf74fa5e6db 100644 --- a/source/_addons/snips.markdown +++ b/source/_addons/snips.markdown @@ -57,6 +57,7 @@ language: custom_tts: description: Whether to use a TTS provider from Home Assistant for a variety of voices. type: boolean + default: false tts_platform: description: Which TTS platform to use. type: string diff --git a/source/_addons/tellstick.markdown b/source/_addons/tellstick.markdown index 3942739af85..dcc28085cd2 100644 --- a/source/_addons/tellstick.markdown +++ b/source/_addons/tellstick.markdown @@ -79,6 +79,7 @@ fade: 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). required: false type: boolean + default: false code: description: A number series based on ones and zeroes often used for dip-switch based devices. required: false diff --git a/source/_components/light.knx.markdown b/source/_components/light.knx.markdown index 1b23b88ebbc..04372579312 100644 --- a/source/_components/light.knx.markdown +++ b/source/_components/light.knx.markdown @@ -66,12 +66,7 @@ color_temperature_state_address: required: false type: string color_temperature_mode: - description: Color temperature group address data type. - keys: - absolute: - description: color temperature in Kelvin. *color_temperature_address -> DPT 7.600* - relative: - description: color temperature in percent cold white (0% warmest; 100% coldest). *color_temperature_address -> DPT 5.001* + 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* required: false type: string default: absolute diff --git a/source/_components/light.mqtt.markdown b/source/_components/light.mqtt.markdown index 8dbd5badb50..a99761c1447 100644 --- a/source/_components/light.mqtt.markdown +++ b/source/_components/light.mqtt.markdown @@ -109,7 +109,7 @@ effect_value_template: effect_list: description: The list of effects the light supports. required: false - type: string list + type: [string, list] hs_command_topic: description: "The MQTT topic to publish commands to change the light's color state in HS format (Hue Saturation). Range for Hue: 0° .. 360°, Range of Saturation: 0..100. @@ -421,7 +421,7 @@ effect: effect_list: description: The list of effects the light supports. required: false - type: string list + type: [string, list] flash_time_long: description: The duration, in seconds, of a “long” flash. required: false @@ -691,7 +691,7 @@ unique_id: effect_list: description: List of possible effects. required: false - type: string list + type: [string, list] command_topic: description: The MQTT topic to publish commands to change the light’s state. required: true @@ -771,6 +771,7 @@ json_attributes_topic: json_attributes_template: 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." required: false + type: template device: 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.' required: false diff --git a/source/_components/logger.markdown b/source/_components/logger.markdown index 7149deb1e70..91c90ab03d4 100644 --- a/source/_components/logger.markdown +++ b/source/_components/logger.markdown @@ -57,9 +57,9 @@ logger: {% configuration %} default: - description: Default log level. + description: Default log level. See [log_level](#log-levels). required: false - type: '[log_level](#log-levels)' + type: string default: debug logs: description: List of integrations and their log level. @@ -67,8 +67,8 @@ logger: type: map keys: '<component_namespace>': - description: Logger namespace of the component. - type: '[log_level](#log-levels)' + description: Logger namespace of the component. See [log_level](#log-levels). + type: string {% endconfiguration %} ### Log Levels diff --git a/source/_components/magicseaweed.markdown b/source/_components/magicseaweed.markdown index 7433ed97d0b..2e86e36bd23 100644 --- a/source/_components/magicseaweed.markdown +++ b/source/_components/magicseaweed.markdown @@ -78,17 +78,10 @@ monitored_conditions: max_breaking_swell: description: The maximum wave height as the state with a detailed list of forecast attributes. units: - description: Specify the unit system. + description: Specify the unit system. Either `uk`, `eu` or `us`. required: false default: Default to `uk` or `us` based on the temperature preference in Home Assistant. type: string - keys: - uk: - description: Use UK units. - eu: - description: Use EU units. - us: - description: Use US units. {% endconfiguration %} Details about the API are available in the [Magicseaweed documentation](https://magicseaweed.com/developer/forecast-api). diff --git a/source/_components/manual.markdown b/source/_components/manual.markdown index 2d926f22f47..f8d3340621f 100644 --- a/source/_components/manual.markdown +++ b/source/_components/manual.markdown @@ -65,6 +65,7 @@ disarm_after_trigger: description: If true, the alarm will automatically disarm after it has been triggered instead of returning to the previous state. required: false type: boolean + default: false armed_custom_bypass/armed_home/armed_away/armed_night/disarmed/triggered: description: State specific settings required: false diff --git a/source/_components/manual_mqtt.markdown b/source/_components/manual_mqtt.markdown index eb4adeb9cfa..2d82aafa8a8 100644 --- a/source/_components/manual_mqtt.markdown +++ b/source/_components/manual_mqtt.markdown @@ -88,6 +88,7 @@ disarm_after_trigger: description: If true, the alarm will automatically disarm after it has been triggered instead of returning to the previous state. required: false type: boolean + default: false armed_home/armed_away/armed_night/disarmed/triggered: description: State specific settings required: false diff --git a/source/_components/met.markdown b/source/_components/met.markdown index 0c9dcc745a2..b7feec48b85 100644 --- a/source/_components/met.markdown +++ b/source/_components/met.markdown @@ -21,23 +21,24 @@ The `met` platform uses the [Met.no](https://met.no/) web service as a source fo 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. {% configuration %} -name: - description: Manually specify Name. +name: + description: Manually specify Name. required: true + type: string default: Provided by Home Assistant configuration latitude: - description: Manually specify latitude. + description: Manually specify latitude. required: true - type: number + type: float default: Provided by Home Assistant configuration longitude: - description: Manually specify longitude. + description: Manually specify longitude. required: true - type: number + type: float default: Provided by Home Assistant configuration altitude: description: Manually specify altitude. required: false - type: number + type: integer default: Provided by Home Assistant configuration {% endconfiguration %} diff --git a/source/_components/miflora.markdown b/source/_components/miflora.markdown index 6c78e650d89..966f30e9eb6 100644 --- a/source/_components/miflora.markdown +++ b/source/_components/miflora.markdown @@ -91,6 +91,7 @@ force_update: description: Sends update events even if the value hasn't changed. required: false type: boolean + default: false median: 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." required: false diff --git a/source/_components/netdata.markdown b/source/_components/netdata.markdown index 0deca3fb283..85f178f2300 100644 --- a/source/_components/netdata.markdown +++ b/source/_components/netdata.markdown @@ -92,7 +92,7 @@ port: name: description: Name of the monitored Netdata instance. required: false - type: number + type: string default: Netdata resources: description: List of details to monitor. diff --git a/source/_components/nilu.markdown b/source/_components/nilu.markdown index 17bd10436c6..fc212b6f6b0 100644 --- a/source/_components/nilu.markdown +++ b/source/_components/nilu.markdown @@ -23,34 +23,34 @@ air_quality: ``` {% configuration %} - latitude: - description: Manually specify latitude. By default, the value will be taken from the Home Assistant configuration. - required: false - type: number - default: Provided by Home Assistant configuration. - longitude: - description: Manually specify longitude. By default, the value will be taken from the Home Assistant configuration. - required: false - type: number - default: Provided by Home Assistant configuration. - name: - description: Name of the sensor to use in the frontend. - required: false - default: NILU - type: string - area: - description: Name of an area to get sensor stations from. See available areas below. - required: exclusive - type: string - stations: - description: Name of a specific station to get measurements from. - required: exclusive - type: string - show_on_map: - description: Option to show the position of the sensor station on the map. - required: false - default: false - type: boolean +latitude: + description: Manually specify latitude. By default, the value will be taken from the Home Assistant configuration. + required: false + type: float + default: Provided by Home Assistant configuration. +longitude: + description: Manually specify longitude. By default, the value will be taken from the Home Assistant configuration. + required: false + type: float + default: Provided by Home Assistant configuration. +name: + description: Name of the sensor to use in the frontend. + required: false + default: NILU + type: string +area: + description: Name of an area to get sensor stations from. See available areas below. + required: exclusive + type: string +stations: + description: Name of a specific station to get measurements from. + required: exclusive + type: string +show_on_map: + description: Option to show the position of the sensor station on the map. + required: false + default: false + type: boolean {% endconfiguration %} ## Health risk index explainations diff --git a/source/_components/nissan_leaf.markdown b/source/_components/nissan_leaf.markdown index b6c0fd82cbd..76ae305b433 100644 --- a/source/_components/nissan_leaf.markdown +++ b/source/_components/nissan_leaf.markdown @@ -47,6 +47,7 @@ nissan_connect: 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. required: false type: boolean + default: true update_interval: 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!). required: false diff --git a/source/_components/no_ip.markdown b/source/_components/no_ip.markdown index b7011daa526..61a4f50d6e3 100644 --- a/source/_components/no_ip.markdown +++ b/source/_components/no_ip.markdown @@ -37,6 +37,6 @@ no_ip: timeout: description: Timeout (in seconds) for the API calls. required: false - type: number + type: integer default: 10 {% endconfiguration %} diff --git a/source/_components/noaa_tides.markdown b/source/_components/noaa_tides.markdown index dd04e3cb897..380b57748d1 100644 --- a/source/_components/noaa_tides.markdown +++ b/source/_components/noaa_tides.markdown @@ -49,13 +49,8 @@ time_zone: lst_ldt: description: Local Standard/Local Daylight Time. The time local to the requested station. unit_system: - description: Specify the unit system. + description: Specify the unit system. Use `metric` (Celsius, meters, cm/s) or `english` (fahrenheit, feet, knots) units. required: false default: Defaults to `metric` or `imperial` based on the Home Assistant configuration. type: string - keys: - metric: - description: Metric (Celsius, meters, cm/s) units. - english: - description: English (fahrenheit, feet, knots) units. {% endconfiguration %} diff --git a/source/_components/norway_air.markdown b/source/_components/norway_air.markdown index a957d14bb11..babf6ddca85 100644 --- a/source/_components/norway_air.markdown +++ b/source/_components/norway_air.markdown @@ -31,11 +31,11 @@ forecast: latitude: description: Manually specify latitude. required: false - type: number + type: float default: Provided by Home Assistant configuration longitude: description: Manually specify longitude. required: false - type: number + type: float default: Provided by Home Assistant configuration {% endconfiguration %} diff --git a/source/_components/nx584.markdown b/source/_components/nx584.markdown index b6d7cf24f79..cca64ed6062 100644 --- a/source/_components/nx584.markdown +++ b/source/_components/nx584.markdown @@ -76,7 +76,7 @@ exclude_zones: zone_types: 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. required: false - type: map + type: list keys: opening: description: Opening diff --git a/source/_components/octoprint.markdown b/source/_components/octoprint.markdown index 3b038cd52af..19d9cf5f2d0 100644 --- a/source/_components/octoprint.markdown +++ b/source/_components/octoprint.markdown @@ -35,82 +35,78 @@ octoprint: ``` {% configuration %} -octoprint: - type: list +host: + description: IP address or hostname of Octoprint host. required: true + type: string +api_key: + description: The retrieved API key. + required: true + type: string +name: + description: The name for this printer, must be unique if multiple printers are defined. + required: false + type: string + default: OctoPrint +port: + description: The port of the Octoprint server. + required: false + type: integer + default: 80 +path: + description: The URL path of the Octoprint instance. + required: false + type: string + default: / +ssl: + description: Enable or disable SSL/TLS. + required: false + type: boolean + default: false +bed: + description: If the printer has a heated bed. + required: false + type: boolean + default: false +number_of_tools: + description: Number of temperature adjustable tools, e.g., nozzle. + required: false + type: integer + default: 0 +sensors: + description: Configuration for the sensors. + required: false + type: map keys: - host: - description: IP address or hostname of Octoprint host. - required: true - type: string - api_key: - description: The retrieved API key. - required: true - type: string - name: - description: The name for this printer, must be unique if multiple printers are defined. - required: false - type: string - default: OctoPrint - port: - description: The port of the Octoprint server. - required: false - type: integer - default: 80 - path: - description: The URL path of the Octoprint instance. - required: false - type: string - default: / - ssl: - description: Enable or disable SSL/TLS. - required: false - type: boolean - default: false - bed: - description: If the printer has a heated bed. - required: false - type: boolean - default: false - number_of_tools: - description: Number of temperature adjustable tools, e.g., nozzle. - required: false - type: integer - default: 0 - sensors: - description: Configuration for the sensors. - required: false - type: map + monitored_conditions: + description: The sensors to activate. + type: list + default: all (`Current State`, `Temperatures`, `Job Percentage`, `Time Elapsed`, `Time Remaining`) keys: - monitored_conditions: - description: The sensors to activate. - type: list - default: all (`Current State`, `Temperatures`, `Job Percentage`, `Time Elapsed`, `Time Remaining`) - keys: - "Current State": - description: Text of current state. - "Temperatures": - description: Temperatures of all available tools, e.g., `print`, `head`, `print bed`, etc. These will be displayed as `tool0`, `tool1`, or `toolN` please refer to your OctoPrint frontend to associate the tool number with an actual device. - "Job Percentage": - description: Percentage of the job. - "Time Elapsed": - description: Time elapsed on current print job, in seconds. - "Time Remaining": - description: Time remaining on current print job, in seconds. - binary_sensors: - description: Configuration for the binary sensors. - required: false - type: map + "Current State": + description: Text of current state. + "Temperatures": + description: Temperatures of all available tools, e.g., `print`, `head`, `print bed`, etc. These will be displayed as `tool0`, `tool1`, or `toolN` please refer to your OctoPrint frontend to associate the tool number with an actual device. + "Job Percentage": + description: Percentage of the job. + "Time Elapsed": + description: Time elapsed on current print job, in seconds. + "Time Remaining": + description: Time remaining on current print job, in seconds. +binary_sensors: + description: Configuration for the binary sensors. + required: false + type: map + keys: + monitored_conditions: + description: The sensors to activate. + type: list + default: all (`Printing`, `Printing Error`) keys: - monitored_conditions: - description: The sensors to activate. - type: list - default: all (`Printing`, `Printing Error`) - keys: - "Printing": - description: State of the printer. - "Printing Error": - description: Error while printing. + "Printing": + description: State of the printer. + "Printing Error": + description: Error while printing. {% endconfiguration %}
Redid my whole layout for the @home_assistant dashboard yesterday on a whim. "Nest hub inspired", I call it. 😄 I like it a lot! Feels put together and less messy. pic.twitter.com/8pmA5CWKev
— Isa (@teachingbirds) July 16, 2019