Merge branch 'next' into hwamsmartctrl

home-assistant · Oct 20, 2024 · 1bee7c2 · 1bee7c2
2 parents 9565343 + fa2184b
commit 1bee7c2
Show file tree

Hide file tree

Showing 26 changed files with 178 additions and 110 deletions.
diff --git a/source/_dashboards/todo-list.markdown b/source/_dashboards/todo-list.markdown
@@ -61,6 +61,11 @@ theme:
   required: false
   description: Override the used theme for this card with any loaded theme. For more information about themes, see the [frontend documentation](/integrations/frontend/).
   type: string
+hide_completed:
+  required: false
+  description: Hide the completed items section in the card.
+  type: boolean
+  default: "false"
 {% endconfiguration %}
 
 ### Examples

diff --git a/source/_data/glossary.yml b/source/_data/glossary.yml
@@ -89,18 +89,18 @@
   link: /integrations/binary_sensor
 - term: Blueprint
   definition: >-
-    A blueprint is a script or automation configuration with certain parts
-    marked as configurable. This allows users to create multiple scripts or
-    automations based on the same blueprint, with each having its own
+    A blueprint is a script, automation or template entity configuration with certain parts
+    marked as configurable. This allows users to create multiple scripts,
+    automations or template entities based on the same blueprint, with each having its own
     configuration-specific settings. Blueprints are shared by the community on
     the [blueprints
     exchange](https://community.home-assistant.io/c/blueprints-exchange/53) in
     the forum.
   link: /docs/blueprint/
   excerpt: >-
-    A blueprint is a script or automation configuration with certain parts
-    marked as configurable. This allows users to create multiple scripts or
-    automations based on the same blueprint, with each having its own
+    A blueprint is a script, automation or template entity configuration with certain parts
+    marked as configurable. This allows users to create multiple scripts,
+    automations or template entities based on the same blueprint, with each having its own
     configuration-specific settings.
   aliases:
     - blueprints

diff --git a/source/_docs/blueprint.markdown b/source/_docs/blueprint.markdown
@@ -18,7 +18,7 @@ This section gives a high-level introduction to blueprints. To view a descriptio
 
 ## What is a blueprint?
 
-A blueprint is a {% term script %} or {% term automation %} configuration with certain parts marked as configurable. This allows you to create different scripts or automations based on the same blueprint.
+A blueprint is a {% term script %}, {% term automation %} or [template entity](/docs/integrations/template/) configuration with certain parts marked as configurable. This allows you to create different scripts, automations or template entities based on the same blueprint.
 
 Imagine you want to control lights based on motion. A blueprint provides the generic {% term automation %} framework, while letting you select one specific motion sensor as a {% term trigger %}, and the exact light to control. This blueprint makes it possible to create two automations. Each automation has their own configuration and act completely independently. Yet, they share some basic automation configuration so that you do not have to set this up every time.
 

diff --git a/source/_docs/blueprint/schema.markdown b/source/_docs/blueprint/schema.markdown
@@ -57,7 +57,7 @@ description:
 domain:
   description: >
     The domain in which this blueprint is used. Currently, only
-    [`automation`](/docs/automation/yaml/) and `script` are supported.
+    [`automation`](/docs/automation/yaml/), `script` and [`template`](/docs/integrations/template/#using-blueprints) are supported.
   type: string
   required: true
 author:

diff --git a/source/_integrations/aosmith.markdown b/source/_integrations/aosmith.markdown
@@ -72,7 +72,7 @@ This table shows the supported operation modes. The available modes will depend
 ### Sensor
 
 The following sensor entities are available:
-- Hot water availability (low, medium, or high)
+- Hot water availability (percentage)
 - Energy usage
 
 ## Disclaimer

diff --git a/source/_integrations/apache_kafka.markdown b/source/_integrations/apache_kafka.markdown
@@ -37,15 +37,15 @@ port:
   required: true
   type: integer
 username:
-  description: The username of Apache Kafka cluster for authentication.
+  description: The username of Apache Kafka cluster for SASL authentication. Required with `SASL_SSL` security protocol only.
   required: false
   type: string
 password:
-  description: The password of Apache Kafka cluster for authentication.
+  description: The password of Apache Kafka cluster for SASL authentication. Required with `SASL_SSL` security protocol only.
   required: false
   type: string
 security_protocol:
-  description: The protocol used to communicate with brokers. Use `SASL_SSL` for authentication.
+  description: The security protocol used to communicate with brokers. Use `SSL` for secure or `SASL_SSL` for secure with SASL authentication. (only `SASL_PLAINTEXT` SASL mechanism is supported)
   required: false
   default: PLAINTEXT
   type: string

diff --git a/source/_integrations/cambridge_audio.markdown b/source/_integrations/cambridge_audio.markdown
@@ -3,12 +3,14 @@ title: Cambridge Audio
 description: Instructions on how to integrate Cambridge Audio Receivers into Home Assistant.
 ha_category:
   - Media player
+  - Select
 ha_release: '2024.10'
 ha_iot_class: Local Push
 ha_domain: cambridge_audio
 ha_platforms:
   - diagnostics
   - media_player
+  - select
 ha_codeowners:
   - '@noahhusby'
 ha_config_flow: true
@@ -48,6 +50,11 @@ Host:
     type: string
 {% endconfiguration_basic %}
 
+## Available configuration entities
+
+The integration provides a few entities to configure the device settings. The following entities are supported:
+- Display brightness
+
 ## Troubleshooting
 
 ### The buttons to skip, shuffle, and repeat the track are missing

diff --git a/source/_integrations/enphase_envoy.markdown b/source/_integrations/enphase_envoy.markdown
@@ -140,6 +140,8 @@ This integration provides several values suitable for the energy dashboard:
 The integration provides a `configure` menu to configure the following options:
 
 - Collect test fixture data in [diagnostics report](#diagnostics) - No/Yes
+- Always use a new connection when requesting data from the Envoy - No/Yes
+  - Some older Envoy firmware may exhibit connection issues when using the, by default enabled, keep-alive connection and report failures. When set, this option disables the use of keep-alive and builds a new connection at each data request. This makes the communication more reliable for these firmware versions. Reported for the Envoy-R but may apply to other older firmware versions as well.
 
 ## Debug logs and diagnostics
 

diff --git a/source/_integrations/google_domains.markdown b/source/_integrations/google_domains.markdown
diff --git a/source/_integrations/habitica.markdown b/source/_integrations/habitica.markdown
@@ -54,6 +54,8 @@ The Habitca {% term integration %} enables you to monitor your adventurer's prog
 - **Next level:** Indicates the remaining experience points needed to reach the next level (for example, "440 XP").
 - **Habits:** Shows the number of habits being tracked (for example, "4 tasks").
 - **Rewards:** Displays the rewards that can be redeemed (for example, "1 task")
+- **Gems:** Shows the total number of gems currently owned by your Habitica character, used for purchasing items and customizations.
+- **Mystic hourglasses:** Displays the number of mystic hourglasses earned as a subscriber, which can be redeemed for exclusive items from past events.
 
 ## To-do lists
 
@@ -73,6 +75,25 @@ The following Habitica tasks are available as to-do lists in Home Assistant. You
 
 - **Rest in the Inn:** When enabled, allows your character to rest in the inn in Habitica, pausing damage dealt from dailies and quest bosses.
 
+## Actions
+
+### Action `habitica.cast_skill`
+
+Use a skill or spell from your Habitica character on a specific task to affect its progress or status.
+
+| Data attribute | Optional |  Description                                                                                                      |
+| -------------- | -------- | ----------------------------------------------------------------------------------------------------------------- |
+| `config_entry` | no       |  Config entry of the character to cast the skill.                                                                 |
+| `skill`        | no       |  Skill or spell you want to cast on the task. Only skills available to your character's class can be used.        |
+| `task`         | no       |  The name of the task to target. Alternatively, you can use the `task ID` or **alias**. Supported task types are **to-do**, **habit**, and **daily**. |
+
+#### Available skills
+
+- **Rogue:** `pickpocket`, `backstab`
+- **Warrior:** `smash`
+- **Mage:** `fireball`
+
+To use task aliases, make sure **Developer Mode** is enabled under [**Settings -> Site Data**](https://habitica.com/user/settings/siteData). Task aliases can only be edited via the **Habitica** web client.
 
 ## API Service
 

diff --git a/source/_integrations/husqvarna_automower.markdown b/source/_integrations/husqvarna_automower.markdown
@@ -178,6 +178,11 @@ The integration will create the following sensors:
 - Total searching time
 - Work area (if available). For example: *My lawn*, *Front lawn*, *Back lawn*
 
+For each work area with activated systematic mowing these sensors are created:
+
+- Progress (in percent)
+- Last time completed
+
 ### Switch
 
 #### Avoid (if available)

diff --git a/source/_integrations/jellyfin.markdown b/source/_integrations/jellyfin.markdown
@@ -4,6 +4,7 @@ description: Instructions on how to integrate the Jellyfin integration into Home
 ha_category:
   - Media player
   - Media source
+  - Remote
   - Sensor
 ha_release: '2021.12'
 ha_iot_class: Local Polling
@@ -15,6 +16,7 @@ ha_domain: jellyfin
 ha_platforms:
   - diagnostics
   - media_player
+  - remote
   - sensor
 ha_integration_type: service
 ---
@@ -28,6 +30,24 @@ server as a media player in Home Assistant to provide media controls for each se
 Browsing media inside Home Assistant in a player's context provides all libraries
 of type Movie and Series.
 
+This integration also creates a `Remote` entity for sending [remote commands](https://github.com/jellyfin/jellyfin/blob/master/MediaBrowser.Model/Session/GeneralCommandType.cs) to the client, if supported. For example, this can be used to tell the client to navigate right twice, down once, and select the focused item:
+
+```yaml
+jellyfin_remote_script:
+  alias: "Jellyfin Remote Script"
+  sequence:
+    - action: remote.send_command
+      target:
+        entity_id: remote.jellyfin_client
+      data:
+        delay_secs: 1.5
+        command:
+          - MoveRight
+          - MoveRight
+          - MoveDown
+          - Select
+```
+
 {% include integrations/config_flow.md %}
 
 {% configuration_basic %}

diff --git a/source/_integrations/modbus.markdown b/source/_integrations/modbus.markdown
@@ -1516,15 +1516,15 @@ switches:
             input:
               description: "Input register."
         state_on:
-          description: "Value when switch is on."
+          description: "Value(s) when switch is on. The value must be an `integer` or a list of integers."
           required: false
           default: "Same as `command_on`"
-          type: integer
+          type: [integer, list]
         state_off:
-          description: "Value when switch is off."
+          description: "Value(s) when switch is off.  The value must be an `integer` or a list of integers."
           required: false
           default: "Same as `command_off`"
-          type: integer
+          type: [integer, list]
 
 {% endconfiguration %}
 

diff --git a/source/_integrations/mold_indicator.markdown b/source/_integrations/mold_indicator.markdown
@@ -51,6 +51,7 @@ sensor:
     indoor_humidity_sensor: sensor.humidity
     outdoor_temp_sensor: sensor.weather_temperature
     calibration_factor: 2.0
+    unique_id: very_unique_id_123
 ```
 
 {% configuration %}
@@ -74,6 +75,10 @@ calibration_factor:
   description: Needs to be calibrated to the critical point in the room.
   required: true
   type: float
+unique_id:
+  description: Provide a unique id for the sensor.
+  required: false
+  type: string
 {% endconfiguration %}
 
 In this case, the weather forecast temperature sensor is used for the outside temperature.

diff --git a/source/_integrations/reolink.markdown b/source/_integrations/reolink.markdown
@@ -378,11 +378,7 @@ Normally, the digits are printed directly under the QR code. Alternatively, you
 
 Then power up the camera while pointing it at the QR code. It takes about a minute to initialize, read the QR code, and connect to your Wi-Fi.
 
-### 2. Enabling HTTP/HTTPS ports
-
-Test if you can access the camera by its IP address in your browser `https://<your-camera-ip>`. If you cannot, in the [Reolink mobile app, Windows, or Mac client](https://reolink.com/software-and-manual/) ensure at least one of the HTTP/HTTPS ports are enabled under **Settings** > **top camera model box** > **Network Information** > **Advanced** (mobile) or **Settings** > **Network** > **Advanced** > **Port Settings** (PC). See [additional instructions](https://support.reolink.com/hc/en-us/articles/900000621783-How-to-Set-up-Reolink-Ports-Settings/) on the Reolink site.
-
-### 3. Add integration in Home Assistant
+### 2. Add integration in Home Assistant
 
 Set up the Reolink integration in Home Assistant using the credentials you set in step 1.
 
@@ -394,7 +390,7 @@ Set up the Reolink integration in Home Assistant using the credentials you set i
 ## Troubleshooting
 
 - Older firmware versions do not expose the necessary information the integration needs to function. Ensure the camera is updated to the [latest firmware](https://reolink.com/download-center/) prior to setting up the integration. Note that Reolink auto update and check for update functions in the app/windows/web client often do not show the latest available firmware version. Therefore check the version in the [Reolink download center](https://reolink.com/download-center/) online.
-- Ensure at least one of the HTTP/HTTPS ports is enabled in the [Reolink mobile app, Windows, or Mac client](https://reolink.com/software-and-manual/) under **Settings** > **top camera model box** > **Network Information** > **Advanced** (mobile) or **Settings** > **Network** > **Advanced** > **Port Settings** (PC), see [additional instructions](https://support.reolink.com/hc/en-us/articles/900000621783-How-to-Set-up-Reolink-Ports-Settings/) on the Reolink site.
+- Test if you can access the camera by its IP address in your browser `https://<your-camera-ip>`. If you cannot, in the [Reolink mobile app, Windows, or Mac client](https://reolink.com/software-and-manual/) ensure at least one of the HTTP/HTTPS ports are enabled under **Settings** > **top camera model box** > **Network Information** > **Advanced** (mobile) or **Settings** > **Network** > **Advanced** > **Port Settings** (PC). See [additional instructions](https://support.reolink.com/hc/en-us/articles/900000621783-How-to-Set-up-Reolink-Ports-Settings/) on the Reolink site.
 - On some camera models, the RTMP port needs to be enabled in order for the HTTP(S) port to function properly. Make sure this port is also enabled if you get a `Cannot connect to host` error while one of the HTTP/HTTPS ports is already enabled.
 - Setting a static IP address for Reolink cameras/NVRs in your router is advisable to prevent (temporal) connectivity issues when the IP address changes.
 - Do not set a static IP in the Reolink device itself, but leave the **Connection Type** on **DHCP** under **Settings** > **Network** > **Network Information** > **Set Up**. If you set it to **static** on the Reolink device itself, this is known to cause incorrect DHCP requests on the network. The incorrect DHCP request causes Home Assistant to use the wrong IP address for the camera, resulting in connection issues. The issue originates from the Reolink firmware, which keeps sending DCHP requests even when you set a static IP address in the Reolink device.

diff --git a/source/_integrations/sensor.markdown b/source/_integrations/sensor.markdown
@@ -58,7 +58,7 @@ The following device classes are supported for sensors:
 - **data_rate**: Data rate in bit/s, kbit/s, Mbit/s, Gbit/s, B/s, kB/s, MB/s, GB/s, KiB/s, MiB/s or GiB/s
 - **data_size**: Data size in bit, kbit, Mbit, Gbit, B, kB, MB, GB, TB, PB, EB, ZB, YB, KiB, MiB, GiB, TiB, PiB, EiB, ZiB or YiB
 - **date**: Date string (ISO 8601)
-- **distance**: Generic distance in km, m, cm, mm, mi, yd, or in
+- **distance**: Generic distance in km, m, cm, mm, mi, nmi, yd, or in
 - **duration**: Duration in d, h, min, or s
 - **energy**: Energy in J, kJ, MJ, GJ, Wh, kWh, MWh, cal, kcal, Mcal, or Gcal
 - **energy_storage**: Stored energy in J, kJ, MJ, GJ, Wh, kWh, MWh, cal, kcal, Mcal, or Gcal

diff --git a/source/_integrations/shelly.markdown b/source/_integrations/shelly.markdown
@@ -330,6 +330,10 @@ The integration supports the following virtual components:
 - `text` in `field` mode, for which a `text` platform entity is created
 - `text` in `label` mode, for which a `sensor` platform entity is created
 
+## Scripts (generation 2 and 3)
+
+For each device script, the integration creates a `switch` entity that allows you to control the script. These entities are disabled by default.
+
 ## Additional info
 
 Shelly devices rely on [SNTP](https://en.wikipedia.org/wiki/Network_Time_Protocol#SNTP) for features like power measurement.

diff --git a/source/_integrations/spider.markdown b/source/_integrations/spider.markdown
diff --git a/source/_integrations/switcher_kis.markdown b/source/_integrations/switcher_kis.markdown
@@ -66,6 +66,10 @@ For Switcher Breeze the integration provides the following buttons:
 
 - For devices which do not support swing status for the vertical swing, the integration provides separate `Vertical swing on` & `Vertical swing off` buttons.
 
+## Lights
+
+For Switcher light control devices (Switcher Runner S11) the integration allows you to control its lights on/off state.
+
 ## Sensors
 
 For Switcher power control devices (Switcher Power Plug, Switcher Touch, Switcher V2/V4) the integration provides the following sensors: