diff --git a/Gemfile b/Gemfile index a019375cea6..8de1d420268 100644 --- a/Gemfile +++ b/Gemfile @@ -19,7 +19,7 @@ group :jekyll_plugins do end gem 'sinatra', '2.0.8.1' -gem 'nokogiri', '1.10.8' +gem 'nokogiri', '1.10.9' # Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem # and associated library diff --git a/Gemfile.lock b/Gemfile.lock index fc82e11cd3a..381459ba399 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -72,9 +72,9 @@ GEM multi_json (1.14.1) mustermann (1.1.0) ruby2_keywords (~> 0.0.1) - nokogiri (1.10.8) + nokogiri (1.10.9) mini_portile2 (~> 2.4.0) - nokogiri (1.10.8-x64-mingw32) + nokogiri (1.10.9-x64-mingw32) mini_portile2 (~> 2.4.0) pathutil (0.16.2) forwardable-extended (~> 2.6) @@ -125,7 +125,7 @@ DEPENDENCIES jekyll-redirect-from (= 0.16.0) jekyll-sitemap (= 1.4.0) jekyll-time-to-read (= 0.1.2) - nokogiri (= 1.10.8) + nokogiri (= 1.10.9) rake (= 13.0.1) sass-globbing (= 1.1.5) sinatra (= 2.0.8.1) diff --git a/_config.yml b/_config.yml index 5c3291d95ec..11cf4a64e01 100644 --- a/_config.yml +++ b/_config.yml @@ -101,8 +101,8 @@ social: # Home Assistant release details current_major_version: 0 current_minor_version: 106 -current_patch_version: 2 -date_released: 2020-02-28 +current_patch_version: 4 +date_released: 2020-03-02 # Either # or the anchor link to latest release notes in the blog post. # Must be prefixed with a # and have double quotes around it. diff --git a/source/_docs/locked_out.md b/source/_docs/locked_out.md index 233492f1198..bf0d7317d77 100644 --- a/source/_docs/locked_out.md +++ b/source/_docs/locked_out.md @@ -10,6 +10,8 @@ or need to recover your data. ### Home Assistant (including Supervised) +If you are still logged in to the web interface with your user, then you are in luck. Add a new user as an administrator and give the new user a password you can remember. Then log out, and log in with this new user. You may then delete the old user account. But this way, your configuration will remain, and you don't have to do a new onboarding process. + If you’ve forgotten your user, then deleting the files mentioned above will be necessary to start a new onboarding process. If you know the user, but not the password and you can access the [Home Assistant console](https://www.home-assistant.io/hassio/commandline/) and use the command below: diff --git a/source/_docs/scripts/conditions.markdown b/source/_docs/scripts/conditions.markdown index deace93861b..561b59a4eb1 100644 --- a/source/_docs/scripts/conditions.markdown +++ b/source/_docs/scripts/conditions.markdown @@ -157,7 +157,9 @@ condition: #### Sunset/sunrise condition -The sun condition can also test if the sun has already set or risen when a trigger occurs. The `before` and `after` keys can only be set to `sunset` or `sunrise`. They have a corresponding optional offset value (`before_offset`, `after_offset`) that can be added, similar to the [sun trigger][sun_trigger]. +The sun condition can also test if the sun has already set or risen when a trigger occurs. The `before` and `after` keys can only be set to `sunset` or `sunrise`. They have a corresponding optional offset value (`before_offset`, `after_offset`) that can be added, similar to the [sun trigger][sun_trigger]. When both keys are used, the result is a logical `and` of separate conditions. + +Note that if only `before` key is used, the condition will be `true` _from midnight_ until sunrise/sunset. If only `after` key is used, the condition will be `true` from sunset/sunrise _until midnight_. Therefore, to cover time between sunset and sunrise one need to use `after: sunset` and `before: sunrise` as 2 separate conditions and combine them using `or`. [sun_trigger]: /docs/automation/trigger/#sun-trigger @@ -171,13 +173,25 @@ In those cases it is advised to use conditions evaluating the solar elevation in condition: condition: sun after: sunset - # Optional offset value - in this case it must from -1 hours relative to sunset, or after after_offset: "-01:00:00" ``` +This is 'when light' - equivalent to a state condition on `sun.sun` of `above_horizon`. + ```yaml condition: - condition: or # 'when dark' condition: either after sunset or before sunrise - equivalent to a state condition on `sun.sun` of `below_horizon` + - condition: sun + after: sunrise + before: sunset +``` + +This is 'when dark' - equivalent to a state condition on `sun.sun` of `below_horizon`. + +We cannot use both keys in this case as it will always be `false`. + +```yaml +condition: + condition: or conditions: - condition: sun after: sunset @@ -185,16 +199,6 @@ condition: before: sunrise ``` -```yaml -condition: - condition: and # 'when light' condition: before sunset and after sunrise - equivalent to a state condition on `sun.sun` of `above_horizon` - conditions: - - condition: sun - before: sunset - - condition: sun - after: sunrise -``` - A visual timeline is provided below showing an example of when these conditions are true. In this chart, sunrise is at 6:00, and sunset is at 18:00 (6:00 PM). The green areas of the chart indicate when the specified conditions are true. Graphic showing an example of sun conditions diff --git a/source/_includes/asides/lovelace_navigation.html b/source/_includes/asides/lovelace_navigation.html index 705cd522a49..b11dff43f86 100644 --- a/source/_includes/asides/lovelace_navigation.html +++ b/source/_includes/asides/lovelace_navigation.html @@ -17,6 +17,7 @@
  • {% active_link /lovelace/header-footer/ Headers & Footers %}
  • {% active_link /lovelace/yaml-mode/ YAML mode %}
  • {% active_link /lovelace/views/ Views %}
    • +
  • {% active_link /lovelace/actions/ Actions %}
  • Developing Custom Cards
    • diff --git a/source/_integrations/coronavirus.markdown b/source/_integrations/coronavirus.markdown new file mode 100644 index 00000000000..b3637c0a6f2 --- /dev/null +++ b/source/_integrations/coronavirus.markdown @@ -0,0 +1,48 @@ +--- +title: Coronavirus (COVID-19) +description: Instructions on how to integrate the Coronavirus sensors within Home Assistant. +logo: coronavirus.png +ha_category: + - Health +ha_release: 0.106 +ha_iot_class: Cloud Polling +ha_config_flow: true +ha_codeowners: + - '@home-assistant/core' +--- + +In December 2019, an outbreak of a novel Coronavirus, also called severe acute +respiratory syndrome coronavirus-2 (SARS-CoV-2), began in the Wuhan region of +China. This virus can cause the COVID-19 disease. + +This novel Coronavirus is spreading globally at a disturbing rate, which keeps +everybody on top of the news. The media worldwide is covering the spread of +the virus constantly, and a lot of people are tracking the number of cases +in their country. + +The Coronavirus integration tracks the number of people that are confirmed with, +recovered from, and deceased caused by the virus in your country, or worldwide. + +The data is sourced from the [Johns Hopkins University](https://www.arcgis.com/apps/opsdashboard/index.html#/bda7594740fd40299423467b48e9ecf6). + +## Configuration + +This integration can be configured via the Home Assistant frontend. + +- Go to **Configuration** -> **Integrations**. +- Click on the `+` in the bottom right corner to add a new integration. +- Search and select the **Coronavirus** integration form the list. +- Follow the instruction on screen to add the sensors. Either choose for adding + world-wide sensors, or a specific set of sensors for your country. + +If you want to track both world-wide and one or more countries at the same time, +you can repeat the configuration process described above to add multiple +instances of the integration. + +
    +This integration is released in a special release of Home Assistant Core: +0.106.3. + +While this integration is marked as released in 0.106, it is only available +on Home Assistant Core 0.106.3 or newer. +
    diff --git a/source/_integrations/device_tracker.mqtt.markdown b/source/_integrations/device_tracker.mqtt.markdown index bdde83a6e2e..effb909204c 100644 --- a/source/_integrations/device_tracker.mqtt.markdown +++ b/source/_integrations/device_tracker.mqtt.markdown @@ -54,13 +54,14 @@ source_type: ```yaml # Complete configuration.yaml entry device_tracker: - devices: - paulus_oneplus: 'location/paulus' - annetherese_n4: 'location/annetherese' - qos: 1 - payload_home: 'present' - payload_not_home: 'not present' - source_type: bluetooth + - platform: mqtt + devices: + paulus_oneplus: 'location/paulus' + annetherese_n4: 'location/annetherese' + qos: 1 + payload_home: 'present' + payload_not_home: 'not present' + source_type: bluetooth ``` ## Usage diff --git a/source/_integrations/gdacs.markdown b/source/_integrations/gdacs.markdown index 40157ff0727..8cac1652f35 100644 --- a/source/_integrations/gdacs.markdown +++ b/source/_integrations/gdacs.markdown @@ -134,3 +134,7 @@ gdacs: latitude: -41.2 longitude: 174.7 ``` + +## Locations NOT supported: + +- Ireland diff --git a/source/_integrations/google_assistant.markdown b/source/_integrations/google_assistant.markdown index d198836a78f..30800ff1a36 100644 --- a/source/_integrations/google_assistant.markdown +++ b/source/_integrations/google_assistant.markdown @@ -185,7 +185,7 @@ Currently, the following domains are available to be used with Google Assistant, - switch (on/off) - fan (on/off/speed) - light (on/off/brightness/rgb color/color temp) -- lock (lock/unlock (to allow assistant to unlock, set the `allow_unlock` key in configuration)) +- lock - cover (on/off/set position) - media_player (on/off/set volume (via set volume)/source (via set input source)) - climate (temperature setting, hvac_mode) diff --git a/source/_integrations/nut.markdown b/source/_integrations/nut.markdown index 2e01891eed5..8214dd227a9 100644 --- a/source/_integrations/nut.markdown +++ b/source/_integrations/nut.markdown @@ -85,7 +85,7 @@ ups.firmware: 868.L3 -P.D battery.mfr.ups.serial: 3B1519X19994 ups.productid: 0002 battery.runtime: 2552 -battery.battery.voltage.nominal: 24.0 +battery.voltage.nominal: 24.0 battery.type: PbAc ups.mfr.ups.status: OL ups.model: Back-UPS RS1000G diff --git a/source/_integrations/ping.markdown b/source/_integrations/ping.markdown index ccdbcf83e14..8efe856f464 100644 --- a/source/_integrations/ping.markdown +++ b/source/_integrations/ping.markdown @@ -89,7 +89,7 @@ device_tracker: {% configuration %} hosts: - description: List of device names and their corresponding IP address or hostname. + description: List of device names and their corresponding IP address or hostname. Device names must conform to the standard requirements of lower case, numbers and underscore only - see [entity names](/docs/configuration/troubleshooting/#entity-names). required: true type: list count: diff --git a/source/_integrations/slack.markdown b/source/_integrations/slack.markdown index 331fcce2ebc..0b60c00b162 100644 --- a/source/_integrations/slack.markdown +++ b/source/_integrations/slack.markdown @@ -148,3 +148,6 @@ You can also use YAML to send messages from your automations Please note that both `message` is a required key, but is always shown, so use an empty (`""`) string for `message` if you don't want the extra text. To use notifications, please see the [getting started with automation page](/getting-started/automation/). + +Extra information: You must add the bot to your Slack channel, otherwise you can't send messages in this channel. + diff --git a/source/_integrations/surepetcare.markdown b/source/_integrations/surepetcare.markdown index ca7cf321659..42b23ef4cb4 100644 --- a/source/_integrations/surepetcare.markdown +++ b/source/_integrations/surepetcare.markdown @@ -15,7 +15,7 @@ The `surepetcare` component allows you to get information on your Sure Petcare C ## Configuration -To add a flap and pet, add the following to your `configuration.yaml` file: +To add a flap, feeder or pet, add the following to your `configuration.yaml` file. The Hubs a flap or feeder is connected to, will be discovered automatically. ```yaml # Example configuration.yaml entry @@ -37,59 +37,22 @@ surepetcare: required: true type: string flaps: - description: The Sure Petcare flaps - required: true - type: map - keys: - id: - description: The Sure Petcare id of a flap - required: true - type: integer - name: - description: A name for the flap - required: true - type: string - feeders: - description: The Sure Petcare feeders - required: true - type: map - keys: - id: - description: The Sure Petcare id of a feeder - required: true - type: integer - name: - description: A name for the feeder - required: true - type: string - pets: - description: Pets managed by Sure Petcare flap(s) - required: true - type: map - keys: - id: - description: The Sure Petcare id of a pet - required: true - type: integer - name: - description: The name of the pet - required: true - type: string - icon: - description: "Icon to display (e.g., `mdi:cat`)" + description: The IDs of the Sure Petcare flaps required: false - default: "mdi:cat" - type: string + type: list + feeders: + description: The IDs of the Sure Petcare feeders + required: false + type: list + pets: + description: The Sure Petcare IDs of the Pets to show + required: false + type: list scan_interval: description: "Minimum time interval between updates. Supported formats: `scan_interval: 'HH:MM:SS'`, `scan_interval: 'HH:MM'` and Time period dictionary (see example below)." required: false default: 3 minutes type: time - device_class: - description: The type/class of the sensor to set the icon in the frontend. - required: false - default: lock - type: device_class {% endconfiguration %} ## Getting the IDs of your flaps, feeders and pets diff --git a/source/_integrations/switch.mqtt.markdown b/source/_integrations/switch.mqtt.markdown index a2ad182a842..1c25ceafaf3 100644 --- a/source/_integrations/switch.mqtt.markdown +++ b/source/_integrations/switch.mqtt.markdown @@ -98,12 +98,12 @@ payload_not_available: type: string default: offline payload_off: - description: The payload that represents disabled state. + description: The payload that represents `off` state. If specified, will be used for both comparing to the value in the `state_topic` (see `value_template` and `state_off` for details) and sending as `off` command to the `command_topic`. required: false type: string default: "OFF" payload_on: - description: The payload that represents enabled state. + description: The payload that represents `on` state. If specified, will be used for both comparing to the value in the `state_topic` (see `value_template` and `state_on` for details) and sending as `on` command to the `command_topic`. required: false type: string default: "ON" @@ -118,12 +118,12 @@ retain: type: boolean default: false state_off: - description: The payload that represents the off state. + description: The payload that represents the `off` state. Used when value that represents `off` state in the `state_topic` is different from value that should be sent to the `command_topic` to turn the device `off`. required: false type: string default: "`payload_off` if defined, else OFF" state_on: - description: The payload that represents the on state. + description: The payload that represents the `on` state. Used when value that represents `on` state in the `state_topic` is different from value that should be sent to the `command_topic` to turn the device `on`. required: false type: string default: "`payload_on` if defined, else ON" @@ -132,7 +132,7 @@ state_topic: required: false type: string value_template: - description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload." + description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's state from the `state_topic`. To determine the switches's state result of this template will be compared to `state_on` and `state_off`." required: false type: string {% endconfiguration %} diff --git a/source/_integrations/uk_transport.markdown b/source/_integrations/uk_transport.markdown index 294a06a8713..ef148c0ae3e 100644 --- a/source/_integrations/uk_transport.markdown +++ b/source/_integrations/uk_transport.markdown @@ -78,27 +78,36 @@ Refer to the [API reference webpage](https://developer.transportapi.com/docs?ram Attributes can be accessed using the [template sensor](/integrations/template) as per this example: +{% raw %} + ```yaml # Example configuration.yaml entry for a template sensor to access the attributes of the next departing train. - platform: template sensors: next_train_status: friendly_name: 'Next train status' - value_template: {% raw %}"{{state_attr('sensor.next_train_to_wat', 'next_trains')[0].status}}"{% endraw %} + value_template: >- + {{state_attr('sensor.next_train_to_wat', 'next_trains')[0].status}} next_trains_origin: friendly_name: 'Next train origin' - value_template: {% raw %}"{{state_attr('sensor.next_train_to_wat', 'next_trains')[0].origin_name}}"{% endraw %} + value_template: >- + {{state_attr('sensor.next_train_to_wat', 'next_trains')[0].origin_name}} next_trains_estimated: friendly_name: 'Next train estimated' - value_template: {% raw %}"{{state_attr('sensor.next_train_to_wat', 'next_trains')[0].estimated}}"{% endraw %} + value_template: >- + {{state_attr('sensor.next_train_to_wat', 'next_trains')[0].estimated}} next_trains_scheduled: friendly_name: 'Next train scheduled' - value_template: {% raw %}"{{state_attr('sensor.next_train_to_wat', 'next_trains')[0].scheduled}}"{% endraw %} + value_template: >- + {{state_attr('sensor.next_train_to_wat', 'next_trains')[0].scheduled}} next_trains_platform: friendly_name: 'Next train platform' - value_template: {% raw %}"{{state_attr('sensor.next_train_to_wat', 'next_trains')[0].platform}}"{% endraw %} + value_template: >- + {{state_attr('sensor.next_train_to_wat', 'next_trains')[0].platform}} ``` +{% endraw %} + Bus sensors require as their `origin` a bus stop ATCO code which can be found by browsing OpenStreetMap data as follows: diff --git a/source/_integrations/vacuum.mqtt.markdown b/source/_integrations/vacuum.mqtt.markdown index fbaa940c1cb..f6f871b22d0 100644 --- a/source/_integrations/vacuum.mqtt.markdown +++ b/source/_integrations/vacuum.mqtt.markdown @@ -272,6 +272,10 @@ fan_speed_list: description: List of possible fan speeds for the vacuum. required: false type: [string, list] +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](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." + required: false + type: template json_attributes_topic: description: The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-topic-configuration) documentation. required: false diff --git a/source/_lovelace/button.markdown b/source/_lovelace/button.markdown index 6c77752c66d..f0f800c7f17 100644 --- a/source/_lovelace/button.markdown +++ b/source/_lovelace/button.markdown @@ -57,129 +57,22 @@ state_color: default: true tap_action: required: false - description: Action to take on tap + description: Action taken on card tap. See [action documentation](/lovelace/actions/#tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`toggle`" - navigation_path: - required: false - description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" hold_action: required: false - description: Action to take on tap-and-hold + description: Action taken on card tap and hold. See [action documentation](/lovelace/actions/#hold-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" double_tap_action: required: false - description: Action to take on double tap + description: Action taken on card double tap. See [action documentation](/lovelace/actions/#double-tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" theme: required: false description: "Set to any theme within `themes.yaml`" type: string {% endconfiguration %} -## Options For Confirmation - -If you define confirmation as an object instead of boolean, you can add more customization and configurations: -{% configuration %} -text: - required: false - description: Text to present in the confirmation dialog. - type: string -exemptions: - required: false - description: "List of `exemption` objects. See below" - type: list -{% endconfiguration %} - ## Options For Exemptions {% configuration badges %} diff --git a/source/_lovelace/entities.markdown b/source/_lovelace/entities.markdown index 9d68a2f3ed5..d6df139460c 100644 --- a/source/_lovelace/entities.markdown +++ b/source/_lovelace/entities.markdown @@ -99,94 +99,16 @@ state_color: default: false tap_action: required: false - description: Action to take on tap + description: Action taken on card tap. See [action documentation](/lovelace/actions/#tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`toggle`" - navigation_path: - required: false - description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none hold_action: required: false - description: Action to take on tap-and-hold + description: Action taken on card tap and hold. See [action documentation](/lovelace/actions/#hold-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none double_tap_action: required: false - description: Action to take on double tap + description: Action taken on card double tap. See [action documentation](/lovelace/actions/#double-tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none {% endconfiguration %} ## Special Row Elements diff --git a/source/_lovelace/glance.markdown b/source/_lovelace/glance.markdown index 726fc4acc77..c0c1c446f57 100644 --- a/source/_lovelace/glance.markdown +++ b/source/_lovelace/glance.markdown @@ -87,123 +87,16 @@ show_state: default: true tap_action: required: false - description: Action to take on tap + description: Action taken on card tap. See [action documentation](/lovelace/actions/#tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" hold_action: required: false - description: Action to take on tap-and-hold + description: Action taken on card tap and hold. See [action documentation](/lovelace/actions/). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" double_tap_action: required: false - description: Action to take on double tap + description: Action taken on card double tap. See [action documentation](/lovelace/actions/#double-tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" -{% endconfiguration %} - -## Options For Confirmation - -If you define confirmation as an object instead of boolean, you can add more customization and configurations: -{% configuration %} -text: - required: false - description: Text to present in the confirmation dialog. - type: string -exemptions: - required: false - description: "List of `exemption` objects. See below" - type: list {% endconfiguration %} ## Options For Exemptions diff --git a/source/_lovelace/picture-elements.markdown b/source/_lovelace/picture-elements.markdown index 0aeb8573ce3..b661856cc4b 100644 --- a/source/_lovelace/picture-elements.markdown +++ b/source/_lovelace/picture-elements.markdown @@ -64,109 +64,16 @@ title: type: string tap_action: required: false - description: Action to take on tap + description: Action taken on card tap. See [action documentation](/lovelace/actions/#tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`toggle`" - navigation_path: - required: false - description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" hold_action: required: false - description: Action to take on tap-and-hold + description: Action taken on card tap and hold. See [action documentation](/lovelace/actions/#hold-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" double_tap_action: required: false - description: Action to take on double tap + description: Action taken on card double tap. See [action documentation](/lovelace/actions/#double-tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" {% endconfiguration %} ### Icon representing an entity state @@ -228,76 +135,18 @@ tap_action: description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" type: [boolean, map] default: "false" +tap_action: + required: false + description: Action taken on card tap. See [action documentation](/lovelace/actions/#tap-action). + type: map hold_action: required: false - description: Action to take on tap-and-hold + description: Action taken on card tap and hold. See [action documentation](/lovelace/actions/#hold-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" double_tap_action: required: false - description: Action to take on double tap + description: Action taken on card double tap. See [action documentation](/lovelace/actions/#double-tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" style: required: true description: Position and style the element using CSS. @@ -330,109 +179,16 @@ title: type: string tap_action: required: false - description: Action to take on tap + description: Action taken on card tap. See [action documentation](/lovelace/actions/#tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" hold_action: required: false - description: Action to take on tap-and-hold + description: Action taken on card tap and hold. See [action documentation](/lovelace/actions/#hold-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`,, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" double_tap_action: required: false - description: Action to take on double tap + description: Action taken on card double tap. See [action documentation](/lovelace/actions/#double-tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" style: required: true description: Position and style the element using CSS. @@ -487,109 +243,16 @@ entity: type: string tap_action: required: false - description: Action to take on tap + description: Action taken on card tap. See [action documentation](/lovelace/actions/#tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" hold_action: required: false - description: Action to take on tap-and-hold + description: Action taken on card tap and hold. See [action documentation](/lovelace/actions/#hold-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" double_tap_action: required: false - description: Action to take on double tap + description: Action taken on card double tap. See [action documentation](/lovelace/actions/#double-tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" style: required: true description: Position and style the element using CSS. @@ -614,109 +277,16 @@ title: type: string tap_action: required: false - description: Action to take on tap + description: Action taken on card tap. See [action documentation](/lovelace/actions/#tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" hold_action: required: false - description: Action to take on tap-and-hold + description: Action taken on card tap and hold. See [action documentation](/lovelace/actions/#hold-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" double_tap_action: required: false - description: Action to take on double tap + description: Action taken on card double tap. See [action documentation](/lovelace/actions/#double-tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" image: required: false description: The image to display. @@ -786,20 +356,6 @@ elements: type: list {% endconfiguration %} -## Options For Confirmation - -If you define confirmation as an object instead of boolean, you can add more customization and configurations: -{% configuration %} -text: - required: false - description: Text to present in the confirmation dialog. - type: string -exemptions: - required: false - description: "List of `exemption` objects. See below" - type: list -{% endconfiguration %} - ## Options For Exemptions {% configuration badges %} diff --git a/source/_lovelace/picture-entity.markdown b/source/_lovelace/picture-entity.markdown index aae5e019b87..8001af5b109 100644 --- a/source/_lovelace/picture-entity.markdown +++ b/source/_lovelace/picture-entity.markdown @@ -65,123 +65,16 @@ theme: type: string tap_action: required: false - description: Action to take on tap + description: Action taken on card tap. See [action documentation](/lovelace/actions/#tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" hold_action: required: false - description: Action to take on tap-and-hold + description: Action taken on card tap and hold. See [action documentation](/lovelace/actions/#hold-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" double_tap_action: required: false - description: Action to take on double tap + description: Action taken on card double tap. See [action documentation](/lovelace/actions/#double-tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" -{% endconfiguration %} - -## Options For Confirmation - -If you define confirmation as an object instead of boolean, you can add more customization and configurations: -{% configuration %} -text: - required: false - description: Text to present in the confirmation dialog. - type: string -exemptions: - required: false - description: "List of `exemption` objects. See below" - type: list {% endconfiguration %} ## Options For Exemptions @@ -226,6 +119,7 @@ state_image: Displaying a live feed from an FFmpeg camera: {% raw %} + ```yaml type: picture-entity entity: camera.backdoor @@ -237,6 +131,7 @@ tap_action: entity_id: camera.backdoor filename: '/shared/backdoor-{{ now().strftime("%Y-%m-%d-%H%M%S") }}.jpg' ``` + {% endraw %} The filename needs to be a path that is writable by Home Assistant in your system. You may need to configure `whitelist_external_dirs` ([documentation](/docs/configuration/basic/)). diff --git a/source/_lovelace/picture-glance.markdown b/source/_lovelace/picture-glance.markdown index 89deb390600..0803d65ba91 100644 --- a/source/_lovelace/picture-glance.markdown +++ b/source/_lovelace/picture-glance.markdown @@ -69,109 +69,16 @@ theme: type: string tap_action: required: false - description: Action to take on tap + description: Action taken on card tap. See [action documentation](/lovelace/actions/#tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" hold_action: required: false - description: Action to take on tap-and-hold + description: Action taken on card tap and hold. See [action documentation](/lovelace/actions/#hold-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" double_tap_action: required: false - description: Action to take on double tap + description: Action taken on card double tap. See [action documentation](/lovelace/actions/). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" {% endconfiguration %} ## Options For Entities @@ -194,113 +101,16 @@ show_state: default: true tap_action: required: false - description: Action to take on tap + description: Action taken on card tap. See [action documentation](/lovelace/actions/#tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - service: - required: false - description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" hold_action: required: false - description: Action to take on tap-and-hold + description: Action taken on card tap and hold. See [action documentation](/lovelace/actions/#hold-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - service: - required: false - description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" double_tap_action: required: false - description: Action to take on double tap + description: Action taken on card double tap. See [action documentation](/lovelace/actions/#double-tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" -{% endconfiguration %} - -## Options For Confirmation - -If you define confirmation as an object instead of boolean, you can add more customization and configurations: -{% configuration %} -text: - required: false - description: Text to present in the confirmation dialog. - type: string -exemptions: - required: false - description: "List of `exemption` objects. See below" - type: list {% endconfiguration %} ## Options For Exemptions diff --git a/source/_lovelace/picture.markdown b/source/_lovelace/picture.markdown index 76e61097ed9..c7c5357e6f3 100644 --- a/source/_lovelace/picture.markdown +++ b/source/_lovelace/picture.markdown @@ -26,123 +26,16 @@ theme: type: string tap_action: required: false - description: Action to take on tap + description: Action taken on card tap. See [action documentation](/lovelace/actions/#tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`call-service`, `navigate`, `url`, `none`)" - type: string - default: "`none`" - navigation_path: - required: false - description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" hold_action: required: false - description: Action to take on tap-and-hold + description: Action taken on card tap and hold. See [action documentation](/lovelace/actions/#hold-action). type: map - keys: - action: - required: true - description: "Action to perform (`call-service`, `navigate`, `url`, `none`)" - type: string - default: "`none`" - navigation_path: - required: false - description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" double_tap_action: required: false - description: Action to take on double tap + description: Action taken on card double tap. See [action documentation](/lovelace/actions/#double-tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" -{% endconfiguration %} - -## Options For Confirmation - -If you define confirmation as an object instead of boolean, you can add more customization and configurations: -{% configuration %} -text: - required: false - description: Text to present in the confirmation dialog. - type: string -exemptions: - required: false - description: "List of `exemption` objects. See below" - type: list {% endconfiguration %} ## Options For Exemptions diff --git a/source/_posts/2020-02-26-release-106-3.markdown b/source/_posts/2020-02-26-release-106-3.markdown new file mode 100644 index 00000000000..0d4ebf7a3ec --- /dev/null +++ b/source/_posts/2020-02-26-release-106-3.markdown @@ -0,0 +1,70 @@ +--- +layout: post +title: "0.106.3: Cornavirus integration (COVID-19), track the outbreak" +description: "A special release of Home Assistant, adding the Coronavirus integration (COVID-19)." +date: 2020-03-02 00:00:00 +date_formatted: "March 02, 2020" +author: Franck Nijhof +author_twitter: frenck +comments: true +categories: Release-Notes +og_image: /images/blog/2020-03-0.106.3/social.png +--- + + + +In December 2019, an outbreak of a novel [Coronavirus](https://en.wikipedia.org/wiki/Coronavirus) +also called severe acute respiratory syndrome coronavirus-2 +([SARS-CoV-2](https://en.wikipedia.org/wiki/Severe_acute_respiratory_syndrome_coronavirus_2)), +began in the Wuhan region of China. This virus can cause the +[COVID-19](https://en.wikipedia.org/wiki/Coronavirus_disease_2019) disease. + +This novel Coronavirus is spreading globally at a disturbing rate, which keeps +everybody on top of the news. The media worldwide is covering the spread of +the virus constantly, and a lot of people are tracking the number of cases +in their country. + +This special release adds the [Coronavirus integration](/integrations/coronavirus), +allowing you to track the outbreak from within Home Assistant. + +## The Coronavirus integration + +While having a meeting at [Nabu Casa](https://www.nabucasa.com/), +we caught ourselves talking a lot about the state of the virus spreading in +the countries we live in. Which brought us to the subject of being able to +track the virus in Home Assistant itself. + +So together, we started working on an integration right away. We decided to +bring you a special release of Home Assistant that includes this integration. + +The Coronavirus integration tracks the number of people that are confirmed with, +recovered from, and deceased caused by the virus in your country, or worldwide. + +The data is sourced from the [Johns Hopkins University](https://www.arcgis.com/apps/opsdashboard/index.html#/bda7594740fd40299423467b48e9ecf6). + +

    +Screenshot of the Coronavirus integration in Home Assistant +Screenshot of the Coronavirus integration in Home Assistant. +

    + +## Adding the Coronavirus integration + +This integration can be configured via the Home Assistant frontend. + +- Go to **Configuration** -> **Integrations**. +- Click on the `+` in the bottom right corner to add a new integration. +- Search and select the **Coronavirus** integration form the list. +- Follow the instruction on screen to add the sensors. Either choose for adding + world-wide sensors, or a specific set of sensors for your country. + +If you want to track both world-wide and one or more countries at the same time, +you can repeat the configuration process described above to add multiple +instances of the integration. + +## Resources + +For the latest information about the Coronavirus, be sure check the website +of the [World Health Organization](https://www.who.int/). The WHO provides +good information on +[basic protective measures](https://www.who.int/emergencies/diseases/novel-coronavirus-2019/advice-for-public) +you can take against the new Coronavirus. diff --git a/source/_posts/2020-02-26-release-106.markdown b/source/_posts/2020-02-26-release-106.markdown index b99b6aaf523..bb9afee41da 100644 --- a/source/_posts/2020-02-26-release-106.markdown +++ b/source/_posts/2020-02-26-release-106.markdown @@ -197,7 +197,9 @@ Experiencing issues introduced by this release? Please report them in our [issue - **Core** - Only administrator users can stop or restart Home Assistant. - ([@balloob] - [#31509]) ([homeassistant docs]) -- **Sure Petcare** - Sure Petcare supports new features and has improved existing features. As a result, you will want to note that `household_id` has been removed from configuration options as it is no longer needed. - ([@benleb] - [#31437]) ([surepetcare docs]) +- **Sure Petcare** - Sure Petcare supports new features and has improved existing features. As a result, you will want to note that the format of the `feeders`/`flaps`/`pets` options changed from a map (`id`/`name`) to a simple list of IDs, which means the `name` option is removed. The `name` is now gathered directly from the Sure Petcare API but changeable via the HA UI. + + The `household_id` (which is no longer needed) and customizing options `icon` and `device_class` are also removed but can still be configured via the UI. - ([@benleb] - [#31437]) ([surepetcare docs]) Example YAML configuration: @@ -383,6 +385,29 @@ Experiencing issues introduced by this release? Please report them in our [issue [rest docs]: /integrations/rest/ [unifi docs]: /integrations/unifi/ +## Release 0.106.3 - March 2 + +Added a Coronavirus integration to help monitor the ongoing epidemic. [More information here.](/blog/2020/03/02/release-106-3/) + +## Release 0.106.4 - March 2 + +- Fixed TypeError with old server versions ([@elmurato] - [#32329]) ([minecraft_server docs]) +- Bump pyeight to 0.1.4 ([@mezz64] - [#32363]) ([eight_sleep docs]) +- Catch Eight Sleep API errors, don't round None type ([@mezz64] - [#32410]) +- Coronavirus updates ([@balloob] - [#32417]) +- Add unique ID to coronavirus ([@balloob] - [#32423]) + +[#32329]: https://github.com/home-assistant/core/pull/32329 +[#32363]: https://github.com/home-assistant/core/pull/32363 +[#32410]: https://github.com/home-assistant/core/pull/32410 +[#32417]: https://github.com/home-assistant/core/pull/32417 +[#32423]: https://github.com/home-assistant/core/pull/32423 +[@balloob]: https://github.com/balloob +[@elmurato]: https://github.com/elmurato +[@mezz64]: https://github.com/mezz64 +[eight_sleep docs]: /integrations/eight_sleep/ +[minecraft_server docs]: /integrations/minecraft_server/ + ## All changes - Change scan_interval defaults for Tesla ([@alandtse] - [#31194]) ([tesla docs]) (breaking change) diff --git a/source/images/blog/2020-03-0.106.3/components.png b/source/images/blog/2020-03-0.106.3/components.png new file mode 100644 index 00000000000..1681b1eb51e Binary files /dev/null and b/source/images/blog/2020-03-0.106.3/components.png differ diff --git a/source/images/blog/2020-03-0.106.3/screenshot.png b/source/images/blog/2020-03-0.106.3/screenshot.png new file mode 100644 index 00000000000..9b5317b2bae Binary files /dev/null and b/source/images/blog/2020-03-0.106.3/screenshot.png differ diff --git a/source/images/blog/2020-03-0.106.3/social.png b/source/images/blog/2020-03-0.106.3/social.png new file mode 100644 index 00000000000..b288f739d17 Binary files /dev/null and b/source/images/blog/2020-03-0.106.3/social.png differ diff --git a/source/images/supported_brands/coronavirus.png b/source/images/supported_brands/coronavirus.png new file mode 100644 index 00000000000..096817033c9 Binary files /dev/null and b/source/images/supported_brands/coronavirus.png differ diff --git a/source/lovelace/actions.markdown b/source/lovelace/actions.markdown new file mode 100644 index 00000000000..f714ec8eb2b --- /dev/null +++ b/source/lovelace/actions.markdown @@ -0,0 +1,198 @@ +--- +title: "Actions" +description: "Define what an object does when interacted with." +--- + +Some Lovelace cards have support for tap actions. These actions define what will happen when you tap or hold on an object within a card. + +Actions can be enabled on: + +- [Entity](/lovelace/entities/) +- [Entity Button](/lovelace/entity-button/) +- [Glance](/lovelace/glance/) +- [Picture](/lovelace/picture/) +- [Picture Element](/lovelace/picture-elements/) +- [Picture Entity](/lovelace/picture-entity/) +- [Picture Glance](/lovelace/picture-glance/) + +## Tap-Action + +Action that will be performed when an object on a card is tapped. + +```yaml +tap_action: + action: toggle +``` + +{% configuration tap-action %} +tap_action: + required: false + description: Action to take on tap. + type: map + keys: + action: + required: true + description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" + type: string + default: "`toggle`" + navigation_path: + required: false + description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" + type: string + default: none + url_path: + required: false + description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" + type: string + default: none + service: + required: false + description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" + type: string + default: none + service_data: + required: false + description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" + type: string + default: none + confirmation: + required: false + description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" + type: [boolean, map] + default: "false" +{% endconfiguration %} + +## Hold Action + +Action that will be performed when an object on a card is tapped and held. + +```yaml +hold_action: + action: toggle +``` + +{% configuration hold_action %} +hold_action: + required: false + description: Action to take on tap-and-hold + type: map + keys: + action: + required: true + description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" + type: string + default: "`more-info`" + navigation_path: + required: false + description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" + type: string + default: none + url_path: + required: false + description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" + type: string + default: none + service: + required: false + description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" + type: string + default: none + service_data: + required: false + description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" + type: string + default: none + confirmation: + required: false + description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" + type: [boolean, map] + default: "false" +{% endconfiguration %} + +## Double-Tap Action + +Action that will be performed when an object on a card is double-tapped. + +```yaml +double_tap_action: + action: toggle +``` + +{% configuration double_tap_action %} +double_tap_action: + required: false + description: Action to take on double tap + type: map + keys: + action: + required: true + description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" + type: string + default: "`more-info`" + navigation_path: + required: false + description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" + type: string + default: none + url_path: + required: false + description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" + type: string + default: none + service: + required: false + description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" + type: string + default: none + service_data: + required: false + description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" + type: string + default: none + confirmation: + required: false + description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" + type: [boolean, map] + default: "false" +{% endconfiguration %} + +## Options For Confirmation + +If you define confirmation as an object instead of boolean, you can add more customization and configurations. + +```yaml +hold_action: + action: toggle +``` + +{% configuration confirmation%} +text: + required: false + description: Text to present in the confirmation dialog. + type: string +exemptions: + required: false + description: "List of `exemption` objects. See below" + type: list +{% endconfiguration %} + +## Options For Exemptions + +{% configuration exemptions %} +user: + required: true + description: User id that can see the view tab. + type: string +{% endconfiguration %} + +## Examples + +Tap action implemented on an entity button card: + +```yaml +type: button +tap_action: + action: toggle +hold_action: + action: more-info +``` diff --git a/source/lovelace/header-footer.markdown b/source/lovelace/header-footer.markdown index 4c1997df04a..655ddd17cdc 100644 --- a/source/lovelace/header-footer.markdown +++ b/source/lovelace/header-footer.markdown @@ -29,15 +29,15 @@ image: type: string tap_action: required: false - description: Action to take on tap. + description: Action taken on card tap. See [action documentation](/lovelace/actions/#tap-action). type: map hold_action: required: false - description: Action to take on tap-and-hold + description: Action to take on tap-and-hold. See [action documentation](/lovelace/actions/#hold-action). type: map double_tap_action: required: false - description: Action to take on double tap + description: Action to take on tap-and-hold. See [action documentation](/lovelace/actions/#double-tap-action). type: map {% endconfiguration %}