Merge branch 'current' into next

This commit is contained in:
Franck Nijhof 2019-07-18 19:17:44 +02:00
commit 26e70ada7a
No known key found for this signature in database
GPG Key ID: D62583BA8AB11CA3
76 changed files with 290 additions and 265 deletions

View File

@ -23,12 +23,13 @@ featured: true
lets_encrypt: lets_encrypt:
description: Let's Encrypt is a free, automated, and open certificate authority. description: Let's Encrypt is a free, automated, and open certificate authority.
required: true required: true
type: list type: map
keys: keys:
accept_terms: 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. 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 required: true
type: boolean type: boolean
default: false
token: token:
description: Your Duck DNS API key, from your DuckDNS account page. description: Your Duck DNS API key, from your DuckDNS account page.
required: true required: true

View File

@ -44,6 +44,7 @@ rf_enable:
description: Enable or disable BidCoS-RF. description: Enable or disable BidCoS-RF.
required: true required: true
type: boolean type: boolean
default: false
rf: rf:
description: RF devices. description: RF devices.
required: true required: true
@ -61,6 +62,7 @@ wired_enable:
description: Enable or disable BidCoS-Wired. description: Enable or disable BidCoS-Wired.
required: true required: true
type: boolean type: boolean
default: false
wired: wired:
description: Wired devices. description: Wired devices.
required: true required: true
@ -82,6 +84,7 @@ hmip_enable:
description: Enable or disable hmip. description: Enable or disable hmip.
required: true required: true
type: boolean type: boolean
default: false
hmip: hmip:
description: HMIP devices. description: HMIP devices.
required: true required: true

View File

@ -41,6 +41,7 @@ customize:
description: If you enable it, it reads additional configuration files (`*.conf`) from `/share/mosquitto`. description: If you enable it, it reads additional configuration files (`*.conf`) from `/share/mosquitto`.
required: false required: false
type: [boolean, string] type: [boolean, string]
default: false
{% endconfiguration %} {% endconfiguration %}
### Home Assistant user management ### Home Assistant user management

View File

@ -57,6 +57,7 @@ language:
custom_tts: custom_tts:
description: Whether to use a TTS provider from Home Assistant for a variety of voices. description: Whether to use a TTS provider from Home Assistant for a variety of voices.
type: boolean type: boolean
default: false
tts_platform: tts_platform:
description: Which TTS platform to use. description: Which TTS platform to use.
type: string type: string

View File

@ -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). 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 required: false
type: boolean type: boolean
default: false
code: code:
description: A number series based on ones and zeroes often used for dip-switch based devices. description: A number series based on ones and zeroes often used for dip-switch based devices.
required: false required: false

View File

@ -66,12 +66,7 @@ color_temperature_state_address:
required: false required: false
type: string type: string
color_temperature_mode: color_temperature_mode:
description: Color temperature group address data type. 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*
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*
required: false required: false
type: string type: string
default: absolute default: absolute

View File

@ -109,7 +109,7 @@ effect_value_template:
effect_list: effect_list:
description: The list of effects the light supports. description: The list of effects the light supports.
required: false required: false
type: string list type: [string, list]
hs_command_topic: hs_command_topic:
description: "The MQTT topic to publish commands to change the light's color state in HS format (Hue Saturation). 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. Range for Hue: 0° .. 360°, Range of Saturation: 0..100.
@ -421,7 +421,7 @@ effect:
effect_list: effect_list:
description: The list of effects the light supports. description: The list of effects the light supports.
required: false required: false
type: string list type: [string, list]
flash_time_long: flash_time_long:
description: The duration, in seconds, of a “long” flash. description: The duration, in seconds, of a “long” flash.
required: false required: false
@ -691,7 +691,7 @@ unique_id:
effect_list: effect_list:
description: List of possible effects. description: List of possible effects.
required: false required: false
type: string list type: [string, list]
command_topic: command_topic:
description: The MQTT topic to publish commands to change the lights state. description: The MQTT topic to publish commands to change the lights state.
required: true required: true
@ -771,6 +771,7 @@ json_attributes_topic:
json_attributes_template: 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." 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 required: false
type: template
device: 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.' 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 required: false

View File

