mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-23 17:27:19 +00:00
s-integrations: add glossary reference to config file (#32762)
This commit is contained in:
parent
42c3b4524b
commit
d545c0bf86
@ -33,7 +33,7 @@ Some integrations like [Philips Hue](/integrations/hue), [MQTT](/integrations/mq
|
||||
|
||||
You can create scenes that capture the states you want certain entities to be. For example, a scene can specify that light A should be turned on and light B should be bright red.
|
||||
|
||||
Scenes can be created and managed via the user interface using the [Scene Editor](/docs/scene/editor/). They can also be manually configured via `configuration.yaml`. Note that the entity data is not service call parameters, it's a representation of the wanted state:
|
||||
Scenes can be created and managed via the user interface using the [Scene Editor](/docs/scene/editor/). They can also be manually configured via {% term "`configuration.yaml`" %}. Note that the entity data is not service call parameters, it's a representation of the wanted state:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
@ -12,7 +12,7 @@ The `mqtt` scene platform lets you control your MQTT enabled scenes.
|
||||
|
||||
## Configuration
|
||||
|
||||
To enable a MQTT scene in your installation, add the following to your `configuration.yaml` file:
|
||||
To enable a MQTT scene in your installation, add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
@ -23,7 +23,7 @@ and then choose the **{% my config_flow_start domain=schedule title="Schedule" %
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
To be able to add **{% my helpers title="Helpers" %}** via the user interface you should
|
||||
have `default_config:` in your `configuration.yaml`, it should already
|
||||
have `default_config:` in your {% term "`configuration.yaml`" %}, it should already
|
||||
be there by default unless you removed it.
|
||||
|
||||
If you removed `default_config:` from your configuration,
|
||||
|
@ -47,7 +47,7 @@ device:
|
||||
|
||||
The SCSGate integration relies on the [scsgate](https://github.com/flavio/scsgate) Python module.
|
||||
|
||||
This module provides also a command line tool called `scs-monitor`. This program can be used to find the IDs of your lights, switches and roller shutters and produce the YAML snippet to insert into your `configuration.yaml` file.
|
||||
This module provides also a command line tool called `scs-monitor`. This program can be used to find the IDs of your lights, switches and roller shutters and produce the YAML snippet to insert into your {% term "`configuration.yaml`" %} file.
|
||||
|
||||
For more information checkout [this](https://scsgate.readthedocs.org/en/latest/?badge=latest#creation-of-a-home-assistant-configuration-file) section of `scsgate`'s documentation.
|
||||
|
||||
@ -55,7 +55,7 @@ For more information checkout [this](https://scsgate.readthedocs.org/en/latest/?
|
||||
|
||||
The SCSGate devices can control motorized covers connected to the BTicino MyHome system.
|
||||
|
||||
To enable SCSGate covers in your installation, add the following to your `configuration.yaml` file:
|
||||
To enable SCSGate covers in your installation, add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
@ -98,7 +98,7 @@ devices:
|
||||
|
||||
The SCSGate device can control lights of the BTicino MyHome system.
|
||||
|
||||
To enable SCSGate lights in your installation, add the following to your `configuration.yaml` file:
|
||||
To enable SCSGate lights in your installation, add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
@ -121,7 +121,7 @@ devices:
|
||||
|
||||
The SCSGate device can control switches of the BTicino MyHome system.
|
||||
|
||||
To enable SCSGate switches in your installation, add the following to your `configuration.yaml` file:
|
||||
To enable SCSGate switches in your installation, add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
@ -12,7 +12,7 @@ The `mqtt` Select platform allows you to integrate devices that might expose con
|
||||
|
||||
## Configuration
|
||||
|
||||
To enable MQTT Select in your installation, add the following to your `configuration.yaml` file:
|
||||
To enable MQTT Select in your installation, add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
@ -12,7 +12,7 @@ This `mqtt` sensor platform uses the MQTT message payload as the sensor value. I
|
||||
|
||||
## Configuration
|
||||
|
||||
To use your MQTT sensor in your installation, add the following to your `configuration.yaml` file:
|
||||
To use your MQTT sensor in your installation, add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
@ -443,7 +443,7 @@ mqtt:
|
||||
|
||||
### Get sensor value from a device with ESPEasy
|
||||
|
||||
Assuming that you have flashed your ESP8266 unit with [ESPEasy](https://github.com/letscontrolit/ESPEasy). Under "Config" set a name ("Unit Name:") for your device (here it's "bathroom"). A "Controller" for MQTT with the protocol "OpenHAB MQTT" is present and the entries ("Controller Subscribe:" and "Controller Publish:") are adjusted to match your needs. In this example the topics are prefixed with "home". Please keep in mind that the ESPEasy default topics start with a `/` and only contain the name when writing your entry for the `configuration.yaml` file.
|
||||
Assuming that you have flashed your ESP8266 unit with [ESPEasy](https://github.com/letscontrolit/ESPEasy). Under "Config" set a name ("Unit Name:") for your device (here it's "bathroom"). A "Controller" for MQTT with the protocol "OpenHAB MQTT" is present and the entries ("Controller Subscribe:" and "Controller Publish:") are adjusted to match your needs. In this example the topics are prefixed with "home". Please keep in mind that the ESPEasy default topics start with a `/` and only contain the name when writing your entry for the {% term "`configuration.yaml`" %} file.
|
||||
|
||||
- **Controller Subscribe**: `home/%sysname%/#` (instead of `/%sysname%/#`)
|
||||
- **Controller Publish**: `home/%sysname%/%tskname%/%valname%` (instead of `/%sysname%/%tskname%/%valname%`)
|
||||
|
@ -12,7 +12,7 @@ The `rest` sensor platform is consuming a given endpoint which is exposed by a [
|
||||
|
||||
_Tip:_ If you want to create multiple `sensors` using the same endpoint, use the [RESTful](/integrations/rest) configuration instructions.
|
||||
|
||||
To enable this sensor, add the following lines to your `configuration.yaml` file for a GET request:
|
||||
To enable this sensor, add the following lines to your {% term "`configuration.yaml`" %} file for a GET request:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
@ -30,7 +30,7 @@ At this time, the following sensors are supported:
|
||||
|
||||
## Configuration
|
||||
|
||||
To use your PM sensor in your installation, add the following to your `configuration.yaml` file:
|
||||
To use your PM sensor in your installation, add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
sensor:
|
||||
|
@ -115,7 +115,7 @@ It's suggested that the first attempt to determine the needed parameters is usin
|
||||
ssocr -D erosion crop 390 250 490 280 -t 20 -d 4 seven-seg.png
|
||||
```
|
||||
|
||||
This would lead to the following entry for the `configuration.yaml` file:
|
||||
This would lead to the following entry for the {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
camera:
|
||||
|
@ -304,7 +304,7 @@ The `switch` entity in Home Assistant does not support transition states. For th
|
||||
|
||||
In some cases, it may be needed to customize the CoAP UDP port (default: `5683`) your Home Assistant instance is listening to.
|
||||
|
||||
In order to change it, add the following key to your `configuration.yaml`:
|
||||
In order to change it, add the following key to your {% term "`configuration.yaml`" %}:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
@ -33,7 +33,7 @@ The output will be limited to 3 decimals.
|
||||
|
||||
## Configuration
|
||||
|
||||
To add a simulated sensor to your installation, add the following to your `configuration.yaml` file:
|
||||
To add a simulated sensor to your installation, add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
sensor:
|
||||
|
@ -18,7 +18,7 @@ When a `state_topic` is not available, the siren will work in optimistic mode. I
|
||||
|
||||
Optimistic mode can be forced, even if the `state_topic` is available. Try to enable it, if experiencing incorrect operation.
|
||||
|
||||
To enable this siren in your installation, add the following to your `configuration.yaml` file:
|
||||
To enable this siren in your installation, add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
@ -25,14 +25,14 @@ There is currently support for the following device types within Home Assistant:
|
||||
|
||||
The light and media players will be automatically added for each of your Sisyphus tables, if the Sisyphus integration is configured.
|
||||
|
||||
There are two ways to configure this integration. For the automatic discovery of your table(s), add the following to your `configuration.yaml`:
|
||||
There are two ways to configure this integration. For the automatic discovery of your table(s), add the following to your {% term "`configuration.yaml`" %}:
|
||||
|
||||
```yaml
|
||||
# This will auto-detect all Sisyphus tables on your local network.
|
||||
sisyphus:
|
||||
```
|
||||
|
||||
Auto-detection can be a little slow, so if your table has a fixed IP address or hostname, you may add a list of tables in your `configuration.yaml`. For example:
|
||||
Auto-detection can be a little slow, so if your table has a fixed IP address or hostname, you may add a list of tables in your {% term "`configuration.yaml`" %}. For example:
|
||||
|
||||
```yaml
|
||||
# This will skip auto-detection and add only the listed tables
|
||||
|
@ -361,7 +361,7 @@ If you have completed the checklist above and are still unable to setup the plat
|
||||
|
||||
### Debugging
|
||||
|
||||
The SmartThings integration will log additional information about push updates received, events fired, and other messages when the log level is set to `debug`. Add the relevant line below to the `configuration.yaml`:
|
||||
The SmartThings integration will log additional information about push updates received, events fired, and other messages when the log level is set to `debug`. Add the relevant line below to the {% term "`configuration.yaml`" %}:
|
||||
|
||||
```yaml
|
||||
logger:
|
||||
|
@ -37,7 +37,7 @@ The integration has a fan platform to view and control the ventilation speed, an
|
||||
|
||||
## Configuration
|
||||
|
||||
To set it up, add the following information to your `configuration.yaml` file:
|
||||
To set it up, add the following information to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
smarty:
|
||||
|
@ -13,7 +13,7 @@ ha_integration_type: integration
|
||||
|
||||
The SMTP platform allows you to deliver notifications from Home Assistant to an email recipient.
|
||||
|
||||
To enable notification by email in your installation, add the following to your `configuration.yaml` file:
|
||||
To enable notification by email in your installation, add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
@ -95,7 +95,7 @@ followed by a command, e.g.
|
||||
|
||||
_Set the lights to green in the living room_
|
||||
|
||||
As the Snips Platform parses this query into an intent, it will be published on MQTT, on the `hermes/intent/<intentName>` topic. The Snips Home Assistant integration subscribes to this topic, and handles the intent according to the rules defined in `configuration.yaml` file, as explained below.
|
||||
As the Snips Platform parses this query into an intent, it will be published on MQTT, on the `hermes/intent/<intentName>` topic. The Snips Home Assistant integration subscribes to this topic, and handles the intent according to the rules defined in {% term "`configuration.yaml`" %} file, as explained below.
|
||||
|
||||
#### Optional: specifying an external MQTT broker
|
||||
|
||||
@ -121,7 +121,7 @@ probability_threshold:
|
||||
|
||||
### Specifying the MQTT broker
|
||||
|
||||
Messages between Snips and Home Assistant are passed via MQTT. We can either point Snips to the MQTT broker used by Home Assistant, as explained above, or tell Home Assistant which [MQTT broker](/integrations/mqtt) to use by adding the following entry to the `configuration.yaml` file:
|
||||
Messages between Snips and Home Assistant are passed via MQTT. We can either point Snips to the MQTT broker used by Home Assistant, as explained above, or tell Home Assistant which [MQTT broker](/integrations/mqtt) to use by adding the following entry to the {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
mqtt:
|
||||
|
@ -15,7 +15,7 @@ The `sony_projector` switch platform allows you to control the state of SDCP com
|
||||
|
||||
## Configuration
|
||||
|
||||
To use your Sony Projector in your installation, add the following to your `configuration.yaml` file:
|
||||
To use your Sony Projector in your installation, add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
@ -28,7 +28,7 @@ This can be used to present statistics about Home Assistant sensors if used with
|
||||
|
||||
## Configuration by YAML
|
||||
|
||||
To configure this sensor, define the sensor connection variables and a list of queries to your `configuration.yaml` file. A sensor will be created for each query.
|
||||
To configure this sensor, define the sensor connection variables and a list of queries to your {% term "`configuration.yaml`" %} file. A sensor will be created for each query.
|
||||
|
||||
To enable it, add the following lines to your {% term "`configuration.yaml`" %} file.
|
||||
{% include integrations/restart_ha_after_config_inclusion.md %}
|
||||
|
@ -20,7 +20,7 @@ The stream integration provides a way to proxy live streams through Home Assista
|
||||
|
||||
## Configuration
|
||||
|
||||
The `stream` integration is automatically loaded by `default_config` and enabled by the `camera` platforms that support it. If `default_config` is used, no separate `configuration.yaml` entry is necessary. However, there are some extra options you can configure.
|
||||
The `stream` integration is automatically loaded by `default_config` and enabled by the `camera` platforms that support it. If `default_config` is used, no separate {% term "`configuration.yaml`" %} entry is necessary. However, there are some extra options you can configure.
|
||||
|
||||
{% configuration %}
|
||||
ll_hls:
|
||||
@ -44,7 +44,7 @@ part_duration:
|
||||
|
||||
LL-HLS reduces the start time and delay for a stream, but it has strict timing and network requirements and opens additional browser connections. To avoid running into browser limits it is strongly recommended to use an HTTP/2 proxy (e.g., NGINX or haproxy) to take advantage of request pipelining. LL-HLS is enabled by default, but when not using HTTP/2, the Home Assistant frontend will revert back to regular HLS if too many streams are open.
|
||||
|
||||
You can further adjust LL-HLS settings in `configuration.yaml` as it may perform better or worse with different values depending on your network setup, cameras, or whether or not they are local or cloud.
|
||||
You can further adjust LL-HLS settings in {% term "`configuration.yaml`" %} as it may perform better or worse with different values depending on your network setup, cameras, or whether or not they are local or cloud.
|
||||
|
||||
Example configuration:
|
||||
|
||||
|
@ -27,7 +27,7 @@ For more complete Home Assistant support based on MQTT autodiscovery, consider s
|
||||
|
||||
## Configuration
|
||||
|
||||
To use SUPLA devices in your installation, add the following to your `configuration.yaml`:
|
||||
To use SUPLA devices in your installation, add the following to your {% term "`configuration.yaml`" %}:
|
||||
|
||||
```yaml
|
||||
supla:
|
||||
|
@ -18,7 +18,7 @@ When a `state_topic` is not available, the switch will work in optimistic mode.
|
||||
|
||||
Optimistic mode can be forced, even if the `state_topic` is available. Try to enable it, if experiencing incorrect switch operation.
|
||||
|
||||
To enable this switch in your installation, add the following to your `configuration.yaml` file:
|
||||
To enable this switch in your installation, add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
@ -12,7 +12,7 @@ The `rest` switch platform allows you to control a given endpoint that supports
|
||||
|
||||
## Configuration
|
||||
|
||||
To enable this switch, add the following lines to your `configuration.yaml` file:
|
||||
To enable this switch, add the following lines to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
@ -17,7 +17,7 @@ This can simplify the GUI and make it easier to write automations.
|
||||
|
||||
## Configuration
|
||||
|
||||
To enable Template Switches in your installation, add the following to your `configuration.yaml` file:
|
||||
To enable Template Switches in your installation, add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
{% raw %}
|
||||
|
||||
|
@ -18,7 +18,7 @@ This `Switchmate` switch platform allows you to control Switchmate [devices]( ht
|
||||
|
||||
## Configuration
|
||||
|
||||
To enable it, add the following lines to your `configuration.yaml`:
|
||||
To enable it, add the following lines to your {% term "`configuration.yaml`" %}:
|
||||
|
||||
```yaml
|
||||
switch:
|
||||
|
@ -13,7 +13,7 @@ The `system_log` integration stores information about all logged errors and warn
|
||||
|
||||
## Configuration
|
||||
|
||||
This integration is automatically loaded by the `frontend` (so no need to do anything if you are using the frontend). If you are not doing so, or if you wish to change a parameter, add the following section to your `configuration.yaml` file:
|
||||
This integration is automatically loaded by the `frontend` (so no need to do anything if you are using the frontend). If you are not doing so, or if you wish to change a parameter, add the following section to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
system_log:
|
||||
|
Loading…
x
Reference in New Issue
Block a user