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 17:27:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

u-z integrations: apply sentence-style caps to categories (#29907)

Browse Source 
* u-z integrations: apply sentence-style caps to categories

* Apply suggestions from code review

Co-authored-by: Joakim Sørensen <joasoe@gmail.com>

* Add references to glossary terms

* Update source/_integrations/universal.markdown

Co-authored-by: Joakim Sørensen <joasoe@gmail.com>

* Update source/_integrations/universal.markdown

Co-authored-by: Joakim Sørensen <joasoe@gmail.com>

* linter: change vizio to VIZIO

- as per product website https://www.vizio.com/en/smartcast

* remove term refs from YAML

* VIZIO: change spelling according to website

- https://www.vizio.com/en/t

* Update source/_integrations/vizio.markdown

* Update source/_integrations/universal.markdown

* Apply suggestions from code review

Co-authored-by: Joakim Sørensen <joasoe@gmail.com>

* Update source/_integrations/unifiprotect.markdown

Co-authored-by: Joakim Sørensen <joasoe@gmail.com>

* Apply suggestions from code review

Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>

* Apply suggestions from code review

Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>

* Fix some more to sentence-style caps

* Update source/_integrations/unifiprotect.markdown

Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>

* Update source/_integrations/unifiprotect.markdown

Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>

* Update source/_integrations/unifiprotect.markdown

Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>

---------

Co-authored-by: Joakim Sørensen <joasoe@gmail.com>
Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>
This commit is contained in:
c0ffeeca7 2023-11-19 14:43:27 +01:00 committed by GitHub
parent 40c0c10b29
commit a4a68172c0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
109 changed files with 487 additions and 480 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.textlintrc.json
View File

@ -273,7 +273,7 @@
"ViCare",
"Viessmann",
"VIVOTEK",
"Vizio",
"VIZIO",
"Vultr",
"WebDAV",
"WeMo",

4
source/_integrations/ubiwizz.markdown
View File

@ -3,7 +3,7 @@ title: Ubiwizz
description: Connect and control your Ubiwizz devices using the Overkiz integration
ha_category:
- Alarm
- Binary Sensor
- Binary sensor
- Button
- Climate
- Cover
@ -16,7 +16,7 @@ ha_category:
- Sensor
- Siren
- Switch
- Water Heater
- Water heater
ha_domain: ubiwizz
ha_integration_type: virtual
ha_supporting_domain: overkiz

6
source/_integrations/ubus.markdown
View File

@ -2,7 +2,7 @@
title: OpenWrt (ubus)
description: Instructions on how to integrate OpenWRT routers into Home Assistant.
ha_category:
- Presence Detection
- Presence detection
ha_release: 0.7.6
ha_iot_class: Local Polling
ha_domain: ubus
@ -87,7 +87,7 @@ See the [device tracker integration page](/integrations/device_tracker/) for ins
If you find that this never creates `known_devices.yaml`, or if you need more information on the communication chain between Home Assistant and OpenWrt, follow these steps to grab the packet stream and gain insight into what's happening.
### Increase Log Level
### Increase log level
1. On your Home Assistant device, stop Home Assistant
2. Adjust `configuration.yaml` to log more detail for the `device_tracker` integration.
@ -128,7 +128,7 @@ If you find that this never creates `known_devices.yaml`, or if you need more in
17-04-28 10:50:34 INFO (Thread-7) [homeassistant.components.device_tracker.ubus] Checking ARP
```
### Inspect Packets With TCPDump
### Inspect packets with TCPDump
_These steps require that `tcpdump` is installed on your Home Assistant device, and that you have a utility such as [Wireshark](https://www.wireshark.org) for viewing the packets. It also assumes that Home Assistant is communicating with your router over HTTP and not HTTPS._

2
source/_integrations/ue_smart_radio.markdown
View File

@ -2,7 +2,7 @@
title: Logitech UE Smart Radio
description: Instructions on how to integrate a Logitech UE Smart Radio player into Home Assistant.
ha_category:
- Media Player
- Media player
ha_release: '0.60'
ha_iot_class: Cloud Polling
ha_domain: ue_smart_radio

2
source/_integrations/uk_transport.markdown
View File

@ -153,6 +153,6 @@ template:
## Managing API requests
If you wish to manage the rate of API requests (e.g., to disable requests when you aren't interested in travel, so that you can request updates more frequently when you do travel) set a really long `scan_interval` in the configuration options, and use the service `homeassistant.update_entity` to request the update of an entity, rather than waiting for the next scheduled update.
If you wish to manage the rate of API requests (e.g., to disable requests when you aren't interested in travel, so that you can request updates more frequently when you do travel) set a really long `scan_interval` in the configuration options, and use the service `homeassistant.update_entity` to request the update of an {% term entity %}, rather than waiting for the next scheduled update.
Powered by [transportAPI](https://www.transportapi.com/)

2
source/_integrations/ukraine_alarm.markdown
View File

@ -14,7 +14,7 @@ ha_platforms:
ha_integration_type: integration
---
The Ukraine Alarm integration uses the siren.pp.ua API - public wrapper for [Ukraine Alarm](https://www.ukrainealarm.com/) web service to offer air-raid siren notifications. The integration will create 6 binary sensors for your selected region in Ukraine:
The **Ukraine Alarm** {% term integration %} uses the siren.pp.ua API - public wrapper for [Ukraine Alarm](https://www.ukrainealarm.com/) web service to offer air-raid siren notifications. The {% term integration %} will create 6 binary sensors for your selected region in Ukraine:
- Air
- Artillery

2
source/_integrations/ultraloq.markdown
View File

@ -13,7 +13,7 @@ ha_iot_standard: zwave
Ultraloq smart locks allow users to enter their homes without a key. The lock can be controlled remotely using the Ultraloq app or by using Home Assistant. U-tec, their parent company, is a member of the Works with Home Assistant partner program. This means they are committed to making sure the Ultraloq Z-Wave products are up-to-date and ready to use with Home Assistant.
Ultraloq Z-Wave Series smart locks work locally and integrate seamlessly with the Z-Wave integration in Home Assistant (Z-Wave stick required).
Ultraloq Z-Wave Series smart locks work locally and integrate seamlessly with the **Z-Wave** {% term integration %} in Home Assistant (Z-Wave stick required).
To add Ultraloq Z-Wave products, pair them as Z-Wave devices:

16
source/_integrations/unifi.markdown
View File

@ -4,7 +4,7 @@ description: Instructions on how to configure UniFi Network integration with Uni
ha_category:
- Hub
- Image
- Presence Detection
- Presence detection
- Sensor
- Switch
- Update
@ -33,7 +33,7 @@ There is currently support for the following device types within Home Assistant:
- [Button](#button)
- [Image](#image)
- [Presence Detection](#presence-detection)
- [Presence detection](#presence-detection)
- [Switch](#switch)
- [Sensor](#sensor)
- [Firmware updates](#firmware-updates)
@ -44,7 +44,7 @@ The user needs administrator privileges in order to control switches.
### Extra configuration of the integration
All configuration options are offered from the front end. Enter what UniFi Network integration you want to change options on and press the cog wheel. Some advanced options are available when "Advanced Mode" is enabled on your user profile page.
All configuration options are offered from the front end. Enter what UniFi Network {% term integration %} you want to change options on and press the cog wheel. Some advanced options are available when "Advanced Mode" is enabled on your user profile page.
### Configuring Users
@ -56,7 +56,7 @@ For UniFi OS a local-only user needs to be created. A user who uses the Ubiquiti
### Conflicts with MQTT
The UniFi Network application can either be a UniFi OS console device (like the Cloud Key), or as software on any Linux system. If you run the UniFi Network application on the same operating system as Home Assistant there may be conflicts in ports if you have the MQTT integration as well.
The UniFi Network application can either be a UniFi OS console device (like the Cloud Key), or as software on any Linux system. If you run the UniFi Network application on the same operating system as Home Assistant there may be conflicts in ports if you have the MQTT {% term integration %} as well.
It is recommended that you run the UniFi Network application in a dedicated virtual machine to avoid that situation.
@ -90,7 +90,7 @@ Try to get a wireless client to reconnect to the network.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | --------------------------------------------------------------------------- |
| `device_id` | No | String representing a device ID related to a UniFi Network integration. |
| `device_id` | No | String representing a device ID related to a UniFi Network {% term integration %} . |
### Service unifi.remove_clients
@ -100,7 +100,7 @@ Clean up clients on the UniFi Network application that has only been associated
### Block network access for clients
Allow control of network access to clients configured in the integration options by adding MAC addresses. Items in this list will have a Home Assistant switch created, using the UniFi Device name, allowing for blocking and unblocking.
Allow control of network access to clients configured in the {% term integration %} options by adding MAC addresses. Items in this list will have a Home Assistant switch created, using the UniFi Device name, allowing for blocking and unblocking.
### PoE port control
@ -108,7 +108,7 @@ Provides per-port PoE control. Entities are disabled by default. This feature re
### Control DPI Traffic Restrictions
Entities appear automatically for each restriction group. If there are no restrictions in a group, no entity will be visible. Toggling the switch in Home Assistant will enable or disable all restrictions inside a group.
Entities appear automatically for each restriction group. If there are no restrictions in a group, no {% term entity %} will be visible. Toggling the switch in Home Assistant will enable or disable all restrictions inside a group.
### Control Port forward functonality
@ -146,7 +146,7 @@ This will show if there are firmware updates available for the UniFi network dev
## Debugging integration
If you have problems with the UniFi Network application or integration you can add debug prints to the log.
If you have problems with the UniFi Network application or {% term integration %} you can add debug prints to the log.
```yaml
logger:

2
source/_integrations/unifi_direct.markdown
View File

@ -2,7 +2,7 @@
title: UniFi AP
description: Instructions on how to use a Unifi WAP as a device tracker.
ha_category:
- Presence Detection
- Presence detection
ha_iot_class: Local Polling
ha_release: 0.59
ha_domain: unifi_direct

78
source/_integrations/unifiprotect.markdown
View File

@ -2,15 +2,15 @@
title: UniFi Protect
description: Instructions on how to configure the Ubiquiti UniFi Protect integration.
ha_category:
- Binary Sensor
- Binary sensor
- Button
- Camera
- Doorbell
- Hub
- Light
- Lock
- Media Player
- Media Source
- Media player
- Media source
- Number
- Select
- Sensor
@ -41,13 +41,13 @@ ha_platforms:
ha_integration_type: hub
---
The UniFi Protect integration adds support for retrieving Camera feeds and Sensor data from a [UniFi Protect application](https://ui.com/camera-security) by [Ubiquiti Networks, inc.](https://www.ui.com/) that is running on a UniFi OS Console.
The **UniFi Protect** {% term integration %} adds support for retrieving camera feeds and sensor data from a [UniFi Protect application](https://ui.com/camera-security) by [Ubiquiti Networks, inc.](https://www.ui.com/) that is running on a UniFi OS Console.
## Prerequisites
### Hardware Support
### Hardware support
This Integration supports all UniFi OS Consoles that can run UniFi Protect. Currently, this includes:
This {% term integration %} supports all UniFi OS Consoles that can run UniFi Protect. Currently, this includes:
- Any UniFi Protect Network Video Recorder (**[UNVR](https://store.ui.com/collections/unifi-protect-nvr/products/unvr)** or **[UNVRPRO](https://store.ui.com/collections/unifi-protect-nvr/products/unvr-pro)**)
- Any UniFi "Dream" device (**[UDMPRO](https://store.ui.com/collections/unifi-network-unifi-os-consoles/products/udm-pro)**, **[UDR](https://store.ui.com/collections/unifi-network-unifi-os-consoles/products/dream-router)**, or **[UDMSE](https://store.ui.com/collections/unifi-network-unifi-os-consoles/products/dream-machine-se)**), _except the base UniFi Dream Machine/UDM_
@ -55,7 +55,7 @@ This Integration supports all UniFi OS Consoles that can run UniFi Protect. Curr
UCKP with Firmware v1.x **do NOT run UniFi OS**, you must upgrade to firmware `[v2.0.24](https://community.ui.com/releases/UniFi-Cloud-Key-Firmware-2-0-24/b6684f1e-8542-4660-bc0b-74e0634448e8)` or newer.
### Software Support
### Software support
The absolute **minimal** software version is `[v1.20.0](https://community.ui.com/releases/UniFi-Protect-Application-1-20-0/d43c0905-3fb4-456b-a7ca-73aa830cb011)` for UniFi Protect. If you have an older version, you will get errors trying to set up the integration. However, the general advice is the latest 2 minor versions of UniFi Protect and hardware supported by those are supported.
@ -65,15 +65,15 @@ The absolute **minimal** software version is `[v1.20.0](https://community.ui.com
**Early Access releases are not supported by Home Assistant.**
Using Early Access versions will likely cause your UniFi Protect integration to break unexpectedly.
Using Early Access versions will likely cause your UniFi Protect {% term integration %} to break unexpectedly.
</div>
#### Downgrading UniFi Protect
In the event you accidentally upgrade to an Early Access version of UniFi Protect you can downgrade to a stable version by either [restoring a backup](https://help.ui.com/hc/articles/360008976393) or by manually downgrading your UniFi Protect.
In the event you accidentally upgrade to an Early Access version of UniFi Protect, you can downgrade to a stable version by either [restoring a backup](https://help.ui.com/hc/articles/360008976393) or by manually downgrading your UniFi Protect.
##### Manually Downgrade
##### Manually downgrade
Manually downgrading comes with its own risks and it is not recommended unless you do not have a backup available. Some Protect versions cannot be downgraded from (like `v2.0` to `v1.21`). To downgrade, you can access your [UniFi OS Console via SSH](https://help.ui.com/hc/articles/204909374) and then do the following:
@ -95,7 +95,7 @@ If you want to downgrade to another Early Access version, you must have [Remote
</div>
### Local User
### Local user
You will need a local user created in your UniFi OS Console to log in with. Ubiquiti SSO Cloud Users will **not** work.
It is recommended you use the Administrator or a user with full read/write access to get the most out of the integration,
@ -112,7 +112,7 @@ use has.
![UniFi OS User Creation](/images/integrations/unifiprotect/user.png)
### Camera Streams
### Camera streams
The integration uses the RTSP(S) Streams as the Live Feed source, so this needs to be enabled on each camera to ensure
you can stream your camera in Home Assistant. This may already be enabled by default, but it is recommended to just
@ -126,20 +126,20 @@ check that this is done. To check and enable the feature:
{% include integrations/config_flow.md %}
## Device Support
## Device support
All known UniFi Protect devices should be supported. Each UniFi Protect device will get a variety of entities added for
each of the different entity platforms.
each of the different {% term entity %} platforms.
<div class='note'>
**Permissions**: The below sections on the features available to your Home Assistant instance assume you have full
write access to each device. If the user you are using has limited access to some devices, you will get fewer entities
and in many cases, get a read-only sensor instead of an editable switch/select/number entity.
and in many cases, get a read-only sensor instead of an editable switch/select/number {% term entity %}.
</div>
### UniFi Protect Cameras
### UniFi Protect cameras
<div class='note'>
@ -154,9 +154,9 @@ G3 Series cameras do _not_ have Smart detections.
Each UniFi Protect camera will get a device in Home Assistant with the following:
- **Camera** - A camera for each camera channel and RTSP(S) combination found for each camera (up to 7). Only the highest resolution RTSPS camera entity will be enabled by default.
- If your camera is a G4 Doorbell Pro, an additional camera entity will be added for the Package Camera. The Package Camera entity will _not_ have streaming capabilities regardless of whether RTSPS is enabled on the channel or not. This is due to the Package Camera having a very low FPS that does not make it compatible with HLS streaming.
- **Media Player** - If your camera has a speaker, you will get a media player entity that allows you to play audio to your camera's speaker. Any audio file URI that is playable by FFmpeg will be able to be played to your speaker, including via the [TTS Say Service](/integrations/tts/#service-say).
- **Camera** - A camera for each camera channel and RTSP(S) combination found for each camera (up to 7). Only the highest resolution RTSPS camera {% term entity %} will be enabled by default.
- If your camera is a G4 Doorbell Pro, an additional camera {% term entity %} will be added for the Package Camera. The Package Camera {% term entity %} will _not_ have streaming capabilities regardless of whether RTSPS is enabled on the channel or not. This is due to the Package Camera having a very low FPS that does not make it compatible with HLS streaming.
- **Media Player** - If your camera has a speaker, you will get a media player {% term entity %} that allows you to play audio to your camera's speaker. Any audio file URI that is playable by FFmpeg will be able to be played to your speaker, including via the [TTS Say Service](/integrations/tts/#service-say).
- **Privacy Mode** - If your camera allows for Privacy Masks, there will be a configuration switch to toggle a "Privacy Mode" that disables recording, microphone, and a black privacy zone over the whole camera.
- **Sensors** - Sensors include "Is Dark", "Motion Detected", detected object sensors (if the camera supports smart detections), and "Doorbell Chime" (if the camera has a chime). Several diagnostics sensors are added including sensors on uptime, network connection stats, and storage stats. Doorbells will also have a "Voltage" sensor for troubleshooting electrical issues.
- There is one detected object sensor per Smart Detection supported by the camera and a combined sensor for if _any_ object is detected.
@ -166,16 +166,16 @@ Each UniFi Protect camera will get a device in Home Assistant with the following
- configuration text and select for LCD Screen for doorbells to either set custom messages or use predefined messages
- **Button** - A disabled by default button is added for each camera device. The button will let you reboot your camera device.
### UniFi Protect Floodlights
### UniFi Protect floodlights
Each UniFi Protect floodlight will get a device in Home Assistant with the following:
- **Light** - A light entity will be added for each floodlight device. The light entity will let you control turning on or off your light as well as adjust the brightness of your floodlight.
- **Light** - A light {% term entity %} will be added for each floodlight device. The light {% term entity %} will let you control turning on or off your light as well as adjust the brightness of your floodlight.
- **Sensors** - Sensors are provided for data provided from floodlight devices. Sensors include "Is Dark" and "Motion Detected".
- **Device Configuration** - Floodlights will get configuration controls for the PIR Motion Sensitivity, the Auto-shutoff Duration after detected motion, and Status Light switch
- **Button** - A disabled by default button is added for each floodlight device. The button will let you reboot your floodlight device.
### UniFi Protect Smart Sensors
### UniFi Protect smart sensors
UniFi Protect smart sensors are a bit different than normal sensors. They are a multi-sensor that can act as a contact sensor (door/window), a motion detector, a light level detector, a humidity sensor, a temperature level sensor, an alarm sound sensor, and/or a leak detector. Each sensor function can be enabled or disabled dynamically. Disabled sensors will be marked as "unavailable".
@ -190,11 +190,11 @@ UniFi Protect smart sensors are a bit different than normal sensors. They are a
- **Device Configuration** - Smart sensors will get configuration controls for the Status Light, enabling/disabling all of the main sensors, selecting the Paired Camera, and changing the Mount Type of the sensor.
- **Button** - A button to clear the tampered state as well as a disabled by default button to restart the device.
#### Tamper Sensor
#### Tamper sensor
Once the tamper sensor is triggered, it stays active until manually cleared. A button entity is available to clear the tampered state.
Once the tamper sensor is triggered, it stays active until manually cleared. A button {% term entity %} is available to clear the tampered state.
### UniFi Protect Viewers
### UniFi Protect viewers
Each UniFi Protect viewer will get a device in Home Assistant with the following:
@ -223,11 +223,11 @@ Your main UniFi Protect NVR device also gets a number of diagnostics sensors tha
- **Disk Health**: Each disk installed in your NVR will have a disk health sensor. These are simple good/bad sensors and the order is not promised to match the order in UniFi OS. Disk model number is provided as a state attribute though to help map sensor to disk.
- **Utilization and Storage Sensors**: Several other sensors are also added for uptime, hardware utilization, and distribution details of the video on disk.
## Media Source
## Media source
A media source is provided for your UniFi Protect cameras so you can fetch video clips and event thumbnails.
### Media Browser
### Media browser
The media source is split into 5 folders/levels:
@ -243,9 +243,9 @@ The media source is split into 5 folders/levels:
Since the media browser does not have any pagination or filtering, all of the events must be loaded into memory. As a result, the number of events loaded at once is truncated to 10,000 by default. The number of events will be listed at "10000 (TRUNCATED)" if the event count was truncated. You can raise or lower the limit of the number of events that can be loaded using the Config Entry Options.
### Media Identifiers
### Media identifiers
Below are the accepted identifiers to resolve media. Since events do not necessarily map to any Home Assistant entity, all IDs are in reference to the UniFi Protect IDs, not Home Assistant ones.
Below are the accepted identifiers to resolve media. Since events do not necessarily map to any Home Assistant {% term entity %}, all IDs are in reference to the UniFi Protect IDs, not Home Assistant ones.
| Identifier Format | Description |
| -------------------------------- | ---------------------------------- |
@ -254,7 +254,7 @@ Below are the accepted identifiers to resolve media. Since events do not necessa
## Services
### Service unifiprotect.set_default_doorbell_text
### {% term Service %} unifiprotect.set_default_doorbell_text
Sets the default doorbell message. This will be the message that is automatically selected when a message "expires".
@ -263,7 +263,7 @@ Sets the default doorbell message. This will be the message that is automaticall
| `device_id` | No | Any device from the UniFi Protect instance you want to change. In case you have multiple Protect instances. |
| `message` | No | The default message for your Doorbell. Must be less than 30 characters. |
### Service unifiprotect.add_doorbell_text
### {% term Service %} unifiprotect.add_doorbell_text
Adds a new custom message for Doorbells.
@ -272,7 +272,7 @@ Adds a new custom message for Doorbells.
| `device_id` | No | Any device from the UniFi Protect instance you want to change. In case you have multiple Protect instances. |
| `message` | No | New custom message to add for Doorbells. Must be less than 30 characters. |
### Service unifiprotect.remove_doorbell_text
### {% term Service %} unifiprotect.remove_doorbell_text
Removes an existing message for Doorbells.
@ -281,7 +281,7 @@ Removes an existing message for Doorbells.
| `device_id` | No | Any device from the UniFi Protect instance you want to change. In case you have multiple Protect instances. |
| `message` | No | Existing custom message to remove for Doorbells. |
### Service unifiprotect.set_chime_paired_doorbells
### {% term Service %} unifiprotect.set_chime_paired_doorbells
Use to set the paired doorbell(s) with a smart chime.
@ -292,32 +292,32 @@ Use to set the paired doorbell(s) with a smart chime.
## Views
The integration provides two proxy views to proxy media content from your Home Assistant instance so you can access thumbnails and video clips from within the context of Home Assistant without having to expose your UniFi Protect NVR Console. As with the media identifiers, all IDs are UniFi Protect IDs as they may not map to specific Home Assistant entities depending on how you have configured your integration.
The {% term integrations %} provides two proxy views to proxy media content from your Home Assistant instance so you can access thumbnails and video clips from within the context of Home Assistant without having to expose your UniFi Protect NVR Console. As with the media identifiers, all IDs are UniFi Protect IDs as they may not map to specific Home Assistant entities depending on how you have configured your {% term integrations %}.
These URLs work great when trying to send notifications. Home Assistant will automatically sign the URLs and make them safe for external consumption if used in an automation or [notify service](/integrations/notify/).
These URLs work great when trying to send notifications. Home Assistant will automatically sign the URLs and make them safe for external consumption if used in an {% term automation %} or [notify service](/integrations/notify/).
| View URL | Description |
| ------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `/api/unifiprotect/thumbnail/{nvr_id}/{event_id}` | Proxies a JPEG event thumbnail from UniFi Protect. |
| `/api/unifiprotect/video/{nvr_id}/{camera_id}/{start}/{end}` | Proxies a MP4 video clip from UniFi Protect for a specific camera. Start and end must be in [ISO 8601 format](https://www.iso.org/iso-8601-date-and-time-format.html). |
`nvr_id` can either be the UniFi Protect ID of your NVR or the config entry ID for your UniFi Protect integration. `camera_id` can either be the UniFi Protect ID of your camera or an entity ID of any entity provided by the UniFi Protect integration that can be reversed to a UniFi Protect camera (i.e., an entity ID of a detected object sensor).
`nvr_id` can either be the UniFi Protect ID of your NVR or the config entry ID for your UniFi Protect {% term integrations %}. `camera_id` can either be the UniFi Protect ID of your camera or an entity ID of any {% term entity %} provided by the UniFi Protect {% term integrations %} that can be reversed to a UniFi Protect camera (i.e., an entity ID of a detected object sensor).
The easiest way to find the `nvr_id`, `camera_id`, `start`, and `end` times is by viewing one of the videos from UniFi Protect in the Media browser. If you open the video in a new browser tab, you will see all these values in the URL. The `start` time is the last_changed timestamp of the event when the sensor started detecting motion. The `end` time is the last_changed timestamp of the event when the sensor stopped detecting motion. Similarly, to see the `event_id` of the image, go to {% my developer_states title="**Developer Tools** > **States**" %} and find the event when the sensor started detecting motion.
## Troubleshooting
### Delay in Video Feed
### Delay in video feed
The default settings on the stream integration will give you a 5-15+ second delay. You can reduce this delay to 1-3 seconds, by enabling [LL-HLS in the stream integration](/integrations/stream/#ll-hls). You will also want to put an HTTP/2 reserve proxy in front of Home Assistant so you can have connection pooling. If you do not add a reverse proxy, you may start to get "Waiting for WebSocket..." messages while trying to view too many camera streams at once. One way to do this is using the official NGINX Proxy Add-on:
{% my supervisor_addon addon="core_nginx_proxy" badge %}
### Cannot Play Audio to Speakers
### Cannot play audio to speakers
Unlike with many other things, playing audio to your speakers requires your Home Assistant to be able to reach your camera directly. Specifically via port `tcp/7004`. You can [enable debug logging](#enabling-debug-logging) and it will output the full FFmpeg command that will be run and the output from FFmpeg to help you troubleshoot why audio is not playing to the device.
### Liveview Options for Viewer Missing Options or Out of Date
### Liveview options for viewer missing options or out of date
Main control selects currently cannot have dynamic options since the options are exported out to voice assistants. After you add/remove/change a Liveview in UniFi Protect, you must restart Home Assistant to get the new options for your Viewer.

20
source/_integrations/universal.markdown
View File

@ -1,8 +1,8 @@
---
title: Universal Media Player
title: Universal media player
description: Instructions on how to create a universal media player in Home Assistant.
ha_category:
- Media Player
- Media player
ha_iot_class: Calculated
ha_release: 0.11
ha_quality_scale: internal
@ -12,11 +12,11 @@ ha_platforms:
ha_integration_type: integration
---
A Universal Media Player can combine multiple existing entities in Home Assistant into a single media player entity. This is used to create a single media player entity that can control an entire media center.
A universal media player can combine multiple existing entities in Home Assistant into a single media player {% term entity %}. This is used to create a single media player {% term entity %} that can control an entire media center.
Multiple media player entities may be controlled from a Universal Media Player. Additionally, the Universal Media Player can enable volume and power commands to be directed to other Home Assistant entities. This enables the media player power and volume commands to control devices like a television, amplifier or audio receiver, for example.
Multiple media player entities may be controlled from a universal media player. Additionally, the universal media player can enable volume and power commands to be directed to other Home Assistant entities. This enables the media player power and volume commands to control devices like a television, amplifier or audio receiver, for example.
A Universal Media Player is created in `configuration.yaml` as follows.
A universal media player is created in `configuration.yaml` as follows.
```yaml
# Example configuration.yaml entry
@ -101,13 +101,13 @@ unique_id:
type: string
{% endconfiguration %}
The Universal Media Player will primarily imitate one of its `children`. The Universal Media Player will control the first child on the list that is active (not idle/off). The Universal Media Player will also inherit its state from the first active child if a `state_template` is not provided. Entities in the `children:` list must be media players, but the state template can contain any entity.
The universal media player will primarily imitate one of its `children`. The universal media player will control the first child on the list that is active (not idle/off). The universal media player will also inherit its state from the first active child if a `state_template` is not provided. Entities in the `children:` list must be media players, but the state template can contain any {% term entity %}.
Using `active_child_template` will allow you to specify an active entity if the default behavior is unsuitable for your task. The template must return the `entity_id` of the child that will be selected as active or `None` to return the default behavior.
Using `active_child_template` will allow you to specify an active {% term entity %} if the default behavior is unsuitable for your task. The template must return the `entity_id` of the child that will be selected as active or `None` to return the default behavior.
It is recommended that the command `turn_on`, the command `turn_off`, and the attribute `state` all be provided together. The `state` attribute indicates if the media player is on or off. If `state` indicates the media player is off, this status will take precedence over the states of the children. If all the children are idle/off and `state` is on, the Universal Media Player's state will be on. If not provided, the `toggle` command will delegate to `turn_on` or `turn_off` based on the `state`.
It is also recommended that the command `volume_up`, the command `volume_down`, the command `volume_mute`, and the attribute `is_volume_muted` all be provided together. The attribute `is_volume_muted` should return either True or the on state when the volume is muted. The `volume_mute` service should toggle the mute setting.
It is also recommended that the command `volume_up`, the command `volume_down`, the command `volume_mute`, and the attribute `is_volume_muted` all be provided together. The attribute `is_volume_muted` should return either True or the on state when the volume is muted. The `volume_mute` {% term service %} should toggle the mute setting.
When providing `select_source` as a command, it is recommended to also provide the attributes `source`, and `source_list`. The `source` attribute is the currently select source, while the `source_list` attribute is a list of all available sources.
@ -119,7 +119,7 @@ The `browse_media_entity` parameter allows you to specify which media player wil
### Chromecast & Kodi control with switches
In this example, a switch is available to control the power to the television. Switches are also available to turn the volume up, turn the volume down, and mute the audio. These could be command line switches or any other entity in Home Assistant. The `turn_on` and `turn_off` commands will be redirected to the television, and the volume commands will be redirected to an audio receiver. The `select_source` command will be passed directly to an A/V receiver.
In this example, a switch is available to control the power to the television. Switches are also available to turn the volume up, turn the volume down, and mute the audio. These could be command line switches or any other {% term entity %} in Home Assistant. The `turn_on` and `turn_off` commands will be redirected to the television, and the volume commands will be redirected to an audio receiver. The `select_source` command will be passed directly to an A/V receiver.
The children are a Chromecast and a Kodi player. If the Chromecast is playing, the Universal Media Player will reflect its status. If the Chromecast is idle and Kodi is playing, the universal media player will change to reflect its status.
@ -278,7 +278,7 @@ automation:
{% endraw %}
### Harmony Remote Example
### Harmony remote example
The complete configuration is:

8
source/_integrations/upb.markdown
View File

@ -16,7 +16,8 @@ ha_platforms:
ha_integration_type: integration
---
The UPB integration allows Home Assistant to connect to a Universal Powerline Bus Powerline Interface Module (UPB PIM) to get status and control UPB devices and UPB links. The UPB PIM may be connected either to a serial port or over TCP. The integration implements the following platforms:
The ***Universal Powerline Bus (UPB)** {% term integration %} allows Home Assistant to connect to a Universal Powerline Bus Powerline Interface Module (UPB PIM) to get status and control UPB devices and UPB links. The UPB PIM may be connected either to a serial port or over TCP. The integration implements the following platforms:
- Light
- Scene
@ -26,7 +27,7 @@ The UPB integration requires that an export from the `UPStart` UPB configuration
{% include integrations/config_flow.md %}
## Device Configuration
## Device configuration
Using UPStart, configure each UPB dimmer-switch to report its state when it is manually operated. If you omit this step, manual changes to a dimmer-switch's state (on/off/brightness) will *not* be reported to Home Assistant.
@ -70,7 +71,7 @@ Besides the standard services provided by the Home Assistant [Light](/integratio
- `upb.scene_fade_stop`
- `upb.scene_blink`
### Rate Transition Time
### Rate transition time
Both standard and custom services that take a `transition` or a `rate` for changing brightness levels take time in seconds. The UPB
system only offers a discrete set of transition times. As such, the transition time requested is changed to the closest time based on
@ -233,6 +234,7 @@ kitchen_fade_on:
- Alterations to your UPB configuration with UpStart must be re-exported. The exported UPE file must have the same filename in the Home Assistant `config` directory.
## Debugging
Debug logs are often required to solve an issue. To enable UPB debug logs add the following to your `configuration.yaml` file in your Home Assistant `config` directory:
```yaml

2
source/_integrations/upc_connect.markdown
View File

@ -2,7 +2,7 @@
title: UPC Connect Box
description: Instructions on how to integrate UPC ConnectBox into Home Assistant.
ha_category:
- Presence Detection
- Presence detection
ha_release: 0.36
ha_codeowners:
- '@pvizeli'

12
source/_integrations/upcloud.markdown
View File

@ -2,9 +2,9 @@
title: UpCloud
description: Instructions on how to integrate UpCloud within Home Assistant.
ha_category:
- Binary Sensor
- Binary sensor
- Switch
- System Monitor
- System monitor
ha_release: 0.65
ha_config_flow: true
ha_iot_class: Cloud Polling
@ -17,11 +17,11 @@ ha_platforms:
ha_integration_type: integration
---
The `upcloud` integration allows you to access the information about your [UpCloud](https://upcloud.com/) servers from Home Assistant.
The **Upcloud** {% term integration %} allows you to access the information about your [UpCloud](https://upcloud.com/) servers from Home Assistant.
There is currently support for the following device types within Home Assistant:
- [Binary Sensor](#binary-sensor)
- [Binary sensor](#binary-sensor)
- [Switch](#switch)
## Setup
@ -32,8 +32,8 @@ Set up your API user credentials in your [UpCloud control panel](https://hub.upc
## Binary sensor
A binary sensor entity is set up for all discovered servers.
A binary sensor {% term entity %} is set up for all discovered servers.
## Switch
A switch entity is set up for all discovered servers. You can use the switch to control (start/stop) them.
A switch {% term entity %} is set up for all discovered servers. You can use the switch to control (start/stop) them.

30
source/_integrations/update.markdown
View File

@ -10,29 +10,29 @@ ha_codeowners:
ha_integration_type: entity
---
An update entity is an entity that indicates if an update is available for a
An update {% term entity %} is an entity that indicates if an update is available for a
device or service. This can be any update, including update of a firmware
for a device like a light bulb or router, or software updates for things like
add-ons or containers.
The state of the update entity indicates if there is an update pending or not,
The state of the update {% term entity %} indicates if there is an update pending or not,
and if there is an update available, more information on that update can be
provided by an integration to the entity. For example, the version that is
provided by an integration to the {% term entity %}. For example, the version that is
available, a summary of the release notes, and even links that provide more
information on the available update.
Lastly, there are two services available for the update entity. If possible and
made available by the integration providing the update entity, triggering
Lastly, there are two services available for the update {% term entity %}. If possible and
made available by the integration providing the update {% term entity %}, triggering
the actual update from Home Assistant. The other service exposed allows for
skipping the offered update.
{% include integrations/building_block_integration.md %}
For a list of integrations offering update entities, on the integrations page, select the ["Update" category](/integrations/#update).
For a list of {% term integrations %} offering update entities, on the integrations page, select the ["Update" category](/integrations/#update).
## The state of an update entity
The state of an update entity reflects whether an update is available or not.
The state of an update {% term entity %} reflects whether an update is available or not.
When the state is `on`, it means there is an update available; when everything
is up-to-date, the state is `off`.
@ -56,11 +56,11 @@ device classes. The following device classes are supported for switches:
- **`None`**: A generic software update. This is the default and doesn't need
to be set.
- **`firmware`**: This update integration provides firmwares.
- **`firmware`**: This update {% term integration %} provides firmwares.
## Services
The update entity exposes two services that can be used to install or skip
The update {% term entity %} exposes two services that can be used to install or skip
an offered software update.
### Service {% my developer_call_service service="update.install" %}
@ -68,16 +68,16 @@ an offered software update.
The {% my developer_call_service service="update.install" %} service can be used
to install an offered update to the device or service.
This service is only available for an update entity if an integration provides
this capability. Additionally, if allowed by the integration, the service
This service is only available for an update {% term entity %} if an {% term integration %} provides
this capability. Additionally, if allowed by the {% term integration %}, the service
provides for installing a specific version and even could make a
backup before installing the update.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | String or list of strings that point at `entity_id`s of updates. To target all updates, set `entity_id` to `all`.
| `version` | yes | A specific update version to install, if not provided, the latest available update will be installed. Availability of this atrribute is dependent on the integration.
| `backup` | yes | If set to `true`, a backup will be made before installing the update. Availability of this attribute is dependent on the integration.
| `version` | yes | A specific update version to install, if not provided, the latest available update will be installed. Availability of this atrribute is dependent on the {% term integration %}.
| `backup` | yes | If set to `true`, a backup will be made before installing the update. Availability of this attribute is dependent on the {% term integration %}.
Example service call:
@ -93,7 +93,7 @@ target:
The {% my developer_call_service service="update.skip" %} service can be used
to skip an offered update to the device or service.
After skipping an offered update, the entity will return to the `off` state,
After skipping an offered update, the {% term entity %} will return to the `off` state,
which means there is no update available.
```yaml
@ -113,7 +113,7 @@ The {% my developer_call_service service="update.clear_skipped" %} service can
be used to remove skipped version marker of a previously skipped an offered
update to the device or service.
After skipping an offered update, the entity will return to the `off` state,
After skipping an offered update, the {% term entity %} will return to the `off` state,
but will not return to it until a newer version becomes available again.
Using the `update.clear_skipped` service, the skipped version marker can be

8
source/_integrations/upnp.markdown
View File

@ -2,7 +2,7 @@
title: UPnP/IGD
description: Internet Gateway Device (IGD) Protocol for Home Assistant.
ha_category:
- Binary Sensor
- Binary sensor
- Network
- Sensor
ha_release: 0.18
@ -18,20 +18,20 @@ ha_platforms:
ha_integration_type: device
---
The `upnp` integration enables you to collect network statistics from your router such as bytes in/out and packets in/out, uptime, WAN IP address, and WAN connectivity status. This information is provided by the [UPnP](https://en.wikipedia.org/wiki/Universal_Plug_and_Play)/[Internet Gateway Device (IGD) Protocol](https://en.wikipedia.org/wiki/Internet_Gateway_Device_Protocol) if enabled on your router.
The **UPnP/IGD** {% term integration %} enables you to collect network statistics from your router such as bytes in/out and packets in/out, uptime, WAN IP address, and WAN connectivity status. This information is provided by the [UPnP](https://en.wikipedia.org/wiki/Universal_Plug_and_Play)/[Internet Gateway Device (IGD) Protocol](https://en.wikipedia.org/wiki/Internet_Gateway_Device_Protocol) if enabled on your router.
There is currently support for the following device types within Home Assistant:
- **Binary Sensor** - If router is connected to the WAN.
- **Sensor** - Allows to get the network statistics from your router such as bytes in/out and packets in/out, uptime, status, and IP. Sensor for uptime will only be there if supported by the router.
Please note that UPnP or NAT-PMP needs to be enabled on your router for this integration to work.
Please note that UPnP or NAT-PMP needs to be enabled on your router for this {% term integration %} to work.
{% include integrations/config_flow.md %}
## Debugging integration
If you have problems with this integration you can add debug prints to the log.
If you have problems with this {% term integration %} you can add debug prints to the log.
```yaml
logger:

2
source/_integrations/uptime.markdown
View File

@ -16,7 +16,7 @@ ha_codeowners:
ha_integration_type: service
---
The uptime integration provides a sensor that stores the timestamp
The **Uptime** {% term integration %} provides a sensor that stores the timestamp
(date and time) when Home Assistant was last started.
{% include integrations/config_flow.md %}

4
source/_integrations/uptimerobot.markdown
View File

@ -2,7 +2,7 @@
title: UptimeRobot
description: Instructions on how to set up UptimeRobot within Home Assistant.
ha_category:
- System Monitor
- System monitor
ha_release: 0.72
ha_iot_class: Cloud Polling
ha_codeowners:
@ -19,7 +19,7 @@ ha_config_flow: true
ha_integration_type: integration
---
The `uptimerobot` integration provides entities to get the status for all of your monitors from your account on [UptimeRobot]( https://uptimerobot.com).
The **UptimeRobot** {% term integration %} provides entities to get the status for all of your monitors from your account on [UptimeRobot]( https://uptimerobot.com).
{% include integrations/config_flow.md %}

4
source/_integrations/usb.markdown
View File

@ -12,7 +12,7 @@ ha_codeowners:
ha_integration_type: system
---
The USB Discovery integration will detect newly connected USB devices. Discovered devices will show up in the discovered section on the integrations page in the configuration panel.
The **USB Discovery** {% term integration %} will detect newly connected USB devices. Discovered devices will show up in the discovered section on the integrations page in the configuration panel.
- On all supported systems, devices are detected during startup.
- On Linux systems that have functional `udev` support, including Home Assistant Operating System, devices are detected as soon as they are plugged in.
@ -20,7 +20,7 @@ The USB Discovery integration will detect newly connected USB devices. Discovere
## Configuration
This integration is part of [`default_config:`](/integrations/default_config/) if you have opted to not use [`default_config:`](/integrations/default_config/)you can add this integration by adding the following lines to your `configuration.yaml`
This {% term integration %} is part of [`default_config:`](/integrations/default_config/) if you have opted to not use [`default_config:`](/integrations/default_config/)you can add this {% term integration %} by adding the following lines to your `configuration.yaml`
```yaml
# Example configuration.yaml entry

12
source/_integrations/usgs_earthquakes_feed.markdown
View File

@ -19,7 +19,7 @@ The `usgs_earthquakes_feed` platform lets you integrate a GeoJSON feed provided
<img src='/images/screenshots/usgs-earthquake-hazards-program-feed-entities.png' />
</p>
Entities are generated, updated and removed automatically with each update from the feed. Each entity defines latitude and longitude and will be shown on the map automatically. The distance in kilometers is available as the state of each entity.
Entities are generated, updated and removed automatically with each update from the feed. Each {% term entity %} defines latitude and longitude and will be shown on the map automatically. The distance in kilometers is available as the state of each {% term entity %}.
<p class='img'>
<img src='/images/screenshots/usgs-earthquake-hazards-program-feed-map.png' />
@ -65,7 +65,7 @@ longitude:
default: Longitude defined in your `configuration.yaml`
{% endconfiguration %}
### Supported Feed Types
### Supported feed types
| Description | Feed Type |
|----------------------------------------|--------------------------------------|
@ -91,9 +91,9 @@ longitude:
| Past 30 Days - All Earthquakes | `past_month_all_earthquakes` |
## State Attributes
## State attributes
The following state attributes are available for each entity in addition to the standard ones:
The following state attributes are available for each {% term entity %} in addition to the standard ones:
| Attribute | Description |
|--------------------|-------------|
@ -109,7 +109,7 @@ The following state attributes are available for each entity in addition to the
| type | Type of seismic event: "earthquake" or "quarry". |
## Full Configuration
## Full configuration
```yaml
# Example configuration.yaml entry
@ -121,7 +121,7 @@ geo_location:
latitude: 35.899722
longitude: -120.432778
```
## Card Example
## Card example
Assuming you configure this service using `feed_type: past_week_all_earthquakes`, you can create a corresponding map card in a dashboard with the following card:
```yaml

18
source/_integrations/utility_meter.markdown
View File

@ -18,14 +18,14 @@ ha_config_flow: true
ha_integration_type: helper
---
The Utility Meter integration provides functionality to track consumptions of various utilities (e.g., energy, gas, water, heating).
The **Utility Meter** {% term integration %} provides functionality to track consumptions of various utilities (e.g., energy, gas, water, heating).
From a user perspective, utility meters operate in cycles (usually monthly) for billing purposes. This sensor will track a source sensor values, automatically resetting the meter based on the configured cycle. On reset an attribute will store the previous meter value, providing the means for comparison operations (e.g., "did I spend more or less this month?") or billing estimation (e.g., through a sensor template that multiplies the metered value per the charged unit amount).
Some utility providers have different tariffs according to time/resource availability/etc. The utility meter enables you to define the various tariffs supported by your utility provider and accounts your consumptions in accordance. When tariffs are defined a new entity will show up indicating the current tariff. In order to change the tariff, the user must call a service, usually through an automation that can be based in time or other external source (eg. a REST sensor).
Some utility providers have different tariffs according to time/resource availability/etc. The utility meter enables you to define the various tariffs supported by your utility provider and accounts your consumptions in accordance. When tariffs are defined a new {% term entity %} will show up indicating the current tariff. In order to change the tariff, the user must call a service, usually through an automation that can be based in time or other external source (eg. a REST sensor).
<div class='note'>
Sensors created with this integration are persistent, so values are retained across restarts of Home Assistant. The first cycle for each sensor will be incomplete; a sensor tracking daily usage will start to be accurate the next day after the integration was activated. A sensor tracking monthly usage will present accurate data starting the first of the next month after being added to Home Assistant.
Sensors created with this {% term integration %} are persistent, so values are retained across restarts of Home Assistant. The first cycle for each sensor will be incomplete; a sensor tracking daily usage will start to be accurate the next day after the {% term integration %} was activated. A sensor tracking monthly usage will present accurate data starting the first of the next month after being added to Home Assistant.
</div>
{% include integrations/config_flow.md %}
@ -65,9 +65,9 @@ If the meter reset cycle and reset offsets are to limited for your use case,
consider using the YAML configuration below, which support CRON-style patterns
that provide a greater flexibility.
## YAML Configuration
## YAML configuration
Alternatively, this integration can be configured and set up manually via YAML
Alternatively, this {% term integration %} can be configured and set up manually via YAML
instead. To enable the Integration sensor in your installation, add the
following to your `configuration.yaml` file:
@ -163,7 +163,7 @@ Calibrate the Utility Meter. Change the value of a given sensor.
| `entity_id` | no | String or list of strings that point at `entity_id`s of utility_meters.
| `value` | no | Number | Value to calibrate the sensor with |
## Advanced Configuration
## Advanced configuration
The following configuration shows an example where 2 utility_meters (`daily_energy` and `monthly_energy`) track daily and monthly energy consumptions.
@ -241,9 +241,9 @@ utility_meter:
cron: "0 17 L * *"
```
## Advanced Configuration for DSMR users
## Advanced configuration for DSMR users
When using the [DSMR integration](/integrations/dsmr) to get data from the utility meter, each tariff (peak and off-peak) has a separate sensor. Additionally, there is a separate sensor for gas consumption. The meter switches automatically between tariffs, so an automation is not necessary in this case. But, you do have to setup a few more instances of the `utility_meter` integration.
When using the [DSMR integration](/integrations/dsmr) to get data from the utility meter, each tariff (peak and off-peak) has a separate sensor. Additionally, there is a separate sensor for gas consumption. The meter switches automatically between tariffs, so an automation is not necessary in this case. But, you do have to setup a few more instances of the `utility_meter` {% term integration %}.
If you want to create a daily and monthly sensor for each tariff, you have to track separate sensors:
@ -251,7 +251,7 @@ If you want to create a daily and monthly sensor for each tariff, you have to tr
- `sensor.energy_consumption_tarif_2` for tarif 2 power (for example peak)
- `sensor.gas_consumption` for gas consumption
So, tracking daily and monthly consumption for each sensor, will require setting up 6 entries under the `utility_meter` integration.
So, tracking daily and monthly consumption for each sensor, will require setting up 6 entries under the `utility_meter` {% term integration %}.
```yaml
utility_meter:

2
source/_integrations/vacuum.markdown
View File

@ -11,7 +11,7 @@ ha_codeowners:
ha_integration_type: entity
---
The `vacuum` integration enables the ability to control home cleaning robots within Home Assistant.
The **Vacuum** {% term integration %} enables the ability to control home cleaning robots within Home Assistant.
{% include integrations/building_block_integration.md %}

6
source/_integrations/vacuum.mqtt.markdown
View File

@ -7,8 +7,8 @@ ha_release: 0.54
ha_domain: mqtt
---
The `mqtt` vacuum integration allows you to control your MQTT-enabled vacuum.
The initial state of the MQTT vacuum entity will set to `unknown` and can be reset by a device by sending a `null` payload as state.
The `mqtt` vacuum {% term integration %} allows you to control your MQTT-enabled vacuum.
The initial state of the MQTT vacuum {% term entity %} will set to `unknown` and can be reset by a device by sending a `null` payload as state.
## Configuration
@ -251,7 +251,7 @@ Possible MQTT payloads:
- `clean_spot` - Initialize a spot cleaning cycle
- `locate` - Locate the vacuum (typically by playing a song)
### Send Custom Command
### Send custom command
Vacuum send_command allows three parameters:

8
source/_integrations/vacuum.template.markdown
View File

@ -1,6 +1,6 @@
---
title: "Template Vacuum"
description: "Instructions how to setup Template vacuums within Home Assistant."
title: "Template vacuum"
description: "Instructions how to setup template vacuums within Home Assistant."
ha_category:
- Vacuum
ha_release: 0.96
@ -106,7 +106,7 @@ vacuum:
### Template and action variables
State-based template entities have the special template variable `this` available in their templates and actions. The `this` variable aids [self-referencing](/integrations/template#self-referencing) of an entity's state and attribute in templates and actions.
State-based template entities have the special template variable `this` available in their templates and actions. The `this` variable aids [self-referencing](/integrations/template#self-referencing) of an {% term entity %}'s state and attribute in templates and actions.
## Examples
@ -180,7 +180,7 @@ vacuum:
{% endraw %}
### Add Custom Attributes
### Add custom attributes
This example shows how to add custom attributes.

6
source/_integrations/vallox.markdown
View File

@ -22,9 +22,9 @@ ha_codeowners:
ha_integration_type: integration
---
The `vallox` integration lets you control any Vallox ventilation unit that is supported by the [vallox_websocket_api](https://github.com/yozik04/vallox_websocket_api) (follow the link for a list of supported units).
The **Vallox** {% term integration %} lets you control any Vallox ventilation unit that is supported by the [vallox_websocket_api](https://github.com/yozik04/vallox_websocket_api) (follow the link for a list of supported units).
The **fan** platform of this integration allows you to turn on/off the complete unit via the toggle switch, control fan speed and select a ventilation profile.
The **fan** platform of this {% term integration %} allows you to turn on/off the complete unit via the toggle switch, control fan speed and select a ventilation profile.
The **sensor** platform exposes a number of relevant metrics like fan speed, various air temperatures, and humidity.
@ -36,7 +36,7 @@ The **number** platform allows to control supply air temperatures.
## Profile switching
For convenient switching of ventilation profiles in the GUI, just click on the `Vallox` fan entity to get a drop-down menu to select from. Alternatively, the service `fan/set_preset_mode` can be used.
For convenient switching of ventilation profiles in the GUI, just click on the `Vallox` fan {% term entity %} to get a drop-down menu to select from. Alternatively, the service `fan/set_preset_mode` can be used.
The four standard Vallox profiles are supported:

10
source/_integrations/velbus.markdown
View File

@ -2,7 +2,7 @@
title: Velbus
description: Access and control your Velbus devices.
ha_category:
- Binary Sensor
- Binary sensor
- Button
- Climate
- Hub
@ -29,7 +29,7 @@ ha_platforms:
ha_integration_type: hub
---
The `velbus` integration is used to control [Velbus](https://www.velbus.eu/?lang=en) modules. It supports the Velbus USB, Velbus serial and a TCP/IP gateway.
The **Velbus** {% term integration %} is used to control [Velbus](https://www.velbus.eu/?lang=en) modules. It supports the Velbus USB, Velbus serial and a TCP/IP gateway.
The pushbutton LEDs of input modules are disabled by default. These can be enabled from the `Devices` panel in the `Configuration` page of the web interface.
@ -99,7 +99,6 @@ Use this service when you make changes to your configuration via velbuslink.
| `interface` | no | The port used to connect to the bus (the same one used during configuration). |
| `address` | no | The module address in decimal format, which is displayed on the device list on the integration page, if provided the service will only clear the cache for this model, without an address, the full velbuscache will be cleared. |
## VMB7IN and the Energy dashboard
In some cases, the VMB7IN sensor does not report what the counter is counting. If the counter is related to an energy device, everything will work out of the box.
@ -116,11 +115,10 @@ The device_class attribute can have 2 values:
- gas: if the counter represents a gas meter
- water: if the counter represents a water meter
## Example automation
The Velbus integration allows you to link a Velbus button (i.e., a button of a [VMBGPOD](https://www.velbus.eu/products/view/?id=416302&lang=en) module) to a controllable entity of Home Assistant.
The actual linking can be realized by two automation rules. One rule to control the device using the push button and a second rule to update the LED state of the push button as soon as the entity state changes.
The Velbus {% term integration %} allows you to link a Velbus button (i.e., a button of a [VMBGPOD](https://www.velbus.eu/products/view/?id=416302&lang=en) module) to a controllable {% term entity %} of Home Assistant.
The actual linking can be realized by two automation rules. One rule to control the device using the push button and a second rule to update the LED state of the push button as soon as the {% term entity %} state changes.
```yaml
# Control light living from Velbus push_button_10

4
source/_integrations/velux.markdown
View File

@ -16,7 +16,7 @@ ha_platforms:
ha_integration_type: integration
---
[Velux](https://www.velux.com/) integration for Home Assistant allows you to connect to a Velux KLF 200 interface, to control [io-homecontrol](http://www.io-homecontrol.com) devices like windows and blinds. The module allows you to start scenes configured within KLF 200.
[Velux](https://www.velux.com/) {% term integration %} for Home Assistant allows you to connect to a Velux KLF 200 interface, to control [io-homecontrol](http://www.io-homecontrol.com) devices like windows and blinds. The module allows you to start scenes configured within KLF 200.
At least firmware version > 2.0.0.0 is required on the KLF 200 device. The firmware images may be obtained [here](https://www.velux.com/klf200) and may be imported via the webinterface of your KLF 200.
@ -70,6 +70,6 @@ automation:
## Velux Active (KIX 300)
The Velux Active (KIX 300) set is not supported by this integration. To integrate Velux Active (KIX 300) with Home Assistant, you can use the [HomeKit Controller](/integrations/homekit_controller) integration and get full control over your windows, curtains, covers, the air quality sensor KLA 300, etc.
The Velux Active (KIX 300) set is not supported by this {% term integration %}. To integrate Velux Active (KIX 300) with Home Assistant, you can use the [HomeKit Controller](/integrations/homekit_controller) {% term integration %} and get full control over your windows, curtains, covers, the air quality sensor KLA 300, etc.
Add the Velux Active gateway using HomeKit pairing (with the pairing code on the sticker at the bottom of the Velux Active gateway) and the devices connected to the gateway - including sensors - will be automatically discovered and added to Home Assistant.

5
source/_integrations/venstar.markdown
View File

@ -2,7 +2,7 @@
title: Venstar
description: Instructions for how to integrate Venstar WiFi thermostats within Home Assistant.
ha_category:
- Binary Sensor
- Binary sensor
- Climate
- Sensor
ha_release: 0.62
@ -19,7 +19,7 @@ ha_config_flow: true
ha_integration_type: integration
---
The `venstar` climate platform allows you to control [Venstar](https://www.venstar.com/) thermostats from Home Assistant.
The **Venstar** climate {% term integration %} allows you to control [Venstar](https://www.venstar.com/) thermostats from Home Assistant.
Venstar thermostats feature a local API that allows for automation without the need for their Skyport cloud service.
Currently supported and tested thermostats:
@ -51,6 +51,7 @@ The following values are supported for the preset_mode state attribute:
Note - Please ensure that you update your thermostat to the latest firmware. Initially tested on firmware 5.10 and currently VH6.79.
### Enabling local API
Local API mode needs to be enabled on the thermostat itself. It cannot be enabled using the Venstar mobile apps or Skyport cloud service. Exact steps vary across different [series](https://venstar.com/thermostats/) of thermostats:
- [ColorTouch](https://venstar.com/thermostats/colortouch/)

11
source/_integrations/vera.markdown
View File

@ -2,7 +2,7 @@
title: Vera
description: Instructions on how to setup Vera Z-Wave hubs and configure devices within Home Assistant.
ha_category:
- Binary Sensor
- Binary sensor
- Climate
- Cover
- Hub
@ -31,13 +31,13 @@ The [Vera](https://getvera.com/) hub is a controller mainly for connecting to Z-
The supported Vera hubs (Edge, Plus and Secure) are no longer available and the firmware is not being actively enhanced by the vendor. New Z-Wave devices are not directly supported and so are not easy to add to the platform.
The newer Ezlo hubs use a different firmware and are not supported by this integration.
The newer Ezlo hubs use a different firmware and are not supported by this {% term integration %}.
[Z-Wave JS](/integrations/zwave_js/) is a better choice for new Z-Wave users or for users wanting support for new Z-Wave devices.
There is currently support for the following device types within Home Assistant:
- Binary Sensor
- Binary sensor
- Cover
- Light
- Lock
@ -57,7 +57,8 @@ and will be automatically added when HA connects to your Vera controller.
</div>
## Options
Once the Vera integration is configured, you can set additional options in the integration, click the gear icon.
Once the Vera {% term integration %} is configured, you can set additional options in the {% term integration %}, click the gear icon.
- Vera switch device - By default your switches will be added to Home Assistant as switches, however, if some of them are light switches, you can tell Home Assistant this by providing a list of light ids.
- Vera device ids to exclude - Vera imports detailed Z-Wave devices into Home Assistant. This can include system devices and other devices that you don't use; you can tell Home Assistant not to load these devices by providing a list of device ids.
@ -66,7 +67,7 @@ You can find the Vera device id either via the advanced properties of the device
### Using Z-Wave devices in automation
If you want to use a Z-Wave device from the Vera controller in Home Assistant automation, you'll need the entity id. In the Home Assistant UI you'll find all entities listed under **Developer Tools** -> **States**. Look for entities that contain 'Vera Device Id' in their attributes, and you'll find the entity id on the left.
If you want to use a Z-Wave device from the Vera controller in Home Assistant automation, you'll need the {% term entity %} id. In the Home Assistant UI you'll find all entities listed under **Developer Tools** -> **States**. Look for entities that contain 'Vera Device Id' in their attributes, and you'll find the {% term entity %} id on the left.
### Sensor

6
source/_integrations/verisure.markdown
View File

@ -3,7 +3,7 @@ title: Verisure
description: Instructions on how to setup Verisure devices within Home Assistant.
ha_category:
- Alarm
- Binary Sensor
- Binary sensor
- Camera
- Hub
- Lock
@ -36,11 +36,11 @@ There is currently support for the following device types within Home Assistant:
- Switch (Smartplug)
- Sensor (Thermometers and Hygrometers)
- Lock
- Binary Sensor (Door & Window)
- Binary sensor (Door & Window)
{% include integrations/config_flow.md %}
## Alarm Control Panel
## Alarm control panel
The Verisure alarm control panel platform allows you to control your [Verisure](https://www.verisure.com/) Alarms.

2
source/_integrations/vermont_castings.markdown
View File

@ -2,7 +2,7 @@
title: Vermont Castings
description: Connect and control your Vermont Castings devices using the IntelliFire integration
ha_category:
- Binary Sensor
- Binary sensor
- Climate
- Fan
- Light

4
source/_integrations/versasense.markdown
View File

@ -17,7 +17,7 @@ ha_platforms:
ha_integration_type: integration
---
The `VersaSense` integration supports the VersaSense Edge Gateway. The gateway is able to control hubs and their peripherals (sensors and actuators) in the mesh network.
The **VersaSense** {% term integration %} supports the VersaSense Edge Gateway. The gateway is able to control hubs and their peripherals (sensors and actuators) in the mesh network.
## Configuration
@ -38,7 +38,7 @@ host:
All VersaSense gateways with software version >= 1.0.2.10
The integration is tested with following peripherals and devices:
The {% term integration %} is tested with following peripherals and devices:
- S03 S04: Temperature and Humidity sensor
- S06: Barometric Pressure sensor

10
source/_integrations/version.markdown
View File

@ -18,13 +18,13 @@ ha_config_flow: true
ha_integration_type: integration
---
The Version integration can display the current Home Assistant Core versions.
The **Version** {% term integration %} can display the current Home Assistant Core versions.
{% include integrations/config_flow.md %}
## Version sources
With this integration you can select various sources to get a version from.
With this {% term integration %} you can select various sources to get a version from.
{% configuration_basic %}
"Local installation":
@ -46,12 +46,12 @@ With this integration you can select various sources to get a version from.
## Entities
The entities created by this integration depends on which source you set it up with (you can also set up the integration multiple times to use more sources).
The entities created by this {% term integration %} depends on which source you set it up with (you can also set up the {% term integration %} multiple times to use more sources).
### Sensor
For all sources the integration will create a [sensor](/integrations/sensor) entity that displays the newest version published to that source.
For all sources the {% term integration %} will create a [sensor](/integrations/sensor) {% term entity %} that displays the newest version published to that source.
### Binary Sensor
For all sources (except for the ["Local installation"](#local-installation) source) the integration will create a [binary_sensor](/integrations/binary_sensor) entity that show if there is a newer version than the one you are currently running published to that source.
For all sources (except for the ["Local installation"](#local-installation) source) the {% term integration %} will create a [binary_sensor](/integrations/binary_sensor) {% term entity %} that show if there is a newer version than the one you are currently running published to that source.

25
source/_integrations/vesync.markdown
View File

@ -22,9 +22,9 @@ ha_platforms:
ha_integration_type: integration
---
The `vesync` integration enables you to control smart switches and outlets connected to the VeSync App.
The `**VeSync** {% term integration %} enables you to control smart switches and outlets connected to the VeSync App.
The devices must be added to the VeSync App before this integration can discover them.
The devices must be added to the VeSync App before this {% term integration %} can discover them.
The following platforms are supported:
@ -33,21 +33,21 @@ The following platforms are supported:
- **fan**
- **sensor**
## Supported Devices
## Supported devices
This integration supports devices controllable by the VeSync App. The following devices are supported by this integration:
This {% term integration %} supports devices controllable by the VeSync App. The following devices are supported by this {% term integration %}:
### Bulbs
- Etekcity WiFi Dimmable LED Bulb (ESL100)
- Etekcity WiFi Dimmable and Tunable White LED Bulb (ESL100CW)
### Wall Switches
### Wall switches
- Etekcity In Wall Smart Switch (EWSL01-USA)
- Etekcity Wifi Dimmer Switch (ESD16)
- Etekcity Wifi Dimmer Switch (ESWD16)
### Outlet Plugs
### Outlet plugs
- Etekcity 7 Amp US outlet - ESW01-USA (Round)
- Etekcity 10 Amp US outlet - ESW10-USA (Round)
@ -65,7 +65,7 @@ This integration supports devices controllable by the VeSync App. The following
## Prerequisite
Before you can use this integration, all devices must be registered with the
Before you can use this {% term integration %}, all devices must be registered with the
VeSync App. Once registration is complete, continue with the steps described in
the configuration section below.
@ -77,10 +77,10 @@ the configuration section below.
|---------|-------------|
| `update_devices` | Poll Vesync server to find and add any new devices |
## Power & Energy Sensors
## Power & energy sensors
Many VeSync outlets support power & energy monitoring. This data is exposed as sensor entities alongside the outlet
itself. Note that prior versions of the integration exposed these as state attributes on the outlet switch entity.
itself. Note that prior versions of the {% term integration %} exposed these as state attributes on the outlet switch {% term entity %}.
| Sensor | Description | Example |
| ------------------------------------------|-------------------------------------------------------------------------|---------|
@ -91,7 +91,7 @@ itself. Note that prior versions of the integration exposed these as state attri
| `sensor.<outlet name>_energy_use_monthly` | Total energy usage for month starting from 12:01AM on the first in kWh | 52.30 |
| `sensor.<outlet name>_energy_use_yearly` | Total energy usage for year start from 12:01AM on Jan 1 in kWh | 105.25 |
## Fan & Air Quality Sensors
## Fan & air quality sensors
All VeSync air purifiers expose the remaining filter lifetime, and some also expose air quality measurements.
| Sensor | Description | Example |
@ -100,7 +100,7 @@ All VeSync air purifiers expose the remaining filter lifetime, and some also exp
| `air_quality` | The current air quality reading. (LV-PUR131S, Core300s/400s/600s) | excellent |
| `pm2_5` | The current air quality reading. (Core300s/400s/600s) | 8 |
## Fan Exposed Attributes
## Fan exposed attributes
VeSync air purifiers will expose the following details depending on the features supported by the model:
@ -114,7 +114,7 @@ VeSync air purifiers will expose the following details depending on the features
| `night_light` | The current status of the night light (Core200S/Core400s) | off |
| `child_lock` | The current status of the child lock (Core200S/300s/400s) | off |
## Extracting Attribute data
## Extracting attribute data
In order to get the attributes readings from supported devices, such as voltage from outlets or fan attributes, you'll have to create a [template sensor](/integrations/template#state-based-template-sensors/).
@ -131,4 +131,5 @@ template:
state: "{{ state_attr('switch.vesync_switch', 'voltage') | float(default=0) }}"
unit_of_measurement: "V"
```
{% endraw %}

2
source/_integrations/viaggiatreno.markdown
View File

@ -11,7 +11,7 @@ ha_platforms:
ha_integration_type: integration
---
The `viaggiatreno` sensor will give you information about configured train ids and stations using the public [ViaggiaTreno](http://viaggiatreno.it) API.
The **Trenitalia ViaggiaTreno** {% term integration %} will give you information about configured train ids and stations using the public [ViaggiaTreno](http://viaggiatreno.it) API.
To activate the sensor you need at least two parameters: the `train_id` and the `station_id`.

18
source/_integrations/vicare.markdown
View File

@ -18,13 +18,13 @@ ha_dhcp: true
ha_integration_type: integration
---
The `ViCare` integration lets you control [Viessmann](https://www.viessmann.com) devices via the Viessmann ViCare (REST) API.
The **Viessmann ViCare** {% term integration %} lets you control [Viessmann](https://www.viessmann.com) devices via the Viessmann ViCare (REST) API.
Most recent network-connected Viessmann heating devices (e.g., gas boilers) should be supported.
There is currently support for the following device types within Home Assistant:
- [Climate](#climate) (Heating)
- [Water Heater](#water-heater) (Domestic Hot Water)
- [Water heater](#water-heater) (Domestic hot water)
- [Sensor](#sensor) (Sensor)
- [Button](#button) (Button)
@ -44,7 +44,7 @@ The required Client ID can be obtained as follows:
The `heating_type` can either be `auto` to automatically find the most suitable type for your device or one of `gas`, `oil`, `pellets`, `heatpump`, `fuelcell`, `hybrid`.
Important: the redirect URI that you configure requires that you perform the initial setup on a device that has the ViCare application installed. If your device does not know how to handle the `vicare://` URL, you will receive an **Invalid credentials** notification and the setup procedure will fail. This means: install the ViCare app on your phone and set up the integration from your phone.
Important: the redirect URI that you configure requires that you perform the initial setup on a device that has the ViCare application installed. If your device does not know how to handle the `vicare://` URL, you will receive an **Invalid credentials** notification and the setup procedure will fail. This means: install the ViCare app on your phone and set up the {% term integration %} from your phone.
Multiple device instances might be generated depending on the number of burners and/or circuits of your installation. If there is more than a single instance all devices are suffixed with the circuit or burner ID.
@ -55,7 +55,7 @@ The Viessmann API is rate-limited. If you exceed one of the limits below you wil
- Limit 1: 120 calls for a time window of 10 minutes
- Limit 2: 1450 calls for a time window of 24 hours
The integration polls the Viessmann API every 60 seconds and will work within these limits. Note however that any additional requests to the API, e.g., by setting the temperature via the integration but also by interacting with the ViCare app also counts into those limits.
The {% term integration %} polls the Viessmann API every 60 seconds and will work within these limits. Note however that any additional requests to the API, e.g., by setting the temperature via the {% term integration %} but also by interacting with the ViCare app also counts into those limits.
## Climate
@ -63,7 +63,7 @@ A note about the current temperature attribute: Viessmann devices with room temp
### Supported services `climate.vicare_heating`
The following services of the [Climate integration](/integrations/climate/) are provided by the ViCare integration: `set_temperature`, `set_hvac_mode`, `set_preset_mode`
The following services of the [Climate integration](/integrations/climate/) are provided by the ViCare {% term integration %}: `set_temperature`, `set_hvac_mode`, `set_preset_mode`
#### Service `set_temperature`
@ -80,7 +80,7 @@ Note that `set_temperature` will always affect the current normal temperature or
Set HVAC mode for the climate device. The following modes are supported:
The `climate.vicare_heating` integration has the following mapping of HVAC modes to Viessmann operation modes:
The `climate.vicare_heating` {% term integration %} has the following mapping of HVAC modes to Viessmann operation modes:
| HVAC mode | Viessmann mode | Description |
| ---------------------- | -------- | ----------- |
@ -100,7 +100,7 @@ Set the mode for the climate device as defined by Viessmann (see [set_hvac_mode]
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. To target all entities, use `all` keyword instead of entity_id.
| `vicare_mode` | no | New value of ViCare mode. For supported values see the `vicare_modes` attribute of the climate entity.
| `vicare_mode` | no | New value of ViCare mode. For supported values see the `vicare_modes` attribute of the climate {% term entity %}.
#### Service `set_preset_mode`
@ -114,11 +114,11 @@ Eco mode reduces the target temperature by 3°C, whereas Comfort mode sets the t
## Water heater
It is not possible to turn on/off water heating via the Water Heater integration since this would conflict with the operation modes of the heating integration. Therefore the operation mode of that integration is just available as an attribute and cannot be modified.
It is not possible to turn on/off water heating via the water heater {% term integration %} since this would conflict with the operation modes of the heating {% term integration %}. Therefore the operation mode of that {% term integration %} is just available as an attribute and cannot be modified.
### Supported services `water_heater.vicare_water`
The following services of the [Water Heater integration](/integrations/water_heater/) are provided by the ViCare integration: `set_temperature`
The following services of the [water heater integration](/integrations/water_heater/) are provided by the ViCare {% term integration %}: `set_temperature`
#### Service `set_temperature`

4
source/_integrations/vilfo.markdown
View File

@ -5,7 +5,7 @@ ha_release: '0.106'
ha_category:
- Network
- Sensor
- System Monitor
- System monitor
ha_iot_class: Local Polling
ha_config_flow: true
ha_codeowners:
@ -16,7 +16,7 @@ ha_platforms:
ha_integration_type: integration
---
The `Vilfo Router` integration allows you to observe the state of your [Vilfo Router](https://www.vilfo.com) from Home Assistant.
The **Vilfo Router** {% term integration %} allows you to observe the state of your [Vilfo Router](https://www.vilfo.com) from Home Assistant.
It currently supports reporting the current load of the device in percent and the current uptime measured in minutes.

8
source/_integrations/vivotek.markdown
View File

@ -13,7 +13,7 @@ ha_platforms:
ha_integration_type: integration
---
The `vivotek` camera platform allows you to integrate a VIVOTEK IP camera into Home Assistant.
The **VIVOTEK** camera {% term integration %} allows you to integrate a VIVOTEK IP camera into Home Assistant.
Home Assistant will serve the images via its server, making it possible to view your IP cameras while outside of your network. The endpoint is `/api/camera_proxy/camera.[name]`.
@ -106,13 +106,13 @@ Available services: `enable_motion_detection`, `disable_motion_detection`, `snap
#### Service `play_stream`
Play a live stream from a camera to selected media player(s). Requires [`stream`](/integrations/stream) integration to be set up.
Play a live stream from a camera to selected media player(s). Requires [`stream`](/integrations/stream) {% term integration %} to be set up.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | Name of entity to fetch stream from, e.g., `camera.front_door_camera`. |
| `entity_id` | no | Name of {% term entity %} to fetch stream from, e.g., `camera.front_door_camera`. |
| `media_player` | no | Name of media player to play stream on, e.g., `media_player.living_room_tv`. |
| `format` | yes | Stream format supported by `stream` integration and selected `media_player`. Default: `hls` |
| `format` | yes | Stream format supported by `stream` {% term integration %} and selected `media_player`. Default: `hls` |
For example, the following action in an automation would send an `hls` live stream to your chromecast.

23
source/_integrations/vizio.markdown
View File

@ -1,8 +1,8 @@
---
title: VIZIO SmartCast
description: Instructions on how to integrate Vizio SmartCast TVs and sound bars into Home Assistant.
description: Instructions on how to integrate VIZIO SmartCast TVs and sound bars into Home Assistant.
ha_category:
- Media Player
- Media player
ha_release: 0.49
ha_iot_class: Local Polling
ha_config_flow: true
@ -16,7 +16,7 @@ ha_platforms:
ha_integration_type: device
---
The `vizio` integration allows you to control [SmartCast](https://www.vizio.com/smartcast-app)-compatible TVs and sound bars (2016+ models).
The **VIZIO SmartCast** {% term integration %} allows you to control [SmartCast](https://www.vizio.com/smartcast-app)-compatible TVs and sound bars (2016+ models).
## Find your device
@ -45,11 +45,11 @@ Write down its IP address and port number. If you have trouble finding a device
## Pairing
This integration requires an access token in order to communicate with TVs (speakers do not need an access token). An access token can be obtained by going through a pairing process, either manually, or through the Home Assistant frontend.
This {% term integration %} requires an access token in order to communicate with TVs (speakers do not need an access token). An access token can be obtained by going through a pairing process, either manually, or through the Home Assistant frontend.
### Pair using the Home Assistant frontend
- **Using `configuration.yaml`:** If you have a `vizio` entry in `configuration.yaml` but don't provide an access token value in your configuration, after you initialize Home Assistant, you will see a Vizio SmartCast device ready to be configured. When you open the configuration window, you will be guided through the pairing process. While Home Assistant will store the access token for the life of your `vizio` entity, it is a good idea to note the access token value displayed in the window and add it to your `configuration.yaml`. This will ensure that you will not have to go through the pairing process again in the future if you decide to rebuild your Home Assistant instance.
- **Using `configuration.yaml`:** If you have a `vizio` entry in `configuration.yaml` but don't provide an access token value in your configuration, after you initialize Home Assistant, you will see a VIZIO SmartCast device ready to be configured. When you open the configuration window, you will be guided through the pairing process. While Home Assistant will store the access token for the life of your `vizio` {% term entity %}, it is a good idea to note the access token value displayed in the window and add it to your `configuration.yaml`. This will ensure that you will not have to go through the pairing process again in the future if you decide to rebuild your Home Assistant instance.
- **Using discovery or manual setup through the Integrations menu:** To initiate the pairing process, submit your initial configuration with an empty Access Token value.
### Pair manually using the CLI
@ -104,7 +104,7 @@ You will need the authentication token returned by this command to configure Hom
## Configuration
To add your Vizio TV to your installation, add the following to your `configuration.yaml` file:
To add your VIZIO TV to your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -119,10 +119,10 @@ host:
required: true
type: string
name:
description: Nickname for your device that will be used to generate the device's entity ID. If multiple Vizio devices are configured, the value must be unique for each entry.
description: Nickname for your device that will be used to generate the device's entity ID. If multiple VIZIO devices are configured, the value must be unique for each entry.
required: false
type: string
default: Vizio SmartCast
default: VIZIO SmartCast
access_token:
description: Authentication token you received in the last step of the pairing process. This token is only needed if your device is a TV, and you can opt not to provide it in your configuration and instead go through the pairing process via the Home Assistant frontend.
required: false
@ -138,7 +138,7 @@ volume_step:
type: integer
default: 1
apps:
description: Use this section to define app specific settings (only applicable for Vizio Smart TVs).
description: Use this section to define app specific settings (only applicable for VIZIO Smart TVs).
required: false
type: map
keys:
@ -207,7 +207,8 @@ vizio:
If there is an app you want to be able to launch from Home Assistant that isn't detected by default, you will need to specify the app configuration in `configuration.yaml`. This configuration can be obtained from the `app_id` state attribute when an unknown app is running on your device.
### Obtaining a list of valid apps to include or exclude
The list of apps that are provided by default is statically defined [here](https://github.com/vkorn/pyvizio/blob/master/pyvizio/const.py#L23). If you'd prefer a more concise list, you can either view the source list of a Vizio Smart TV in the Home Assistant frontend, or run the following command (requires `pyvizio` to be installed locally):
The list of apps that are provided by default is statically defined [here](https://github.com/vkorn/pyvizio/blob/master/pyvizio/const.py#L23). If you'd prefer a more concise list, you can either view the source list of a VIZIO Smart TV in the Home Assistant frontend, or run the following command (requires `pyvizio` to be installed locally):
```bash
pyvizio --ip=0 get-apps-list
@ -215,7 +216,7 @@ pyvizio --ip=0 get-apps-list
## Service `vizio.update_setting`
This service allows you to update a setting on a given Vizio device. You will need to know the type of setting and the name of the setting to call this service. You can determine this by using the SmartCast app and going to device settings for your target device. The setting type is the lowercase version of the first menu item you'd select (e.g., display, audio, system), and the setting name is what you see in the app, but spaces are replaced with underscores and it is also all lowercase (e.g., AV delay would be called `av_delay`).
This service allows you to update a setting on a given VIZIO device. You will need to know the type of setting and the name of the setting to call this service. You can determine this by using the SmartCast app and going to device settings for your target device. The setting type is the lowercase version of the first menu item you'd select (e.g., display, audio, system), and the setting name is what you see in the app, but spaces are replaced with underscores and it is also all lowercase (e.g., AV delay would be called `av_delay`).
| Service data attribute | Optional | Description | Example |
| ---------------------- | -------- | ----------- | ------- |

4
source/_integrations/vlc.markdown
View File

@ -2,7 +2,7 @@
title: VLC media player
description: Instructions on how to integrate VLC media player into Home Assistant.
ha_category:
- Media Player
- Media player
ha_release: 0.35
ha_iot_class: Local Polling
ha_domain: vlc
@ -15,7 +15,7 @@ The `vlc` platform allows you to control [VLC media player](https://www.videolan
<div class='note'>
The VLC media player integration, is currently only available for installations that are based on the Home Assistant Core in a Python virtual environment.
The **VLC media player** {% term integration %}, is currently only available for installations that are based on the Home Assistant Core in a Python virtual environment.
</div>

6
source/_integrations/vlc_telnet.markdown
View File

@ -2,7 +2,7 @@
title: VLC media player via Telnet
description: Instructions on how to integrate VLC media player into Home Assistant using the telnet interface.
ha_category:
- Media Player
- Media player
ha_release: 0.95
ha_iot_class: Local Polling
ha_codeowners:
@ -15,7 +15,7 @@ ha_platforms:
ha_integration_type: integration
---
The `vlc_telnet` platform allows you to control a [VLC media player](https://www.videolan.org/vlc/index.html) using the built in telnet interface.
The **VLC media player via Telnet** {% term integration %} allows you to control a [VLC media player](https://www.videolan.org/vlc/index.html) using the built in telnet interface.
This service will control any instance of VLC player on the network with the telnet interface activated.
To activate the telnet interface on your VLC Player please read the [official VLC documentation](https://wiki.videolan.org/Documentation:Modules/telnet/). Also remember to add a firewall rule allowing inbound connections for the port used in the device running VLC.
@ -30,7 +30,7 @@ Consider to set the locale to `en_US` before starting VLC.
When using the `media_player.play_media` service, only the "music" media type is supported for now.
## Home Assistant Add-on
## Home Assistant add-on
You can run a VLC Media Player on your Home Assistant installation using the official [VLC add-on](https://github.com/home-assistant/addons/blob/master/vlc/DOCS.md).
Using it you can play files on the local network, Internet or files and playlist locally saved to the `/share` and `/media` folder of your Home Assistant installation.

11
source/_integrations/vodafone_station.markdown
View File

@ -2,7 +2,7 @@
title: Vodafone Station
description: Instructions on how to integrate Vodafone Station routers into Home Assistant.
ha_category:
- Presence Detection
- Presence detection
ha_release: 2023.9
ha_domain: vodafone_station
ha_config_flow: true
@ -17,7 +17,7 @@ ha_platforms:
ha_integration_type: integration
---
The Vodafone Station integration allows you to control your [Vodafone Station](https://www.vodafone.it/privati/area-supporto/assistenza-dispositivi/vodafone-station.html) based router.
The **Vodafone Station** {% term integration %} allows you to control your [Vodafone Station](https://www.vodafone.it/privati/area-supporto/assistenza-dispositivi/vodafone-station.html) based router.
<div class="note">
The integration supports only Sercomm models so far.
@ -28,11 +28,12 @@ There is support for the following platform types within Home Assistant:
- **Device tracker** - presence detection by looking at connected devices.
- **Sensor** - external IP address, uptime, firmware, resources and network monitors.
- **Button** - restart router, dsl/fiber/internet key connections.
{% include integrations/config_flow.md %}
## Integration options
It is possible to change some behaviors through the integration options.
It is possible to change some behaviors through the {% term integration %} options.
To change the settings, go to {% my integrations title="**Settings** > **Devices & Services**" %}. On the **Vodafone Station** integration, select the cogwheel. Then select **Configure**.
- **Consider home**: Number of seconds that must elapse before considering a disconnected device "not at home".
@ -41,11 +42,11 @@ To change the settings, go to {% my integrations title="**Settings** > **Devices
### Device tracker
**Note**: If you don't want to automatically track newly detected devices, disable the integration system option `Enable new added entities`.
**Note**: If you don't want to automatically track newly detected devices, disable the {% term integration %} system option `Enable new added entities`.
### Tested models
This integration was tested against the following models from Sercomm:
This {% term integration %} was tested against the following models from Sercomm:
- Vodafone Power Station (SHG3000)
- Vodafone WiFi 6 Station (RHG3006)

2
source/_integrations/voicerss.markdown
View File

@ -11,7 +11,7 @@ ha_platforms:
ha_integration_type: integration
---
The `voicerss` text-to-speech platform uses [VoiceRSS](http://www.voicerss.org/) text-to-speech engine to read a text with natural sounding voices.
The **VoiceRSS** text-to-speech {% term integration %} uses [VoiceRSS](http://www.voicerss.org/) text-to-speech engine to read a text with natural sounding voices.
## Configuration

2
source/_integrations/voip.markdown
View File

@ -18,7 +18,7 @@ ha_platforms:
ha_config_flow: true
---
The VoIP integration enables users to talk to [Assist](/voice_control/) using an analog phone and a VoIP adapter. Currently, the system works with the [Grandstream HT801](https://amzn.to/40k7mRa). See [the tutorial](/voice_control/worlds-most-private-voice-assistant) for detailed instructions.
The **VoIP** {% term integration %} enables users to talk to [Assist](/voice_control/) using an analog phone and a VoIP adapter. Currently, the system works with the [Grandstream HT801](https://amzn.to/40k7mRa). See [the tutorial](/voice_control/worlds-most-private-voice-assistant) for detailed instructions.
As an alternative, the [Grandstream HT802](https://www.amazon.com/Grandstream-GS-HT802-Analog-Telephone-Adapter/dp/B01JH7MYKA/) can be used, which is basically the same as the previously mentioned HT801, but has two phone ports, of which Home Assistant currently support using only one of them.

4
source/_integrations/volkszaehler.markdown
View File

@ -2,7 +2,7 @@
title: Volkszaehler
description: Instructions on how to integrate Volkszaehler sensors into Home Assistant.
ha_category:
- System Monitor
- System monitor
ha_iot_class: Local Polling
ha_release: 0.78
ha_domain: volkszaehler
@ -11,7 +11,7 @@ ha_platforms:
ha_integration_type: integration
---
The `volkszaehler` sensor platform is consuming the system information provided by the [Volkszaehler](https://wiki.volkszaehler.org/) API.
The **Volkszaehler** {% term integration %} is consuming the system information provided by the [Volkszaehler](https://wiki.volkszaehler.org/) API.
## Configuration

6
source/_integrations/volumio.markdown
View File

@ -2,7 +2,7 @@
title: Volumio
description: How to set up the Volumio media player integration
ha_category:
- Media Player
- Media player
ha_release: 0.41
ha_iot_class: Local Polling
ha_config_flow: true
@ -15,10 +15,10 @@ ha_platforms:
ha_integration_type: integration
---
The `Volumio` platform allows you to control a [Volumio](https://volumio.org/) media player from Home Assistant.
The **Volumio** {% term integration %} allows you to control a [Volumio](https://volumio.org/) media player from Home Assistant.
{% include integrations/config_flow.md %}
<div class='note'>
Volumio versions 2.799 and below do not have a unique id when manually configured, so you will not be able to rename your entity or add your device to an area. If discovery does not work for you, it is advised to upgrade Volumio before configuring.
Volumio versions 2.799 and below do not have a unique id when manually configured, so you will not be able to rename your {% term entity %} or add your device to an area. If discovery does not work for you, it is advised to upgrade Volumio before configuring.
</div>

2
source/_integrations/volvooncall.markdown
View File

@ -18,7 +18,7 @@ ha_integration_type: integration
ha_config_flow: true
---
The `volvooncall` integration offers integration with the [Volvo Cars App](https://www.volvocars.com/intl/v/volvo-cars-app) (former Volvo On Call) cloud service and offers presence detection as well as sensors such as odometer and fuel level.
The **Volvo On Call** {% term integration %} offers integration with the [Volvo Cars App](https://www.volvocars.com/intl/v/volvo-cars-app) (former Volvo On Call) cloud service and offers presence detection as well as sensors such as odometer and fuel level.
{% include integrations/config_flow.md %}

4
source/_integrations/vulcan.markdown
View File

@ -15,7 +15,7 @@ ha_platforms:
ha_integration_type: integration
---
The Uonet+ Vulcan integration allows you to view timetable from your e-register.
The **Uonet+ Vulcan** {% term integration %} allows you to view timetable from your e-register.
Supported informations:
@ -23,6 +23,6 @@ Supported informations:
## Prerequisites
To use Uonet+ Vulcan integration in Home Assistant you must obtain `token`, `symbol` and `pin` from your Vulcan account. You can find them in the student/parent panel in `Mobile access`/`Dostęp mobilny` tab.
To use **Uonet+ Vulcan** {% term integration %} in Home Assistant you must obtain `token`, `symbol` and `pin` from your Vulcan account. You can find them in the student/parent panel in `Mobile access`/`Dostęp mobilny` tab.
{% include integrations/config_flow.md %}

8
source/_integrations/vultr.markdown
View File

@ -2,10 +2,10 @@
title: Vultr
description: Instructions on how to integrate Vultr within Home Assistant.
ha_category:
- Binary Sensor
- Binary sensor
- Sensor
- Switch
- System Monitor
- System monitor
ha_release: 0.58
ha_iot_class: Cloud Polling
ha_domain: vultr
@ -16,11 +16,11 @@ ha_platforms:
ha_integration_type: integration
---
The `vultr` integration allows you to access information about and interact with your [Vultr](https://www.vultr.com) subscriptions (Virtual Private Servers) from Home Assistant.
The **Vultr** {% term integration %} allows you to access information about and interact with your [Vultr](https://www.vultr.com) subscriptions (Virtual Private Servers) from Home Assistant.
There is currently support for the following device types within Home Assistant:
- [Binary Sensor](#binary-sensor)
- [Binary sensor](#binary-sensor)
- [Sensor](#sensor)
- [Switch](#switch)

4
source/_integrations/w800rf32.markdown
View File

@ -2,7 +2,7 @@
title: WGL Designs W800RF32
description: Instructions on how to integrate a W800rf32(a) into Home Assistant.
ha_category:
- Binary Sensor
- Binary sensor
- Hub
ha_release: 0.83
ha_iot_class: Local Push
@ -12,7 +12,7 @@ ha_platforms:
ha_integration_type: integration
---
The `w800rf32` integration supports W800RF32 devices by WGL Designs which
The **WGL Designs W800RF32** {% term integration %} supports W800RF32 devices by WGL Designs which
communicate in the frequency range of 310MHz or if you are outside Canada or the U.S., 433.92 MHz.
The W800 family of RF receivers are designed to receive X10 RF signals generated from X10 products: Palm Pad

6
source/_integrations/wake_on_lan.markdown
View File

@ -14,7 +14,7 @@ ha_codeowners:
ha_integration_type: integration
---
The `wake_on_lan` integration enables the ability to send _magic packets_ to [Wake on LAN](https://en.wikipedia.org/wiki/Wake-on-LAN) capable devices to turn them on.
The **Wake on LAN** {% term integration %} enables the ability to send _magic packets_ to [Wake on LAN](https://en.wikipedia.org/wiki/Wake-on-LAN) capable devices to turn them on.
There is currently support for the following device types within Home Assistant:
@ -22,7 +22,7 @@ There is currently support for the following device types within Home Assistant:
## Configuration
To use this integration in your installation, add the following to your `configuration.yaml` file:
To use this {% term integration %} in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -58,7 +58,7 @@ The service to route the packet is most likely named "IP Helper". It may support
## Switch
The `wake_on_lan` (WOL) switch integration allows you to turn on a [WOL](https://en.wikipedia.org/wiki/Wake-on-LAN) enabled computer.
The `wake_on_lan` (WOL) switch {% term integration %} allows you to turn on a [WOL](https://en.wikipedia.org/wiki/Wake-on-LAN) enabled computer.
### Switch configuration

2
source/_integrations/wake_word.markdown
View File

@ -12,7 +12,7 @@ ha_integration_type: entity
ha_quality_scale: internal
---
A wake-word-detection entity allows other integrations or applications to detect wake words in streaming audio.
A wake-word-detection {% term entity %} allows other {% term integrations %} or applications to detect wake words in streaming audio.
The wake-word-detection entities cannot be implemented manually, but can be provided by integrations such as [Wyoming](/integrations/wyoming). The API in [Assist Pipelines](https://developers.home-assistant.io/docs/voice/pipelines/) enables wake-word-detection as part of [Assist](/voice_control/).

40
source/_integrations/wallbox.markdown
View File

@ -17,41 +17,41 @@ ha_codeowners:
ha_integration_type: integration
---
The Wallbox integration pulls data from the [MyWallbox Portal](https://my.wallbox.com) for your Wallbox charging station.
The **Wallbox** {% term integration %} pulls data from the [MyWallbox Portal](https://my.wallbox.com) for your Wallbox charging station.
{% include integrations/config_flow.md %}
## Sensors
The integration adds the following sensors:
The {% term integration %} adds the following sensors:
- Added Energy
- Added Range
- Charging Power
- Charging Speed
- Charging Time
- Added energy
- Added range
- Charging power
- Charging speed
- Charging time
- Cost
- Current Mode
- Depot Price
- Energy Price
- Max Available Power
- State of Charge
- Status Description
- Max Charging Current
- Current mode
- Depot price
- Energy price
- Max available power
- State of charge
- Status description
- Max charging current
## Number
The integration adds the following number entities:
The {% term integration %} adds the following number entities:
- Max Charging Current
- Energy Price
- Max charging current
- Energy price
The number entity is only loaded if the supplied username has sufficient rights to change the Max. Charging Current.
The number {% term entity %} is only loaded if the supplied username has sufficient rights to change the Max. Charging Current.
## Lock
The integration adds a lock entity, allowing you to lock the charger. Please note, this only works with a user with admin rights.
The {% term integration %} adds a lock {% term entity %}, allowing you to lock the charger. Please note, this only works with a user with admin rights.
## Switch
The integration adds a switch entity, allowing you to pause/resume the charging process.
The {% term integration %} adds a switch {% term entity %}, allowing you to pause/resume the charging process.

2
source/_integrations/waqi.markdown
View File

@ -14,7 +14,7 @@ ha_integration_type: integration
ha_config_flow: true
---
The `waqi` sensor platform will query [World Air Quality Index](https://aqicn.org/city/beijing/) service to check AQI value for a specific set of locations. The resulting indexes will be added to the Home Assistant as sensor outputs.
The **World Air Quality Index (WAQI)** {% term integration %} will query [World Air Quality Index](https://aqicn.org/city/beijing/) service to check AQI value for a specific set of locations. The resulting indexes will be added to the Home Assistant as sensor outputs.
## Setup

8
source/_integrations/water_heater.markdown
View File

@ -1,5 +1,5 @@
---
title: Water Heater
title: Water heater
description: Instructions on how to setup water heater devices within Home Assistant.
ha_release: 0.81
ha_domain: water_heater
@ -10,9 +10,9 @@ ha_codeowners:
ha_integration_type: entity
---
The `water_heater` integration is built for the controlling and monitoring of hot water heaters.
The **Water heater** {% term integration %} is built for the controlling and monitoring of hot water heaters.
To enable this integration, pick one of the platforms, and add it to your `configuration.yaml`:
To enable this {% term integration %}, pick one of the platforms, and add it to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
@ -40,7 +40,7 @@ Sets target temperature of water heater device.
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at the `entity_id` of water heater devices to control. Use `entity_id: all` to target all.
| `temperature` | no | New target temperature for water heater
| `operation_mode` | yes | Operation mode to set the temperature to. This defaults to current_operation mode if not set, or set incorrectly. For a list of possible modes, refer to the integration documentation.
| `operation_mode` | yes | Operation mode to set the temperature to. This defaults to current_operation mode if not set, or set incorrectly. For a list of possible modes, refer to the {% term integration %} documentation.
#### Automation example

22
source/_integrations/water_heater.mqtt.markdown
View File

@ -1,14 +1,14 @@
---
title: "MQTT Water Heater"
description: "Instructions on how to integrate MQTT Water Heater into Home Assistant."
title: "MQTT water heater"
description: "Instructions on how to integrate MQTT water heater into Home Assistant."
ha_category:
- Water Heater
- Water heater
ha_release: 2023.7
ha_iot_class: Local Polling
ha_domain: mqtt
---
The `mqtt` water heater platform lets you control your MQTT enabled Water Heater devices.
The `mqtt` water heater platform lets you control your MQTT enabled water heater devices.
## Configuration
@ -70,7 +70,7 @@ current_temperature_topic:
required: false
type: string
device:
description: 'Information about the device this Water Heater device is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/integrations/mqtt/#mqtt-discovery) and when [`unique_id`](#unique_id) is set. At least one of identifiers or connections must be present to identify the device.'
description: 'Information about the device this water heater device is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/integrations/mqtt/#mqtt-discovery) and when [`unique_id`](#unique_id) is set. At least one of identifiers or connections must be present to identify the device.'
required: false
type: map
keys:
@ -158,7 +158,7 @@ mode_command_template:
required: false
type: template
mode_command_topic:
description: The MQTT topic to publish commands to change the Water Heater operation mode.
description: The MQTT topic to publish commands to change the water heater operation mode.
required: false
type: string
mode_state_template:
@ -166,7 +166,7 @@ mode_state_template:
required: false
type: template
mode_state_topic:
description: The MQTT topic to subscribe for changes of the Water Heater operation mode. If this is not set, the operation mode works in optimistic mode (see below).
description: The MQTT topic to subscribe for changes of the water heater operation mode. If this is not set, the operation mode works in optimistic mode (see below).
required: false
type: string
modes:
@ -175,10 +175,10 @@ modes:
default: ['off', 'eco', 'electric', 'gas', 'heat_pump', 'high_demand', 'performance']
type: list
name:
description: The name of the Water Heater. Can be set to `null` if only the device name is relevant.
description: The name of the water heater. Can be set to `null` if only the device name is relevant.
required: false
type: string
default: MQTT Water Heater
default: MQTT water heater
object_id:
description: Used instead of `name` for automatic generation of `entity_id`
required: false
@ -252,7 +252,7 @@ temperature_unit:
required: false
type: string
unique_id:
description: An ID that uniquely identifies this Water Heater device. If two Water Heater devices have the same unique ID, Home Assistant will raise an exception.
description: An ID that uniquely identifies this water heater device. If two water heater devices have the same unique ID, Home Assistant will raise an exception.
required: false
type: string
value_template:
@ -263,7 +263,7 @@ value_template:
## Optimistic mode
If a property works in *optimistic mode* (when the corresponding state topic is not set), Home Assistant will assume that any state changes published to the command topics did work and change the internal state of the entity immediately after publishing to the command topic. If it does not work in optimistic mode, the internal state of the entity is only updated when the requested update is confirmed by the device through the state topic. You can enforce optimistic mode by setting the `optimistic` option to `true`. When set, the internal state will always be updated, even when a state topic is defined.
If a property works in *optimistic mode* (when the corresponding state topic is not set), Home Assistant will assume that any state changes published to the command topics did work and change the internal state of the {% term entity %} immediately after publishing to the command topic. If it does not work in optimistic mode, the internal state of the {% term entity %} is only updated when the requested update is confirmed by the device through the state topic. You can enforce optimistic mode by setting the `optimistic` option to `true`. When set, the internal state will always be updated, even when a state topic is defined.
## Using templates

2
source/_integrations/waterfurnace.markdown
View File

@ -11,7 +11,7 @@ ha_platforms:
ha_integration_type: integration
---
The `waterfurnace` integration communicates with the WaterFurnace Symphony website's WebSocket to show you many of the sensors in your system. While not an official API, this is the same backend the Symphony website is based on, and should be reasonably stable.
The **WaterFurnace** {% term integration %} communicates with the WaterFurnace Symphony website's WebSocket to show you many of the sensors in your system. While not an official API, this is the same backend the Symphony website is based on, and should be reasonably stable.
The sensors provided include:

6
source/_integrations/watson_iot.markdown
View File

@ -9,12 +9,12 @@ ha_iot_class: Cloud Push
ha_integration_type: integration
---
The `watson_iot` integration enables you to link the devices in Home Assistant
The **IBM Watson IoT Platform** {% term integration %} enables you to link the devices in Home Assistant
with an [IBM Watson IoT Platform instance](https://www.ibm.com/us-en/marketplace/internet-of-things-cloud).
## Configuration
To use this integration, you first need to register a gateway device type and then
To use this {% term integration %}, you first need to register a gateway device type and then
a gateway device in your IoT platform instance. For instructions on how to do
this check the [official documentation](https://cloud.ibm.com/docs/services/IoT?topic=iot-platform-getting-started#IoT_connectGateway)
which provides the details on doing this. After you register the gateway device
@ -25,7 +25,7 @@ for your Home Assistant instance you'll need four pieces of information:
- Gateway device ID
- Authentication Token
With this basic information you can configure the integration:
With this basic information you can configure the {% term integration %}:
```yaml
# Example configuration.yaml entry:

4
source/_integrations/watttime.markdown
View File

@ -15,9 +15,9 @@ ha_platforms:
ha_integration_type: service
---
The WattTime integration allows users to get real-time emissions data for a latitude/longitude from [WattTime](https://www.watttime.org).
The **WattTime** {% term integration %} allows users to get real-time emissions data for a latitude/longitude from [WattTime](https://www.watttime.org).
## Registering an Account
## Registering an account
WattTime account registration is accomplished [via the REST API itself](https://www.watttime.org/api-documentation/#register-new-user). The simplest way to do this is by using cURL on the command line:

10
source/_integrations/waze_travel_time.markdown
View File

@ -14,15 +14,15 @@ ha_codeowners:
ha_integration_type: integration
---
The `waze_travel_time` sensor provides travel time from the [Waze](https://www.waze.com/).
The **Waze Travel Time** {% term integration %} provides travel time from the [Waze](https://www.waze.com/).
{% include integrations/config_flow.md %}
Notes:
- If a unit system is not specified, the integration will use the unit system configured on your Home Assistant instance.
- If a unit system is not specified, the {% term integration %} will use the unit system configured on your Home Assistant instance.
- **Origin** and **Destination** can be the address or the GPS coordinates of the location. For coordinates, use the following format: `52.5200, 13.4050`. Make sure the coordinates are separated by a comma. They must not include letters. You can also enter an entity id which provides this information in its state, an entity id with latitude and longitude attributes, or zone friendly name (case sensitive).
- The string inputs for `Substring *` allow you to force the integration to use a particular route or avoid a particular route in its time travel calculation. These inputs are case insensitive and matched against the description of the route.
- The string inputs for `Substring *` allow you to force the {% term integration %} to use a particular route or avoid a particular route in its time travel calculation. These inputs are case insensitive and matched against the description of the route.
- When using the `Avoid Toll Roads?`, `Avoid Subscription Roads?` and `Avoid Ferries?` options, be aware that Waze will sometimes still route you over toll roads or ferries if a valid vignette/subscription is assumed. Default behavior is that Waze will route you over roads having subscription options. It is therefor best is to set both `Avoid Toll Roads?` and `Avoid Subscription Roads?` or `Avoid Ferries?` if needed and experiment to ensure the desired outcome.
## Defining a custom polling interval
@ -31,7 +31,7 @@ Notes:
## Example using dynamic destination
Using the flexible option to set a sensor value to the `Destination`, you can setup a single Waze integration that will calculate travel time to multiple optional locations on demand.
Using the flexible option to set a sensor value to the `Destination`, you can setup a single Waze {% term integration %} that will calculate travel time to multiple optional locations on demand.
In the following example, the `Input Select` is converted into an address which is used to modify the destination for the Waze route calculation from the `device_tracker.myphone` location. It takes a few minutes for the value to update due to the interval of Waze data fetching.
@ -84,7 +84,7 @@ In this example we are using the entity ID of a zone as the origin and the frien
- Destination: "Eddies House"
- Region: "US"
#### Tracking entity in Imperial Units
#### Tracking entity in imperial units
- Name: "Somewhere in New York"
- Origin: `person.paulus`

8
source/_integrations/weather.markdown
View File

@ -17,17 +17,17 @@ The `weather` platforms gather meteorological information from web services and
For a list of weather integrations, on the integrations page, select the [weather category](/integrations/#weather).
Read the integration documentation for your particular weather provider to learn how to set it up.
Read the {% term integration %} documentation for your particular weather provider to learn how to set it up.
Home Assistant currently supports free web services some of which require registration.
## State and state attributes
A weather entity's state is used to indicate the current overall conditions, e.g. 'cloudy' or 'sunny'.
A weather {% term entity %}'s state is used to indicate the current overall conditions, e.g. 'cloudy' or 'sunny'.
### Condition mapping
The `weather` entity can provide the conditions listed below as its state:
The `weather` {% term entity %} can provide the conditions listed below as its state:
- 'clear-night'
- 'cloudy'
@ -47,7 +47,7 @@ The `weather` entity can provide the conditions listed below as its state:
### State attributes
Detailed weather conditions as well as the unit of measurements used for the conditions are indicated by state attributes. A weather entity may not support all the state attributes.
Detailed weather conditions as well as the unit of measurements used for the conditions are indicated by state attributes. A weather {% term entity %} may not support all the state attributes.
{% raw %}
```yaml

6
source/_integrations/weather.template.markdown
View File

@ -11,11 +11,11 @@ ha_domain: template
The `template` integrations creates weather provider that combines integrations and an existing weather provider into a fused weather provider.
There are several powerful ways to use this integration, including localizing your weather provider information with local information from temperature, humidity, pressure sensors that you own.
There are several powerful ways to use this {% term integration %}, including localizing your weather provider information with local information from temperature, humidity, pressure sensors that you own.
Another use case could be using temperature and humidity from one weather platform, with forecasts from a different one.
Output will be converted according to the user's unit system or entity override, see [documentation](https://developers.home-assistant.io/docs/core/entity/weather/#unit-conversion).
Output will be converted according to the user's unit system or {% term entity %} override, see [documentation](https://developers.home-assistant.io/docs/core/entity/weather/#unit-conversion).
## Configuration
@ -136,4 +136,4 @@ precipitation_unit:
### Template variables
State-based template entities have the special template variable `this` available in their templates. The `this` variable aids [self-referencing](/integrations/template#self-referencing) of an entity's state and attribute in templates.
State-based template entities have the special template variable `this` available in their templates. The `this` variable aids [self-referencing](/integrations/template#self-referencing) of an {% term entity %}'s state and attribute in templates.

8
source/_integrations/weatherflow.markdown
View File

@ -16,17 +16,17 @@ ha_domain: weatherflow
ha_integration_type: hub
---
This integration is a local-only WeatherFlow integration that reads weather data from all [WeatherFlow Tempest](https://weatherflow.com/tempest-weather-system/) compatible weather station on the local network.
The **WeatherFlow** {% term integration %} is a local-only {% term integration %} that reads weather data from all [WeatherFlow Tempest](https://weatherflow.com/tempest-weather-system/) compatible weather station on the local network.
<div class='note'>
You may see slight deviations between the values reported in Home Assistant and the values in the WeatherFlow App. This is because the WeatherFlow app considers both forecasts and neighboring weather stations in addition to the local data used in this integration.
You may see slight deviations between the values reported in Home Assistant and the values in the WeatherFlow App. This is because the WeatherFlow app considers both forecasts and neighboring weather stations in addition to the local data used in this {% term integration %}.
</div>
{% include integrations/config_flow.md %}
## Sensors
This integration will expose the following sensors:
This {% term integration %} will expose the following sensors:
- Air density
- Air pressure
@ -60,4 +60,4 @@ Additionally the following diagnostic sensors are available:
## Networking notes
This integration relies on the ability of Home Assistant to receive `UDP` traffic on port `50222`. You may run into trouble if you have a more complex network setup utilizing either VLANs or multiple subnets.
This {% term integration %} relies on the ability of Home Assistant to receive `UDP` traffic on port `50222`. You may run into trouble if you have a more complex network setup utilizing either VLANs or multiple subnets.

8
source/_integrations/weatherkit.markdown
View File

@ -15,7 +15,7 @@ ha_platforms:
- weather
---
The Apple WeatherKit integration obtains current weather and forecasts (hourly and daily) from Apple Weather. It is the most direct replacement for those coming from the Dark Sky API since Apple bought Dark Sky and implemented its technology into their weather service.
The **Apple WeatherKit** {% term integration %} obtains current weather and forecasts (hourly and daily) from Apple Weather. It is the most direct replacement for those coming from the Dark Sky API since Apple bought Dark Sky and implemented its technology into their weather service.
There is currently support for the following device types within Home Assistant:
@ -24,7 +24,7 @@ There is currently support for the following device types within Home Assistant:
## Requirements
You will need a [paid Apple Developer Program account](https://developer.apple.com/support/compare-memberships/) to use this integration.
You will need a [paid Apple Developer Program account](https://developer.apple.com/support/compare-memberships/) to use this {% term integration %}.
{% include integrations/config_flow.md %}
@ -44,7 +44,7 @@ You will need to obtain the appropriate credentials which you will use to connec
3. For the identifier, Apple recommends using a reverse-DNS style name, like `com.example.homeassistant`.
4. Save the identifier you used. This is your **Service ID**.
You can add a new WeatherKit integration entry now that you have all the credentials. Using the details from earlier, it should look something like this:
You can add a new WeatherKit {% term integration %} entry now that you have all the credentials. Using the details from earlier, it should look something like this:
- **Key ID**: `ABC123DEFG`
- **Service ID**: `com.example.homeassistant`
@ -55,7 +55,7 @@ You can add a new WeatherKit integration entry now that you have all the credent
### Troubleshooting
If you are having issues setting up the integration, please make sure the following are true:
If you are having issues setting up the {% term integration %}, please make sure the following are true:
- You are entering the key exactly as it appears in the `.p8` file, including the header and footer.
- There are no leading or trailing spaces in other configuration values.

8
source/_integrations/webostv.markdown
View File

@ -2,7 +2,7 @@
title: LG webOS Smart TV
description: Instructions on how to integrate a LG webOS Smart TV within Home Assistant.
ha_category:
- Media Player
- Media player
- Notifications
ha_iot_class: Local Push
ha_release: 0.18
@ -23,7 +23,7 @@ The `webostv` platform allows you to control a [LG](https://www.lg.com/) webOS S
There is currently support for the following device types within Home Assistant:
- [Media Player](/integrations/media_player/)
- [Media player](/integrations/media_player/)
- [Notifications](/integrations/notify/)
To begin with enable *LG Connect Apps* feature in *Network* settings of the TV.
@ -32,7 +32,7 @@ To begin with enable *LG Connect Apps* feature in *Network* settings of the TV.
## Turn on action
Home Assistant is able to turn on an LG webOS Smart TV if you specify an action, provided by an integration like [HDMI-CEC](/integrations/hdmi_cec/) or [WakeOnLan](/integrations/wake_on_lan/).
Home Assistant is able to turn on an LG webOS Smart TV if you specify an action, provided by an {% term integration %} like [HDMI-CEC](/integrations/hdmi_cec/) or [WakeOnLan](/integrations/wake_on_lan/).
Common for webOS 3.0 and higher would be to use WakeOnLan feature. To use this feature your TV should be connected to your network via Ethernet rather than Wireless and you should enable the *LG Connect Apps* feature in *Network* settings of the TV (or *Mobile App* in *General* settings for older models) (*may vary by version).
@ -64,7 +64,7 @@ Any other [actions](/docs/automation/action/) to power on the device can be conf
## Sources
It is possible to select which sources will be available to the media player. When the TV is powered on press the **CONFIGURE** button in the integration card and select the sources to enable. If you don't select any source the media player will offer all of the sources of the TV.
It is possible to select which sources will be available to the media player. When the TV is powered on press the **CONFIGURE** button in the {% term integration %} card and select the sources to enable. If you don't select any source the media player will offer all of the sources of the TV.
## Change channel through play_media service

14
source/_integrations/wemo.markdown
View File

@ -2,7 +2,7 @@
title: Belkin WeMo
description: Instructions on how to integrate Belkin WeMo devices into Home Assistant.
ha_category:
- Binary Sensor
- Binary sensor
- Fan
- Hub
- Light
@ -24,11 +24,11 @@ ha_codeowners:
ha_integration_type: integration
---
The `wemo` integration is the main integration to integrate various [Belkin WeMo](https://www.belkin.com/products/wemo-smart-home/) devices with Home Assistant.
The **Belkin WeMo** {% term integration %} is the main {% term integration %} to integrate various [Belkin WeMo](https://www.belkin.com/products/wemo-smart-home/) devices with Home Assistant.
There is currently support for the following device types within Home Assistant:
- Binary Sensor (Belkin WeMo Motion Sensor)
- Binary sensor (Belkin WeMo Motion Sensor)
- Fan (Belkin WeMo (Holmes) Smart Humidifier)
- Light (Belkin WeMo LED lights and Smart Dimmer Switch)
- Switch ([Belkin WeMo Switches](https://www.belkin.com/products/wemo-smart-home/) and includes support for WeMo enabled [Mr. Coffee](https://www.mrcoffee.com/) smart coffee makers.)
@ -73,9 +73,9 @@ Note that if you use static device entries, you may want to set up your router (
If the device doesn't seem to work and all you see is the state "unavailable" on your dashboard, check that your firewall doesn't block incoming requests on port 8989, since this is the port to which the WeMo devices send their updates.
### Device Options
### Device options
Clicking the **Configure** button on the WeMo integration will bring up some additional options that can be configured for WeMo devices.
Selecting the **Configure** button on the WeMo {% term integration %} will bring up some additional options that can be configured for WeMo devices.
![Device Options](/images/integrations/wemo/device_options.png)
@ -107,7 +107,7 @@ wemo:
The `wemo` platform allows you to control your Belkin WeMo humidifiers from within Home Assistant. This includes support for the Holmes Smart Humidifier.
WeMo devices are automatically discovered if the `discovery` integration is enabled.
WeMo devices are automatically discovered if the `discovery` {% term integration %} is enabled.
### Attributes
@ -135,7 +135,7 @@ There are several services which can be used for automations and control of the
| `wemo.set_humidity` | Calling this service will set the desired relative humidity setting on the device (entity_id is a required list of 1 or more entities to set humidity on, and target_humidity is a required float value between 0 and 100 (this value will be rounded down and mapped to one of the valid desired humidity settings of 45, 50, 55, 60, or 100 that are supported by the WeMo humidifier)).
| `wemo.reset_filter_life` | Calling this service will reset the humdifier's filter lifetime back to 100% (entity_id is a required list of 1 or more entities to reset the filter lifetime on). Call this service when you change the filter on your humidifier.
## Long Press Events and Triggers
## Long press events and triggers
For WeMo Light Switches and Dimmers, pressing the button on the device for two seconds will activate a long press event. The long-press can trigger an automation
either by using an `event` trigger or a `device` trigger. For an `event` trigger the `event_type` will be `wemo_subscription_event`. The event data will have a `type` parameter

2
source/_integrations/whirlpool.markdown
View File

@ -17,7 +17,7 @@ ha_platforms:
ha_integration_type: hub
---
The `whirlpool` integration integrates Whirlpool 6th Sense Live, and Whirlpool/Maytag Washer and Dryer appliances into Home Assistant.
The **Whirlpool Appliances** {% term integration %} integrates Whirlpool 6th Sense Live, and Whirlpool/Maytag Washer and Dryer appliances into Home Assistant.
There is currently support for the following device types within Home Assistant:

3
source/_integrations/whois.markdown
View File

@ -15,7 +15,6 @@ ha_platforms:
ha_integration_type: service
---
The Whois integration allows you to perform daily WHOIS lookups against your owned domains. This provides you with information such as `expiration_date`, `name_servers` and `registrar` details.
The **Whois** {% term integration %} allows you to perform daily WHOIS lookups against your owned domains. This provides you with information such as `expiration_date`, `name_servers` and `registrar` details.
{% include integrations/config_flow.md %}

2
source/_integrations/wiffi.markdown
View File

@ -15,7 +15,7 @@ ha_platforms:
ha_integration_type: integration
---
This integration allows you to connect your [STALL WIFFI](https://stall.biz) devices directly to Home Assistant.
This **Wiffi** {% term integration %} allows you to connect your [STALL WIFFI](https://stall.biz) devices directly to Home Assistant.
{% include integrations/config_flow.md %}

10
source/_integrations/wilight.markdown
View File

@ -23,7 +23,7 @@ ha_platforms:
ha_integration_type: integration
---
The `wilight` integration is to integrate [WiLight](http://www.wilight.com.br) devices with Home Assistant.
The **WiLight** {% term integration %} is to integrate [WiLight](http://www.wilight.com.br) devices with Home Assistant.
There is currently support for the following device types within Home Assistant:
@ -36,9 +36,9 @@ There is currently support for the following device types within Home Assistant:
## Fan
The `wilight` integration allows you to control your Fans from within Home Assistant.
The **WiLight** {% term integration %} allows you to control your Fans from within Home Assistant.
### Fan Services
### Fan services
There are several services which can be used for automations and control of the fan:
@ -52,12 +52,12 @@ There are several services which can be used for automations and control of the
## Irrigation
The `wilight` integration allows you to control your Irrigation from within Home Assistant. This is exposed via switches in Home Assistant.
The **WiLight** {% term integration %} allows you to control your Irrigation from within Home Assistant. This is exposed via switches in Home Assistant.
There are two switch types for Irrigation: `watering switch` and `pause switch`.
A `watering switch` can turn on and off the irrigation valve, while the `pause switch` can disable / enable the action of a `watering switch`.
`Triggers` activate (turn on) the `watering switch` (irrigation valve) at the programmed time. The trigger can be set to run on a day of the week or only once (today).
### Irrigation Services
### Irrigation services
There are several services which can be used for automations and control of the Irrigation:

6
source/_integrations/wirelesstag.markdown
View File

@ -2,7 +2,7 @@
title: Wireless Sensor Tags
description: Instructions on how to integrate your Wireless Tags sensors within Home Assistant.
ha_category:
- Binary Sensor
- Binary sensor
- Hub
- Sensor
- Switch
@ -18,11 +18,11 @@ ha_codeowners:
ha_integration_type: integration
---
The `wirelesstag` implementation allows you to integrate your [wirelesstag.net](https://wirelesstag.net/) sensors tags in Home Assistant.
The **Wireless Sensor Tags** {% term integration %} allows you to integrate your [wirelesstag.net](https://wirelesstag.net/) sensors tags in Home Assistant.
There is currently support for the following device types within Home Assistant:
- [Binary Sensor](#binary-sensor)
- [Binary sensor](#binary-sensor)
- [Sensor](#sensor)
- [Switch](#switch)

10
source/_integrations/withings.markdown
View File

@ -19,7 +19,7 @@ ha_integration_type: integration
ha_quality_scale: platinum
---
The Withings integration consumes data from various health products produced by [Withings](https://www.withings.com).
The **Withings** {% term integration %} consumes data from various health products produced by [Withings](https://www.withings.com).
## Create a Withings developer account
@ -57,15 +57,15 @@ Withings will validate (with HTTP HEAD) these requirements each time you save yo
## Data updates
The integration automatically detects if you can use webhooks. This enables the integration only to update when there is new data.
The binary sensor for sleep will only work if the integration can establish webhooks with Withings.
The {% term integration %} automatically detects if you can use webhooks. This enables the {% term integration %} only to update when there is new data.
The binary sensor for sleep will only work if the {% term integration %} can establish webhooks with Withings.
## Available data
The integration provides several entities, some of which are dynamically enabled if data is available.
The {% term integration %} provides several entities, some of which are dynamically enabled if data is available.
For example, measurement sensors like weight only work when data has been registered in the last 14 days. So if you start using a new device, for example, to measure your temperature or you manually update a value in the app, the sensor automatically appears.
Sleep sensors are only created if the integration can find sleep data for you within the last day.
Sleep sensors are only created if the {% term integration %} can find sleep data for you within the last day.
Workout calendar and the workout and activity sensors show if the latest available data point is no older than 14 days.

16
source/_integrations/wiz.markdown
View File

@ -2,7 +2,7 @@
title: WiZ
description: Instructions on setting up WiZ within Home Assistant.
ha_category:
- Binary Sensor
- Binary sensor
- Light
- Number
- Sensor
@ -25,7 +25,7 @@ ha_platforms:
ha_integration_type: integration
---
The WiZ integration allows you to control your WiZ lights and smart sockets.
The **WiZ** {% term integration %} allows you to control your WiZ lights and smart sockets.
The devices are set up through your Wi-Fi network and don't need any additional bridge or gateway.
These devices have been sold under at least the following brands:
@ -55,7 +55,7 @@ These devices have been sold under at least the following brands:
- [Trio](https://wiz.trio-lighting.com/)
- [Wofi](https://wofi-wiz.com/)
The integration can report the state of occupancy sensors that have been linked to a device.
The {% term integration %} can report the state of occupancy sensors that have been linked to a device.
{% include integrations/config_flow.md %}
@ -66,7 +66,7 @@ If you have further questions, please have a look at the [WiZ Support Page](http
### Enable local connectivity
The integration needs to communicate locally with the WiZ device. This setting **Allow local communication** can be disabled or enabled in WiZ app.
The {% term integration %} needs to communicate locally with the WiZ device. This setting **Allow local communication** can be disabled or enabled in WiZ app.
This setting should be enabled by default.
Steps to enable:
@ -76,7 +76,7 @@ Steps to enable:
3. Scroll down to the security settings.
4. Enable the switch **Allow local communication**.
### Occupancy Sensors
### Occupancy sensors
The occupancy sensors will only be added once a motion event is detected. Home Assistant can detect the sensors if they turn on at least one device when the room is occupied, and turn off at least one device when the room is not occupied. Sensors that are not linked to a device cannot be detected.
@ -84,7 +84,7 @@ When a device is linked to an occupancy sensor, by default, the sensor will be d
Devices linked to the occupancy sensor that was last controlled manually will show an unknown at startup. The state will be known the next time the light is controlled by the sensor.
### Power Monitoring Sensors
### Power monitoring sensors
A power monitoring sensor is available on devices with the following hardware modules:
@ -93,6 +93,6 @@ A power monitoring sensor is available on devices with the following hardware mo
- ESP20_SHRGB_31R
- ESP20_SHTW_31R
### Effect Speed
### Effect speed
The speed of an effect can be controlled via a `number` entity. The entity will only be available when an effect has been set that allows the speed to be adjusted.
The speed of an effect can be controlled via a `number` {% term entity %}. The {% term entity %} will only be available when an effect has been set that allows the speed to be adjusted.

47
source/_integrations/wled.markdown
View File

@ -38,9 +38,9 @@ newer is recommended to get the optimal experience.
## Lights
This integration adds the WLED device as a light in Home Assistant.
This {% term integration %} adds the WLED device as a light in Home Assistant.
Home Assistant treats every segment of the LED strip as a separate light
entity.
{% term entity %}.
Only native supported features of a light in Home Assistant are supported
(which includes effects).
@ -53,33 +53,33 @@ well. The fully-featured segment control has been introduced in WLED 0.10
but has been partly around via APIs since WLED 0.8.6.
If WLED has 1 segment defined (the default), that one segment controls the whole
LED strip. Home Assistant creates a single light entity to control the
LED strip. Home Assistant creates a single light {% term entity %} to control the
strip.
If WLED has 2 or more segments, each segment gets its own light entity in
Home Assistant. Additionally, a master light entity is created. This master
entity controls the strip power and overall brightness applied to all segments.
If WLED has 2 or more segments, each segment gets its own light {% term entity %} in
Home Assistant. Additionally, a master light {% term entity %} is created. This master
{% term entity %} controls the strip power and overall brightness applied to all segments.
Additionally, select and number entities described below will be created for each segment.
## Select Entities
## Select entities
This integration provides selects for the following information from WLED:
This {% term integration %} provides selects for the following information from WLED:
- Playlist
- Preset
- Color palette (per segment, disabled by default).
## Number Entities
## Number entities
This integration provides `number` entities to control the following, segment-specific settings:
This {% term integration %} provides `number` entities to control the following, segment-specific settings:
- Intensity
- Speed
## Sensor Entities
## Sensor entities
This integration provides sensors for the following information from WLED:
This {% term integration %} provides sensors for the following information from WLED:
- Estimated current (in mA).
- Uptime (disabled by default)
@ -92,31 +92,31 @@ This integration provides sensors for the following information from WLED:
## Switches
The integration will create a number of switches:
The {% term integration %} will create a number of switches:
### Nightlight
Toggles the WLED Timer.
Can be configured on the WLED itself under settings > LED Preferences > Timed light.
### Sync Receive and Sync Send
### Sync receive and sync send
Toggles the synchronization between multiple WLED devices.
Can be configured on the WLED itself under settings > Sync Interfaces > WLED Broadcast.
[WLED Sync documentation](https://kno.wled.ge/interfaces/udp-realtime/)
## Firmware Updates
## Firmware updates
The integration has an [update entity](/integrations/update/) that provides
The {% term integration %} has an [update entity](/integrations/update/) that provides
information on the latest available version of WLED and indicates if a
firmware update is available for installation.
The firmware update can be triggered and installed onto your WLED device
directly from Home Assistant.
The update entity will only provide updates to stable versions, unless you are
using a beta version of WLED. In that case, the update entity will also provide
The update {% term entity %} will only provide updates to stable versions, unless you are
using a beta version of WLED. In that case, the update {% term entity %} will also provide
updates to newer beta versions.
{% include integrations/option_flow.md %}
@ -125,9 +125,10 @@ updates to newer beta versions.
Keep Master Light:
description: Keep the master light, even if there is only 1 segment. This ensures the master light is always there, in case you are automating segments to appear and remove dynamically.
{% endconfiguration_basic %}
## Example Automations
### Activating Random Effect
## Example automations
### Activating random effect
You can automate changing the effect using a service call like this:
@ -143,11 +144,11 @@ data:
{% endraw %}
### Activating Random Palette
### Activating random palette
Activating a random palette is very similar to the above random effect,
and can be done by selecting a random one from the available palette select
entity.
{% term entity %}.
{% raw %}
@ -178,7 +179,7 @@ to a preset called My Preset:
option: "My Preset"
```
### Automation Using Specific Palette Name
### Automation using specific palette name
An automation to turn on a WLED light and select a specific palette and
set intensity, and speed can be created by first calling the `light.turn_on`

6
source/_integrations/wolflink.markdown
View File

@ -14,13 +14,13 @@ ha_platforms:
ha_integration_type: integration
---
The `wolflink` integration uses the [Wolf Smart-Set](https://www.wolf-smartset.com/) web service as a source to fetch your heating system status.
The **Wolf SmartSet Service** {% term integration %} uses the [Wolf Smart-Set](https://www.wolf-smartset.com/) web service as a source to fetch your heating system status.
Currently, integration can collect information such as temperature, pressure and heating state.
Currently, {% term integration %} can collect information such as temperature, pressure and heating state.
Remember that to integrate your heating device with Home Assistant, you need to have a WOLF LinkHome device connected to your heating device.
The integration fetches all data based on parameters, that are exposed by your heating device.
The {% term integration %} fetches all data based on parameters, that are exposed by your heating device.
## Tested devices

2
source/_integrations/workday.markdown
View File

@ -2,7 +2,7 @@
title: Workday
description: Steps to configure the binary workday sensor.
ha_category:
- Binary Sensor
- Binary sensor
- Utility
ha_iot_class: Local Polling
ha_release: 0.41

6
source/_integrations/ws66i.markdown
View File

@ -2,7 +2,7 @@
title: Soundavo WS66i 6-Zone Amplifier
description: Instructions on how to integrate WS66i 6-Zone Home Audio Controller into Home Assistant.
ha_category:
- Media Player
- Media player
ha_release: 2022.6
ha_config_flow: true
ha_iot_class: Local Polling
@ -15,13 +15,13 @@ ha_platforms:
ha_integration_type: integration
---
The Soundavo WS66i 6-Zone Amplifier integration allows you to control the [Soundavo Whole-Home Audio Amplifier](https://www.soundavo.com/products/ws-66i) via the local network. This amplifier is an upgrade of the amplifier sold by [Monoprice](https://www.monoprice.com/product?p_id=10761) that adds 2 built-in wireless streamers and an Ethernet port for control over LAN.
The **Soundavo WS66i 6-Zone Amplifier** {% term integration %} allows you to control the [Soundavo Whole-Home Audio Amplifier](https://www.soundavo.com/products/ws-66i) via the local network. This amplifier is an upgrade of the amplifier sold by [Monoprice](https://www.monoprice.com/product?p_id=10761) that adds 2 built-in wireless streamers and an Ethernet port for control over LAN.
{% include integrations/config_flow.md %}
## Configuration notes
Enter the IP Address of the WS66i amplifier when prompted to connect to the device and hit submit. It will detect the number of connected amplifiers and present each zone as an entity.
Enter the IP address of the WS66i amplifier when prompted to connect to the device and hit submit. It will detect the number of connected amplifiers and present each zone as an {% term entity %}.
- 1 Amplifier: Zones 11..16
- 2 Amplifiers: Zones 11..16, Zones 21..26

2
source/_integrations/wsdot.markdown
View File

@ -11,7 +11,7 @@ ha_platforms:
ha_integration_type: integration
---
The `wsdot` sensor will give you travel time information from the [Washington State Department of Transportation (WSDOT)](https://wsdot.com/).
The **Washington State Department of Transportation (WSDOT)** {% term integration %} will give you travel time information from the [Washington State Department of Transportation (WSDOT)](https://wsdot.com/).
## Setup

2
source/_integrations/wyoming.markdown
View File

@ -17,7 +17,7 @@ ha_platforms:
ha_config_flow: true
---
The Wyoming integration connects external voice services to Home Assistant using a [small protocol](https://github.com/rhasspy/rhasspy3/blob/master/docs/wyoming.md). This enables [Assist](/voice_control/) to use a variety of local [speech-to-text](/integrations/stt/), [text-to-speech](/integrations/tts/), and [wake-word-detection](/integrations/wake_word/) systems, such as:
The **Wyoming** {% term integration %} connects external voice services to Home Assistant using a [small protocol](https://github.com/rhasspy/rhasspy3/blob/master/docs/wyoming.md). This enables [Assist](/voice_control/) to use a variety of local [speech-to-text](/integrations/stt/), [text-to-speech](/integrations/tts/), and [wake-word-detection](/integrations/wake_word/) systems, such as:
- Whisper {% my supervisor_addon badge addon="core_whisper" %}
- Piper {% my supervisor_addon badge addon="core_piper" %}

24
source/_integrations/xbox.markdown
View File

@ -2,9 +2,9 @@
title: Xbox
description: Instructions on how to set up Xbox devices in Home Assistant.
ha_category:
- Binary Sensor
- Media Player
- Media Source
- Binary sensor
- Media player
- Media source
- Remote
ha_iot_class: Cloud Polling
ha_release: 0.117
@ -20,7 +20,7 @@ ha_platforms:
ha_integration_type: integration
---
The Xbox integration allows you to control Xbox One (or newer) consoles from Home Assistant.
The **Xbox** {% term integration %} allows you to control Xbox One (or newer) consoles from Home Assistant.
Home Assistant authenticates with Xbox Live through OAuth2 using the Home Assistant Cloud account linking service.
@ -34,9 +34,9 @@ Because it uses the Home Assistant Cloud account linking service you **must** ha
</div>
## Media Player
## Media player
The Xbox media player platform will create Media Player entities for each console linked to your Microsoft account. These entities will display the active app and playback controls as well as a media browser implementation, allowing you to launch any installed application.
The Xbox media player platform will create media player entities for each console linked to your Microsoft account. These entities will display the active app and playback controls as well as a media browser implementation, allowing you to launch any installed application.
### Service `play_media`
@ -99,7 +99,7 @@ command:
delay_sec: 0.1
```
### Picture Elements Card
### Picture elements card
Below is a picture elements card that can be added to a dashboard to provide an Xbox controller interface in your frontend. It utilizes the services detailed above. Replace `remote.xboxone_remote` and `media_player.xboxone` with the names of your entities and enjoy! Courtesy of [@SeanPM5](https://github.com/SeanPM5) and [@hunterjm](https://github.com/hunterjm).
@ -241,7 +241,7 @@ elements:
overflow: hidden
```
## Binary Sensor
## Binary sensor
The Xbox binary sensor platform automatically keeps track of your "**Favorite** friends". In your friends list, select **Change friendship -> Favorite** to have that person automatically pulled into Home Assistant.
@ -267,15 +267,15 @@ Just like the binary sensors, the Xbox sensor platform automatically keeps track
| `sensor.{gamertag}_account_tier` | Disabled | Shows your friend's Xbox Live account tier (Gold or Silver). |
| `sensor.{gamertag}_gold_tenure` | Disabled | Shows how long your friend has had Xbox Live Gold. |
## Media Source
## Media source
The Xbox media source platform allows you to use the Media Browser panel to view both your own, and community, gameclips or screenshots for games that you have installed on any of your consoles. As with any other media source integration, you are also able to send these clips to supported media players like Chromecast.
The Xbox media source platform allows you to use the Media Browser panel to view both your own, and community, gameclips or screenshots for games that you have installed on any of your consoles. As with any other media source {% term integration %}, you are also able to send these clips to supported media players like Chromecast.
<div class="note">
It can take up to a couple of days for newly installed applications to appear in the media browser.
</div>
## Manual Configuration
## Manual configuration
<div class="note">
These steps are not required, nor will they be supported if issues are encountered.
@ -291,7 +291,7 @@ If you prefer not to use the Home Assistant account linking service, you may man
- On the App Page, navigate to "Certificates & secrets"
- Generate a new client secret and save for later use
You may then add the credentials to [Application Credentials](/integrations/application_credentials/) and then setup the integration.
You may then add the credentials to [Application Credentials](/integrations/application_credentials/) and then setup the {% term integration %}.
{% details "I have manually disabled My Home Assistant" %}

6
source/_integrations/xiaomi.markdown
View File

@ -16,7 +16,7 @@ The `Xiaomi` camera platform allows you to utilize Xiaomi Cameras within Home As
To successfully implement this platform, the Home Assistant host should be capable of multiple simultaneous reads. For every concurrent Home Assistant user, a connection will be made to the camera every 10 seconds. This should normally not be a problem.
## Preparing the Device
## Preparing the device
In order to integrate the camera with Home Assistant, it is necessary to install a custom firmware on the device. Instructions for doing so can be found for each models.
@ -47,7 +47,7 @@ The live stream writing by the camera is not a supported format when the hass re
If you enabled RTSP server, you can connect to your camera via other Home Assistant camera platforms. However, this RTSP server disables the ability to use the supremely-useful Mi Home app. In order to maintain both Home Assistant compatibility _and_ the native app, this platform retrieves videos via FTP.
</div>
## Configuring the Platform
## Configuring the platform
To enable the platform, add the following lines to your`configuration.yaml` file:
@ -117,7 +117,7 @@ camera:
```
## Hostname template
The hostname/IP address can be provided either a value or from the existing entity attributes.
The hostname/IP address can be provided either a value or from the existing {% term entity %} attributes.
```yaml
camera:

10
source/_integrations/xiaomi_aqara.markdown
View File

@ -21,11 +21,11 @@ ha_platforms:
ha_integration_type: integration
---
The `xiaomi_aqara` integration allows you to integrate [Xiaomi](https://www.mi.com/en/) Aqara-compatible devices into Home Assistant.
The **Xiaomi Gateway (Aqara)** {% term integration %} allows you to integrate [Xiaomi](https://www.mi.com/en/) Aqara-compatible devices into Home Assistant.
Please note, there are two versions of the hub: v1 and v2. v1 can be used with Home Assistant without any problems, however, v2 might be less straight forward when it comes to enabling the local API, and might even require you to open up your device in order to do so. Xiaomi has suggested this is in the pipeline.
## Supported Devices
## Supported devices
- Aqara Air Conditioning Companion (lumi.acpartner.v3)
- Aqara Intelligent Door Lock (lock.aq1)
@ -52,7 +52,7 @@ Please note, there are two versions of the hub: v1 and v2. v1 can be used with H
- Water Leak Sensor
- Xiaomi Mijia Gateway (lumi.gateway.v2, lumi.gateway.v3)
## Unsupported Devices
## Unsupported devices
- Xiaomi Aqara Gateway (lumi.gateway.aqhm01), as it is not possible to activate dev mode in the Mi Home App.
- Gateway Radio
@ -155,7 +155,7 @@ Removes a specific device. The removal is required if a device shall be paired w
## Examples
### Long Press on Smart Button 1st Generation
### Long press on smart button 1st generation
This example plays the sound of a dog barking when the button is held down and stops the sound when the button is pressed once. Only works for the round button of the 1st generation.
@ -189,7 +189,7 @@ This example plays the sound of a dog barking when the button is held down and s
gw_mac: xxxxxxxxxxxx
```
### Double Click on Smart Button
### Double click on smart button
This example toggles the living room lamp on a double click of the button.

2
source/_integrations/xiaomi_ble.markdown
View File

@ -2,7 +2,7 @@
title: Xiaomi BLE
description: Instructions on how to integrate Xiaomi BLE devices into Home Assistant.
ha_category:
- Binary Sensor
- Binary sensor
- Sensor
ha_bluetooth: true
ha_release: 2022.8

14
source/_integrations/xiaomi_miio.markdown
View File

@ -7,7 +7,7 @@ ha_category:
- Health
- Hub
- Light
- Presence Detection
- Presence detection
- Remote
- Vacuum
ha_iot_class: Local Polling
@ -38,7 +38,7 @@ ha_platforms:
ha_integration_type: integration
---
The Xiaomi Miio integration supports the following devices:
The **Xiaomi Miio** {% term integration %} supports the following devices:
- [Xiaomi Gateway](#xiaomi-gateway)
- [Xiaomi device tracker (Xiaomi Mi WiFi Repeater 2)](#xiaomi-device-tracker-xiaomi-mi-wifi-repeater-2)
@ -82,7 +82,7 @@ The most common problems are:
## Xiaomi Gateway
The `xiaomi_miio` gateway integration allows you to control the gateway and its connected subdevices.
The `xiaomi_miio` gateway {% term integration %} allows you to control the gateway and its connected subdevices.
### Supported Xiaomi gateway models:
@ -96,9 +96,9 @@ The `xiaomi_miio` gateway integration allows you to control the gateway and its
| Mi AC Companion | lumi.acpartner.v2 | KTBL02LM | untested |
| Aqara AC Companion | lumi.acpartner.v3 | KTBL11LM | yes |
Some gateways (lumi.gateway.mieu01) do not support getting the connected subdevices locally. For those gateways, cloud credentials can be specified during the config flow and the "Use cloud to get connected subdevices" can be enabled in the options flow (after setting up the integration, click Configuration in the sidebar, then click Integrations and then click Options on the already set up Xiaomi Miio Gateway integration). The connected subdevices will then be retrieved from the Xiaomi Miio cloud (internet), control and status updates of those subdevices will then further take place over local network connection. A re-authentication flow may be triggered when no cloud credentials are provided yet and are needed for that particular gateway model.
Some gateways (lumi.gateway.mieu01) do not support getting the connected subdevices locally. For those gateways, cloud credentials can be specified during the config flow and the "Use cloud to get connected subdevices" can be enabled in the options flow (after setting up the {% term integration %}, click Configuration in the sidebar, then click Integrations and then click Options on the already set up Xiaomi Miio Gateway {% term integration %}). The connected subdevices will then be retrieved from the Xiaomi Miio cloud (internet), control and status updates of those subdevices will then further take place over local network connection. A re-authentication flow may be triggered when no cloud credentials are provided yet and are needed for that particular gateway model.
### Gateway Features
### Gateway features
- Gateway alarm control (Turn on/off; see status `armed_away`, `disarmed`, `arming`)
- Gateway light control (Turn on/off; change brightness; change color; see status)
@ -1432,7 +1432,7 @@ Currently supported services are:
### Platform Services
In addition to all of the services provided by the `vacuum` integration (`start`, `pause`, `stop`, `return_to_base`, `locate`, `set_fan_speed` and `send_command`), the `xiaomi_miio` platform introduces specific services to access the remote control mode of the robot. These are:
In addition to all of the services provided by the `vacuum` {% term integration %} (`start`, `pause`, `stop`, `return_to_base`, `locate`, `set_fan_speed` and `send_command`), the `xiaomi_miio` platform introduces specific services to access the remote control mode of the robot. These are:
- `xiaomi_miio.vacuum_clean_zone`
- `xiaomi_miio.vacuum_clean_segment`
@ -1688,7 +1688,7 @@ Water Shortage\*\*:
{% endconfiguration_basic %}
<div class="note">
* Needs to be manually enabled once the integration has been added. <br>
* Needs to be manually enabled once the {% term integration %} has been added. <br>
** Only enabled if the vacuum has a mop.
</div>

2
source/_integrations/xiaomi_tv.markdown
View File

@ -2,7 +2,7 @@
title: Xiaomi TV
description: Instructions on how to integrate a Xiaomi TV into Home Assistant.
ha_category:
- Media Player
- Media player
ha_release: 0.64
ha_iot_class: Assumed State
ha_codeowners:

6
source/_integrations/xmpp.markdown
View File

@ -83,7 +83,7 @@ All Jabber IDs (JID) must include the domain. Make sure that the password matche
You can send text messages and images as well as other files through Jabber.
### Jabber Text Message
### Jabber text message
Here are some examples on how to set up a script, that can be run from an automation.
@ -101,7 +101,7 @@ Number 1 shows a classical, text-only message. The Title is optional, although i
message: "My funny or witty message"
```
### Jabber Image Message
### Jabber image message
You can send images or files from locally stored files or remote web locations via Jabber's HTTP Upload feature.
To send files and images, your jabber server must support [XEP_0363](https://xmpp.org/extensions/xep-0363.html).
@ -145,7 +145,7 @@ Number 3 sends an image from a local path.
path: "/home/homeassistant/super_view.jpg"
```
### Jabber File Message
### Jabber file message
Number 4 sends a text-file, retrieved from GitHub, renamed to `Hass_Cheatsheet.txt` to be viewable on a mobile Android device, as most don't offer any application to view `.md` files. Optionally you can add a timeout for the HTTP upload in seconds.

12
source/_integrations/xs1.markdown
View File

@ -16,7 +16,7 @@ ha_platforms:
ha_integration_type: integration
---
The [EZcontrol XS1](http://www.ezcontrol.de/content/view/36/28/) integration for Home Assistant allows you to observe and control devices configured on the XS1 Gateway. Please have a look at the official documentation for using this gateway [Bedienungsanleitung v3.0.0.0](http://www.ezcontrol.de/support/downloads/XS1/xs1manual/Bedienungsanleitung_EZcontrol_XS1_3.0.0.0-2.pdf).
The [EZcontrol XS1](http://www.ezcontrol.de/content/view/36/28/) {% term integration %} for Home Assistant allows you to observe and control devices configured on the XS1 Gateway. Please have a look at the official documentation for using this gateway [Bedienungsanleitung v3.0.0.0](http://www.ezcontrol.de/support/downloads/XS1/xs1manual/Bedienungsanleitung_EZcontrol_XS1_3.0.0.0-2.pdf).
## Configuration
@ -28,7 +28,7 @@ xs1:
host: "192.168.2.100"
```
The integration will automatically detect the configuration of the XS1 Gateway only **on initialization** which currently means when Home Assistant boots. When you change the configuration of the XS1 you (currently) have to restart Home Assistant to see the effects.
The {% term integration %} will automatically detect the configuration of the XS1 Gateway only **on initialization** which currently means when Home Assistant boots. When you change the configuration of the XS1 you (currently) have to restart Home Assistant to see the effects.
{% configuration %}
host:
@ -55,10 +55,10 @@ password:
type: string
{% endconfiguration %}
## Supported Device Types
## Supported device types
<div class='note warning'>
This integration currently only covers part of the device types supported by the XS1 gateway, unsupported types are simply ignored.
This {% term integration %} currently only covers part of the device types supported by the XS1 gateway, unsupported types are simply ignored.
</div>
### Sensors
@ -77,7 +77,7 @@ If you are using climate devices the "current temp" sensor will be automatically
| `dimmer` | Partly | Dimmers are currently handled like switches so actual dimming is not supported :(|
| `temperature` | Yes | |
### Climate Actuator/Sensor
### Climate actuator/sensor
Home Assistant can combine temperature sensors and climate actuators into a single device. The XS1 gateway does not allow this, but a sensor and actuator can be configured separately. To make Home Assistant register them in the same climate device just prefix the **sensor** name with the actuator name on the XS1 gateway configuration, f.ex:
@ -86,7 +86,7 @@ Home Assistant can combine temperature sensors and climate actuators into a sing
## Examples
In this section, you find some real-life examples of how to use this integration.
In this section, you find some real-life examples of how to use this {% term integration %}.
### Full configuration

2
source/_integrations/yale_home.markdown
View File

@ -2,7 +2,7 @@
title: Yale Home
description: Connect and control your Yale Home devices using the August integration
ha_category:
- Binary Sensor
- Binary sensor
- Button
- Camera
- Doorbell

12
source/_integrations/yale_smart_alarm.markdown
View File

@ -3,7 +3,7 @@ title: Yale Smart Living
description: Instructions on how to integrate Yale Smart Alarms into Home Assistant.
ha_category:
- Alarm
- Binary Sensor
- Binary sensor
- Button
- Lock
ha_release: 0.78
@ -21,24 +21,24 @@ ha_platforms:
ha_integration_type: integration
---
The Yale Smart Living integration provides connectivity with the Yale Smart Alarm systems and Smart Hub through Yale's API.
The **Yale Smart Living** {% term integration %} provides connectivity with the Yale Smart Alarm systems and Smart Hub through Yale's API.
There is currently support for the following device types within Home Assistant:
- Alarm
- Binary Sensor
- Binary sensor
- Button
- Lock
{% include integrations/config_flow.md %}
## Alarm Control Panel
## Alarm control panel
Services provided are `armed_away`, `armed_home`, and `disarmed`.
No code is required to operate the alarm.
## Binary Sensors
## Binary sensors
Provides support for contact sensors for doors showing if door is open or closed.
@ -50,4 +50,4 @@ Provides support for pressing the panic button to trigger the alarm. Be careful
The lock platform requires a code for unlocking but no code for locking.
The integration can be configured to provide a default code that is used if no code is supplied and the number of digits required.
The {% term integration %} can be configured to provide a default code that is used if no code is supplied and the number of digits required.

16
source/_integrations/yalexs_ble.markdown
View File

@ -2,7 +2,7 @@
title: Yale Access Bluetooth
description: Instructions on how to integrate Yale Access Bluetooth devices into Home Assistant.
ha_category:
- Binary Sensor
- Binary sensor
- Lock
- Sensor
ha_bluetooth: true
@ -23,9 +23,9 @@ Integrates [Yale Access](https://www.yalehome.com/us/en/products/smart-technolog
{% include integrations/config_flow.md %}
The Yale Access Bluetooth integration will automatically discover devices once the [Bluetooth](/integrations/bluetooth) integration is enabled and functional.
The **Yale Access Bluetooth** {% term integration %} will automatically discover devices once the [Bluetooth](/integrations/bluetooth) integration is enabled and functional.
Devices must have a Yale Access module installed to function with this integration if one is not already built-in.
Devices must have a Yale Access module installed to function with this {% term integration %} if one is not already built-in.
## Supported devices
@ -56,17 +56,17 @@ Lock operation requires setting up an encrypted connection highly sensitive to l
## Push updates
Some locks only send push updates when they have an active HomeKit pairing. If your lock is not sending push updates, ensure it's paired with a HomeKit using an iOS device or the HomeKit controller integration. The lock cannot be paired via HomeKit Controller and the Yale Access Bluetooth integration on the same Home Assistant instance as they will both try to access the lock simultaneously and fail.
Some locks only send push updates when they have an active HomeKit pairing. If your lock is not sending push updates, ensure it's paired with a HomeKit using an iOS device or the HomeKit controller {% term integration %}. The lock cannot be paired via HomeKit Controller and the Yale Access Bluetooth {% term integration %} on the same Home Assistant instance as they will both try to access the lock simultaneously and fail.
One easy way to fix this is to create a new/second home in the Apple Home app and add the lock to that new home. Push updates should occur as intended after the lock is added.
Alternatively, call the `homeassistant.update_entity` service to force the integration to update the lock state, or enable the always connected option.
Alternatively, call the `homeassistant.update_entity` service to force the {% term integration %} to update the lock state, or enable the always connected option.
{% include integrations/option_flow.md %}
If the lock does not support push updates via advertisements or you want lock operation to be more responsive, you can enable always connected mode. Always connected will cause the lock to stay connected to Home Assistant via Bluetooth, which will use more battery.
## Door Sensors
## Door sensors
The lock must be calibrated in the Yale Access App for the door sensors to function correctly. If the door sensor has an unknown state or is not updating, try recalibrating the lock in the app.
@ -76,9 +76,9 @@ The offline key and slot number are required to operate the lock. These credenti
### Yale Access, Yale Home, or August Cloud
The [August](/integrations/august) integration can automatically provision the offline key if the configured account has the key loaded. You may need to create or use a non-primary existing account with owner-level access to the lock, as not all accounts will have the key loaded. If the lock was not discovered by Home Assistant when the cloud integration was loaded, reload the cloud integration once the lock has been discovered.
The [August](/integrations/august) {% term integration %} can automatically provision the offline key if the configured account has the key loaded. You may need to create or use a non-primary existing account with owner-level access to the lock, as not all accounts will have the key loaded. If the lock was not discovered by Home Assistant when the cloud {% term integration %} was loaded, reload the cloud {% term integration %} once the lock has been discovered.
If the offline key can automatically be provisioned, you will not be asked to enter it and the integration should be automatically added, configured and running.
If the offline key can automatically be provisioned, you will not be asked to enter it and the {% term integration %} should be automatically added, configured and running.
Most Yale branded locks can use the August cloud to obtain the keys. Accessing the August cloud to receive the key may not work unless the lock was purchased in a market that sells under both brands.

2
source/_integrations/yamaha.markdown
View File

@ -2,7 +2,7 @@
title: Yamaha Network Receivers
description: Instructions on how to integrate Yamaha Network Receivers into Home Assistant.
ha_category:
- Media Player
- Media player
ha_release: 0.16
ha_iot_class: Local Polling
ha_domain: yamaha

18
source/_integrations/yamaha_musiccast.markdown
View File

@ -2,7 +2,7 @@
title: MusicCast
description: Instructions on how to integrate Yamaha MusicCast Receivers into Home Assistant.
ha_category:
- Media Player
- Media player
ha_release: 0.53
ha_codeowners:
- '@vigonotion'
@ -19,7 +19,7 @@ ha_platforms:
ha_integration_type: integration
---
The Yamaha MusicCast integration allows you to control [Yamaha MusicCast Receivers](https://usa.yamaha.com/products/audio_visual/musiccast/index.html) from Home Assistant.
The Yamaha **MusicCast** {% term integration %} allows you to control [Yamaha MusicCast Receivers](https://usa.yamaha.com/products/audio_visual/musiccast/index.html) from Home Assistant.
Supported devices are listed on their [site](https://usa.yamaha.com/products/contents/audio_visual/musiccast/musiccast-compatiblity.html).
@ -27,14 +27,14 @@ Supported devices are listed on their [site](https://usa.yamaha.com/products/con
## Grouping functionality
The Yamaha MusicCast integration implements the grouping services. There are some limitations in the MusicCast system for grouping:
The Yamaha MusicCast {% term integration %} implements the grouping services. There are some limitations in the MusicCast system for grouping:
- It is not possible to let mediaplayer entities of the same device (e.g., different zones) be in distinct groups.
- If a non-main zone is the master of a group, it is not possible to let other mediaplayers of the same device join this group.
## Play media functionality
The MusicCast integration supports the Home Assistant media browser for all streaming services, your device supports. For services such as Deezer, you have to log in using the official MusicCast app. In addition, local HTTP URLs can be played back using this service. This includes the Home Assistant text-to-speech services.
The MusicCast {% term integration %} supports the Home Assistant media browser for all streaming services, your device supports. For services such as Deezer, you have to log in using the official MusicCast app. In addition, local HTTP URLs can be played back using this service. This includes the Home Assistant text-to-speech services.
It is also possible to recall NetUSB presets using the play media service. To do so "presets:<preset_num>" has to be used as `media_content_id` in the service call.
@ -62,7 +62,7 @@ data:
media_content_type: "music"
```
## Configuration/Diagnostic Entities
## Configuration / diagnostic entities
Depending on the features supported by the device, several entities will be added for every MusicCast Device. Some of the entities are related to the MusicCast device and some are related to a zone of the device. All device and main zone related entities will be assigned to the Home Assistant device of the main zone. Entities related to other zones will be assigned to the Home Assistant device of the corresponding zone.
@ -70,9 +70,9 @@ Depending on the features supported by the device, several entities will be adde
The following entities will be added, if they are supported by the MusicCast device:
- Equalizer (configuration, zone level)
- One number entity each is added for high, mid and low
- One number {% term entity %} each is added for high, mid and low
- Tone Control (configuration, zone level)
- One number entity each is added for bass and treble
- One number {% term entity %} each is added for bass and treble
- Dialogue Level (configuration, zone level)
- Set the volume of dialogues in relation to the general volume
- Dialogue Lift (configuration, zone level)
@ -81,6 +81,7 @@ The following entities will be added, if they are supported by the MusicCast dev
- Control the volume of dialogues for DTS:X content
### Select entities
The following entities will be added, if they are supported by the MusicCast device:
- Dimmer (configuration, device level)
- Set the display brightness
@ -100,6 +101,7 @@ The following entities will be added, if they are supported by the MusicCast dev
- Set the audio quality for grouped speakers
### Switch entities
The following entities will be added, if they are supported by the MusicCast device:
- Speaker A (configuration, device level)
- A switch to turn on the speaker set A
@ -124,7 +126,7 @@ In this section known problems and their resolution are documented.
### Errors on handling UDP messages
The Yamaha MusicCast integration is working with updates sent from the device to Home Assistant instead of pulling all information every few seconds. There is no error correction mechanism in these messages, so that only 100% correct messages can be processed. Whenever there is a corrupt message the Yamaha MusicCast integration will update all device information and log an error message like these:
The Yamaha MusicCast {% term integration %} is working with updates sent from the device to Home Assistant instead of pulling all information every few seconds. There is no error correction mechanism in these messages, so that only 100% correct messages can be processed. Whenever there is a corrupt message the Yamaha MusicCast integration will update all device information and log an error message like these:
- `Received invalid message: <message>`
- `Received non UTF-8 compliant message: b'<binary>'`

2
source/_integrations/yandex_transport.markdown
View File

@ -71,7 +71,7 @@ sensor:
- 677к
```
## Options For Entities
## Options for entities
You can configure view information about the next bus using dashboard card.
To enable displaying the relative time in your `default_view` add the following lines:

4
source/_integrations/yardian.markdown
View File

@ -15,7 +15,7 @@ ha_platforms:
ha_integration_type: integration
---
The Yardian integration allows you to control your [Yardian Smart Sprinkler Controller](https://yardian.com/products/yardian-pro-smart-sprinkler-controller/).
The **Yardian** {% term integration %} allows you to control your [Yardian Smart Sprinkler Controller](https://yardian.com/products/yardian-pro-smart-sprinkler-controller/).
There is currently support for the following platform within Home Assistant:
@ -31,7 +31,7 @@ During the configuration, you will have to manually set the **Host** and the **A
### yardian.start_irrigation
Start a zone for a given number of minutes. This service accepts an Yardian Zone switch entity and allows a given duration.
Start a zone for a given number of minutes. This service accepts an Yardian Zone switch {% term entity %} and allows a given duration.
| Service Data Attribute | Optional | Description |
| ---------------------- | -------- | ----------------------------------------------------- |

8
source/_integrations/yeelight.markdown
View File

@ -22,12 +22,12 @@ ha_zeroconf: true
ha_integration_type: integration
---
The Yeelight integration allows you to control your Yeelight Wi-Fi bulbs with Home Assistant.
The **Yeelight** {% term integration %} allows you to control your Yeelight Wi-Fi bulbs with Home Assistant.
There is support for the following device types within Home Assistant:
- **Light** - The Yeelight platform for supporting lights.
- **Binary Sensor** - The Yeelight platform for supporting binary sensors. Currently, only nightlight mode sensor for ceiling lights.
- **Binary sensor** - The Yeelight platform for supporting binary sensors. Currently, only nightlight mode sensor for ceiling lights.
{% include integrations/config_flow.md %}
@ -151,7 +151,7 @@ custom_effects:
### Music mode
Per default, the bulb limits the number of requests per minute to 60, a limitation that can be bypassed by enabling the music mode. In music mode, the bulb is commanded to connect back to a socket provided by the integration and it tries to keep the connection open, which may not be wanted in all use-cases.
Per default, the bulb limits the number of requests per minute to 60, a limitation that can be bypassed by enabling the music mode. In music mode, the bulb is commanded to connect back to a socket provided by the {% term integration %} and it tries to keep the connection open, which may not be wanted in all use-cases.
**Also note that bulbs in music mode will not update their state to "unavailable" if they are disconnected, which can cause delays in Home Assistant. Bulbs in music mode may also not react to commands from Home Assistant the first time if the connection is dropped. If you experience this issue, turn the light off and back on again in the frontend and everything will return to normal.**
### Initial setup
@ -168,7 +168,7 @@ Information on how to enable "LAN Control" can be found [here](https://www.yeeli
### Supported models
<div class='note warning'>
This integration is tested to work with the following models. If you have a different model and it is working, please let us know.
This {% term integration %} is tested to work with the following models. If you have a different model and it is working, please let us know.
</div>
| Model ID | Model number | Product name |

8
source/_integrations/yi.markdown
View File

@ -22,9 +22,9 @@ The `yi` camera platform allows you to utilize [Yi Home Cameras](https://www.yit
To successfully implement this platform, the Home Assistant host should be capable of multiple simultaneous reads. For every concurrent Home Assistant user, a connection will be made to the camera every 10 seconds. This should normally not be a problem.
## Preparing the Device
## Preparing the device
### Installing Alternative Firmware
### Installing alternative firmware
In order to integrate the camera with Home Assistant, it is necessary to install a custom firmware on the device. Instructions for doing so can be found via the [yi-hack-v3 GitHub project](https://github.com/shadow-1/yi-hack-v3).
If you have a 2019/2020 version camera use [yi-hack-MStar GitHub project](https://github.com/roleoroleo/yi-hack-MStar) or [yi-hack-Allwinner GitHub project](https://github.com/roleoroleo/yi-hack-Allwinner). In this case configure the cam as ONVIF and read the wiki for further details.
@ -53,7 +53,7 @@ Some alternative Yi firmwares enable an experimental RTSP server, which will all
</div>
### Changing the FTP Password
### Changing the FTP password
Once the custom firmware is installed, a password must be added to the FTP
server. To do so:
@ -64,7 +64,7 @@ server. To do so:
4. Enter your new password twice.
5. Log out of Telnet.
## Configuring the Platform
## Configuring the platform
To enable the platform, add the following lines to your`configuration.yaml` file:

2
source/_integrations/yolink.markdown
View File

@ -2,7 +2,7 @@
title: YoLink
description: Instructions on how to integrate YoLink Devices into Home Assistant.
ha_category:
- Binary Sensor
- Binary sensor
- Climate
- Cover
- Light

6
source/_integrations/youless.markdown
View File

@ -15,9 +15,9 @@ ha_platforms:
ha_integration_type: integration
---
The YouLess integration for Home Assistant allows you to read the meter values from sensors created by [YouLess](https://www.youless.nl/home.html).
The **YouLess** {% term integration %} for Home Assistant allows you to read the meter values from sensors created by [YouLess](https://www.youless.nl/home.html).
The integration is tested and verified for the following devices from YouLess:
The {% term integration %} is tested and verified for the following devices from YouLess:
- LS110
- LS120 running PVOutput firmware
@ -25,7 +25,7 @@ The integration is tested and verified for the following devices from YouLess:
{% include integrations/config_flow.md %}
The integration will create sensors for you to display:
The {% term integration %} will create sensors for you to display:
- The current power usage
- The gas meter

4
source/_integrations/youtube.markdown
View File

@ -18,14 +18,14 @@ api: YouTube Data API v3
api_link: https://console.cloud.google.com/apis/library/youtube.googleapis.com?project=home-assistant-17698
---
The YouTube integration allows you to connect YouTube channels to Home Assistant.
The **YouTube** {% term integration %} allows you to connect YouTube channels to Home Assistant.
For every channel you add, it will create sensors for:
- Subscriber count
- The latest uploaded video
## Prerequisites
To be able to configure the integration, you need to have a YouTube channel.
To be able to configure the {% term integration %}, you need to have a YouTube channel.
To learn how to create one, refer to the [YouTube documentation](https://support.google.com/youtube/answer/1646861).
You need to configure developer credentials to allow Home Assistant to access your Google Account.

6
source/_integrations/zabbix.markdown
View File

@ -3,7 +3,7 @@ title: Zabbix
description: Instructions on how to integrate Zabbix into Home Assistant.
ha_category:
- Sensor
- System Monitor
- System monitor
ha_release: 0.37
ha_iot_class: Local Polling
ha_domain: zabbix
@ -12,7 +12,7 @@ ha_platforms:
ha_integration_type: integration
---
The `zabbix` integration is the main integration to connect to a [Zabbix](https://www.zabbix.com/) monitoring instance via the Zabbix API.
The **Zabbix** {% term integration %} is the main {% term integration %} to connect to a [Zabbix](https://www.zabbix.com/) monitoring instance via the Zabbix API.
It is possible to publish Home Assistant state changes to Zabbix. In Zabbix a host has to be created which will contain the Home Assistant states as individual items. These items are automatically created using Zabbix Low-Level Discovery (LLD). In order to make setup in Zabbix easy, you can use this [template](/assets/integrations/zabbix/zbx_template_home_assistant.xml) for the host.
@ -22,7 +22,7 @@ There is currently also support for the following device types within Home Assis
## Configuration
To set the Zabbix integration up, add the following information to your `configuration.yaml` file:
To set the Zabbix {% term integration %} up, add the following information to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry

Some files were not shown because too many files have changed in this diff Show More