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-23 01:06:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

s-integrations-2: restart HA after changing config (#32721)

Browse Source
This commit is contained in:
c0ffeeca7 2024-05-13 17:18:20 +02:00 committed by GitHub
parent e51daeef79
commit 502179872c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
10 changed files with 70 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
source/_integrations/sigfox.markdown
View File

@ -9,9 +9,12 @@ ha_domain: sigfox
ha_platforms:
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
[SigFox](https://www.sigfox.com/) integration adding a sensor for each Sigfox device registered with your account. The default name of sensors is `sigfox_{DEVICE_ID}` where `DEVICE_ID` is the devices Sigfox ID. The state of an added Sigfox sensor is the payload of the last message published by that device. Additionally, there are attributes for the latitude and longitude coordinates of the device, as well as the signal-to-noise ratio ([snr](https://en.wikipedia.org/wiki/Signal-to-noise_ratio)).
[SigFox](https://www.sigfox.com/) {% term integration %} adding a sensor for each Sigfox device registered with your account. The default name of sensors is `sigfox_{DEVICE_ID}` where `DEVICE_ID` is the devices Sigfox ID. The state of an added Sigfox sensor is the payload of the last message published by that device. Additionally, there are attributes for the latitude and longitude coordinates of the device, as well as the signal-to-noise ratio ([snr](https://en.wikipedia.org/wiki/Signal-to-noise_ratio)).
## Setup
@ -24,7 +27,8 @@ Note that `your_api_login` and `your_api_password` are your **API access credent
## 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

10
source/_integrations/sighthound.markdown
View File

@ -9,19 +9,23 @@ ha_codeowners:
- '@robmarkcole'
ha_domain: sighthound
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
Detect people in camera images using [Sighthound Cloud](https://www.sighthound.com/products/cloud). The Sighthound Developer tier (free for non-commercial use) allows 5000 images to be processed per month. If you need more processing per month you will need to sign up for a production account (i.e., a Basic or Pro account).
This integration adds an image processing entity where the state of the entity is the number of people detected in an image. For each person detected, an `sighthound.person_detected` event is fired. The event data includes the entity_id of the image processing entity firing the event, and the bounding box around the detected person.
This {% term integration %} adds an image processing entity where the state of the entity is the number of people detected in an image. For each person detected, an `sighthound.person_detected` event is fired. The event data includes the entity_id of the image processing entity firing the event, and the bounding box around the detected person.
If `save_file_folder` is configured, on each new detection of a person, an annotated image with the name `sighthound_{camera_name}_latest.jpg` is saved in the configured folder if it doesn't already exist, and overwritten if it does exist. The saved image shows the bounding box around detected people and can be displayed on the Home Assistant front end using a [Local File](/integrations/local_file/) camera, and used in notifications. If `save_timestamped_file` is configured as `true`, then the annotated image is saved with a file name that includes the time of detection.
**Note** that by default the integration will not automatically scan images, but requires you to call the `image_processing.scan` service, e.g., using an automation triggered by motion.
**Note** that by default the {% term integration %} will not automatically scan images, but requires you to call the `image_processing.scan` service, e.g., using an automation triggered by motion.
## Configuration
To enable this platform in your installation, add the following to your `configuration.yaml` file:
To enable this {% 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/signal_messenger.markdown
View File

@ -11,9 +11,12 @@ ha_domain: signal_messenger
ha_platforms:
- notify
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `signal_messenger` integration uses the [Signal Messenger REST API](https://github.com/bbernhard/signal-cli-rest-api) to deliver notifications from Home Assistant to your Android or iOS device.
The `signal_messenger` {% term integration %} uses the [Signal Messenger REST API](https://github.com/bbernhard/signal-cli-rest-api) to deliver notifications from Home Assistant to your Android or iOS device.
## Setup
@ -28,7 +31,8 @@ Please follow those [instructions](https://github.com/bbernhard/signal-cli-rest-
## Configuration
To send Signal Messenger notifications with Home Assistant, add the following to your `configuration.yaml` file:
To send Signal Messenger notifications with Home Assistant, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry for Signal Messenger

8
source/_integrations/sinch.markdown
View File

@ -11,9 +11,12 @@ ha_iot_class: Cloud Push
ha_platforms:
- notify
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `sinch` platform uses [Sinch](https://www.sinch.com/products/apis/messaging/sms/) to deliver notifications from Home Assistant.
The `sinch` {% term integration %} uses [Sinch](https://www.sinch.com/products/apis/messaging/sms/) to deliver notifications from Home Assistant.
## Prerequisites
@ -21,7 +24,8 @@ Go to your [Sinch Dashboard](https://dashboard.sinch.com/sms/api/rest) and click
## Configuration
To add Sinch to your installation, add the following to your Home Assistant `configuration.yaml` file:
To add Sinch to your installation, add the following to your Home Assistant {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

8
source/_integrations/sky_hub.markdown
View File

@ -11,11 +11,15 @@ ha_iot_class: Local Polling
ha_platforms:
- device_tracker
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `sky_hub` platform offers presence detection by looking at connected devices to a [Sky Hub router](https://www.sky.com/shop/broadband-talk/sky-hub/) based router.
The `sky_hub` {% term integration %} offers presence detection by looking at connected devices to a [Sky Hub router](https://www.sky.com/shop/broadband-talk/sky-hub/) based router.
To use your Sky Hub device in your installation, add the following to your `configuration.yaml` file:
To use your Sky Hub device 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/skybeacon.markdown
View File

@ -9,13 +9,17 @@ ha_domain: skybeacon
ha_platforms:
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `skybeacon` sensor platform supports [CR2477](https://cnsky9.en.alibaba.com/)-powered [iBeacon](https://en.wikipedia.org/wiki/IBeacon)/eddystone sensors that come with temperature/sensor module.
The `skybeacon` sensor {% term integration %} supports [CR2477](https://cnsky9.en.alibaba.com/)-powered [iBeacon](https://en.wikipedia.org/wiki/IBeacon)/eddystone sensors that come with temperature/sensor module.
## Configuration
To use your Skybeacon sensor in your installation, add the following to your `configuration.yaml` file:
To use your Skybeacon {% 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/slide.markdown
View File

@ -12,12 +12,18 @@ ha_domain: slide
ha_platforms:
- cover
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `slide` implementation allows you to integrate your [slide.store](https://slide.store/) devices in Home Assistant using the [official API](https://documenter.getpostman.com/view/6223391/S1Lu2pSf?version=latest).
The `slide` {% term integration %} allows you to integrate your [slide.store](https://slide.store/) devices in Home Assistant using the [official API](https://documenter.getpostman.com/view/6223391/S1Lu2pSf?version=latest).
### Configuration
To use the Slide {% term integration %} in your installation, add it to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
slide:

27
source/_integrations/smappee.markdown
View File

@ -19,24 +19,27 @@ ha_platforms:
- sensor
- switch
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The Smappee integration will allow users to integrate their Smappee monitors, Smappee Comfort Plugs and Smappee Switches into Home Assistant using the [official cloud API](https://smappee.atlassian.net/wiki/spaces/DEVAPI/overview) or the limited local option.
The Smappee {% term integration %} will allow users to integrate their Smappee monitors, Smappee Comfort Plugs and Smappee Switches into Home Assistant using the [official cloud API](https://smappee.atlassian.net/wiki/spaces/DEVAPI/overview) or the limited local option.
## Smappee monitors
The table below summarizes the available options to initiate the Smappee integration in Home Assistant per Smappee monitor type.
|Monitor type|Local discovery|Cloud API|
|---|---|---|
|Smappee Energy|Yes|Yes|
|Smappee Solar|Yes|Yes|
|Smappee Plus|Yes|Yes|
|Smappee Pro|Yes|Yes|
|Smappee Genius|Yes|Yes|
|Smappee Connect|No|Yes|
|Smappee Wi-Fi Connect|No|Yes|
|Smappee P1/S1 module|No|Yes|
| Monitor type | Local discovery | Cloud API |
| --------------------- | --------------- | --------- |
| Smappee Energy | Yes | Yes |
| Smappee Solar | Yes | Yes |
| Smappee Plus | Yes | Yes |
| Smappee Pro | Yes | Yes |
| Smappee Genius | Yes | Yes |
| Smappee Connect | No | Yes |
| Smappee Wi-Fi Connect | No | Yes |
| Smappee P1/S1 module | No | Yes |
## Local discovery
@ -59,7 +62,7 @@ Switch entities are created for each Smappee Switch and Smappee Comfort Plug.
## Cloud API configuration
To use the Smappee cloud integration you need a personal `client_id` and `client_secret` and add these to your `configuration.yaml` file. For personal use, access to the API is free and credentials can be obtained by contacting [support@smappee.com](mailto:support@smappee.com). For commercial usage, it is based on a recurring fee and credentials can be obtained by contacting [info@smappee.com](mailto:info@smappee.com).
To use the Smappee cloud integration you need a personal `client_id` and `client_secret` and add these to your {% term "`configuration.yaml`" %} file. For personal use, access to the API is free and credentials can be obtained by contacting [support@smappee.com](mailto:support@smappee.com). For commercial usage, it is based on a recurring fee and credentials can be obtained by contacting [info@smappee.com](mailto:info@smappee.com).
For any information about the use of the API please refer to the [Smappee API space](https://smappee.atlassian.net/wiki/spaces/DEVAPI/overview).
```yaml

7
source/_integrations/solaredge_local.markdown
View File

@ -13,9 +13,12 @@ ha_domain: solaredge_local
ha_platforms:
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `solaredge_local` integration uses the local API available on some SolarEdge Inverters to allow you to get details from your SolarEdge solar power setup and integrate these into your Home Assistant installation.
The `solaredge_local` {% term integration %} uses the local API available on some SolarEdge Inverters to allow you to get details from your SolarEdge solar power setup and integrate these into your Home Assistant installation.
Only specific models support the local API. The local API is available on inverters that do not have an LCD character screen. You can also check the datasheets if in the section "Additional Features", sub-section "Inverter Commissioning" is present the following line "With the SetApp mobile application using built-in Wi-Fi access point for local connection". These inverters also have a part number that ends with a 4. For example: SEXXK-XXXXXBXX4 or SEXXXXH-XXXXXBXX4
@ -31,7 +34,7 @@ If your inverter does not support the local API, you can use the [cloud based ve
## Configuration
To use the SolarEdge sensors in your installation, add the following to your `configuration.yaml` file:
To use the SolarEdge {% term integration %} in your installation, add the following to your {% term "`configuration.yaml`" %}
```yaml
# Example configuration.yaml entry

8
source/_integrations/spaceapi.markdown
View File

@ -9,13 +9,17 @@ ha_codeowners:
- '@fabaff'
ha_domain: spaceapi
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `spaceapi` integration allow Hackerspaces to expose information to web apps or any other application with the [SpaceAPI](https://spaceapi.io/).
The `spaceapi` {% term integration %} allow Hackerspaces to expose information to web apps or any other application with the [SpaceAPI](https://spaceapi.io/).
## Configuration
To setup the `spaceapi` integration in your installation, add the following to your `configuration.yaml` file:
To setup the `spaceapi` {% 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