From 7e7f6a29ae3891dd5e6860aa2de91d06ac0d25b4 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Wed, 8 May 2024 23:10:02 +0200 Subject: [PATCH] n integrations 2/2: restart HA after changing config (#32651) --- source/_integrations/nissan_leaf.markdown | 12 ++++--- source/_integrations/nmbs.markdown | 8 +++-- source/_integrations/no_ip.markdown | 8 +++-- source/_integrations/noaa_tides.markdown | 7 ++-- source/_integrations/norway_air.markdown | 8 +++-- source/_integrations/notify_events.markdown | 34 +++++++++++-------- .../nsw_rural_fire_service_feed.markdown | 34 +++++++++++-------- source/_integrations/nx584.markdown | 24 +++++++------ 8 files changed, 82 insertions(+), 53 deletions(-) diff --git a/source/_integrations/nissan_leaf.markdown b/source/_integrations/nissan_leaf.markdown index b710bc007b8..950010d0b67 100644 --- a/source/_integrations/nissan_leaf.markdown +++ b/source/_integrations/nissan_leaf.markdown @@ -14,17 +14,20 @@ ha_platforms: - sensor - switch ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The `nissan_leaf` integration offers integration with the [NissanConnect EV](https://www.nissan.co.uk/dashboard.html) cloud service. NissanConnect EV was previously known as Nissan Carwings. +The `nissan_leaf` {% term integration %} offers integration with the [NissanConnect EV](https://www.nissan.co.uk/dashboard.html) cloud service. NissanConnect EV was previously known as Nissan Carwings.
-Please be aware that the `nissan_leaf` integration only works with Nissan vehicles from before 2019. Newer vehicles will not work with this integration. +Please be aware that the `nissan_leaf` {% term integration %} only works with Nissan vehicles from before 2019. Newer vehicles will not work with this integration.
-The integration offers offers: +The {% term integration %} offers offers: - sensors for the battery status, range and charging status. - a switch to start and stop the climate control. @@ -33,7 +36,8 @@ The integration offers offers: ## Configuration -To use Nissan Leaf in your installation, add the following to your `configuration.yaml` file: +To use Nissan Leaf in your installation, add the following to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/nmbs.markdown b/source/_integrations/nmbs.markdown index 56cf49efd75..2e7f69a32e1 100644 --- a/source/_integrations/nmbs.markdown +++ b/source/_integrations/nmbs.markdown @@ -11,13 +11,17 @@ ha_domain: nmbs ha_platforms: - sensor ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The `nmbs` platform will create sensors for monitoring travel time and information between 2 stations. +The `nmbs` {% term integration %} will create sensors for monitoring travel time and information between 2 stations. ## Configuration -To enable this sensor, add the following lines to your `configuration.yaml`: +To enable this {% term integration %}, add the following lines to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/no_ip.markdown b/source/_integrations/no_ip.markdown index 040c40b5dbb..7a04f498ebf 100644 --- a/source/_integrations/no_ip.markdown +++ b/source/_integrations/no_ip.markdown @@ -7,13 +7,17 @@ ha_iot_class: Cloud Polling ha_release: 0.57 ha_domain: no_ip ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -With the `no_ip` integration you can keep your current IP address in sync with your [NO-IP.com](https://www.noip.com) hostname or domain. +With the `no_ip` {% term integration %} you can keep your current IP address in sync with your [NO-IP.com](https://www.noip.com) hostname or domain. Note that it does not confirm your hostname (as is required periodically for free domain names); you will still need to do that manually. -To use the integration in your installation, add the following to your `configuration.yaml` file: +To use the {% term integration %} in your installation, add the following to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/noaa_tides.markdown b/source/_integrations/noaa_tides.markdown index 64ea1349272..2df28c52e01 100644 --- a/source/_integrations/noaa_tides.markdown +++ b/source/_integrations/noaa_tides.markdown @@ -13,15 +13,16 @@ ha_platforms: ha_integration_type: integration --- -The `noaa_tides` sensor platform uses details from [NOAA Tides and Currents](https://tidesandcurrents.noaa.gov/api/) to provide information about the prediction for the tides for any location in the United States. +The `noaa_tides` sensor {% term integration %} uses details from [NOAA Tides and Currents](https://tidesandcurrents.noaa.gov/api/) to provide information about the prediction for the tides for any location in the United States. ## Setup -This sensor requires the use of a NOAA station ID. Search [NOAA Tide Predictions](https://tidesandcurrents.noaa.gov/tide_predictions.html) to find a location. Use the ID from the search results in your configuration. Alternatively, you can determine a station ID from a URL. For example, `8721164` in the following URL: `https://tidesandcurrents.noaa.gov/noaatidepredictions.html?id=8721164` +This {% term integration %} requires the use of a NOAA station ID. Search [NOAA Tide Predictions](https://tidesandcurrents.noaa.gov/tide_predictions.html) to find a location. Use the ID from the search results in your configuration. Alternatively, you can determine a station ID from a URL. For example, `8721164` in the following URL: `https://tidesandcurrents.noaa.gov/noaatidepredictions.html?id=8721164` ## Configuration -To use this sensor, add the following to your `configuration.yaml` file: +To use this {% term integration %}, add the following to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/norway_air.markdown b/source/_integrations/norway_air.markdown index 8c3751d7936..7c1ed2c040b 100644 --- a/source/_integrations/norway_air.markdown +++ b/source/_integrations/norway_air.markdown @@ -9,11 +9,15 @@ ha_domain: norway_air ha_platforms: - air_quality ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The `norway_air` integration [queries](https://luftkvalitet.miljostatus.no/) the Norway air quality [data feed](https://api.met.no/weatherapi/airqualityforecast/0.1/documentation) provided by the Norwegian Meteorological Institute. +The `norway_air` {% term integration %} [queries](https://luftkvalitet.miljostatus.no/) the Norway air quality [data feed](https://api.met.no/weatherapi/airqualityforecast/0.1/documentation) provided by the Norwegian Meteorological Institute. -To add air quality sensor to your installation, add the following to your `configuration.yaml` file: +To add the air quality {% term integration %} to your installation, add the following to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/notify_events.markdown b/source/_integrations/notify_events.markdown index b51bf8bce00..60ada8c75cc 100644 --- a/source/_integrations/notify_events.markdown +++ b/source/_integrations/notify_events.markdown @@ -12,11 +12,14 @@ ha_iot_class: Cloud Push ha_platforms: - notify ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- ## Description -The [Notify.Events service](https://notify.events/) is a platform for the **notify** integration. +The [Notify.Events service](https://notify.events/) is an {% term integration %} for the **notify** integration. This platform allows you to quickly configure the distribution of messages between different recipients, no matter how they are used to receiving notifications: @@ -52,7 +55,8 @@ token: type: string {% endconfiguration %} -Now you can use notify_events integration as a platform for your **notify service**, add the following to your `configuration.yaml` file: +Now you can use notify_events integration as a platform for your **notify service**, add the following to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %}: ```yaml # Example configuration.yaml entry @@ -98,21 +102,21 @@ Now you can use the `notify.events` service inside your Home Assistant to: The following attributes can be placed inside `data` for extended functionality. -| Attribute | Description -| ---------- | ----------- -| `title` | Message title. -| `level` | For recipients who have differences in the display of messages at different levels, this level will be applied.
Available values: `verbose`, `info`, `notice`, `warning`, `error`, `success`. -| `priority` | For recipients which supports priority, the message will be highlighted accordingly.
Available values: `lowest`, `low`, `normal`, `high`, `highest`. -| `images` | Array of images to attach (see item properties below). -| `files` | Array of files to attach (see item properties below). -| `token` | Notify.Events channel token (in case you want to override the channel to get this message to). +| Attribute | Description | +| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `title` | Message title. | +| `level` | For recipients who have differences in the display of messages at different levels, this level will be applied.
Available values: `verbose`, `info`, `notice`, `warning`, `error`, `success`. | +| `priority` | For recipients which supports priority, the message will be highlighted accordingly.
Available values: `lowest`, `low`, `normal`, `high`, `highest`. | +| `images` | Array of images to attach (see item properties below). | +| `files` | Array of files to attach (see item properties below). | +| `token` | Notify.Events channel token (in case you want to override the channel to get this message to). | Every item of images and files has the following properties: -| Property | Required | Description -| ---------------------------- | -------- | ---- -| `path` or `url` or `content` | True | File source. -| `name` | False | Result file name -| `mime_type` | False | File MIME-type +| Property | Required | Description | +| ---------------------------- | -------- | ---------------- | +| `path` or `url` or `content` | True | File source. | +| `name` | False | Result file name | +| `mime_type` | False | File MIME-type | To use notifications effectively, please see the [getting started with automation page](/getting-started/automation/). diff --git a/source/_integrations/nsw_rural_fire_service_feed.markdown b/source/_integrations/nsw_rural_fire_service_feed.markdown index 19882a14db0..fd77fae7699 100644 --- a/source/_integrations/nsw_rural_fire_service_feed.markdown +++ b/source/_integrations/nsw_rural_fire_service_feed.markdown @@ -11,6 +11,9 @@ ha_domain: nsw_rural_fire_service_feed ha_platforms: - geo_location ha_integration_type: service +related: + - docs: /docs/configuration/ + title: Configuration file --- The `nsw_rural_fire_service_feed` platform lets you integrate a GeoJSON feed provided by the [NSW Rural Fire Service](https://www.rfs.nsw.gov.au/fire-information/fires-near-me) with information about bush fires, grass fires, hazard reductions and more. It retrieves incidents from a feed and shows information of those incidents filtered by distance to Home Assistant's location. @@ -31,7 +34,8 @@ The data is updated every 5 minutes. ## Configuration -To integrate the NSW Rural Fire Service Incidents feed, add the following lines to your `configuration.yaml`. +To integrate the NSW Rural Fire Service Incidents feed, add the following lines to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry @@ -66,21 +70,21 @@ longitude: The following state attributes are available for each entity in addition to the standard ones: -| Attribute | Description | -|--------------------|-------------| -| latitude | Latitude of the incident. | -| longitude | Longitude of the incident. | +| Attribute | Description | +| ------------------ | ----------------------------------------------------------------------------------------------- | +| latitude | Latitude of the incident. | +| longitude | Longitude of the incident. | | source | `nsw_rural_fire_service_feed` to be used in conjunction with `geo_location` automation trigger. | -| external_id | The external ID used in the feed to identify the incident in the feed. | -| category | One of 'Emergency Warning', 'Watch and Act', 'Advice', 'Not Applicable'. | -| location | Location details of where the incident takes place. | -| publication_date | Date and time when this incident was last updated. | -| council_area | Council area in which this incident takes place. | -| status | One of 'Under Control', 'Being Controlled', 'Out of Control'. | -| type | Incident type, for example 'Bush Fire', 'Grass Fire' or 'Hazard Reduction'. | -| fire | `True` if this incident is a fire, `False` otherwise. | -| size | Size in hectare | -| responsible_agency | Agency responsible for this incident. | +| external_id | The external ID used in the feed to identify the incident in the feed. | +| category | One of 'Emergency Warning', 'Watch and Act', 'Advice', 'Not Applicable'. | +| location | Location details of where the incident takes place. | +| publication_date | Date and time when this incident was last updated. | +| council_area | Council area in which this incident takes place. | +| status | One of 'Under Control', 'Being Controlled', 'Out of Control'. | +| type | Incident type, for example 'Bush Fire', 'Grass Fire' or 'Hazard Reduction'. | +| fire | `True` if this incident is a fire, `False` otherwise. | +| size | Size in hectare | +| responsible_agency | Agency responsible for this incident. | ## Advanced Configuration Example diff --git a/source/_integrations/nx584.markdown b/source/_integrations/nx584.markdown index 3c5574a3bef..23a44649cb7 100644 --- a/source/_integrations/nx584.markdown +++ b/source/_integrations/nx584.markdown @@ -11,9 +11,12 @@ ha_platforms: - alarm_control_panel - binary_sensor ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The `nx584` platform provides integration with GE, Caddx, Interlogix (and other brands) alarm panels that support the NX584 interface module (or have it built in). Supported panels include NX4/6/8/8E. Actual integration is done through [pynx584](https://github.com/kk7ds/pynx584) which is required for this to work. +The `nx584` {% term integration %} provides integration with GE, Caddx, Interlogix (and other brands) alarm panels that support the NX584 interface module (or have it built in). Supported panels include NX4/6/8/8E. Actual integration is done through [pynx584](https://github.com/kk7ds/pynx584) which is required for this to work. There is currently support for the following device types within Home Assistant: @@ -22,7 +25,8 @@ There is currently support for the following device types within Home Assistant: ## Alarm control panel -To enable this, add the following lines to your `configuration.yaml`: +To enable this, add the following lines to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry @@ -120,16 +124,16 @@ binary_sensor: This service will bypass a given zone. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `entity_id` | yes | entity_id of the NX584 Alarm. -| `zone` | no | Zone number you want to bypass. +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ------------------------------- | +| `entity_id` | yes | entity_id of the NX584 Alarm. | +| `zone` | no | Zone number you want to bypass. | ### Service `unbypass_zone` This service will unbypass a given zone. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `entity_id` | yes | entity_id of the NX584 Alarm. -| `zone` | no | Zone number you want to unbypass. +| Service data attribute | Optional | Description | +| ---------------------- | -------- | --------------------------------- | +| `entity_id` | yes | entity_id of the NX584 Alarm. | +| `zone` | no | Zone number you want to unbypass. |