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-08 18:06:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

d-integrations: add glossary reference to configuration.yaml (#32753)

Browse Source
This commit is contained in:
c0ffeeca7 2024-05-14 15:08:50 +02:00 committed by GitHub
parent 88b471a62b
commit 23d49e8fc4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
10 changed files with 64 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
source/_integrations/decora_wifi.markdown
View File

@ -9,6 +9,9 @@ ha_domain: decora_wifi
ha_platforms:
- light
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
Support for [Leviton Decora Wi-Fi](https://www.leviton.com/products/residential/automation-smart-home/decora-smart-all/decora-smart-with-wifi-technology) dimmers/switches via the MyLeviton API.
@ -20,7 +23,8 @@ Supported devices (tested):
- - [DW15S-1BZ](https://www.leviton.com/products/dw15s-1bz) (Decora Smart Wi-Fi 15A Switch)
- [D215S-2RW](https://store.leviton.com/products/decora-smart-wi-fi-switch-2nd-gen-d215s-2rw) (Decora Smart Wi-Fi 15A Switch - 2nd Gen)
To enable these lights, add the following lines to your `configuration.yaml` file:
To enable these lights, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

2
source/_integrations/default_config.markdown
View File

@ -37,7 +37,7 @@ This {% term integration %} is a meta-component and configures a default set of
## Configuration
To integrate this into Home Assistant, add the following section to your `configuration.yaml` file:
To integrate this into Home Assistant, add the following section to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry

8
source/_integrations/device_tracker.markdown
View File

@ -17,7 +17,7 @@ The device tracker allows you to track devices in Home Assistant. This can happe
## Configuring a `device_tracker` platform
To get started add the following lines to your `configuration.yaml` (example for Netgear):
To get started add the following lines to your {% term "`configuration.yaml`" %} (example for Netgear):
```yaml
# Example configuration.yaml entry for Netgear device
@ -37,7 +37,7 @@ The following optional parameters can be used with any platform:
</div>
| Parameter | Default | Description |
|----------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `interval_seconds` | 12 | Seconds between each scan for new devices. This only applies to local device trackers, not applications that push updates. |
| `consider_home` | 180 | Seconds to wait till marking someone as not home after not being seen. This parameter is most useful for households with Apple iOS devices that go into sleep mode while still at home to conserve battery life. iPhones will occasionally drop off the network and then re-appear. `consider_home` helps prevent false alarms in presence detection when using IP scanners such as Nmap. `consider_home` accepts various time representations, (e.g., the following all represents 3 minutes: `180`, `0:03`, `0:03:00`) |
@ -90,7 +90,7 @@ In the example above, `devicename` refers to the detected name of the device. F
</div>
| Parameter | Default | Description |
|----------------|-------------------------------|---------------------------------------------------------------------------------------------------------|
| --------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | Host name or "Unnamed Device" | The friendly name of the device. |
| `mac` | None | The MAC address of the device. Add this if you are using a network device tracker like Nmap or SNMP. |
| `picture` | None | A picture that you can use to easily identify the person or device. You can also save the image file in a folder "www" in the same location (can be obtained from developer tools) where you have your `configuration.yaml` file and just use `picture: /local/favicon-192x192.png`. The path 'local' is mapped to the 'www' folder you create. |
@ -108,7 +108,7 @@ The state of your tracked device will be `'home'` if it is in the [home zone](/i
The `device_tracker.see` service can be used to manually update the state of a device tracker:
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| ---------------------- | -------- | --------------------------------------------------------------------------------------- |
| `dev_id` | no | The `object_id`, for example `tardis` for `device_tracker.tardis` |
| `location_name` | yes | The location, `home`, `not_home`, or the name of the zone |
| `host_name` | yes | The hostname of the device tracker |

7
source/_integrations/device_tracker.mqtt.markdown
View File

@ -6,14 +6,17 @@ ha_category:
ha_iot_class: Configurable
ha_release: 0.7.3
ha_domain: mqtt
related:
- docs: /docs/configuration/
title: Configuration file
---
The `mqtt` device tracker platform allows you to define new device_trackers through [manual YAML configuration](#yaml-configuration) in `configuration.yaml` and also to automatically discover device_trackers [using the MQTT Discovery protocol](#using-the-discovery-protocol).
The `mqtt` device tracker {% term integration %} allows you to define new device_trackers through [manual YAML configuration](#yaml-configuration) in {% term "`configuration.yaml`" %} and also to automatically discover device_trackers [using the MQTT Discovery protocol](#using-the-discovery-protocol).
## 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:
```yaml
# Example configuration.yaml entry

2
source/_integrations/device_tracker.xiaomi.markdown
View File

@ -11,7 +11,7 @@ The `xiaomi` platform offers presence detection by looking at connected devices
## Setup
To use an Xiaomi router in your installation, add the following to your `configuration.yaml` file:
To use an Xiaomi router in your installation, add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry

2
source/_integrations/device_trigger.mqtt.markdown
View File

@ -14,7 +14,7 @@ An MQTT device trigger is a better option than a [binary sensor](/integrations/b
## Configuration
MQTT device triggers are only supported through [MQTT discovery](/integrations/mqtt/#mqtt-discovery), manual setup through `configuration.yaml` is not supported.
MQTT device triggers are only supported through [MQTT discovery](/integrations/mqtt/#mqtt-discovery), manual setup through {% term "`configuration.yaml`" %} is not supported.
The discovery topic needs to be: `<discovery_prefix>/device_automation/[<node_id>/]<object_id>/config`. Note that only one trigger may be defined per unique discovery topic. Also note that the combination of `type` and `subtype` should be unique for a device.
{% configuration %}

4
source/_integrations/digital_ocean.markdown
View File

@ -54,7 +54,7 @@ The `digital_ocean` binary sensor platform allows you to monitor your Digital Oc
### Configuration
To use your Digital Ocean droplets, you first have to set up your [Digital Ocean hub](/integrations/digital_ocean/) and then add the following to your `configuration.yaml` file:
To use your Digital Ocean droplets, you first have to set up your [Digital Ocean hub](/integrations/digital_ocean/) and then add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
@ -78,7 +78,7 @@ The `digital_ocean` switch platform allows you to control (start/stop) your Digi
### Configuration
To use your Digital Ocean droplets, you first have to set up your [Digital Ocean hub](/integrations/digital_ocean/) and then add the following to your `configuration.yaml` file:
To use your Digital Ocean droplets, you first have to set up your [Digital Ocean hub](/integrations/digital_ocean/) and then add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry

9
source/_integrations/dovado.markdown
View File

@ -17,14 +17,14 @@ related:
title: Configuration file
---
The `dovado` {% term integration %} manages communication with the [Dovado](https://www.dovado.com/) router.
The **Dovado** {% term integration %} manages communication with the [Dovado](https://www.dovado.com/) router.
There is currently support for the following device types within Home Assistant:
- [Notifications](/integrations/dovado/#notifications)
- [Sensor](/integrations/dovado/#sensor)
To add a Dovado integration to your installation, add the following to your {% term "`configuration.yaml`" %} file.
To add a Dovado {% term integration %} to your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
@ -59,7 +59,8 @@ port:
The `dovado` notify platform allows you to send SMS from your [Dovado](https://www.dovado.com/) router, if it supports it.
To add the Dovado notify platform to your installation, add the following to your `configuration.yaml` file:
To add the Dovado {% term integration %} 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
@ -89,7 +90,7 @@ automation:
The `dovado` sensor platform let you monitor your [Dovado](https://www.dovado.com/) router.
To add a Dovado sensor to your installation, add the following to your `configuration.yaml` file:
To add a Dovado sensor to your installation, add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry

2
source/_integrations/dweet.markdown
View File

@ -62,7 +62,7 @@ The `dweet` sensor platform allows you to get details from your devices which ar
### Configuration
To use Dweet.io sensors in your installation, add the following to your `configuration.yaml` file:
To use Dweet.io sensors in your installation, add the following to your {% term "`configuration.yaml`" %} file:
{% raw %}

22
source/_integrations/dynalite.markdown
View File

@ -48,7 +48,7 @@ There are global setup parameters and advanced parameters that should normally b
Maybe the most difficult thing about a Dynalite system is finding out the areas and channel mapping. If you have them or have access to the Dynalite software and your configuration files, this could be easy,
but in the likely case that your system was installed by an integrator, you will have to discover them on your own.
This is where the `autodiscover` option comes handy. If it is on, the component will track the Dynet network and every time a device is used, it will be added to Home Assistant. It will initially show as "Area 123 Channel 7", but you can then add it to your `configuration.yaml` with the correct configuration.
This is where the `autodiscover` option comes handy. If it is on, the component will track the Dynet network and every time a device is used, it will be added to Home Assistant. It will initially show as "Area 123 Channel 7", but you can then add it to your {% term "`configuration.yaml`" %} with the correct configuration.
For example, you would go to your kitchen light and turn it on. Now you log into Home Assistant and see what the channel was. If there was more than one discovered (e.g., someone turned off the living room lights), you can try one, turn it on and off in Home Assistant and see which light it affects.
@ -67,10 +67,10 @@ This does not return the area preset. It sends a network command asking the area
</div>
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `host` | yes | Which gateway to send the command to. If not specified, sends to all configured gateways.
| `area` | no | Area for the requested channel.
| `channel` | no | Which channel to request.
| ---------------------- | -------- | ----------------------------------------------------------------------------------------- |
| `host` | yes | Which gateway to send the command to. If not specified, sends to all configured gateways. |
| `area` | no | Area for the requested channel. |
| `channel` | no | Which channel to request. |
### Service `dynalite.request_channel_level`
@ -83,10 +83,10 @@ This does not return the channel level. It sends a network command asking the ch
</div>
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `host` | yes | Which gateway to send the command to. If not specified, sends to all configured gateways.
| `area` | no | Which area to request the preset for.
| `channel` | yes | Which channel to use. If not specified, uses the area configuration or system default.
| ---------------------- | -------- | ----------------------------------------------------------------------------------------- |
| `host` | yes | Which gateway to send the command to. If not specified, sends to all configured gateways. |
| `area` | no | Which area to request the preset for. |
| `channel` | yes | Which channel to use. If not specified, uses the area configuration or system default. |
## Events
@ -95,7 +95,7 @@ This does not return the channel level. It sends a network command asking the ch
Event `dynalite_preset` is fired every time a preset is selected in a given Dynalite area.
| Field | Description |
| ----------- | --------------------------------------------------------------------------------------------------- |
| -------- | ------------------------------------- |
| `host` | Host IP of the Dynalite gateway |
| `area` | Area number where preset was selected |
| `preset` | The specific preset that was selected |
@ -105,6 +105,6 @@ Event `dynalite_preset` is fired every time a preset is selected in a given Dyna
Event `dynalite_packet` is fired whenever there is a packet on the Dynalite network.
| Field | Description |
| ----------- | --------------------------------------------------------------------------------------------------- |
| -------- | ----------------------------------------------------------------------- |
| `host` | Host IP of the Dynalite gateway |
| `packet` | List of integers representing the 8-byte packet, including the checksum |