@ -57,9 +57,9 @@ logger:
{% configuration %} {% configuration %}
default: default:
description: Default log level. description: Default log level. See [log_level](#log-levels).
required: false required: false
type: '[log_level](#log-levels)' type: string
default: debug default: debug
logs: logs:
description: List of integrations and their log level. description: List of integrations and their log level.
@ -67,8 +67,8 @@ logger:
type: map type: map
keys: keys:
'<component_namespace>': '<component_namespace>':
description: Logger namespace of the component. description: Logger namespace of the component. See [log_level](#log-levels).
type: '[log_level](#log-levels)' type: string
{% endconfiguration %} {% endconfiguration %}
### Log Levels ### Log Levels

View File

@ -78,17 +78,10 @@ monitored_conditions:
max_breaking_swell: max_breaking_swell:
description: The maximum wave height as the state with a detailed list of forecast attributes. description: The maximum wave height as the state with a detailed list of forecast attributes.
units: units:
description: Specify the unit system. description: Specify the unit system. Either `uk`, `eu` or `us`.
required: false required: false
default: Default to `uk` or `us` based on the temperature preference in Home Assistant. default: Default to `uk` or `us` based on the temperature preference in Home Assistant.
type: string type: string
keys:
uk:
description: Use UK units.
eu:
description: Use EU units.
us:
description: Use US units.
{% endconfiguration %} {% endconfiguration %}
Details about the API are available in the [Magicseaweed documentation](https://magicseaweed.com/developer/forecast-api). Details about the API are available in the [Magicseaweed documentation](https://magicseaweed.com/developer/forecast-api).

View File

@ -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. description: If true, the alarm will automatically disarm after it has been triggered instead of returning to the previous state.
required: false required: false
type: boolean type: boolean
default: false
armed_custom_bypass/armed_home/armed_away/armed_night/disarmed/triggered: armed_custom_bypass/armed_home/armed_away/armed_night/disarmed/triggered:
description: State specific settings description: State specific settings
required: false required: false

View File

@ -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. description: If true, the alarm will automatically disarm after it has been triggered instead of returning to the previous state.
required: false required: false
type: boolean type: boolean
default: false
armed_home/armed_away/armed_night/disarmed/triggered: armed_home/armed_away/armed_night/disarmed/triggered:
description: State specific settings description: State specific settings
required: false required: false

View File

@ -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. 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 %} {% configuration %}
name: name:
description: Manually specify Name. description: Manually specify Name.
required: true required: true
type: string
default: Provided by Home Assistant configuration default: Provided by Home Assistant configuration
latitude: latitude:
description: Manually specify latitude. description: Manually specify latitude.
required: true required: true
type: number type: float
default: Provided by Home Assistant configuration default: Provided by Home Assistant configuration
longitude: longitude:
description: Manually specify longitude. description: Manually specify longitude.
required: true required: true
type: number type: float
default: Provided by Home Assistant configuration default: Provided by Home Assistant configuration
altitude: altitude:
description: Manually specify altitude. description: Manually specify altitude.
required: false required: false
type: number type: integer
default: Provided by Home Assistant configuration default: Provided by Home Assistant configuration
{% endconfiguration %} {% endconfiguration %}

View File

@ -91,6 +91,7 @@ force_update:
description: Sends update events even if the value hasn't changed. description: Sends update events even if the value hasn't changed.
required: false required: false
type: boolean type: boolean
default: false
median: 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." 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 required: false

View File

@ -92,7 +92,7 @@ port:
name: name:
description: Name of the monitored Netdata instance. description: Name of the monitored Netdata instance.
required: false required: false
type: number type: string
default: Netdata default: Netdata
resources: resources:
description: List of details to monitor. description: List of details to monitor.

View File

@ -23,34 +23,34 @@ air_quality:
``` ```
{% configuration %} {% configuration %}
latitude: latitude:
description: Manually specify latitude. By default, the value will be taken from the Home Assistant configuration. description: Manually specify latitude. By default, the value will be taken from the Home Assistant configuration.
required: false required: false
type: number type: float
default: Provided by Home Assistant configuration. default: Provided by Home Assistant configuration.
longitude: longitude:
description: Manually specify longitude. By default, the value will be taken from the Home Assistant configuration. description: Manually specify longitude. By default, the value will be taken from the Home Assistant configuration.
required: false required: false
type: number type: float
default: Provided by Home Assistant configuration. default: Provided by Home Assistant configuration.
name: name:
description: Name of the sensor to use in the frontend. description: Name of the sensor to use in the frontend.
required: false required: false
default: NILU default: NILU
type: string type: string
area: area:
description: Name of an area to get sensor stations from. See available areas below. description: Name of an area to get sensor stations from. See available areas below.
required: exclusive required: exclusive
type: string type: string
stations: stations:
description: Name of a specific station to get measurements from. description: Name of a specific station to get measurements from.
required: exclusive required: exclusive
type: string type: string
show_on_map: show_on_map:
description: Option to show the position of the sensor station on the map. description: Option to show the position of the sensor station on the map.
required: false required: false
default: false default: false
type: boolean type: boolean
{% endconfiguration %} {% endconfiguration %}
## Health risk index explainations ## Health risk index explainations

View File

@ -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. 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 required: false
type: boolean type: boolean
default: true
update_interval: 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!). 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 required: false

View File

@ -37,6 +37,6 @@ no_ip:
timeout: timeout:
description: Timeout (in seconds) for the API calls. description: Timeout (in seconds) for the API calls.
required: false required: false
type: number type: integer
default: 10 default: 10
{% endconfiguration %} {% endconfiguration %}

View File

@ -49,13 +49,8 @@ time_zone:
lst_ldt: lst_ldt:
description: Local Standard/Local Daylight Time. The time local to the requested station. description: Local Standard/Local Daylight Time. The time local to the requested station.
unit_system: 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 required: false
default: Defaults to `metric` or `imperial` based on the Home Assistant configuration. default: Defaults to `metric` or `imperial` based on the Home Assistant configuration.
type: string type: string
keys:
metric:
description: Metric (Celsius, meters, cm/s) units.
english:
description: English (fahrenheit, feet, knots) units.
{% endconfiguration %} {% endconfiguration %}

View File

@ -31,11 +31,11 @@ forecast:
latitude: latitude:
description: Manually specify latitude. description: Manually specify latitude.
required: false required: false
type: number type: float
default: Provided by Home Assistant configuration default: Provided by Home Assistant configuration
longitude: longitude:
description: Manually specify longitude. description: Manually specify longitude.
required: false required: false
type: number type: float
default: Provided by Home Assistant configuration default: Provided by Home Assistant configuration
{% endconfiguration %} {% endconfiguration %}

View File

@ -76,7 +76,7 @@ exclude_zones:
zone_types: 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. 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 required: false
type: map type: list
keys: keys:
opening: opening:
description: Opening description: Opening

View File

@ -35,82 +35,78 @@ octoprint:
``` ```
{% configuration %} {% configuration %}
octoprint: host:
type: list description: IP address or hostname of Octoprint host.
required: true 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: keys:
host: monitored_conditions:
description: IP address or hostname of Octoprint host. description: The sensors to activate.
required: true type: list
type: string default: all (`Current State`, `Temperatures`, `Job Percentage`, `Time Elapsed`, `Time Remaining`)
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: keys:
monitored_conditions: "Current State":
description: The sensors to activate. description: Text of current state.
type: list "Temperatures":
default: all (`Current State`, `Temperatures`, `Job Percentage`, `Time Elapsed`, `Time Remaining`) 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.
keys: "Job Percentage":
"Current State": description: Percentage of the job.
description: Text of current state. "Time Elapsed":
"Temperatures": description: Time elapsed on current print job, in seconds.
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. "Time Remaining":
"Job Percentage": description: Time remaining on current print job, in seconds.
description: Percentage of the job. binary_sensors:
"Time Elapsed": description: Configuration for the binary sensors.
description: Time elapsed on current print job, in seconds. required: false
"Time Remaining": type: map
description: Time remaining on current print job, in seconds. keys:
binary_sensors: monitored_conditions:
description: Configuration for the binary sensors. description: The sensors to activate.
required: false type: list
type: map default: all (`Printing`, `Printing Error`)
keys: keys:
monitored_conditions: "Printing":
description: The sensors to activate. description: State of the printer.
type: list "Printing Error":
default: all (`Printing`, `Printing Error`) description: Error while printing.
keys:
"Printing":
description: State of the printer.
"Printing Error":
description: Error while printing.
{% endconfiguration %} {% endconfiguration %}
<div class='note'> <div class='note'>

View File

@ -41,7 +41,7 @@ name:
max_volume: max_volume:
description: Maximum volume. Defaults to 80. description: Maximum volume. Defaults to 80.
required: false required: false
type: number type: integer
sources: sources:
description: A list of mappings from source to source name. Valid sources can be found below. A default list will be used if no source mapping is specified. description: A list of mappings from source to source name. Valid sources can be found below. A default list will be used if no source mapping is specified.
required: false required: false

View File

@ -86,6 +86,7 @@ events_only:
description: Home Assistant will ignore all location updates and rely solely on geofence enter/leave events. description: Home Assistant will ignore all location updates and rely solely on geofence enter/leave events.
required: false required: false
type: boolean type: boolean
default: false
region_mapping: region_mapping:
description: "Dictionary to remap names of regions as configured in the Owntracks app to Home Assistant zones. Use this if you have multiple homes or Home Assistant instances and want to map a different label to 'home'. `key: value` maps Owntracks region `key` to Home Assistant zone `value`." description: "Dictionary to remap names of regions as configured in the Owntracks app to Home Assistant zones. Use this if you have multiple homes or Home Assistant instances and want to map a different label to 'home'. `key: value` maps Owntracks region `key` to Home Assistant zone `value`."
required: false required: false

View File

@ -64,6 +64,7 @@ require_admin:
description: If admin access is required to see this panel. description: If admin access is required to see this panel.
required: false required: false
type: boolean type: boolean
default: false
embed_iframe: embed_iframe:
description: Set to `true` to embed panel in iframe. This is necessary if the panel is using the React framework or if it contains conflicting web components. description: Set to `true` to embed panel in iframe. This is necessary if the panel is using the React framework or if it contains conflicting web components.
required: false required: false
@ -75,7 +76,7 @@ trust_external_script:
default: false default: false
type: boolean type: boolean
webcomponent_path: webcomponent_path:
description: The HTML path to your component. If omitted will default to `<config dir>/panels/<component name>.html` This is exclusive to `js_url` and `module_url`. description: "*DEPRECATED* The HTML path to your component. If omitted will default to `<config dir>/panels/<component name>.html` This is exclusive to `js_url` and `module_url`."
required: exclusive *DEPRECATED* required: exclusive
type: string type: string
{% endconfiguration %} {% endconfiguration %}

View File

@ -33,32 +33,33 @@ panel_iframe:
{% configuration %} {% configuration %}
panel_iframe: panel_iframe:
description: Enables the panel_iframe component. Only allowed once. description: Enables the panel_iframe component. Only allowed once.
required: true required: true
type: map type: map
keys: keys:
panel_name: panel_name:
description: Name of the panel. Only allowed once. description: Name of the panel. Only allowed once.
required: true required: true
type: map type: map
keys: keys:
title: title:
description: Friendly title for the panel. Will be used in the sidebar. description: Friendly title for the panel. Will be used in the sidebar.
required: true required: true
type: string type: string
url: url:
description: The absolute URL or relative URL with an absolute path to open. description: The absolute URL or relative URL with an absolute path to open.
required: true required: true
type: string type: string
icon: icon:
description: Icon for entry. description: Icon for entry.
required: false required: false
type: icon type: icon
require_admin: require_admin:
description: If admin access is required to see this iframe. description: If admin access is required to see this iframe.
required: false required: false
type: boolean type: boolean
default: false
{% endconfiguration %} {% endconfiguration %}
<div class='note warning'> <div class='note warning'>

View File

@ -41,11 +41,11 @@ host:
port: port:
description: The port of the ethernet to serial adapter. description: The port of the ethernet to serial adapter.
required: true required: true
type: integer (positive integer between 1-65535) type: integer
boards: boards:
description: Number of boards daisy-chained together (default is 1). description: Number of boards daisy-chained together (default is 1).
required: false required: false
type: int between 1 and 8 type: integer
relays: relays:
description: List of relays. description: List of relays.
required: true required: true
@ -62,5 +62,5 @@ relays:
board: board:
description: The board number (defaults to 1). description: The board number (defaults to 1).
required: false required: false
type: int between 1 and 8 type: integer
{% endconfiguration %} {% endconfiguration %}

View File

@ -116,6 +116,7 @@ disarm_after_trigger:
description: Configure sensor as trigger type. description: Configure sensor as trigger type.
required: false required: false
type: boolean type: boolean
default: false
reset_delay_sec: reset_delay_sec:
description: > description: >
Seconds before the sensor is disarmed if Seconds before the sensor is disarmed if

View File

@ -85,10 +85,12 @@ force_resize:
description: Resize the image even if the resulting image would take up more bandwidth than the original. description: Resize the image even if the resulting image would take up more bandwidth than the original.
required: false required: false
type: boolean type: boolean
default: false
cache_images: cache_images:
description: Preserve the last image and re-send in the case the camera is not responding. description: Preserve the last image and re-send in the case the camera is not responding.
required: false required: false
type: boolean type: boolean
default: false
{% endconfiguration %} {% endconfiguration %}
## Examples ## Examples

View File

@ -63,6 +63,7 @@ sensor:
{% configuration %} {% configuration %}
monitored_conditions: monitored_conditions:
description: Conditions to be monitored. description: Conditions to be monitored.
type: list
keys: keys:
rainsensor: rainsensor:
description: Returns the sensor level. description: Returns the sensor level.

View File

@ -118,10 +118,6 @@ monitored_conditions:
keys: keys:
auto_watering: auto_watering:
description: Toggle the watering scheduled per zone. description: Toggle the watering scheduled per zone.
required: false
type: boolean
manual_watering: manual_watering:
description: Toggle manually the watering per zone. It will inherent the value in minutes specified on the RainCloud hub component. description: Toggle manually the watering per zone. It will inherent the value in minutes specified on the RainCloud hub component.
required: false
type: boolean
{% endconfiguration %} {% endconfiguration %}

View File

@ -72,7 +72,7 @@ switches:
channel_config: channel_config:
description: Channel configuration of the control unit. The exact keys needed depend on the control unit manufacturer and model. description: Channel configuration of the control unit. The exact keys needed depend on the control unit manufacturer and model.
required: true required: true
type: dict type: map
{% endconfiguration %} {% endconfiguration %}
## Device support ## Device support

View File

@ -49,11 +49,11 @@ recorder:
domains: domains:
description: The list of domains to be excluded from recordings. description: The list of domains to be excluded from recordings.
required: false required: false
type: List type: list
entities: entities:
description: The list of entity ids to be excluded from recordings. description: The list of entity ids to be excluded from recordings.
required: false required: false
type: List type: list
include: include:
description: Configure which integrations should be included in recordings. If set, all other entities will not be recorded. description: Configure which integrations should be included in recordings. If set, all other entities will not be recorded.
required: false required: false
@ -62,11 +62,11 @@ recorder:
domains: domains:
description: The list of domains to be included in the recordings. description: The list of domains to be included in the recordings.
required: false required: false
type: List type: list
entities: entities:
description: The list of entity ids to be included in the recordings. description: The list of entity ids to be included in the recordings.
required: false required: false
type: List type: list
{% endconfiguration %} {% endconfiguration %}
Defining domains and entities to `exclude` (aka. blacklist) is convenient when you are basically happy with the information recorded, but just want to remove some entities or domains. Usually, these are entities/domains that do not change (like `weblink`) or rarely change (like `updater` or `automation`). Defining domains and entities to `exclude` (aka. blacklist) is convenient when you are basically happy with the information recorded, but just want to remove some entities or domains. Usually, these are entities/domains that do not change (like `weblink`) or rarely change (like `updater` or `automation`).

View File

@ -56,15 +56,15 @@ stop_id:
route: route:
description: List of route names. description: List of route names.
required: false required: false
type: string|list type: [string, list]
direction: direction:
description: List of directions to filter by. description: List of directions to filter by.
required: false required: false
type: string|list type: [string, list]
departure_type: departure_type:
description: List of departure types to filter by. description: List of departure types to filter by.
required: false required: false
type: string|list type: [string, list]
{% endconfiguration %} {% endconfiguration %}
## Direction ## Direction

View File

@ -51,6 +51,7 @@ hidden:
type: boolean type: boolean
default: true default: true
commands: commands:
description: A list of commands
required: false required: false
type: map type: map
keys: keys:

View File

@ -26,6 +26,7 @@ repetier:
{% configuration %} {% configuration %}
repetier: repetier:
description: Repetier integration
type: list type: list
required: true required: true
keys: keys:

View File

@ -68,7 +68,7 @@ verify_ssl:
timeout: timeout:
description: Defines max time to wait data from the endpoint. description: Defines max time to wait data from the endpoint.
required: false required: false
type: positive integer type: integer
default: 10 default: 10
unit_of_measurement: unit_of_measurement:
description: Defines the units of measurement of the sensor, if any. description: Defines the units of measurement of the sensor, if any.

View File

@ -52,7 +52,7 @@ password:
include: include:
description: A list of license plates to include, if this is not specified, all vehicles will be added. description: A list of license plates to include, if this is not specified, all vehicles will be added.
required: false required: false
type: strings type: list
{% endconfiguration %} {% endconfiguration %}
See the [device tracker integration page](/components/device_tracker/) for instructions on how to configure the people to be tracked. See the [device tracker integration page](/components/device_tracker/) for instructions on how to configure the people to be tracked.

View File

@ -75,8 +75,9 @@ registers:
type: integer type: integer
count: count:
description: Number of registers to read. description: Number of registers to read.
required: integer required: false
type: integer type: integer
default: 1
reverse_order: reverse_order:
description: Reverse the order of registers when count >1. description: Reverse the order of registers when count >1.
required: false required: false

View File

@ -79,6 +79,7 @@ json_attributes_topic:
json_attributes_template: 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`." description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`."
required: false required: false
type: template
json_attributes: json_attributes:
description: (Deprecated, replaced by json_attributes_topic) A list of keys to extract values from a JSON dictionary payload and then set as sensor attributes. description: (Deprecated, replaced by json_attributes_topic) A list of keys to extract values from a JSON dictionary payload and then set as sensor attributes.
required: false required: false

View File

@ -63,7 +63,7 @@ period:
description: The time in seconds for one complete oscillation of the periodic contribution. description: The time in seconds for one complete oscillation of the periodic contribution.
required: false required: false
default: 0 default: 0
type: seconds type: integer
phase: phase:
description: The phase offset (in degrees) to apply to the periodic component. description: The phase offset (in degrees) to apply to the periodic component.
required: false required: false

View File

@ -38,7 +38,7 @@ name:
monitored_conditions: monitored_conditions:
description: The parameters that should be monitored. description: The parameters that should be monitored.
required: false required: false
type: map type: list
keys: keys:
temperature: temperature:
description: Temperature at the sensor's location. description: Temperature at the sensor's location.

View File

@ -45,6 +45,7 @@ notify:
name: name:
description: Setting this parameter allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`. description: Setting this parameter allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`.
required: false required: false
type: string
default: "notify" default: "notify"
api_key: api_key:
description: The Slack API token to use for sending Slack messages. description: The Slack API token to use for sending Slack messages.
@ -62,6 +63,7 @@ username:
icon: icon:
description: Use one of the Slack emojis as an Icon for the supplied username. Slack uses the standard emoji sets used [here](http://www.webpagefx.com/tools/emoji-cheat-sheet/). description: Use one of the Slack emojis as an Icon for the supplied username. Slack uses the standard emoji sets used [here](http://www.webpagefx.com/tools/emoji-cheat-sheet/).
required: false required: false
type: string
{% endconfiguration %} {% endconfiguration %}
### Slack service data ### Slack service data

View File

@ -55,10 +55,10 @@ group:
default: user default: user
type: string type: string
sensors: sensors:
description: A dictionary of sensors that will be added. The value of the dictionary can include a list of sensor names that will be used as attributes. description: A list of sensors that will be added. The value of the list can include a list of sensor names that will be used as attributes.
required: false required: false
default: All sensors default: All sensors
type: map type: list
keys: keys:
pv_power: pv_power:
description: Current power generated by the inverter (W). description: Current power generated by the inverter (W).

View File

@ -39,12 +39,12 @@ Only location close to Sweden can be added. See [SMHI.se area](http://opendata.s
latitude: latitude:
description: Manually specify latitude. description: Manually specify latitude.
required: false required: false
type: number type: float
default: Provided by Home Assistant configuration default: Provided by Home Assistant configuration
longitude: longitude:
description: Manually specify longitude. description: Manually specify longitude.
required: false required: false
type: number type: float
default: Provided by Home Assistant configuration default: Provided by Home Assistant configuration
name: name:
description: Name to use in the frontend. description: Name to use in the frontend.

View File

@ -127,6 +127,6 @@ sensors:
platform: template platform: template
sensors: sensors:
solaredge_energy_this_year_template: solaredge_energy_this_year_template:
value_template: '{{(states('sensor.solaredge_energy_this_year') | float / 1000) | round(2)}}' value_template: "{{ (states('sensor.solaredge_energy_this_year') | float / 1000) | round(2) }}"
``` ```
{% endraw %} {% endraw %}

View File

@ -58,11 +58,11 @@ In case you would like to convert the values for example to kWh instead of the d
{% raw %} {% raw %}
```yaml ```yaml
# Example configuration.yaml entry for template platform # Example configuration.yaml entry for sensor template platform
sensors: sensor:
platform: template - platform: template
sensors: sensors:
solaredge_energy_this_year_template: solaredge_energy_this_year_template:
value_template: '{{(states('sensor.solaredge_energy_this_year') | float / 1000) | round(2)}}' value_template: "{{ (states('sensor.solaredge_energy_this_year') | float / 1000) | round(2) }}"
``` ```
{% endraw %} {% endraw %}

View File

@ -75,7 +75,7 @@ contact:
issue_report_channels: issue_report_channels:
description: "The reporting channel for issues. Pick an entity from `contact:`." description: "The reporting channel for issues. Pick an entity from `contact:`."
required: true required: true
type: List type: list
state: state:
description: The current state of the Hackerspace. description: The current state of the Hackerspace.
required: true required: true
@ -84,7 +84,7 @@ state:
entity_id: entity_id:
description: "The `entity_id` of a binary sensor that represents the current state." description: "The `entity_id` of a binary sensor that represents the current state."
required: true required: true
type: entity_id type: string
icon_open: icon_open:
description: The URL which is publicly accessible of the icon for the open Hackerspace. description: The URL which is publicly accessible of the icon for the open Hackerspace.
required: false required: false
@ -101,11 +101,11 @@ sensors:
temperature: temperature:
description: List of temperature sensors. description: List of temperature sensors.
required: true required: true
type: entity_id type: string
humidity: humidity:
description: List of humidity sensors. description: List of humidity sensors.
required: true required: true
type: entity_id type: string
{% endconfiguration %} {% endconfiguration %}
The list of sensors can be any sensor, not just temperature or humidity. The list of sensors can be any sensor, not just temperature or humidity.

View File

@ -39,7 +39,7 @@ binary_sensor:
entity_id: entity_id:
description: "The entity to monitor. Only [sensors](/components/sensor/) are supported." description: "The entity to monitor. Only [sensors](/components/sensor/) are supported."
required: true required: true
type: entity_id type: string
lower: lower:
description: The lower threshold which the observed value is compared against. description: The lower threshold which the observed value is compared against.
required: false required: false

View File

@ -41,6 +41,7 @@ device_tracker:
description: whether to show expired/disabled Tiles description: whether to show expired/disabled Tiles
required: false required: false
type: boolean type: boolean
default: false
{% endconfiguration %} {% endconfiguration %}
Multiple Tile accounts can be used by repeating the `tile` platform. Tracked devices in `known_devices.yaml` will be named `tile_<tile_identifier>`. You can find `<tile_identifier>` in the Tile app by clicking on a tile. Multiple Tile accounts can be used by repeating the `tile` platform. Tracked devices in `known_devices.yaml` will be named `tile_<tile_identifier>`. You can find `<tile_identifier>` in the Tile app by clicking on a tile.

View File

@ -44,7 +44,7 @@ name:
before: before:
description: The absolute local time value or sun event for beginning of the time range. description: The absolute local time value or sun event for beginning of the time range.
required: true required: true
type: string or time type: [string, time]
before_offset: before_offset:
description: The time offset of the beginning time range. description: The time offset of the beginning time range.
required: false required: false
@ -52,7 +52,7 @@ before_offset:
after: after:
description: The absolute local time value or sun event for ending of the time range. description: The absolute local time value or sun event for ending of the time range.
required: true required: true
type: string or time type: [string, time]
after_offset: after_offset:
description: The time offset of the beginning time range. description: The time offset of the beginning time range.
type: time type: time

View File

@ -56,7 +56,7 @@ station:
monitored_conditions: monitored_conditions:
description: Specify what measurement data to retrieve from the weather station. description: Specify what measurement data to retrieve from the weather station.
required: true required: true
type: map type: list
keys: keys:
air_temp: air_temp:
description: Air temperature. description: Air temperature.

View File

@ -64,6 +64,7 @@ turtle_mode:
description: If enabled, it creates a switch entity to control the 'Alternative Speed Limits' (aka 'Turtle mode') setting. description: If enabled, it creates a switch entity to control the 'Alternative Speed Limits' (aka 'Turtle mode') setting.
required: false required: false
type: boolean type: boolean
default: false
scan_interval: scan_interval:
description: How frequently to query for new data. Defaults to 120 seconds. description: How frequently to query for new data. Defaults to 120 seconds.
required: false required: false
@ -72,7 +73,7 @@ monitored_conditions:
type: integer type: integer
description: "List of monitored conditions. Possible values are:" description: "List of monitored conditions. Possible values are:"
required: false required: false
type: map type: list
keys: keys:
current_status: current_status:
description: The status of your Transmission daemon. description: The status of your Transmission daemon.

View File

@ -36,10 +36,7 @@ client_id:
required: true required: true
type: string type: string
channels: channels:
description: List of channels. description: List of channels names
required: true required: true
type: map type: list
keys:
channel_id:
description: Name of the channel.
{% endconfiguration %} {% endconfiguration %}

View File

@ -60,7 +60,7 @@ detection_time:
default: 300 default: 300
ssid_filter: ssid_filter:
description: Filter the SSIDs that tracking will occur on. description: Filter the SSIDs that tracking will occur on.
type: list of strings type: list
required: false required: false
default: None default: None
{% endconfiguration %} {% endconfiguration %}

View File

@ -42,7 +42,7 @@ schema:
supported_features: supported_features:
description: List of features that the vacuum supports (possible values are `turn_on`, `turn_off`, `pause`, `stop`, `return_home`, `battery`, `status`, `locate`, `clean_spot`, `fan_speed`, `send_command`)." description: List of features that the vacuum supports (possible values are `turn_on`, `turn_off`, `pause`, `stop`, `return_home`, `battery`, `status`, `locate`, `clean_spot`, `fan_speed`, `send_command`)."
required: false required: false
type: string list type: [string, list]
default: "`turn_on`, `turn_off`, `stop`, `return_home`, `status`, `battery`, `clean_spot`" default: "`turn_on`, `turn_off`, `stop`, `return_home`, `status`, `battery`, `clean_spot`"
command_topic: command_topic:
description: The MQTT topic to publish commands to control the vacuum. description: The MQTT topic to publish commands to control the vacuum.
@ -148,7 +148,7 @@ set_fan_speed_topic:
fan_speed_list: fan_speed_list:
description: List of possible fan speeds for the vacuum. description: List of possible fan speeds for the vacuum.
required: false required: false
type: string list type: [string, list]
send_command_topic: send_command_topic:
description: The MQTT topic to publish custom commands to the vacuum. description: The MQTT topic to publish custom commands to the vacuum.
required: false required: false
@ -273,7 +273,7 @@ schema:
supported_features: supported_features:
description: "List of features that the vacuum supports (possible values are `start`, `stop`, `pause`, `return_home`, `battery`, `status`, `locate`, `clean_spot`, `fan_speed`, `send_command`)." description: "List of features that the vacuum supports (possible values are `start`, `stop`, `pause`, `return_home`, `battery`, `status`, `locate`, `clean_spot`, `fan_speed`, `send_command`)."
required: false required: false
type: string list type: [string, list]
default: "`start`, `stop`, `return_home`, `status`, `battery`, `clean_spot`" default: "`start`, `stop`, `return_home`, `status`, `battery`, `clean_spot`"
command_topic: command_topic:
description: The MQTT topic to publish commands to control the vacuum. description: The MQTT topic to publish commands to control the vacuum.
@ -334,7 +334,7 @@ set_fan_speed_topic:
fan_speed_list: fan_speed_list:
description: List of possible fan speeds for the vacuum. description: List of possible fan speeds for the vacuum.
required: false required: false
type: string list type: [string, list]
send_command_topic: send_command_topic:
description: The MQTT topic to publish custom commands to the vacuum. description: The MQTT topic to publish custom commands to the vacuum.
required: false required: false

View File

@ -46,7 +46,7 @@ name:
monitored_conditions: monitored_conditions:
description: Entries to monitor. description: Entries to monitor.
required: false required: false
type: map type: list
default: average default: average
keys: keys:
average: average:

View File

@ -130,8 +130,8 @@ monitored_conditions:
keys: keys:
current_bandwidth_used: current_bandwidth_used:
description: The current (invoice period) bandwidth usage in Gigabytes (GB). description: The current (invoice period) bandwidth usage in Gigabytes (GB).
temperature: pending_charges:
pending_charges: The current (invoice period) charges that have built up for this subscription. Value is in US Dollars (US$). description: The current (invoice period) charges that have built up for this subscription. Value is in US Dollars (US$).
{% endconfiguration %} {% endconfiguration %}
Full `configuration.yaml` using `{}` to format condition name (produces `sensor.server_current_bandwidth_used` and `sensor.server_pending_charges`): Full `configuration.yaml` using `{}` to format condition name (produces `sensor.server_current_bandwidth_used` and `sensor.server_pending_charges`):

View File

@ -57,6 +57,7 @@ realtime:
description: If this is set to false, Waze returns the time estimate, not including current conditions, but rather the average travel time for the current time of day. The parameter defaults to true, meaning Waze will return real-time travel time. description: If this is set to false, Waze returns the time estimate, not including current conditions, but rather the average travel time for the current time of day. The parameter defaults to true, meaning Waze will return real-time travel time.
required: false required: false
type: boolean type: boolean
default: true
units: units:
description: "Set the unit for the sensor in metric or imperial, otherwise the default unit the same as the unit set in `unit_system:`." description: "Set the unit for the sensor in metric or imperial, otherwise the default unit the same as the unit set in `unit_system:`."
required: false required: false

View File

@ -38,12 +38,12 @@ api_key:
latitude: latitude:
description: Manually specify latitude. By default the value will be taken from the Home Assistant configuration. description: Manually specify latitude. By default the value will be taken from the Home Assistant configuration.
required: false required: false
type: number type: float
default: Provided by Home Assistant configuration default: Provided by Home Assistant configuration
longitude: longitude:
description: Manually specify longitude. By default the value will be taken from the Home Assistant configuration. description: Manually specify longitude. By default the value will be taken from the Home Assistant configuration.
required: false required: false
type: number type: float
default: Provided by Home Assistant configuration default: Provided by Home Assistant configuration
units: units:
description: "Manually specify unit system. Valid values are: `auto`, `us`, `si`, `ca`, `uk` and `uk2`." description: "Manually specify unit system. Valid values are: `auto`, `us`, `si`, `ca`, `uk` and `uk2`."

View File

@ -44,9 +44,11 @@ resource:
password: password:
description: The password for your given Jabber account. description: The password for your given Jabber account.
required: true required: true
type: string
recipient: recipient:
description: The Jabber ID (JID) that will receive the messages. description: The Jabber ID (JID) that will receive the messages.
required: true required: true
type: string
tls: tls:
description: Force TLS. description: Force TLS.
required: false required: false

View File

@ -80,7 +80,7 @@ devices:
custom_effects: custom_effects:
description: List of custom effects to add. Check examples below. description: List of custom effects to add. Check examples below.
required: false required: false
type: array type: map
keys: keys:
name: name:
description: Name of effect. description: Name of effect.
@ -99,8 +99,7 @@ custom_effects:
transitions: transitions:
description: List of transitions, for that effect, check [example](#custom-effects). description: List of transitions, for that effect, check [example](#custom-effects).
required: true required: true
type: array type: list
{% endconfiguration %} {% endconfiguration %}
#### Music mode #### Music mode

View File

@ -101,4 +101,5 @@ individual:
description: A 'true'/'false' to specify whether we should show individual sensors when a list of hostids is provided. If false, the sensor state will be the count of all triggers for the specified hosts (or all hosts within the Zabbix instance, if hostids isn't provided). description: A 'true'/'false' to specify whether we should show individual sensors when a list of hostids is provided. If false, the sensor state will be the count of all triggers for the specified hosts (or all hosts within the Zabbix instance, if hostids isn't provided).
required: false required: false
type: boolean type: boolean
{% endconfiguration %} default: false
{% endconfiguration %}

View File

@ -80,15 +80,20 @@ homeassistant:
trusted_networks: trusted_networks:
description: A list of IP address or IP network you want to whitelisted. It accepts both IPv4 and IPv6 IP address or network description: A list of IP address or IP network you want to whitelisted. It accepts both IPv4 and IPv6 IP address or network
required: true required: true
type: list of string type: list
trusted_users: trusted_users:
description: You can also assign which users are available to select when user access login page from certain IP address or network. description: You can also assign which users are available to select when user access login page from certain IP address or network.
required: false required: false
type: dictionary, string as key, list of string as value type: map
keys:
IP_ADDRESS:
description: List of users available to select on this IP address or network.
required: false
type: [list, string]
allow_bypass_login: allow_bypass_login:
description: You can bypass login page if you have only one user available for selection. description: You can bypass login page if you have only one user available for selection.
required: false required: false
default: False default: false
type: boolean type: boolean
{% endconfiguration %} {% endconfiguration %}

View File

@ -72,6 +72,8 @@ There are a few very important rules to remember when writing automation templat
Remembering these simple rules will help save you from many headaches and endless hours of frustration when using automation templates. Remembering these simple rules will help save you from many headaches and endless hours of frustration when using automation templates.
It is possible to use `data` and `data_template` concurrently but be aware that `data_template` will overwrite attributes that are provided in both.
## Trigger State Object ## Trigger State Object
Knowing how to access the [state object](/docs/configuration/state_object/) of a trigger entity could be one of the more common questions. Here are a few ways for the [`state`](#state), [`numeric_state`](#numeric_state) and [`template`](#template) triggers: Knowing how to access the [state object](/docs/configuration/state_object/) of a trigger entity could be one of the more common questions. Here are a few ways for the [`state`](#state), [`numeric_state`](#numeric_state) and [`template`](#template) triggers:

View File

@ -54,6 +54,7 @@ tls_insecure:
required: false required: false
description: Set the verification of the server hostname in the server certificate. description: Set the verification of the server hostname in the server certificate.
type: boolean type: boolean
default: false
tls_version: tls_version:
required: false required: false
description: "TLS/SSL protocol version to use. Available options are: `'auto'`, `'1.0'`, `'1.1'`, `'1.2'`. Make sure to put quotes around the value. Defaults to `'auto'`." description: "TLS/SSL protocol version to use. Available options are: `'auto'`, `'1.0'`, `'1.1'`, `'1.2'`. Make sure to put quotes around the value. Defaults to `'auto'`."

View File

@ -77,6 +77,16 @@ data_template:
temperature: {% raw %}{{ 22 - distance(states.device_tracker.paulus) }}{% endraw %} temperature: {% raw %}{{ 22 - distance(states.device_tracker.paulus) }}{% endraw %}
``` ```
It is even possible to use `data` and `data_template` concurrently but be aware that `data_template` will overwrite attributes that are provided in both.
```yaml
service: thermostat.set_temperature
data:
entity_id: thermostat.upstairs
data_template:
temperature: {% raw %}{{ 22 - distance(states.device_tracker.paulus) }}{% endraw %}
```
### `homeassistant` services ### `homeassistant` services
There are four `homeassistant` services that aren't tied to any single domain, these are: There are four `homeassistant` services that aren't tied to any single domain, these are:

View File

@ -31,7 +31,7 @@ conditions:
card: card:
required: true required: true
description: Card to display if all conditions match. description: Card to display if all conditions match.
type: object type: map
{% endconfiguration %} {% endconfiguration %}
*one is required (`state` or `state_not`) *one is required (`state` or `state_not`)

View File

@ -91,7 +91,7 @@ action_name:
service_data: service_data:
required: false required: false
description: The service data to use. description: The service data to use.
type: object type: map
{% endconfiguration %} {% endconfiguration %}
### Divider ### Divider
@ -104,7 +104,7 @@ type:
style: style:
required: false required: false
description: Style the element using CSS. description: Style the element using CSS.
type: object type: string
default: "height: 1px, background-color: var(--secondary-text-color)" default: "height: 1px, background-color: var(--secondary-text-color)"
{% endconfiguration %} {% endconfiguration %}

View File

@ -53,7 +53,7 @@ icon_height:
tap_action: tap_action:
required: false required: false
description: Action to take on tap description: Action to take on tap
type: object type: map
keys: keys:
action: action:
required: true required: true
@ -78,7 +78,7 @@ tap_action:
hold_action: hold_action:
required: false required: false
description: Action to take on tap-and-hold description: Action to take on tap-and-hold
type: object type: map
keys: keys:
action: action:
required: true required: true

View File

@ -29,7 +29,7 @@ state_filter:
card: card:
required: false required: false
description: Extra options to pass down to the card rendering the result. description: Extra options to pass down to the card rendering the result.
type: object type: map
default: entities card default: entities card
show_empty: show_empty:
required: false required: false

View File

@ -69,7 +69,7 @@ icon:
tap_action: tap_action:
required: false required: false
description: Action to take on tap description: Action to take on tap
type: object type: map
keys: keys:
action: action:
required: true required: true
@ -94,7 +94,7 @@ tap_action:
hold_action: hold_action:
required: false required: false
description: Action to take on tap-and-hold description: Action to take on tap-and-hold
type: object type: map
keys: keys:
action: action:
required: true required: true

View File

@ -48,7 +48,7 @@ entity:
style: style:
required: true required: true
description: Position and style the element using CSS. description: Position and style the element using CSS.
type: object type: map
default: "position: absolute, transform: translate(-50%, -50%)" default: "position: absolute, transform: translate(-50%, -50%)"
title: title:
required: false required: false
@ -78,7 +78,7 @@ title:
tap_action: tap_action:
required: false required: false
description: Action to take on tap description: Action to take on tap
type: object type: map
keys: keys:
action: action:
required: true required: true
@ -103,7 +103,7 @@ tap_action:
hold_action: hold_action:
required: false required: false
description: Action to take on tap-and-hold description: Action to take on tap-and-hold
type: object type: map
keys: keys:
action: action:
required: true required: true
@ -128,7 +128,7 @@ hold_action:
style: style:
required: true required: true
description: Position and style the element using CSS. description: Position and style the element using CSS.
type: object type: string
default: "position: absolute, transform: translate(-50%, -50%)" default: "position: absolute, transform: translate(-50%, -50%)"
{% endconfiguration %} {% endconfiguration %}
@ -158,7 +158,7 @@ title:
tap_action: tap_action:
required: false required: false
description: Action to take on tap description: Action to take on tap
type: object type: map
keys: keys:
action: action:
required: true required: true
@ -183,7 +183,7 @@ tap_action:
hold_action: hold_action:
required: false required: false
description: Action to take on tap-and-hold description: Action to take on tap-and-hold
type: object type: map
keys: keys:
action: action:
required: true required: true
@ -208,7 +208,7 @@ hold_action:
style: style:
required: true required: true
description: Position and style the element using CSS. description: Position and style the element using CSS.
type: object type: string
default: "position: absolute, transform: translate(-50%, -50%)" default: "position: absolute, transform: translate(-50%, -50%)"
{% endconfiguration %} {% endconfiguration %}
@ -230,11 +230,11 @@ service:
service_data: service_data:
required: false required: false
description: The service data to use. description: The service data to use.
type: object type: map
style: style:
required: true required: true
description: Position and style the element using CSS. description: Position and style the element using CSS.
type: object type: string
default: "position: absolute, transform: translate(-50%, -50%)" default: "position: absolute, transform: translate(-50%, -50%)"
{% endconfiguration %} {% endconfiguration %}
@ -260,7 +260,7 @@ entity:
tap_action: tap_action:
required: false required: false
description: Action to take on tap description: Action to take on tap
type: object type: map
keys: keys:
action: action:
required: true required: true
@ -285,7 +285,7 @@ tap_action:
hold_action: hold_action:
required: false required: false
description: Action to take on tap-and-hold description: Action to take on tap-and-hold
type: object type: map
keys: keys:
action: action:
required: true required: true
@ -310,7 +310,7 @@ hold_action:
style: style:
required: true required: true
description: Position and style the element using CSS. description: Position and style the element using CSS.
type: object type: string
default: "position: absolute, transform: translate(-50%, -50%)" default: "position: absolute, transform: translate(-50%, -50%)"
{% endconfiguration %} {% endconfiguration %}
@ -332,7 +332,7 @@ title:
tap_action: tap_action:
required: false required: false
description: Action to take on tap description: Action to take on tap
type: object type: map
keys: keys:
action: action:
required: true required: true
@ -357,7 +357,7 @@ tap_action:
hold_action: hold_action:
required: false required: false
description: Action to take on tap-and-hold description: Action to take on tap-and-hold
type: object type: map
keys: keys:
action: action:
required: true required: true
@ -395,7 +395,7 @@ camera_view:
state_image: state_image:
required: false required: false
description: '[State-based images](#how-to-use-state_image)' description: '[State-based images](#how-to-use-state_image)'
type: object type: map
filter: filter:
required: false required: false
description: Default CSS filter description: Default CSS filter
@ -403,7 +403,7 @@ filter:
state_filter: state_filter:
required: false required: false
description: '[State-based CSS filters](#how-to-use-state_filter)' description: '[State-based CSS filters](#how-to-use-state_filter)'
type: object type: map
aspect_ratio: aspect_ratio:
required: false required: false
description: Height-width-ratio. description: Height-width-ratio.
@ -412,7 +412,7 @@ aspect_ratio:
style: style:
required: true required: true
description: Position and style the element using CSS. description: Position and style the element using CSS.
type: object type: string
default: "position: absolute, transform: translate(-50%, -50%)" default: "position: absolute, transform: translate(-50%, -50%)"
{% endconfiguration %} {% endconfiguration %}
@ -458,7 +458,7 @@ type:
style: style:
required: true required: true
description: Position and style the element using CSS. description: Position and style the element using CSS.
type: object type: string
default: "position: absolute, transform: translate(-50%, -50%)" default: "position: absolute, transform: translate(-50%, -50%)"
{% endconfiguration %} {% endconfiguration %}

View File

@ -36,7 +36,7 @@ image:
state_image: state_image:
required: false required: false
description: "Map entity states to images (`state: image URL`, check the example below)." description: "Map entity states to images (`state: image URL`, check the example below)."
type: object type: map
aspect_ratio: aspect_ratio:
required: false required: false
description: "Forces the height of the image to be a ratio of the width. You may enter a value such as: `16x9`, `16:9`, `1.78`." description: "Forces the height of the image to be a ratio of the width. You may enter a value such as: `16x9`, `16:9`, `1.78`."
@ -58,7 +58,7 @@ show_state:
tap_action: tap_action:
required: false required: false
description: Action to take on tap description: Action to take on tap
type: object type: map
keys: keys:
action: action:
required: true required: true
@ -83,7 +83,7 @@ tap_action:
hold_action: hold_action:
required: false required: false
description: Action to take on tap-and-hold description: Action to take on tap-and-hold
type: object type: map
keys: keys:
action: action:
required: true required: true

View File

@ -40,7 +40,7 @@ camera_view:
state_image: state_image:
required: false required: false
description: Background image based on entity state. description: Background image based on entity state.
type: object type: map
keys: keys:
state: state:
type: string type: string
@ -57,7 +57,7 @@ entity:
tap_action: tap_action:
required: false required: false
description: Action to take on tap description: Action to take on tap
type: object type: map
keys: keys:
action: action:
required: true required: true
@ -82,7 +82,7 @@ tap_action:
hold_action: hold_action:
required: false required: false
description: Action to take on tap-and-hold description: Action to take on tap-and-hold
type: object type: map
keys: keys:
action: action:
required: true required: true

View File

@ -23,7 +23,7 @@ image:
tap_action: tap_action:
required: false required: false
description: Action to take on tap description: Action to take on tap
type: object type: map
keys: keys:
action: action:
required: true required: true
@ -48,7 +48,7 @@ tap_action:
hold_action: hold_action:
required: false required: false
description: Action to take on tap-and-hold description: Action to take on tap-and-hold
type: object type: map
keys: keys:
action: action:
required: true required: true

View File

@ -85,6 +85,10 @@ Big shout out to [@frenck] who has been doing a lot of clean up on the website.
Last week [@balloob] showed a preview of the upcoming [Home Assistant Cast](/blog/2019/07/09/home-assistant-cast-preview/), a new interface for Home Assistant that runs on Chromecasts and Google Assistant devices with screens. Last week [@balloob] showed a preview of the upcoming [Home Assistant Cast](/blog/2019/07/09/home-assistant-cast-preview/), a new interface for Home Assistant that runs on Chromecasts and Google Assistant devices with screens.
The [Home Assistant code repository on GitHub](https://github.com/home-assistant/home-assistant) has hit 25.000 stars! 🤩
The Home Assistant Podcast has published [episode 53](https://hasspodcast.io/ha053/) to discuss all the ins and outs of this new release.
[@teachingbirds] has redone her Lovelace UI and it is looking fabulous! [@teachingbirds] has redone her Lovelace UI and it is looking fabulous!
<blockquote class="twitter-tweet"><p lang="en" dir="ltr">Redid my whole layout for the <a href="https://twitter.com/home_assistant?ref_src=twsrc%5Etfw">@home_assistant</a> dashboard yesterday on a whim. &quot;Nest hub inspired&quot;, I call it. 😄 I like it a lot! Feels put together and less messy. <a href="https://t.co/8pmA5CWKev">pic.twitter.com/8pmA5CWKev</a></p>&mdash; Isa (@teachingbirds) <a href="https://twitter.com/teachingbirds/status/1151113630391427072?ref_src=twsrc%5Etfw">July 16, 2019</a> <blockquote class="twitter-tweet"><p lang="en" dir="ltr">Redid my whole layout for the <a href="https://twitter.com/home_assistant?ref_src=twsrc%5Etfw">@home_assistant</a> dashboard yesterday on a whim. &quot;Nest hub inspired&quot;, I call it. 😄 I like it a lot! Feels put together and less messy. <a href="https://t.co/8pmA5CWKev">pic.twitter.com/8pmA5CWKev</a></p>&mdash; Isa (@teachingbirds) <a href="https://twitter.com/teachingbirds/status/1151113630391427072?ref_src=twsrc%5Etfw">July 16, 2019</a>