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-20 15:56:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

m integrations 2/2: restart HA after changing config (#32649)

Browse Source
This commit is contained in:
c0ffeeca7 2024-05-08 23:11:03 +02:00 committed by GitHub
parent 7e7f6a29ae
commit c1c9979d75
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
13 changed files with 76 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
source/_integrations/mochad.markdown
View File

@ -12,9 +12,12 @@ ha_platforms:
- light - light
- switch - switch
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The `mochad` integration is the main integration to integrate all X10 platforms being controlled by [mochad](https://sourceforge.net/projects/mochad/). Besides this integration you will have to setup your X10 devices separately. The `mochad` {% term integration %} is the main integration to integrate all X10 platforms being controlled by [mochad](https://sourceforge.net/projects/mochad/). Besides this integration you will have to setup your X10 devices separately.
There is currently support for the following device types within Home Assistant: There is currently support for the following device types within Home Assistant:
@ -23,7 +26,8 @@ There is currently support for the following device types within Home Assistant:
## Configuration ## Configuration
To integrate your Mochad units with Home Assistant, add the following section to your `configuration.yaml` file: To integrate your Mochad units with Home Assistant, add the following section to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

12
source/_integrations/modbus.markdown
View File

@ -18,13 +18,16 @@ ha_platforms:
- switch - switch
ha_quality_scale: platinum ha_quality_scale: platinum
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
[modbus](http://www.modbus.org/) is a communication protocol to control PLCs (Programmable Logic Controller) and RTUs (Remote Terminal Unit). [modbus](http://www.modbus.org/) is a communication protocol to control PLCs (Programmable Logic Controller) and RTUs (Remote Terminal Unit).
The integration adheres strictly to the [protocol specification](https://www.modbus.org/docs/Modbus_Application_Protocol_V1_1b3.pdf) using [pymodbus](https://github.com/pymodbus-dev/pymodbus) for the protocol implementation. The integration adheres strictly to the [protocol specification](https://www.modbus.org/docs/Modbus_Application_Protocol_V1_1b3.pdf) using [pymodbus](https://github.com/pymodbus-dev/pymodbus) for the protocol implementation.
The modbus integration supports all devices adhering to the modbus standard. The communication to the device/devices can be serial (rs-485), TCP, or UDP connections. The modbus integration allows multiple communication channels e.g. a serial port connection combined with one or more TCP connections. The modbus {% term integration %} supports all devices adhering to the modbus standard. The communication to the device/devices can be serial (rs-485), TCP, or UDP connections. The modbus integration allows multiple communication channels e.g. a serial port connection combined with one or more TCP connections.
# Configuring modbus communication # Configuring modbus communication
@ -34,6 +37,9 @@ The modbus integration allows you to use multiple connections each with multiple
The modbus integration provides a number of parameters to help communicate with "difficult" devices, these parameters are independent of the type of communication. The modbus integration provides a number of parameters to help communicate with "difficult" devices, these parameters are independent of the type of communication.
To enable this integration, add it to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
{% configuration %} {% configuration %}
delay: delay:
description: "Time to delay sending messages in seconds after connecting. description: "Time to delay sending messages in seconds after connecting.
@ -1608,7 +1614,7 @@ Description:
| Attribute | Description | | Attribute | Description |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| hub | Hub name (defaults to 'modbus_hub' when omitted) | | hub | Hub name (defaults to 'modbus_hub' when omitted) |
| slave | Slave address (0-255) | | slave | Slave address (0-255) |
| address | Address of the Register (e.g. 138) | | address | Address of the Register (e.g. 138) |
| value | (write_register) A single value or an array of 16-bit values. Single value will call modbus function code 0x06. Array will call modbus function code 0x10. Values might need reverse ordering. E.g., to set 0x0004 you might need to set `[4,0]`, this depend on the byte order of your CPU | | value | (write_register) A single value or an array of 16-bit values. Single value will call modbus function code 0x06. Array will call modbus function code 0x10. Values might need reverse ordering. E.g., to set 0x0004 you might need to set `[4,0]`, this depend on the byte order of your CPU |
| state | (write_coil) A single boolean or an array of booleans. Single boolean will call modbus function code 0x05. Array will call modbus function code 0x0F | | state | (write_coil) A single boolean or an array of booleans. Single boolean will call modbus function code 0x05. Array will call modbus function code 0x0F |
@ -1660,7 +1666,7 @@ When opening an issue, please add your current configuration (or a scaled down v
- the entity (sensor, etc.) lines - the entity (sensor, etc.) lines
In order for the developers better to identify the problem, please add the In order for the developers better to identify the problem, please add the
following lines to configuration.yaml: following lines to {% term "`configuration.yaml`" %}:
```yaml ```yaml
logger: logger:

8
source/_integrations/mold_indicator.markdown
View File

@ -10,15 +10,19 @@ ha_domain: mold_indicator
ha_platforms: ha_platforms:
- sensor - sensor
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The Mold Indicator sensor integration consumes information of two temperature sensors and a humidity sensor to give an indication for possible mold growth in your home. In case of bad ventilation and insulation, the indoor humidity may lead to condensation on cold surfaces as the windows or even walls. Condensation or a high relative humidity near those cold surfaces leads to a higher risk for mold growth. This sensor integration estimates the temperature at a pre-calibrated critical point in the room (the coldest surface) and calculates the relative humidity of the air at that point. If the sensor value rises above approximately 70 percent, mold growth might occur and the room should be ventilated. At 100%, the air humidity condensates at the critical point. The Mold Indicator sensor {% term integration %} consumes information of two temperature sensors and a humidity sensor to give an indication for possible mold growth in your home. In case of bad ventilation and insulation, the indoor humidity may lead to condensation on cold surfaces as the windows or even walls. Condensation or a high relative humidity near those cold surfaces leads to a higher risk for mold growth. This sensor integration estimates the temperature at a pre-calibrated critical point in the room (the coldest surface) and calculates the relative humidity of the air at that point. If the sensor value rises above approximately 70 percent, mold growth might occur and the room should be ventilated. At 100%, the air humidity condensates at the critical point.
The sensor data may be used e.g., to signal bad air quality (too high air humidity) or to automate operation of indoor air humidifiers to keep the indoor humidity at an optimum. The sensor data may be used e.g., to signal bad air quality (too high air humidity) or to automate operation of indoor air humidifiers to keep the indoor humidity at an optimum.
## Configuration ## Configuration
To use the Mold Indicator sensor in your installation, add the following to your `configuration.yaml` file: To use the Mold Indicator sensor 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/mpd.markdown
View File

@ -9,13 +9,17 @@ ha_domain: mpd
ha_platforms: ha_platforms:
- media_player - media_player
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The `mpd` platform allows you to control a [Music Player Daemon](https://www.musicpd.org/) from Home Assistant. Unfortunately you will not be able to manipulate the playlist (add or delete songs) or add transitions between the songs. The `mpd` {% term integration %} allows you to control a [Music Player Daemon](https://www.musicpd.org/) from Home Assistant. Unfortunately you will not be able to manipulate the playlist (add or delete songs) or add transitions between the songs.
Even though no playlist manipulation is possible, it is possible to use the play_media service to load an existing saved playlist as part of an automation or scene. Even though no playlist manipulation is possible, it is possible to use the play_media service to load an existing saved playlist as part of an automation or scene.
To add MPD to your installation, add the following to your `configuration.yaml` file: To add MPD 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

4
source/_integrations/mqtt.markdown
View File

@ -311,7 +311,7 @@ Best practice for entities with a `unique_id` is to set `<object_id>` to `unique
#### Discovery payload #### Discovery payload
The payload must be a serialized JSON dictionary and will be checked like an entry in your `configuration.yaml` file if a new device is added, with the exception that unknown configuration keys are allowed but ignored. This means that missing variables will be filled with the integration's default values. All configuration variables which are *required* must be present in the payload. The reason for allowing unknown documentation keys is allow some backwards compatibility, software generating MQTT discovery messages can then be used with older Home Assistant versions which will simply ignore new features. The payload must be a serialized JSON dictionary and will be checked like an entry in your {% term "`configuration.yaml`" %} file if a new device is added, with the exception that unknown configuration keys are allowed but ignored. This means that missing variables will be filled with the integration's default values. All configuration variables which are *required* must be present in the payload. The reason for allowing unknown documentation keys is allow some backwards compatibility, software generating MQTT discovery messages can then be used with older Home Assistant versions which will simply ignore new features.
Subsequent messages on a topic where a valid payload has been received will be handled as a configuration update, and a configuration update with an empty payload will cause a previously discovered device to be deleted. Subsequent messages on a topic where a valid payload has been received will be handled as a configuration update, and a configuration update with an empty payload will cause a previously discovered device to be deleted.
@ -1001,7 +1001,7 @@ In the example above, the entity_id will be `sensor.my_super_device` instead of
## Manual configured MQTT items ## Manual configured MQTT items
For most integrations, it is also possible to manually set up MQTT items in `configuration.yaml`. Read more [about configuration in YAML](/docs/configuration/yaml). For most integrations, it is also possible to manually set up MQTT items in {% term "`configuration.yaml`" %}. Read more [about configuration in YAML](/docs/configuration/yaml).
MQTT supports two styles for configuring items in YAML. All configuration items are placed directly under the `mqtt` integration key. Note that you cannot mix these styles. Use the *YAML configuration listed per item* style when in doubt. MQTT supports two styles for configuring items in YAML. All configuration items are placed directly under the `mqtt` integration key. Note that you cannot mix these styles. Use the *YAML configuration listed per item* style when in doubt.

8
source/_integrations/mqtt_eventstream.markdown
View File

@ -7,13 +7,17 @@ ha_release: 0.11
ha_iot_class: Local Polling ha_iot_class: Local Polling
ha_domain: mqtt_eventstream ha_domain: mqtt_eventstream
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The `mqtt_eventstream` integration connects two Home Assistant instances via MQTT. The `mqtt_eventstream` {% term integration %} connects two Home Assistant instances via MQTT.
## Configuration ## Configuration
To integrate MQTT Eventstream into Home Assistant, add the following section to your `configuration.yaml` file: To integrate MQTT Eventstream into Home Assistant, add the following section 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/mqtt_json.markdown
View File

@ -9,13 +9,17 @@ ha_domain: mqtt_json
ha_platforms: ha_platforms:
- device_tracker - device_tracker
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The `mqtt_json` device tracker platform allows you to detect presence by monitoring an MQTT topic for new locations. To use this platform, you specify a unique topic for each device. The `mqtt_json` device tracker {% term integration %} allows you to detect presence by monitoring an MQTT topic for new locations. To use this platform, you specify a unique topic for each device.
## Configuration ## Configuration
To use this device tracker in your installation, add the following to your `configuration.yaml` file: To use this device tracker 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/mqtt_room.markdown
View File

@ -9,13 +9,17 @@ ha_domain: mqtt_room
ha_platforms: ha_platforms:
- sensor - sensor
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The `mqtt_room` sensor platform allows you to detect the indoor location of devices using MQTT clients. The `mqtt_room` sensor {% term integration %} allows you to detect the indoor location of devices using MQTT clients.
## Configuration ## Configuration
To use this device tracker in your installation, add the following to your `configuration.yaml` file: To use this device tracker 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/mqtt_statestream.markdown
View File

@ -7,13 +7,17 @@ ha_release: 0.54
ha_iot_class: Local Push ha_iot_class: Local Push
ha_domain: mqtt_statestream ha_domain: mqtt_statestream
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The `mqtt_statestream` integration publishes state changes in Home Assistant to individual MQTT topics. [The MQTT integration](/integrations/mqtt/) is a prerequisite for MQTT Statestream to work. The `mqtt_statestream` {% term integration %} publishes state changes in Home Assistant to individual MQTT topics. [The MQTT integration](/integrations/mqtt/) is a prerequisite for MQTT Statestream to work.
## Configuration ## Configuration
To enable MQTT Statestream in Home Assistant, add the following section to your `configuration.yaml` file: To enable MQTT Statestream in Home Assistant, add the following section 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/mvglive.markdown
View File

@ -9,13 +9,17 @@ ha_domain: mvglive
ha_platforms: ha_platforms:
- sensor - sensor
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The `mvglive` sensor will give you the departure time of the next bus, tram, subway, or train at the next station or stop in the Munich public transport network. Additional details such as the line number and destination are present in the attributes. The `mvglive` {% term integration %} will give you the departure time of the next bus, tram, subway, or train at the next station or stop in the Munich public transport network. Additional details such as the line number and destination are present in the attributes.
## 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

6
source/_integrations/mycroft.markdown
View File

@ -10,6 +10,9 @@ ha_domain: mycroft
ha_platforms: ha_platforms:
- notify - notify
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
[Mycroft](https://mycroft.ai) is an open source voice assistant that allows you to send notifications and more to Mycroft from Home Assistant. [Mycroft](https://mycroft.ai) is an open source voice assistant that allows you to send notifications and more to Mycroft from Home Assistant.
@ -20,7 +23,8 @@ There is currently support for the following device types within Home Assistant:
## Configuration ## Configuration
To use Mycroft in your installation, add the following to your `configuration.yaml` file: To use Mycroft 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/mystrom.markdown
View File

@ -17,6 +17,9 @@ ha_platforms:
- sensor - sensor
- switch - switch
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
There is currently support for the following device types within Home Assistant: There is currently support for the following device types within Home Assistant:
@ -26,7 +29,7 @@ There is currently support for the following device types within Home Assistant:
## Lights and switches ## Lights and switches
The myStrom integration allows you to control your [myStrom](https://mystrom.ch/) Wi-Fi Bulbs and Wi-Fi Switches. Make sure that you have enabled the REST API under **Advanced** in the web frontend of the switch. The myStrom {% term integration %} allows you to control your [myStrom](https://mystrom.ch/) Wi-Fi Bulbs and Wi-Fi Switches. Make sure that you have enabled the REST API under **Advanced** in the web frontend of the switch.
Supported devices are: Supported devices are:
@ -81,7 +84,8 @@ The buttons will give you feedback with its built-in LED:
- white then green: Pattern was submitted successfully - white then green: Pattern was submitted successfully
- white then red: There is a problem with the communication - white then red: There is a problem with the communication
To use your myStrom WiFi Button in your installation, add the following to your `configuration.yaml` file: To use your myStrom WiFi Button 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/mythicbeastsdns.markdown
View File

@ -7,13 +7,17 @@ ha_release: 0.85
ha_iot_class: Cloud Push ha_iot_class: Cloud Push
ha_domain: mythicbeastsdns ha_domain: mythicbeastsdns
ha_integration_type: integration ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
With the `mythicbeastsdns` integration you can automatically update your dynamic DNS entry at [Mythic Beasts](https://www.mythic-beasts.com/). With the `mythicbeastsdns` {% term integration %} you can automatically update your dynamic DNS entry at [Mythic Beasts](https://www.mythic-beasts.com/).
## Configuration ## 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 ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry