jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 07:17:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

g-integrations: restart HA after changing config (#32639)

Browse Source
This commit is contained in:
c0ffeeca7 2024-05-08 23:17:57 +02:00 committed by GitHub
parent cb593a9d68
commit 9c17b062e9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
16 changed files with 103 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
source/_integrations/garadget.markdown
View File

@ -9,13 +9,17 @@ ha_domain: garadget
ha_platforms:
- cover
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `garadget` cover platform lets you control [Garadget](https://www.garadget.com/) garage door futurizers through Home Assistant.
The `garadget` cover {% term integration %} lets you control [Garadget](https://www.garadget.com/) garage door futurizers through Home Assistant.
## Configuration
To enable Garadget Covers in your installation, add the following to your `configuration.yaml` file:
To enable Garadget Covers 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

9
source/_integrations/gc100.markdown
View File

@ -12,6 +12,9 @@ ha_platforms:
- binary_sensor
- switch
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The Global Caché GC-100 can be integrated into Home Assistant. GC-100 is a TCP-controllable
@ -27,7 +30,8 @@ Currently, only relays and ports configured to be digital inputs are supported i
## Configuration
To enable this device, add the following lines to your `configuration.yaml`:
To enable this device, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
@ -73,7 +77,8 @@ ports:
This allows you to control and monitor the relay state on your GC100.
To enable this switch, you first have to set up [gc100](#configuration), and add the following lines to your `configuration.yaml` file:
To enable this switch, you first have to set up [gc100](#configuration), and add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

8
source/_integrations/generic_hygrostat.markdown
View File

@ -12,9 +12,15 @@ ha_iot_class: Local Polling
ha_platforms:
- humidifier
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `generic_hygrostat` humidifier integration is a virtual hygrostat implemented in Home Assistant. It uses a sensor and a switch connected to a humidifier or dehumidifier under the hood. When in humidifier mode, if the measured humidity is less than the target humidity, the humidifier will be turned on and turned off when the required humidity is reached. When in dehumidifier mode, if the measured humidity is greater than the target humidity, the dehumidifier will be turned on and turned off when required humidity is reached. One Generic Hygrostat entity can only control one switch. If you need to activate two switches, one for a humidifier and one for a dehumidifier, you will need two Generic Hygrostat entities.
The `generic_hygrostat` humidifier {% term integration %} is a virtual hygrostat implemented in Home Assistant. It uses a sensor and a switch connected to a humidifier or dehumidifier under the hood. When in humidifier mode, if the measured humidity is less than the target humidity, the humidifier will be turned on and turned off when the required humidity is reached. When in dehumidifier mode, if the measured humidity is greater than the target humidity, the dehumidifier will be turned on and turned off when required humidity is reached. One Generic Hygrostat entity can only control one switch. If you need to activate two switches, one for a humidifier and one for a dehumidifier, you will need two Generic Hygrostat entities.
To enable the {% term integration %}, you need to add it to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

8
source/_integrations/generic_thermostat.markdown
View File

@ -9,9 +9,15 @@ ha_domain: generic_thermostat
ha_platforms:
- climate
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `generic_thermostat` climate platform is a thermostat implemented in Home Assistant. It uses a sensor and a switch connected to a heater or air conditioning under the hood. When in heater mode, if the measured temperature is cooler than the target temperature, the heater will be turned on and turned off when the required temperature is reached. When in air conditioning mode, if the measured temperature is hotter than the target temperature, the air conditioning will be turned on and turned off when required temperature is reached. One Generic Thermostat entity can only control one switch. If you need to activate two switches, one for a heater and one for an air conditioner, you will need two Generic Thermostat entities.
The `generic_thermostat` climate {% term integration %} is a thermostat implemented in Home Assistant. It uses a sensor and a switch connected to a heater or air conditioning under the hood. When in heater mode, if the measured temperature is cooler than the target temperature, the heater will be turned on and turned off when the required temperature is reached. When in air conditioning mode, if the measured temperature is hotter than the target temperature, the air conditioning will be turned on and turned off when required temperature is reached. One Generic Thermostat entity can only control one switch. If you need to activate two switches, one for a heater and one for an air conditioner, you will need two Generic Thermostat entities.
To enable the {% term integration %}, you need to add it to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

11
source/_integrations/geo_rss_events.markdown
View File

@ -11,11 +11,14 @@ ha_domain: geo_rss_events
ha_platforms:
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `geo_rss_events` sensor retrieves events from a GeoRSS feed and shows information of those events filtered by distance to Home Assistant's location and grouped by category.
The `geo_rss_events` {% term integration %} retrieves events from a GeoRSS feed and shows information of those events filtered by distance to Home Assistant's location and grouped by category.
This sensor is particularly useful if events occur unexpectedly in the vicinity of the home while the GeoRSS feed also contains many events representing distant unrelated entries. Typical examples are bush fires alerts or earthquakes.
This {% term integration %} is particularly useful if events occur unexpectedly in the vicinity of the home while the GeoRSS feed also contains many events representing distant unrelated entries. Typical examples are bush fires alerts or earthquakes.
<p class='img'>
<img src='/images/screenshots/geo-rss-incidents-group-screenshot.png' />
@ -29,7 +32,9 @@ The data is updated every 5 minutes.
## Configuration
To enable the GeoRSS events sensor, add the following lines to your `configuration.yaml`. This is an example configuration showing bush fire incidents from the NSW Rural Fire Service.
To enable the GeoRSS events sensor, add the following lines to your {% term "`configuration.yaml`" %} file.
This is an example configuration showing bush fire incidents from the NSW Rural Fire Service.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

8
source/_integrations/geofency.markdown
View File

@ -10,9 +10,12 @@ ha_domain: geofency
ha_platforms:
- device_tracker
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
This integration sets up integration with [Geofency](https://www.geofency.com/). Geofency is a paid app for iOS that lets users to configure a request that will be sent when a geofence or iBeacon region is entered or exited. This can be configured with Home Assistant to update your location.
This {% term integration %} sets up integration with [Geofency](https://www.geofency.com/). Geofency is a paid app for iOS that lets users to configure a request that will be sent when a geofence or iBeacon region is entered or exited. This can be configured with Home Assistant to update your location.
## Configuration
@ -20,7 +23,8 @@ To configure Geofency, you must set it up via the integrations panel in the conf
Geofency will automatically generate the device tracker name used for geofences, and you will find it in the integrations section after the first request. For beacons, the device name will be `beacon_<name from Geofency>`, e.g., `device_tracker.beacon_car`.
When using mobile beacons (optional) an entry in `configuration.yaml` is still needed as this can't be added via the integrations panel.
When using mobile beacons (optional) an entry in {% term "`configuration.yaml`" %} file is still needed as this can't be added via the integrations panel.
{% include integrations/restart_ha_after_config_inclusion.md %}
{% configuration %}
mobile_beacons:

8
source/_integrations/gitlab_ci.markdown
View File

@ -9,9 +9,12 @@ ha_domain: gitlab_ci
ha_platforms:
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `gitlab_ci` sensor platform integrates results reported by CI/CD Pipeline Jobs in [GitLab](https://gitlab.com/).
The `gitlab_ci` sensor {% term integration %} integrates results reported by CI/CD Pipeline Jobs in [GitLab](https://gitlab.com/).
## Setup
@ -23,7 +26,8 @@ A GitLab token with at least the API permission scope is needed, which can be cr
## Configuration
To enable this platform, please add the following to your `configuration.yaml` file:
To enable this {% term integration %}, please add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

8
source/_integrations/gitter.markdown
View File

@ -9,15 +9,19 @@ ha_domain: gitter
ha_platforms:
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
This `gitter` sensor allows one to monitor a [Gitter.im](https://gitter.im) chatroom for unread messages.
This `gitter` {% term integration %} allows one to monitor a [Gitter.im](https://gitter.im) chatroom for unread messages.
## Configuration
Visit [Gitter Developer Apps](https://developer.gitter.im/apps) to retrieve your "Personal Access Token".
To use a Gitter sensor in your installation, add the following to your `configuration.yaml` file:
To use a Gitter {% 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

8
source/_integrations/google_domains.markdown
View File

@ -7,13 +7,17 @@ ha_release: 0.57
ha_domain: google_domains
ha_iot_class: Cloud Polling
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
With the Google Domains integration you can keep your Google Domains **dynamic** DNS record up to date. To setup a dynamic domain name using Goole Domains, refer to the [_Use Dynamic DNS_ section in the Google support documentation](https://support.google.com/domains/answer/6147083).
With the Google Domains {% term integration %} you can keep your Google Domains **dynamic** DNS record up to date. To setup a dynamic domain name using Goole Domains, refer to the [_Use Dynamic DNS_ section in the Google support documentation](https://support.google.com/domains/answer/6147083).
## Configuration
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

8
source/_integrations/google_maps.markdown
View File

@ -9,9 +9,12 @@ ha_domain: google_maps
ha_platforms:
- device_tracker
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `google_maps` platform allows you to detect presence using the unofficial API of [Google Maps Location Sharing](https://myaccount.google.com/locationsharing).
The `google_maps` {% term integration %} allows you to detect presence using the unofficial API of [Google Maps Location Sharing](https://myaccount.google.com/locationsharing).
## Setup
@ -44,7 +47,8 @@ If using more than one account, your own device may show twice, however, the par
## Configuration
To integrate Google Maps Location Sharing in Home Assistant, add the following section to your `configuration.yaml` file:
To integrate Google Maps Location Sharing in Home Assistant, add the following section to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

8
source/_integrations/google_pubsub.markdown
View File

@ -7,9 +7,12 @@ ha_release: 0.88
ha_iot_class: Cloud Push
ha_domain: google_pubsub
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `google_pubsub` integration allows you to hook into the Home Assistant event bus and send events to [Google Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/overview). The current [free tier](https://cloud.google.com/free/) of GCP should allow you to sync about 1 event every 2 seconds on average (2 million invocations per month).
The `google_pubsub` {% term integration %} allows you to hook into the Home Assistant event bus and send events to [Google Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/overview). The current [free tier](https://cloud.google.com/free/) of GCP should allow you to sync about 1 event every 2 seconds on average (2 million invocations per month).
## First time setup
@ -26,7 +29,8 @@ This will download the Service Account JSON key to your machine. Do NOT share th
## Configuration
Add the following lines to your `configuration.yaml` file:
Add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

10
source/_integrations/google_wifi.markdown
View File

@ -9,13 +9,17 @@ ha_domain: google_wifi
ha_platforms:
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `google_wifi` sensor platform is displaying the exposed status of a Google Wifi (or OnHub) router.
The `google_wifi` sensor {% term integration %} is displaying the exposed status of a Google Wifi (or OnHub) router.
The sensor is able to report network status, up-time, current IP address and firmware versions.
The {% term integration %} is able to report network status, up-time, current IP address and firmware versions.
To enable this sensor, add the following lines to your `configuration.yaml` file:
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

8
source/_integrations/graphite.markdown
View File

@ -7,11 +7,15 @@ ha_release: 0.13
ha_domain: graphite
ha_iot_class: Local Push
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `graphite` integration records all events and state changes and feeds the data to a [graphite](http://graphiteapp.org/) instance.
The `graphite` {% term integration %} records all events and state changes and feeds the data to a [graphite](http://graphiteapp.org/) instance.
To enable this integration, 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

8
source/_integrations/greeneye_monitor.markdown
View File

@ -13,11 +13,15 @@ ha_domain: greeneye_monitor
ha_platforms:
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The [GreenEye Monitor (GEM)](https://www.brultech.com/greeneye/) integration for Home Assistant allows you to create sensors for the various data channels of the GEM. Each current transformer (CT) channel, pulse counter, and temperature sensor appears in Home Assistant as a sensor, and can be used in automations.
The [GreenEye Monitor (GEM)](https://www.brultech.com/greeneye/) {% term integration %} for Home Assistant allows you to create sensors for the various data channels of the GEM. Each current transformer (CT) channel, pulse counter, and temperature sensor appears in Home Assistant as a sensor, and can be used in automations.
Configure your GEM(s) to produce binary-format packets (for example, "Bin32 NET" for a 32-channel GEM with some channels configured for net metering) and send them to an unused port on your Home Assistant machine. (These settings are in the "Packet Send" and "Network" pages of the GEM UI.) Then specify that port and information about your monitor(s) and the data channels you wish to monitor in your `configuration.yaml`:
Configure your GEM(s) to produce binary-format packets (for example, "Bin32 NET" for a 32-channel GEM with some channels configured for net metering) and send them to an unused port on your Home Assistant machine. (These settings are in the "Packet Send" and "Network" pages of the GEM UI.) Then specify that port and information about your monitor(s) and the data channels you wish to monitor in your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

8
source/_integrations/gstreamer.markdown
View File

@ -9,11 +9,15 @@ ha_domain: gstreamer
ha_platforms:
- media_player
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `gstreamer` platform allows you to play audio via a [gstreamer](https://gstreamer.freedesktop.org/) pipeline. Practically, this means you can play audio directly on the computer running Home Assistant. It is particularly suited for playing TTS. Advanced users can specify a pipeline to transform the audio stream and/or redirect it elsewhere.
The `gstreamer` {% term integration %} allows you to play audio via a [gstreamer](https://gstreamer.freedesktop.org/) pipeline. Practically, this means you can play audio directly on the computer running Home Assistant. It is particularly suited for playing TTS. Advanced users can specify a pipeline to transform the audio stream and/or redirect it elsewhere.
To add a `gstreamer` media player to your installation, add the following to your `configuration.yaml` file:
To add a `gstreamer` media player 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

8
source/_integrations/gtfs.markdown
View File

@ -9,9 +9,12 @@ ha_domain: gtfs
ha_platforms:
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `gtfs` sensor will give you the next departure time and associated data from your public transit station/stop. The data comes from your chosen public transit authority and is formatted as [General Transit Feed Specification](https://developers.google.com/transit/gtfs/) data, commonly known as GTFS.
The `gtfs` {% term integration %} will give you the next departure time and associated data from your public transit station/stop. The data comes from your chosen public transit authority and is formatted as [General Transit Feed Specification](https://developers.google.com/transit/gtfs/) data, commonly known as GTFS.
You need to find a valid GTFS data set, which you can usually find just by searching the internet. Most public transit authorities have GTFS available somewhere, as Google requires public transit authorities to provide the data if they wish to appear on Google Maps. You may also be able to find data at [TransitFeeds](https://transitfeeds.com/feeds).
@ -35,6 +38,9 @@ Your mileage may vary depending on the transit agency used. Most agencies respec
**Please note**: This is a _static_ data source. Currently, there is no GTFS Realtime support in this sensor due to issues surrounding parsing the protocol buffer format in Python 3. Once those issues have been fixed Realtime support will be added. Once added, the sensor will check for any delays and advisories and report them in the sensor as needed.
To enable the GTFS {% term integration %}, you need to add it to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
sensor: