From 390e3d6d324bb57121796aef50584e4ff81421cc Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Tue, 23 Apr 2024 10:54:18 +0200 Subject: [PATCH] Integrations: move Related topics to meta data (#32426) --- source/_integrations/caldav.markdown | 12 +----- source/_integrations/history.markdown | 5 --- source/_integrations/local_todo.markdown | 10 ++--- source/_integrations/ollama.markdown | 5 --- source/_integrations/ourgroceries.markdown | 7 --- source/_integrations/prusalink.markdown | 5 --- source/_integrations/reolink.markdown | 17 ++++---- source/_integrations/todo.markdown | 50 +++++++++++----------- source/_integrations/tts.markdown | 19 ++++---- 9 files changed, 52 insertions(+), 78 deletions(-) diff --git a/source/_integrations/caldav.markdown b/source/_integrations/caldav.markdown index 533056cbfca..1045fac7652 100644 --- a/source/_integrations/caldav.markdown +++ b/source/_integrations/caldav.markdown @@ -19,6 +19,8 @@ related: title: List of to-do list integrations - docs: /dashboards/todo-list/ title: To-do list card +- docs: /integrations/calendar + title: Calendar --- The **CalDAV** integration allows you to connect your WebDAV calendar to Home Assistant @@ -210,13 +212,3 @@ to generate a new password for use by Home Assistant to avoid sharing your iClou password. {% enddetails %} - -## Related topics - -- [Calendar](/integrations/calendar) - -### To-do list - -- [To-do list integration documentation](/integrations/todo) -- [List of to-do list integrations](/integrations/#to-do-list) -- [To-do list card](/dashboards/todo-list/) diff --git a/source/_integrations/history.markdown b/source/_integrations/history.markdown index 4c05981e26c..b6aa03efdbf 100644 --- a/source/_integrations/history.markdown +++ b/source/_integrations/history.markdown @@ -54,8 +54,3 @@ If you select a time frame that exceeds 10 days, the data is taken from the long The history information is also available through the [RESTful API](/developers/rest_api/#get-apihistory). - -## Related topics - -- [Recorder integration](/integrations/recorder/) -- [Home Assistant Data Science Portal](https://data.home-assistant.io) diff --git a/source/_integrations/local_todo.markdown b/source/_integrations/local_todo.markdown index 934b22aa4bd..311864427d1 100644 --- a/source/_integrations/local_todo.markdown +++ b/source/_integrations/local_todo.markdown @@ -12,6 +12,11 @@ ha_codeowners: ha_integration_type: integration ha_platforms: - todo +related: +- docs: /integrations/todo/ + title: To-do list integration documentation +- docs: /dashboards/todo-list/ + title: To-do list card --- The **Local to-do list** integration allows you to create to-do lists in Home Assistant. @@ -22,8 +27,3 @@ See the [**To-do list** integration](/integrations/todo) for additional details about to-do list entities. {% include integrations/config_flow.md %} - -## Related topics - -- [**To-do list** integration](/integrations/todo) -- [To-do list card](/dashboards/todo-list/) diff --git a/source/_integrations/ollama.markdown b/source/_integrations/ollama.markdown index 5acbedeba09..16354745b97 100644 --- a/source/_integrations/ollama.markdown +++ b/source/_integrations/ollama.markdown @@ -40,8 +40,3 @@ Max history messages: description: Maximum number of messages to keep for each conversation (0 = no limit). Limiting this value will cause older messages in a conversation to be dropped. {% endconfiguration_basic %} - -## Related topics - -- [Home Assistant Templating](/docs/configuration/templating/) -- [Sentence trigger](/docs/automation/trigger/#sentence-trigger) diff --git a/source/_integrations/ourgroceries.markdown b/source/_integrations/ourgroceries.markdown index 26526f6132e..1d925b206bf 100644 --- a/source/_integrations/ourgroceries.markdown +++ b/source/_integrations/ourgroceries.markdown @@ -27,10 +27,3 @@ This integration connects with an [OurGroceries](https://www.ourgroceries.com/) It adds a [to-do list entity](/integrations/todo) for each shopping list, allowing you to create, update, or delete items on the list from the **To-do list** dashboard. {% include integrations/config_flow.md %} - -## Related topics - -- [OurGroceries](https://www.ourgroceries.com/) -- [To-do list integration documentation](/integrations/todo) -- [List of to-do list integrations](/integrations/#to-do-list) -- [To-do list card](/dashboards/todo-list/) diff --git a/source/_integrations/prusalink.markdown b/source/_integrations/prusalink.markdown index 4860f9462bc..a348d54516b 100644 --- a/source/_integrations/prusalink.markdown +++ b/source/_integrations/prusalink.markdown @@ -51,8 +51,3 @@ Firmware update guides can be found here: {% include integrations/config_flow.md %} -## Related topics - -- [PrusaLink documentation](https://help.prusa3d.com/article/prusa-connect-and-prusalink-explained_302608) -- [PrusaLink installation guide for Prusa MK3 with Raspberry Pi Zero W](https://help.prusa3d.com/guide/prusalink-and-prusa-connect-setup-mk3-s-_221744) -- [PrusaLink installation guide for Prusa MK2.5/MK3 with Raspberry Pi 3/4](https://help.prusa3d.com/guide/prusalink-prusa-connect-with-rpi-3-4-usb-mk2-5-s-mk3-s-_469341) diff --git a/source/_integrations/reolink.markdown b/source/_integrations/reolink.markdown index e05afde201b..2784b4921b4 100644 --- a/source/_integrations/reolink.markdown +++ b/source/_integrations/reolink.markdown @@ -24,6 +24,11 @@ ha_platforms: - update ha_integration_type: integration ha_dhcp: true +related: +- docs: /dashboards/picture-glance/#creating-a-card-to-control-the-camera + title: Controlling the camera from the dashboard +- url: https://reolink.com/ + title: Reolink product page --- The integration allows you to control [Reolink](https://reolink.com/) NVRs or cameras. @@ -144,10 +149,10 @@ Depending on the supported features of the camera, button entities are added for Some Reolink PTZ cameras can move at different speeds. For those cameras, the `reolink.ptz_move` service can be used in combination with the **PTZ left**, **right**, **up**, **down**, **zoom in**, or **zoom out** entity which allows specifying the speed attribute. If the PTZ button entities for a specific camera are not shown under **Choose entity** under **targets** of the `reolink.ptz_move` service, it means that this camera does not support custom PTZ speeds. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | -----------------------------------------------------------------------------------------| -| `entity_id` | no | Name of the Reolink PTZ button entity to control. For example, `button.trackmix_ptz_left`. | -| `speed` | no | PTZ move speed. For example `10`. | +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------- | +| `entity_id` | no | Name of the Reolink PTZ button entity to control. For example, `button.trackmix_ptz_left`. | +| `speed` | no | PTZ move speed. For example `10`. | ## Select entities @@ -360,7 +365,3 @@ An SSL certificate can still be enforced for external connections, by, for insta To see if a Reolink integration is currently using `ONVIF push`, `ONVIF long polling` or `Fast polling`, [download the diagnostics text file](/docs/configuration/troubleshooting/#download-diagnostics) and find the `"event connection": "ONVIF push"\"ONVIF long polling"\"Fast polling"` in the txt file. -## Related topics - -- [Controlling the camera from the dashboard](/dashboards/picture-glance/#creating-a-card-to-control-the-camera) -- [Reolink product page](https://reolink.com/) diff --git a/source/_integrations/todo.markdown b/source/_integrations/todo.markdown index c07dc406748..4b6b586efa6 100644 --- a/source/_integrations/todo.markdown +++ b/source/_integrations/todo.markdown @@ -9,6 +9,11 @@ ha_quality_scale: internal ha_codeowners: - '@home-assistant/core' ha_integration_type: entity +related: +- docs: /integrations/local_todo + title: Local to-do list integration documentation +- docs: /dashboards/todo-list/ + title: To-do list card --- The **To-do list** {% term integration %} provides to-do list {% term entities %}, allowing other integrations @@ -46,9 +51,9 @@ services provided by some to-do list entities are described below or you can rea Get to-do items from a to-do list. A to-do list `target` is selected with a [target selector](/docs/blueprint/selectors/#target-selector). The `data` payload supports the following fields: -| Service data attribute | Optional | Description | Example | -| ---------------------- | -------- | ----------- | --------| -| `status` | yes | Only return to-do items with this status. | `needs_action`, `completed` +| Service data attribute | Optional | Description | Example | +| ---------------------- | -------- | ----------------------------------------- | --------------------------- | +| `status` | yes | Only return to-do items with this status. | `needs_action`, `completed` | This is a full example that returns all to-do items that have not been completed: @@ -65,12 +70,12 @@ data: Add a new to-do item. A to-do list `target` is selected with a [Target Selector](/docs/blueprint/selectors/#target-selector) and the `data` payload supports the following fields: -| Service data attribute | Optional | Description | Example | -| ---------------------- | -------- | ----------- | --------| -| `item` | no | the name of the to-do Item. | Submit income tax return -| `due_date` | yes | The date the to-do item is expected to be completed. | 2024-04-10 -| `due_datetime` | yes | The date and time the to-do item is expected to be completed. | 2024-04-10 23:00:00 -| `description` | yes | A more complete description than the one provided by the summary | Collect all necessary documents and submit the final return. +| Service data attribute | Optional | Description | Example | +| ---------------------- | -------- | ---------------------------------------------------------------- | ------------------------------------------------------------ | +| `item` | no | the name of the to-do Item. | Submit income tax return | +| `due_date` | yes | The date the to-do item is expected to be completed. | 2024-04-10 | +| `due_datetime` | yes | The date and time the to-do item is expected to be completed. | 2024-04-10 23:00:00 | +| `description` | yes | A more complete description than the one provided by the summary | Collect all necessary documents and submit the final return. | Only one of `due_date` or `due_datetime` may be specified. @@ -90,14 +95,14 @@ data: Update a to-do item. A to-do list `target` is selected with a [Target Selector](/docs/blueprint/selectors/#target-selector) and the `data` payload supports the following fields: -| Service data attribute | Optional | Description | Example | -| ---------------------- | -------- | ----------- | --------| -| `item` | no | The name of the to-do Item to update. | Submit income tax return -| `rename` | yes | The new name of the to-do Item. | Something else -| `status` | yes | The overall status of the To-do Item. | `needs_action` or `completed` -| `due_date` | yes | The date the to-do item is expected to be completed. | 2024-04-10 -| `due_datetime` | yes | The date and time the to-do item is expected to be completed. | 2024-04-10 23:00:00 -| `description` | yes | A more complete description than the one provided by the summary. | Collect all necessary documents and submit the final return. +| Service data attribute | Optional | Description | Example | +| ---------------------- | -------- | ----------------------------------------------------------------- | ------------------------------------------------------------ | +| `item` | no | The name of the to-do Item to update. | Submit income tax return | +| `rename` | yes | The new name of the to-do Item. | Something else | +| `status` | yes | The overall status of the To-do Item. | `needs_action` or `completed` | +| `due_date` | yes | The date the to-do item is expected to be completed. | 2024-04-10 | +| `due_datetime` | yes | The date and time the to-do item is expected to be completed. | 2024-04-10 23:00:00 | +| `description` | yes | A more complete description than the one provided by the summary. | Collect all necessary documents and submit the final return. | At least one of `rename` or `status` is required. Only one of `due_date` or `due_datetime` may be specified. This is a full example of a service call that updates the status and the name of a to-do item. @@ -115,9 +120,9 @@ data: Removing a to-do item. A to-do list `target` is selected with a [Target Selector](/docs/blueprint/selectors/#target-selector), and the `data` payload supports the following fields: -| Service data attribute | Optional | Description | Example | -| ---------------------- | -------- | ----------- | --------| -| `item` | no | The name of the to-do item. | Submit income tax return +| Service data attribute | Optional | Description | Example | +| ---------------------- | -------- | --------------------------- | ------------------------ | +| `item` | no | The name of the to-do item. | Submit income tax return | This is a full example of a service call that deletes a to-do Item with the specified name. @@ -140,8 +145,3 @@ service: todo.remove_completed_items target: entity_id: todo.personal_tasks ``` - -## Related topics - -- [Local to-do integration](/integrations/local_todo/) -- [To-do list card](/dashboards/todo-list/) diff --git a/source/_integrations/tts.markdown b/source/_integrations/tts.markdown index c3f4e8bc000..b8734da06a9 100644 --- a/source/_integrations/tts.markdown +++ b/source/_integrations/tts.markdown @@ -12,6 +12,17 @@ ha_quality_scale: internal ha_platforms: - notify ha_integration_type: entity +related: +- url: https://www.home-assistant.io/integrations/#text-to-speech + title: List of integrations using the TTS integration +- url: https://www.nabucasa.com/config/tts/ + title: TTS with Home Assistant Cloud +- url: https://www.home-assistant.io/integrations/google_translate/ + title: Google Translate TTS +- url: https://www.home-assistant.io/integrations/microsoft/ + title: Microsoft TTS +- url: https://www.home-assistant.io/voice_control/ + title: Home Assistant Assist --- Text-to-speech (TTS) enables Home Assistant to speak to you. @@ -143,11 +154,3 @@ The Google cast devices (Google Home, Chromecast, etc.) present the following pr - They do not work with URLs that contain hostnames established by local naming means. Let's say your Home Assistant instance is running on a machine made known locally as `ha`. All your machines on your local network are able to access it as `ha`. However, try as you may, your cast device won't download the media files from your `ha` machine. That's because your cast device ignores your local naming setup. In this example, the `say` service creates a URL like `http://ha/path/to/media.mp3` (or `https://...` if you are using SSL). If you are _not_ using SSL then setting an internal URL that contains the IP address of your server works around this issue. By using an IP address, the cast device does not have to resolve the hostname. - If you are using SSL (e.g., `https://yourhost.example.org/...`) then you _must_ use the hostname in the certificate (e.g., `external_url: https://yourhost.example.org`). You cannot use an IP address since the certificate won't be valid for the IP address, and the cast device will refuse the connection. - -### Related topics - -- [List of integrations using the TTS integration](https://www.home-assistant.io/integrations/#text-to-speech) -- [TTS with Home Assistant Cloud](https://www.nabucasa.com/config/tts/) -- [Google Translate TTS](https://www.home-assistant.io/integrations/google_translate/) -- [Microsoft TTS](https://www.home-assistant.io/integrations/microsoft/) -- [Home Assistant Assist](https://www.home-assistant.io/voice_control/)