**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 %}.
-### UniFi Protect Cameras
+### UniFi Protect cameras
@@ -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.
diff --git a/source/_integrations/universal.markdown b/source/_integrations/universal.markdown
index a0de226dce1..5838f0199e3 100644
--- a/source/_integrations/universal.markdown
+++ b/source/_integrations/universal.markdown
@@ -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:
diff --git a/source/_integrations/upb.markdown b/source/_integrations/upb.markdown
index 3d03682d88e..b87d4828a5d 100644
--- a/source/_integrations/upb.markdown
+++ b/source/_integrations/upb.markdown
@@ -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
diff --git a/source/_integrations/upc_connect.markdown b/source/_integrations/upc_connect.markdown
index 50f85b55c08..d53eb8e69aa 100644
--- a/source/_integrations/upc_connect.markdown
+++ b/source/_integrations/upc_connect.markdown
@@ -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'
diff --git a/source/_integrations/upcloud.markdown b/source/_integrations/upcloud.markdown
index ddfd515c579..a2a6bc91dee 100644
--- a/source/_integrations/upcloud.markdown
+++ b/source/_integrations/upcloud.markdown
@@ -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.
diff --git a/source/_integrations/update.markdown b/source/_integrations/update.markdown
index f5f06681409..f0b0368af33 100644
--- a/source/_integrations/update.markdown
+++ b/source/_integrations/update.markdown
@@ -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
diff --git a/source/_integrations/upnp.markdown b/source/_integrations/upnp.markdown
index 14470896409..1f22c24f001 100644
--- a/source/_integrations/upnp.markdown
+++ b/source/_integrations/upnp.markdown
@@ -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:
diff --git a/source/_integrations/uptime.markdown b/source/_integrations/uptime.markdown
index a526d04479b..56f57f17df3 100644
--- a/source/_integrations/uptime.markdown
+++ b/source/_integrations/uptime.markdown
@@ -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 %}
diff --git a/source/_integrations/uptimerobot.markdown b/source/_integrations/uptimerobot.markdown
index bf108415b42..adf8edc4b22 100644
--- a/source/_integrations/uptimerobot.markdown
+++ b/source/_integrations/uptimerobot.markdown
@@ -1,8 +1,8 @@
---
title: UptimeRobot
-description: Instructions on how to set up Uptime Robot within Home Assistant.
+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 %}
diff --git a/source/_integrations/usb.markdown b/source/_integrations/usb.markdown
index 1b1afc1e5c6..1345f1d282d 100644
--- a/source/_integrations/usb.markdown
+++ b/source/_integrations/usb.markdown
@@ -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
diff --git a/source/_integrations/usgs_earthquakes_feed.markdown b/source/_integrations/usgs_earthquakes_feed.markdown
index ec401cf9335..825a7376bae 100644
--- a/source/_integrations/usgs_earthquakes_feed.markdown
+++ b/source/_integrations/usgs_earthquakes_feed.markdown
@@ -19,7 +19,7 @@ The `usgs_earthquakes_feed` platform lets you integrate a GeoJSON feed provided
-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 %}.
@@ -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
diff --git a/source/_integrations/utility_meter.markdown b/source/_integrations/utility_meter.markdown
index 0853b40ffae..12fbb5cf385 100644
--- a/source/_integrations/utility_meter.markdown
+++ b/source/_integrations/utility_meter.markdown
@@ -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).
-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.
{% 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:
diff --git a/source/_integrations/vacuum.markdown b/source/_integrations/vacuum.markdown
index 82ba32360fe..98910b52b04 100644
--- a/source/_integrations/vacuum.markdown
+++ b/source/_integrations/vacuum.markdown
@@ -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 %}
diff --git a/source/_integrations/vacuum.mqtt.markdown b/source/_integrations/vacuum.mqtt.markdown
index efa7145963e..32a665054fa 100644
--- a/source/_integrations/vacuum.mqtt.markdown
+++ b/source/_integrations/vacuum.mqtt.markdown
@@ -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:
diff --git a/source/_integrations/vacuum.template.markdown b/source/_integrations/vacuum.template.markdown
index 5dd93a77d8b..da603774744 100644
--- a/source/_integrations/vacuum.template.markdown
+++ b/source/_integrations/vacuum.template.markdown
@@ -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.
diff --git a/source/_integrations/vallox.markdown b/source/_integrations/vallox.markdown
index 4c5171655da..3e76075e3ec 100644
--- a/source/_integrations/vallox.markdown
+++ b/source/_integrations/vallox.markdown
@@ -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:
diff --git a/source/_integrations/velbus.markdown b/source/_integrations/velbus.markdown
index d6e9127376c..6e3ca159b32 100644
--- a/source/_integrations/velbus.markdown
+++ b/source/_integrations/velbus.markdown
@@ -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
diff --git a/source/_integrations/velux.markdown b/source/_integrations/velux.markdown
index 226f93a1399..dbec481400f 100644
--- a/source/_integrations/velux.markdown
+++ b/source/_integrations/velux.markdown
@@ -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.
diff --git a/source/_integrations/venstar.markdown b/source/_integrations/venstar.markdown
index eec570e83ca..f65443755f8 100644
--- a/source/_integrations/venstar.markdown
+++ b/source/_integrations/venstar.markdown
@@ -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/)
diff --git a/source/_integrations/vera.markdown b/source/_integrations/vera.markdown
index d6c8fd6f9f7..e14368dc786 100644
--- a/source/_integrations/vera.markdown
+++ b/source/_integrations/vera.markdown
@@ -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.