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 15:26:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

s-integrations-1: restart HA after changing config (#32720)

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

10
source/_integrations/saj.markdown
View File

@ -11,9 +11,12 @@ ha_domain: saj
ha_platforms: ha_platforms:
- sensor - sensor
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The `saj` sensor will poll a [SAJ](https://www.saj-electric.com/) solar inverter and present the values as sensors in Home Assistant. The `saj` {% term integration %} will poll a [SAJ](https://www.saj-electric.com/) solar inverter and present the values as sensors in Home Assistant.
This sensor uses the web interface and to use it, you have to be able to connect to the solar inverter from your favorite web browser. This sensor uses the web interface and to use it, you have to be able to connect to the solar inverter from your favorite web browser.
@ -22,7 +25,8 @@ The Wi-Fi module requires a username and password for authentication where the e
## Configuration ## Configuration
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 ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
@ -60,7 +64,7 @@ password:
Sensors available in the library: Sensors available in the library:
| name | Unit | Description | | name | Unit | Description |
|--------------------|------|:-----------------------------------------------------------------------------| | ----------------- | ---- | :------------------------------------------------------------------------- |
| current_power | W | Current power generated by the inverter. | | current_power | W | Current power generated by the inverter. |
| today_yield | kWh | Power yield for today. | | today_yield | kWh | Power yield for today. |
| today_time | h | Inverter's running time for today. | | today_time | h | Inverter's running time for today. |

8
source/_integrations/satel_integra.markdown
View File

@ -14,9 +14,12 @@ ha_platforms:
- binary_sensor - binary_sensor
- switch - switch
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The `satel_integra` integration will allow Home Assistant users who own a Satel Integra alarm panel to leverage their alarm system and its sensors to provide Home Assistant with information about their homes. Connectivity between Home Assistant and the alarm is accomplished through a ETHM extension module that must be installed in the alarm. Compatible with ETHM-1 Plus module with firmware version > 2.00 (version 2.04 confirmed). The `satel_integra` {% term integration %} will allow Home Assistant users who own a Satel Integra alarm panel to leverage their alarm system and its sensors to provide Home Assistant with information about their homes. Connectivity between Home Assistant and the alarm is accomplished through a ETHM extension module that must be installed in the alarm. Compatible with ETHM-1 Plus module with firmware version > 2.00 (version 2.04 confirmed).
There is currently support for the following device types within Home Assistant: There is currently support for the following device types within Home Assistant:
@ -38,7 +41,8 @@ For the binary sensor, check the [type/class](/integrations/binary_sensor/) list
## Configuration ## Configuration
A `satel_integra` section must be present in the `configuration.yaml` file: A `satel_integra` section must be present in the {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

8
source/_integrations/schluter.markdown
View File

@ -11,9 +11,12 @@ ha_codeowners:
ha_platforms: ha_platforms:
- climate - climate
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The `schluter` integration allows you to integrate your [Schluter-DITRA-HEAT-E-WiFi](https://www.schluter.com/schluter-us/en_US/ditra-heat-wifi) electric floor heating thermostat in Home Assistant. The `schluter` {% term integration %} allows you to integrate your [Schluter-DITRA-HEAT-E-WiFi](https://www.schluter.com/schluter-us/en_US/ditra-heat-wifi) electric floor heating thermostat in Home Assistant.
<div class='note'> <div class='note'>
You will need to create a Schluter DITRA-HEAT account and register your thermostat with it. This can be done via the thermostat touchscreen, where an email will be sent to you to confirm your account. You will need to create a Schluter DITRA-HEAT account and register your thermostat with it. This can be done via the thermostat touchscreen, where an email will be sent to you to confirm your account.
@ -23,7 +26,8 @@ You will need to create a Schluter DITRA-HEAT account and register your thermost
You will need your Schluter login information (email and password) to use this module. You will need your Schluter login information (email and password) to use this module.
To set it up, add the following to your `configuration.yaml` file: To set it up, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

8
source/_integrations/scrape.markdown
View File

@ -13,9 +13,12 @@ ha_platforms:
- sensor - sensor
ha_integration_type: integration ha_integration_type: integration
ha_config_flow: true ha_config_flow: true
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The `scrape` sensor platform is scraping information from websites. The sensor loads an HTML page and gives you the option to search and split out a value. As this is not a full-blown web scraper like [scrapy](https://scrapy.org/), it will most likely only work with simple web pages and it can be time-consuming to get the right section. The `scrape` sensor {% term integration %} is scraping information from websites. The sensor loads an HTML page and gives you the option to search and split out a value. As this is not a full-blown web scraper like [scrapy](https://scrapy.org/), it will most likely only work with simple web pages and it can be time-consuming to get the right section.
If you are not using Home Assistant Container or Home Assistant Operating System, this integration requires `libxml2` to be installed. On Debian based installs, run: If you are not using Home Assistant Container or Home Assistant Operating System, this integration requires `libxml2` to be installed. On Debian based installs, run:
@ -27,7 +30,8 @@ Both UI and YAML setup is supported while YAML provides additional configuration
{% include integrations/config_flow.md %} {% include integrations/config_flow.md %}
To enable this sensor, add the following lines to your `configuration.yaml` file: To enable this {% term integration %} using YAML, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

8
source/_integrations/scsgate.markdown
View File

@ -14,9 +14,12 @@ ha_platforms:
- light - light
- switch - switch
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The SCSGate integration support the [SCSGate](https://translate.google.com/translate?hl=en&sl=it&tl=en&u=http%3A%2F%2Fguidopic.altervista.org%2Feibscsgt%2Finterface.html) device. This a home-brew device allows to interact with the MyHome system from BTicino/Legrande. The SCSGate {% term integration %} support the [SCSGate](https://translate.google.com/translate?hl=en&sl=it&tl=en&u=http%3A%2F%2Fguidopic.altervista.org%2Feibscsgt%2Finterface.html) device. This a home-brew device allows to interact with the MyHome system from BTicino/Legrande.
There is currently support for the following device types within Home Assistant: There is currently support for the following device types within Home Assistant:
@ -24,7 +27,8 @@ There is currently support for the following device types within Home Assistant:
- [Light](/integrations/scsgate/#light) - [Light](/integrations/scsgate/#light)
- [Switch](/integrations/scsgate/#switch) - [Switch](/integrations/scsgate/#switch)
To enable SCSGate in your installation, add the following to your `configuration.yaml` file: To enable SCSGate in your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

8
source/_integrations/sendgrid.markdown
View File

@ -9,9 +9,12 @@ ha_iot_class: Cloud Push
ha_platforms: ha_platforms:
- notify - notify
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The `sendgrid` notification platform sends email notifications via [SendGrid](https://sendgrid.com/), a proven cloud-based email platform. The `sendgrid` notification {% term integration %} sends email notifications via [SendGrid](https://sendgrid.com/), a proven cloud-based email platform.
## Setup ## Setup
@ -19,7 +22,8 @@ You need an [API key](https://app.sendgrid.com/settings/api_keys) from SendGrid.
## Configuration ## Configuration
To enable notification emails via SendGrid in your installation, add the following to your `configuration.yaml` file: To enable notification emails via SendGrid in your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

5
source/_integrations/serial.markdown
View File

@ -13,7 +13,7 @@ ha_platforms:
ha_integration_type: integration ha_integration_type: integration
--- ---
The `serial` sensor platform is using the data provided by a device connected to the serial port of the system where Home Assistant is running. With [`ser2net`](https://ser2net.sourceforge.net/) and [`socat`](http://www.dest-unreach.org/socat/) would it also work for sensors connected to a remote system. The `serial` sensor {% term integration %} is using the data provided by a device connected to the serial port of the system where Home Assistant is running. With [`ser2net`](https://ser2net.sourceforge.net/) and [`socat`](http://www.dest-unreach.org/socat/) would it also work for sensors connected to a remote system.
To check what kind of data is arriving at your serial port, use a command-line tool like `minicom` or `picocom` on Linux, on a macOS you can use `screen` or on Windows `putty`. To check what kind of data is arriving at your serial port, use a command-line tool like `minicom` or `picocom` on Linux, on a macOS you can use `screen` or on Windows `putty`.
@ -23,7 +23,8 @@ sudo minicom -D /dev/ttyACM0
## Configuration ## Configuration
To setup a serial sensor to your installation, add the following to your `configuration.yaml` file: To setup a serial sensor to your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

8
source/_integrations/sesame.markdown
View File

@ -9,9 +9,12 @@ ha_domain: sesame
ha_platforms: ha_platforms:
- lock - lock
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The `sesame` platform allows you to control your [Sesame](https://candyhouse.co/) smart locks made by CANDY HOUSE, Inc. The `sesame` {% term integration %} allows you to control your [Sesame](https://candyhouse.co/) smart locks made by CANDY HOUSE, Inc.
## Configuration ## Configuration
@ -19,7 +22,8 @@ Your Sesame needs to be paired with a standalone [Wi-Fi Access Point](https://ca
You will also need to generate an API key from [my.candyhouse.co](https://my.candyhouse.co/#/credentials). You will also need to generate an API key from [my.candyhouse.co](https://my.candyhouse.co/#/credentials).
Once you have remote access enabled using one of the above AND the Integration - cloud option enabled on the Sesame app for that lock settings, add the following to your `configuration.yaml` file: Once you have remote access enabled using one of the above AND the Integration - cloud option enabled on the Sesame app for that lock settings, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

8
source/_integrations/seven_segments.markdown
View File

@ -10,9 +10,12 @@ ha_domain: seven_segments
ha_codeowners: ha_codeowners:
- '@fabaff' - '@fabaff'
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The `seven_segments` image processing platform allows you to read physical seven segments displays through Home Assistant. [`ssocr`](https://www.unix-ag.uni-kl.de/~auerswal/ssocr/) is used to extract the value shown on the display which is observed by a [camera](/integrations/camera/). The `seven_segments` image processing {% term integration %} allows you to read physical seven segments displays through Home Assistant. [`ssocr`](https://www.unix-ag.uni-kl.de/~auerswal/ssocr/) is used to extract the value shown on the display which is observed by a [camera](/integrations/camera/).
{% details "Notes for Home Assistant Core Installations" %} {% details "Notes for Home Assistant Core Installations" %}
@ -33,7 +36,8 @@ make deb # (Optional) This allows you to make a deb so that you apt is aware of
## Configuration ## Configuration
To enable the OCR of a seven segment display in your installation, add the following to your `configuration.yaml` file: To enable the OCR of a seven segment display in your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

8
source/_integrations/shodan.markdown
View File

@ -11,15 +11,19 @@ ha_domain: shodan
ha_platforms: ha_platforms:
- sensor - sensor
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The `shodan` sensor platform is displaying the total of result of a The `shodan` sensor {% term integration %} is displaying the total of result of a
[Shodan](https://www.shodan.io/) query. [Shodan](https://www.shodan.io/) query.
Use "Show API Key" in the upper right corner when you are logged in or got to Use "Show API Key" in the upper right corner when you are logged in or got to
your "My Account" page to retrieve your API key. your "My Account" page to retrieve your API key.
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 %}
file: file:
```yaml ```yaml