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-28 03:37:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

A integrations: minor style fix (#29893)

Browse Source 
* A integrations: minot style fix

- apply sentence style capitalization
- add refs to glossary terms

* Fix glossary

* Apply suggestions from code review

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

---------

Co-authored-by: Joakim Sørensen <joasoe@gmail.com>
This commit is contained in:
c0ffeeca7 2023-11-20 09:02:21 +01:00 committed by GitHub
parent fad4989470
commit 9af249a1fc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
50 changed files with 144 additions and 209 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
source/_data/glossary.yml
View File

@ -7,21 +7,16 @@
# - link: A URL to link to for more information (optional)
# - aliases: A list of aliases for the term (optional)
#
- term: Action
definition: |-
Actions are used in several places in Home Assistant. As part of a script or automation, actions define what is going to happen once a trigger is activated. In scripts, an action is called *sequence*.
Actions use service calls and/or scenes to interact with entities and cause these entities to do something. Actions can also include conditions and a delay. An action can call multiple services at the same time. For example, if your presence is detected in a room, an action may call one service to turn on a light and call another service to start playing music after a delay.
Actions are also used on the dashboard, for example as tap or hold action on a UI element. When triggered, the action calls a service.
aliases:
- actions
link: /docs/automation/action/
excerpt: >
Actions are used in several places in Home Assistant. As part of a script or automation, actions define what is going to happen once a trigger is activated. In scripts, an action is called *sequence*.
- term: Add-on
definition: >-
Add-ons are additional standalone third-party software packages that can be
@ -31,7 +26,6 @@
excerpt: >
Add-ons are additional standalone third-party software packages that can be
installed on Home Assistant OS.
- term: Area
definition: >-
Locations within your home such as living room, dance floor, etc.
@ -41,7 +35,6 @@
Places within your home such as rooms, spaces, etc.
aliases:
- areas
- term: Automation
definition: >-
Automations connect one or more triggers to one or more actions in a
@ -56,7 +49,6 @@
link: /docs/automation/
aliases:
- automations
- term: Backup
definition: >-
Home Assistant has built-in functionality to create files containing a copy of
@ -69,13 +61,11 @@
your configurations. This is available on certain installation types.
aliases:
- backups
- term: Binary sensor
definition: >-
A binary sensor returns information about things that only have two states -
such as on or off.
link: /integrations/binary_sensor
- term: Blueprint
definition: >-
A blueprint is a script or automation configuration with certain parts marked as configurable. This allows users to create multiple scripts or automations based on the same blueprint, with each having its own configuration-specific settings. Blueprints are shared by the community on the [blueprints exchange](https://community.home-assistant.io/c/blueprints-exchange/53) in the forum.
@ -84,11 +74,9 @@
A blueprint is a script or automation configuration with certain parts marked as configurable. This allows users to create multiple scripts or automations based on the same blueprint, with each having its own configuration-specific settings.
aliases:
- blueprints
- term: Component
definition: >-
Better known as: Integrations. Integrations used to be known as components.
- term: Condition
definition: >-
Conditions are an optional part of an automation that will prevent an
@ -96,44 +84,35 @@
link: /docs/scripts/conditions/
aliases:
- conditions
- term: Cover
definition: >-
Covers are devices such as blinds, garage doors, etc that can be opened
and closed and optionally set to a specific position.
link: /integrations/cover
- term: Customize
definition: >-
Customization allows you to overwrite the default parameters of your
devices in the configuration.
- term: Device
definition: |-
A device is a model representing a physical or logical unit that contains entities.
**Example for a device as a physical unit**
A smart plug named 'Coffee machine' which provides 2 entities: a `switch` entity to turn power on or off ('Coffee machine power switch') and a `sensor` entity for power monitoring ('Coffee machine power sensor').
**Example for a device as a logical unit**
An ecobee thermostat with 4 room sensors. This thermostat is seen as 5 devices in Home Assistant: 1 device for the thermostat with 4 sensors, and 1 device for each room sensor. Each device can be in a different area and may have more than one input or output within that area.
Devices have properties such as ID, manufacturer, name, model, hardware version, firmware version, connections, etc.
excerpt: >
A device is a model representing a physical or logical unit that contains entities.
aliases:
- devices
- term: Device tracker
definition: >-
Device trackers are used to track the presence, or location, of a device.
link: /integrations/device_tracker
- term: Discovery
definition: >
Discovery is the automatic setup of zeroconf/mDNS and uPnP devices after
they are discovered.
- term: Domain
definition: >-
Each integration in Home Assistant has a unique identifier:
@ -147,60 +126,47 @@
excerpt: >
Each integration in Home Assistant has a unique identifier: The domain.
It is often shown as the first part (before the dot) of entity IDs.
- term: Entity
definition: |-
An entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. Entities have states.
**Example for entities as part of a device**
A combined temperature and humidity sensor device provides two sensor entities. One for temperature (e.g. `sensor.temperature` with state `21.0` and unit `°C`) and one for humidity
(e.g. `sensor.humidity` with state `65.4` and unit `%`).
**Example for entities as part of a service**
A weather service that provides 3 entities: wind speed, air pressure, and ozon level.
**Example of an entity used for control**
A fan that is turned on when the temperature exceeds 30&nbsp;°C.
There are standardized types of entities for common integrations such as light, switch, camera, sensor, fan, or vacuum.
Some entities are not part of a device or service. Examples of standalone entities are automation, script, scene entities, and helper entities (e.g. input helpers).
Most properties of entities are related to the state. Entities have optional attributes such as friendly name, unit of measurement, and an icon or picture that can be displayed in the frontend.
link: /docs/configuration/state_object/
excerpt: >
An entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service.
aliases:
- entities
- term: Event
definition: >-
An event is when something happens.
link: /docs/configuration/events/
aliases:
- events
- term: Frontend
definition: >-
The frontend is a necessary component for the UI, it is also where you
can define your themes.
link: /integrations/frontend/
- term: Group
definition: >-
Groups are a way to organize your entities into a single unit.
link: /integrations/group/
- term: HASS
definition: >-
HASS or [hass](/docs/tools/hass/) is often used as an abbreviation for
Home Assistant. It is also the command-line tool.
- term: HassOS
definition: >-
Another name for Home Assistant Operating System
link: /hassio/installation/
- term: Home Assistant Core
definition: >-
Home Assistant Core is a Python program. It can be run on various operating
@ -211,7 +177,6 @@
excerpt: >
Home Assistant Core is the hart of Home Assistant itself. It is a Python
program that powers every installation type, but can be installed standalone.
- term: Home Assistant Supervised
definition: >-
Home Assistant Supervised is a full UI managed home automation ecosystem that
@ -221,13 +186,11 @@
excerpt: >
Home Assistant Supervised is the full Home Assistant ecosystem, without the
Home Assistant Operating System.
- term: Home Assistant Supervisor
definition: >-
The Home Assistant Supervisor is a program that manages a Home Assistant
installation, taking care of installing and updating Home Assistant,
add-ons, itself and, if used, updating the Home Assistant Operating System.
- term: Home Assistant Operating System
definition: >-
Home Assistant OS, the Home Assistant Operating System, is an embedded,
@ -238,7 +201,6 @@
excerpt: >
Home Assistant OS, the Home Assistant Operating System, is an embedded,
minimalistic, operating system designed to run the Home Assistant ecosystem.
- term: Host
definition: >-
A device that can communicate with other devices on a network. During setup and configuration,
@ -250,7 +212,6 @@
link: https://en.wikipedia.org/wiki/Host_(network)
aliases:
- hosts
- term: Integration
definition: >-
Integrations connect and integrates Home Assistant with devices, services,
@ -266,46 +227,38 @@
link: /integrations/
aliases:
- integrations
- term: Intent
definition: >-
Intent is a term used with voice assistants. The intent is what Home Assistant thinks you want it to do when it extracts a command from your voice or text utterance. Currently, the following intents are supported out of the box: HassTurnOn, HassTurnOff, HassGetState, and HassLightSet.
These intents allow you to turn things on or off, inquire about a state, or change the brightness or color of a light.
excerpt: >
Intent is a term used with voice assistants. The intent is what Home Assistant thinks you want it to do when it extracts a command from your voice or text utterance.
link: https://developers.home-assistant.io/docs/intent_builtin
aliases:
- Intents
- term: Lovelace
definition: >-
Lovelace is the original code name of the UI that is now known as
[Home Assistant dashboards](/dashboards).
- term: Light
definition: >-
A light has a brightness you can control, and optionally color temperature
or RGB color control.
link: /integrations/light
- term: Matter
definition: >-
Matter is an open-source standard that defines how to control smart home devices on a Wi-Fi or Thread network. The aim of the standard is to improve security and to make devices interoperable across vendors, replacing proprietary protocols for smart home ecosystems. Unlike other standards, Matter allows joining the same device to multiple controllers. For example, you can add a light to Google Home, Apple Home, and Home Assistant at the same time. A bridge device can be used to connect devices running on other smart home technologies such as Zigbee or Z-Wave.
excerpt: >
Matter is an open-source standard that defines how to control smart home devices on a Wi-Fi or Thread network.
link: /integrations/matter
- term: Notification
definition: >-
You can use notifications to send messages, pictures, and more, to devices.
link: /integrations/#notifications
- term: Packages
definition: >
Packages allow you to bundle different component configurations together.
link: /docs/configuration/packages/
- term: Platform
definition: >-
Platforms are building blocks provided by some integrations to be used by
@ -317,7 +270,6 @@
Platforms are building blocks provided by some integrations to be used by
other integrations.
link: /docs/configuration/platform_options/
- term: Reload
definition: >-
Applies the changes made to the Home Assistant configuration files. Changes
@ -331,7 +283,6 @@
Applies the changes made to Home Assistant configuration files. Changes are normally
automatically updated. However, changes made outside of the front
end will not be reflected in Home Assistant and require a reload.
- term: Scene
definition: >-
Scenes capture the states you want certain entities to be. For example,
@ -348,7 +299,6 @@
link: /docs/scripts/
aliases:
- scripts
- term: Sensor
definition: >-
Sensors return information about a thing, for instance the level of water
@ -356,7 +306,6 @@
link: /integrations/sensor/
aliases:
- sensors
- term: Selectors
definition: >-
Selectors are components for the user interface. Some selectors can,
@ -367,21 +316,15 @@
Selectors are components for the user interface. Like toggle, dropdown,
and more.
link: /docs/blueprint/selectors/
- term: Service
definition: |-
The term service has 2 meanings in Home Assistant:
**The information service**
For example, the municipal waste management service that provides entities for organic, paper, and packaging waste. In terms of functionality, the information service is like a device. It is called *service* to avoid confusion, as it does not come with a piece of hardware.
**The software function that interacts with targets to make something happen**
A service carries out one specific task, for example: turning on the light in the living room or sending a notification to a mobile phone.
A service has targets and data. Service targets are: areas, devices, and entities. Service data carries the information required to define the desired state change in the target. For example, the target, together with brightness 150 and RGB color `[255,0,0]`, or the message “Your coffee is ready”.
Services can be used in, for example, automation, scripts, dashboards, or voice commands to control your home.
Home Assistant provides a series of predefined services, such as `homeassistant.turn_on`, `homeassistant.toggle`, or `homeassistant.reload`.
excerpt: >
A service carries out one specific task, for example: turn on the light in the
@ -390,11 +333,9 @@
link: /docs/scripts/service-calls/
aliases:
- services
- term: State
definition: |-
The state holds the information of interest of an entity. For example, if a light is on or off, the current temperature, or the amount of energy used. The data type of state is `string` (a textual value). Entities store 2 timestamps related to the state: `last_updated` and `last_changed`. Each entity has exactly one state and the state only holds one value at a time. However, entities can store attributes related to that state. For example, the state of a light is _on_, and the related state attributes could be its current brightness and color values.
State changes can be used as the source of triggers. The current state can be used in conditions.
link: /docs/configuration/state_object/
@ -402,13 +343,11 @@
- states
excerpt: >
The state holds the information of interest of an entity, for example, if a light is on or off. Each entity has exactly one state and the state only holds one value at a time. However, entities can store attributes related to that state such as brightness, color, or a unit of measurement.
- term: Switch
definition: >-
Switches are things that have two states you can select between, such as
turning on or off a socket.
link: /integrations/switch/
- term: Template
definition: >-
A template is an automation definition that can include variables for the
@ -421,11 +360,9 @@
- term: Thread
definition: >-
Thread is a low-power mesh networking standard that is specifically designed for smart home applications. It is a protocol that defines how devices communicate. *Mesh* topology means that the devices can communicate with each other directly, without going through a central controller first. Thread uses the same radio frequency (RF) technology as Zigbee, but provides IP connectivity similar to Wi-Fi. Unlike Zigbee, Thread does not specify how to control devices. How Thread-enabled devices are controlled is specified in a higher level protocol such as HomeKit or Matter.
link: /integrations/thread/
excerpt: >
Thread is a low-power mesh networking standard that is specifically designed for smart home applications. It is a protocol that defines how devices communicate.
- term: Trigger
definition: >-
A trigger is a set of values or conditions of a platform that are defined
@ -438,16 +375,14 @@
definition: >-
TTS (text-to-speech) allows Home Assistant to talk to you.
link: /integrations/tts/
- term: Variables
definition: >-
Variables are used to store values in memory that can be processed
for example, in a script.
link: /docs/scripts/#variables
- term: Zone
definition: >-
Zones are areas that can be used for presence detection.
link: /integrations/zone/
aliases:
- zones
- zones

18
source/_integrations/abode.markdown
View File

@ -3,7 +3,7 @@ title: Abode
description: Instructions on integrating Abode home security with Home Assistant.
ha_category:
- Alarm
- Binary Sensor
- Binary sensor
- Camera
- Cover
- Hub
@ -30,15 +30,15 @@ ha_platforms:
ha_integration_type: integration
---
The `abode` integration will allow users to integrate their Abode Home Security systems into Home Assistant and use its alarm system and sensors to automate their homes.
The **Abode** {% term integration %} will allow users to integrate their Abode Home Security systems into Home Assistant and use its alarm system and sensors to automate their homes.
Please visit the [Abode website](https://goabode.com/) for further information about Abode Security.
There is currently support for the following device types within Home Assistant:
There is currently support for the following {% term device %} types within Home Assistant:
- **Alarm Control Panel**: Reports on the current alarm status and can be used to arm and disarm the system.
- **Binary Sensor**: Reports on `Quick Actions`, `Door Contacts`, `Connectivity` sensors (remotes, keypads, and status indicators), `Moisture` sensors, and `Motion` or `Occupancy` sensors.
- **Camera**: Reports on `Camera` devices and will download and show the latest captured still image. Can be turned off and on using the [`camera.turn_off`](/integrations/camera/#service-turn_off) and [`camera.turn_on`](/integrations/camera/#service-turn_on) services.
- **Alarm control panel**: Reports on the current alarm status and can be used to arm and disarm the system.
- **Binary sensor**: Reports on `Quick Actions`, `Door Contacts`, `Connectivity` {% term sensors %} (remotes, keypads, and status indicators), `Moisture` sensors, and `Motion` or `Occupancy` sensors.
- **Camera**: Reports on `Camera` devices and will download and show the latest captured still image. Can be turned off and on using the [`camera.turn_off`](/integrations/camera/#service-turn_off) and [`camera.turn_on`](/integrations/camera/#service-turn_on) {% term services %}.
- **Cover**: Reports on `Secure Barriers` and can be used to open and close the cover.
- **Lock**: Reports on `Door Locks` and can be used to lock and unlock the door.
- **Light**: Reports on `Dimmer` lights and can be used to dim or turn the light on and off.
@ -49,7 +49,7 @@ There is currently support for the following device types within Home Assistant:
## Events
There are a number of events that can be triggered from Abode.
There are a number of {% term events %} that can be triggered from Abode.
They are grouped into the below events:
- **abode_alarm**: Fired when an alarm event is triggered from Abode. This includes Smoke, CO, Panic, and Burglar alarms.
@ -64,7 +64,7 @@ They are grouped into the below events:
- **abode_capture**: Fired when an image is captured.
- **abode_device**: Fired for device changes/additions/deletions.
All events have the fields:
All {% term events %} have the fields:
Field | Description
----- | -----------
@ -84,7 +84,7 @@ Field | Description
There is a unique list of known event_codes that can be found
[here](https://github.com/MisterWil/abodepy/files/1262019/timeline_events.txt).
## Services
## {% term Services %}
### Service `change_setting`

2
source/_integrations/accuweather.markdown
View File

@ -17,7 +17,7 @@ ha_platforms:
ha_integration_type: service
---
The AccuWeather integration uses the [AccuWeather](https://accuweather.com/) web service as a source for weather data for your location.
The **AccuWeather** {% term integration %} uses the [AccuWeather](https://accuweather.com/) web service as a source for weather data for your location.
## Setup

2
source/_integrations/acmeda.markdown
View File

@ -16,7 +16,7 @@ ha_platforms:
ha_integration_type: integration
---
The Rollease Acmeda Automate integration allows you to control and monitor covers via your Rollease Acmeda Automate hub. The integrations communicates directly with hubs on the local network, rather than connecting via the cloud or via RS-485. Devices are represented as a cover for monitoring and control as well as a sensor for monitoring battery condition.
The **Rollease Acmeda Automate** {% term integration %} allows you to control and monitor covers via your Rollease Acmeda Automate hub. The integrations communicates directly with hubs on the local network, rather than connecting via the cloud or via RS-485. Devices are represented as a cover for monitoring and control as well as a sensor for monitoring battery condition.
## Supported devices

4
source/_integrations/actiontec.markdown
View File

@ -2,7 +2,7 @@
title: Actiontec
description: Instructions on how to integrate Actiontec routers into Home Assistant.
ha_category:
- Presence Detection
- Presence detection
ha_iot_class: Local Polling
ha_release: 0.7
ha_domain: actiontec
@ -11,7 +11,7 @@ ha_platforms:
ha_integration_type: integration
---
This platform allows you to detect presence by looking at connected devices to an [Actiontec](https://www.actiontec.com/) device.
The **Actiontec** {% term integration %} allows you to detect presence by looking at connected devices to an [Actiontec](https://www.actiontec.com/) device.
Supported devices (tested):

2
source/_integrations/adax.markdown
View File

@ -14,7 +14,7 @@ ha_platforms:
ha_integration_type: integration
---
Integrates Adax heater into Home Assistant.
The **Adax** {% term integration %} integrates Adax heater into Home Assistant.
You can configure the heaters to use a local or cloud interface.

6
source/_integrations/adguard.markdown
View File

@ -18,14 +18,14 @@ ha_integration_type: service
---
AdGuard Home is a network-wide ad- and tracker-blocking DNS server with parental
control (adult content blocking) capabilities. The AdGuard integration allows
control (adult content blocking) capabilities. The **AdGuard** integration allows
you to control and monitor your AdGuard Home instance in Home Assistant.
{% include integrations/config_flow.md %}
## Sensors
This integration provides sensors for the following information from AdGuard Home:
This integration provides {% term sensors %} for the following information from AdGuard Home:
- Number of DNS queries.
- Number of blocked DNS queries.
@ -60,7 +60,7 @@ AdGuard relies on Query Log to provide stats.
## Services
These services allow one to manage filter subscriptions in AdGuard Home.
These {% term services %} allow one to manage filter subscriptions in AdGuard Home.
Using these services in automations could be helpful to block certain
sites/domains at certain times.

4
source/_integrations/ads.markdown
View File

@ -2,7 +2,7 @@
title: ADS
description: Connect Home Assistant to TwinCAT devices via the ADS interface
ha_category:
- Binary Sensor
- Binary sensor
- Cover
- Hub
- Light
@ -24,7 +24,7 @@ The ADS (automation device specification) describes a device-independent and fie
There is currently support for the following device types within Home Assistant:
- [Binary Sensor](#binary-sensor)
- [Binary sensor](#binary-sensor)
- [Light](#light)
- [Sensor](#sensor)
- [Switch](#switch)

2
source/_integrations/advantage_air.markdown
View File

@ -24,7 +24,7 @@ ha_platforms:
ha_integration_type: integration
---
The Advantage Air integration allows you to control [Advantage Air](https://www.advantageair.com.au/) Air Conditioning controllers into Home Assistant.
The **Advantage Air** {% term integration %} allows you to control [Advantage Air](https://www.advantageair.com.au/) Air Conditioning controllers into Home Assistant.
## Prerequisites

2
source/_integrations/aftership.markdown
View File

@ -2,7 +2,7 @@
title: AfterShip
description: Instructions on how to set up AfterShip sensors within Home Assistant.
ha_category:
- Postal Service
- Postal service
ha_release: 0.85
ha_iot_class: Cloud Polling
ha_domain: aftership

2
source/_integrations/agent_dvr.markdown
View File

@ -26,7 +26,7 @@ You can add Agent DVR via integrations using the IP address and port of the serv
Please ensure you are using Agent DVR v2.6.1.0 +
</div>
## Alarm Control Panel
## Alarm control panel
Reports on the current alarm status and can be used to arm and disarm the system.

2
source/_integrations/airly.markdown
View File

@ -16,7 +16,7 @@ ha_platforms:
ha_integration_type: service
---
The Airly integration uses the [Airly](https://airly.eu/) web service as a source for air quality data for your location.
The **Airly** {% term integration %} uses the [Airly](https://airly.eu/) web service as a source for air quality data for your location.
## Setup

2
source/_integrations/airnow.markdown
View File

@ -15,7 +15,7 @@ ha_platforms:
ha_integration_type: integration
---
The `airnow` integration uses the [AirNow](https://www.airnow.gov/) web service
The **AirNow** {% term integration %} uses the [AirNow](https://www.airnow.gov/) web service
as a source for air quality data for your location.
## Setup

6
source/_integrations/airq.markdown
View File

@ -17,15 +17,15 @@ ha_platforms:
ha_integration_type: hub
---
This integration allows integrating the sensors, provided by your [air-Q](https://www.air-q.com/) device, into Home Assistant.
The **air-Q** {% term integration %} allows integrating the sensors, provided by your [air-Q](https://www.air-q.com/) device, into Home Assistant.
{% include integrations/config_flow.md %}
During the configuration, the user is prompted for the IP address of the device or the first 5 characters of the serial number, as well as the device password.
During the configuration, the user is prompted for the IP address of the {% term device %} or the first 5 characters of the serial number, as well as the device password.
For this integration to communicate with the device, both must be connected to the same Wi-Fi network.
After the setup, separate entities will be created for each of the sensors, found in your device.
After the setup, separate {% term entities %} will be created for each of the {% term sensors %}, found in your {% term device %}.
## Sensors

4
source/_integrations/airthings_ble.markdown
View File

@ -17,9 +17,9 @@ ha_config_flow: true
ha_integration_type: integration
---
Integrates Airthings BLE sensors into Home Assistant.
Integrates Airthings BLE {% term sensors %} into Home Assistant.
[Airthings](https://www.airthings.com/) provide different devices for measuring the air quality. Initially focusing on radon gas sensors, each device provides a number of different sensors to monitor typical contaminants that's presence contributes to bad air quality in the home.
[Airthings](https://www.airthings.com/) provide different {% term devices %} for measuring the air quality. Initially focusing on radon gas sensors, each device provides a number of different sensors to monitor typical contaminants that's presence contributes to bad air quality in the home.
Requires Airthings hardware and a compatible Bluetooth dongle.

4
source/_integrations/airtouch4.markdown
View File

@ -14,7 +14,7 @@ ha_codeowners:
- '@samsinnamon'
---
The AirTouch 4 integration allows you to control Ducted Air Conditioning Systems that are using the [AirTouch 4](https://www.airtouch.net.au/airtouch/airtouch-4/) Controller. Currently, this integration only supports AirTouch 4 controllers with the Individual Temperature Control (ITC) modules.
The **AirTouch 4** {% term integration %} allows you to control Ducted Air Conditioning Systems that are using the [AirTouch 4](https://www.airtouch.net.au/airtouch/airtouch-4/) controller. Currently, this integration only supports AirTouch 4 controllers with the Individual Temperature Control (ITC) modules.
{% include integrations/config_flow.md %}
@ -22,4 +22,4 @@ The AirTouch 4 integration allows you to control Ducted Air Conditioning Systems
### Climate
The integration will create a climate entity for each zone that is temperature-controlled.
The {% term integration %} will create a climate {% term entity %} for each {% term zone %} that is temperature-controlled.

6
source/_integrations/airvisual.markdown
View File

@ -47,11 +47,11 @@ For example, Sao Paulo, Brazil shows a breadcrumb title of `Brazil > Sao Paulo >
- State: `Sao Paulo`
- Country: `Brazil`
## Sensor Types
## Sensor types
When configured, the platform will create three sensors for each air quality standard:
### Air Quality Index
### Air quality index
- **Description:** This sensor displays a numeric air quality index (AQI), a metric for the overall "health" of the air.
- **Example Sensor Name:** `sensor.chinese_air_quality_index`
@ -67,7 +67,7 @@ AQI | Status | Description
201 - 300 | **Very unhealthy** | Health warnings of emergency conditions. The entire population is more likely to be affected
301+ | **Hazardous** | Health alert: everyone may experience more serious health effects
### Air Pollution Level
### Air pollution level
- **Description:** This sensor displays the associated `Status` (from the above table) for the current AQI.
- **Sample Sensor Name:** `sensor.us_air_pollution_level`

4
source/_integrations/airvisual_pro.markdown
View File

@ -15,7 +15,7 @@ ha_platforms:
ha_integration_type: device
---
The AirVisual Pro integration allows users to retrieve data from an [AirVisual Node/Pro unit](https://www.iqair.com/air-quality-monitors/airvisual-pro). Communication with the device occurs over the local network.
The **AirVisual Pro** {% term integration %} allows users to retrieve data from an [AirVisual Node/Pro unit](https://www.iqair.com/air-quality-monitors/airvisual-pro). Communication with the device occurs over the local network.
## Determining the Password
@ -25,7 +25,7 @@ You will need the device's Samba password, which [can be found on the unit](http
## Sensor types
AirVisual Pro devices create a variety of sensors:
AirVisual Pro {% term devices %} create a variety of {% term sensors %}:
- Air Quality Index (AQI)
- Battery Level

12
source/_integrations/airzone.markdown
View File

@ -3,11 +3,11 @@ title: Airzone
description: Instructions on how to integrate Airzone within Home Assistant.
ha_release: 2022.4
ha_category:
- Binary Sensor
- Binary sensor
- Climate
- Select
- Sensor
- Water Heater
- Water heater
ha_iot_class: Local Polling
ha_config_flow: true
ha_domain: airzone
@ -49,7 +49,7 @@ For each Airzone system (HVAC machine), the following *binary sensors* are creat
| :------------------ | :--------------------------------- |
| problems | System has errors or warnings. |
For each Airzone zone (Thermostat), the following *binary sensors* are created:
For each Airzone zone (thermostat), the following *binary sensors* are created:
| Condition | Description |
| :------------------ | :--------------------------------- |
@ -60,7 +60,7 @@ For each Airzone zone (Thermostat), the following *binary sensors* are created:
## Climate
For each Airzone zone (Thermostat) a *climate entity* is created.
For each Airzone zone (thermostat) a *climate entity* is created.
**HVAC mode can only be changed on a *parent zone*.**
@ -68,7 +68,7 @@ For each Airzone zone (Thermostat) a *climate entity* is created.
## Select
For each Airzone zone (Thermostat), the following *selects* are created:
For each Airzone zone (thermostat), the following *selects* are created:
| Condition | Description |
| :------------------ | :--------------------------------- |
@ -90,7 +90,7 @@ For the Airzone WebServer, the following *sensors* are created:
| :------------------ | :--------------------------------- |
| rssi | WiFi RSSI. |
For each Airzone zone (Thermostat), the following *sensors* are created:
For each Airzone zone (thermostat), the following *sensors* are created:
| Condition | Description |
| :------------------ | :--------------------------------- |

2
source/_integrations/airzone_cloud.markdown
View File

@ -3,7 +3,7 @@ title: Airzone Cloud
description: Instructions on how to integrate Airzone Cloud within Home Assistant.
ha_release: 2023.6
ha_category:
- Binary Sensor
- Binary sensor
- Sensor
ha_iot_class: Cloud Polling
ha_config_flow: true

2
source/_integrations/alarm_control_panel.ifttt.markdown
View File

@ -1,5 +1,5 @@
---
title: "IFTTT Alarm Control Panel"
title: "IFTTT Alarm control panel"
description: "Instructions on how to integrate IFTTT-controlled security systems into Home Assistant."
ha_category:
- Alarm

4
source/_integrations/alarm_control_panel.markdown
View File

@ -1,6 +1,6 @@
---
title: Alarm Control Panel
description: Instructions on how to integrate Alarm Control Panels into Home Assistant.
title: Alarm control panel
description: Instructions on how to integrate Alarm control panels into Home Assistant.
ha_category:
- Alarm
ha_release: 0.7.3

4
source/_integrations/alarm_control_panel.mqtt.markdown
View File

@ -1,6 +1,6 @@
---
title: "MQTT Alarm Control Panel"
description: "Instructions on how to integrate MQTT capable Alarm Panels into Home Assistant."
title: "MQTT Alarm control panel"
description: "Instructions on how to integrate MQTT capable alarm panels into Home Assistant."
ha_category:
- Alarm
ha_release: 0.7.4

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

@ -1,6 +1,6 @@
---
title: "Template Alarm Control Panel"
description: "Instructions on how to integrate Template Alarm Control Panels into Home Assistant."
title: "Template Alarm control panel"
description: "Instructions on how to integrate template alarm control panels into Home Assistant."
ha_category:
- Alarm
ha_release: 0.105
@ -23,7 +23,7 @@ In optimistic mode, the alarm control panel will immediately change state after
## Configuration
To enable a Template Alarm Control Panel in your installation, add the following to your `configuration.yaml` file:
To enable a template alarm control panel in your installation, add the following to your `configuration.yaml` file:
{% raw %}
@ -129,6 +129,6 @@ State-based template entities have the special template variable `this` availabl
## Considerations
If you are using the state of an integration that takes extra time to load, the Template Alarm Control Panel may get an `unknown` state during startup. This results in error messages in your log file until that integration has completed loading. If you use `is_state()` function in your template, you can avoid this situation.
If you are using the state of an integration that takes extra time to load, the template alarm control panel may get an `unknown` state during startup. This results in error messages in your log file until that integration has completed loading. If you use `is_state()` function in your template, you can avoid this situation.
For example, you would replace {% raw %}`{{ states.switch.source.state == 'on' }}`{% endraw %} with this equivalent that returns `true`/`false` and never gives an unknown result: {% raw %}`{{ is_state('switch.source', 'on') }}`{% endraw %}

38
source/_integrations/alarmdecoder.markdown
View File

@ -3,7 +3,7 @@ title: AlarmDecoder
description: Instructions on how to integrate a DSC/Honeywell alarm panel with Home Assistant using an AlarmDecoder device.
ha_category:
- Alarm
- Binary Sensor
- Binary sensor
- Sensor
ha_release: 0.43
ha_iot_class: Local Push
@ -16,17 +16,17 @@ ha_platforms:
ha_integration_type: integration
---
The `alarmdecoder` integration will allow Home Assistant users who own either a DSC or Honeywell alarm panel to leverage their alarm system and its sensors to provide Home Assistant with rich information about their homes. Connectivity between Home Assistant and the alarm panel is accomplished through a device produced by Nu Tech Software Solutions, known as the AlarmDecoder. The AlarmDecoder devices provide a serial, TCP/IP socket or USB interface to the alarm panel, where it emulates an alarm keypad.
The **AlarmDecoder** {% term integration %} will allow Home Assistant users who own either a DSC or Honeywell alarm panel to leverage their alarm system and its sensors to provide Home Assistant with rich information about their homes. Connectivity between Home Assistant and the alarm panel is accomplished through a device produced by Nu Tech Software Solutions, known as the AlarmDecoder. The AlarmDecoder devices provide a serial, TCP/IP socket or USB interface to the alarm panel, where it emulates an alarm keypad.
Please visit the [AlarmDecoder website](https://www.alarmdecoder.com/) for further information about the AlarmDecoder devices.
There is currently support for the following device types within Home Assistant:
There is currently support for the following {% term device %} types within Home Assistant:
- [Alarm Control Panel](#alarm-control-panel): Reports on alarm status, and can be used to arm/disarm the system
- [Alarm control panel](#alarm-control-panel): Reports on alarm status, and can be used to arm/disarm the system
- Sensor: Emulates a keypad display
- Binary Sensor: Reports on zone status
- Binary sensor: Reports on zone status
This is a fully event-based integration. Any event sent by the AlarmDecoder device will be immediately reflected within Home Assistant.
This is a fully event-based integration. Any {% term event %} sent by the AlarmDecoder device will be immediately reflected within Home Assistant.
{% include integrations/config_flow.md %}
@ -55,25 +55,25 @@ There are currently 3 arming settings for AlarmDecoder (shown below).
Zones can be added, edited, and removed through the option forms.
Each zone that's added to AlarmDecoder will have its own [binary sensor](https://www.home-assistant.io/integrations/binary_sensor/) created.
Each {% term zone %} that's added to AlarmDecoder will have its own [binary sensor](https://www.home-assistant.io/integrations/binary_sensor/) created.
#### Adding a New Zone
#### Adding a new zone
When prompted, enter the number of the zone you'd like to add. Press _Submit_ to move to the next screen where you'll be prompted for the [zone settings](#zone-settings). Press _Submit_ again to save.
When prompted, enter the number of the {% term zone %} you'd like to add. Select _Submit_ to move to the next screen, where you'll be prompted for the [zone settings](#zone-settings). Select _Submit_ again to save.
**Note:** The zone number that was entered will appear as an attribute on the binary sensor entity that's created in order to easily edit the zone settings at a later time.
#### Editing an Existing Zone
#### Editing an existing zone
When prompted, enter the number of the zone you'd like to edit. Press _Submit_ to move to the next screen where the existing zone settings will be pre-filled. Edit the zone settings and press _Submit_ to save the changes.
When prompted, enter the number of the {% term zone %} you'd like to edit. Select _Submit_ to move to the next screen, where the existing zone settings will be pre-filled. Edit the zone settings and select _Submit_ to save the changes.
#### Removing an Existing Zone
#### Removing an existing zone
When prompted, enter the number of the zone you'd like to remove. Press _Submit_ to move to the next screen where the existing zone settings will be pre-filled. Clear the _Zone Name_ field and press _Submit_.
When prompted, enter the number of the {% term zone %} you'd like to remove. Select _Submit_ to move to the next screen, where the existing zone settings will be pre-filled. Clear the _Zone Name_ field and select _Submit_.
#### Zone settings
The settings for zones are described below:
The settings for {% term zone %} are described below:
- **Zone Name** - a name for the zone
- **Zone Type** - the type of sensor (see [Device Classes](https://www.home-assistant.io/integrations/binary_sensor/#device-class))
@ -82,7 +82,7 @@ The settings for zones are described below:
- **Relay Address** - (optional) Address of the relay or zone expander board to associate with the zone. (ex: 12, 13, 14, or 15). Typically used in cases where a panel will not send bypassed zones such as motion during an armed home state, the Vista 20P is an example of this. AlarmDecoder can emulate a zone expander board and the panel can be programmed to push zone events to this virtual expander. This allows the bypassed zone binary sensors to be utilized. One example is using bypassed motion sensors at night for motion-based automated lights while the system is armed with the motion sensor bypassed.
- **Relay Channel** - (optional) Channel of the relay or zone expander board to associate with the zone. (ex: 1, 2, 3, or 4 for relay expander boards, 1 - 8 for zone expander boards)
## Alarm Control Panel
## Alarm control panel
There are several attributes available on the alarm panel to give you more information about your alarm.
@ -100,7 +100,7 @@ There are several attributes available on the alarm panel to give you more infor
## Services
The Alarm Decoder integration gives you access to several services for you to control your alarm with.
The **Alarm Decoder** {% term integration %} gives you access to several {% term services %} for you to control your alarm with.
- `alarm_arm_away`: Arms the alarm in away mode; all faults will trigger the alarm.
- `alarm_arm_home`: Arms the alarm in stay mode; faults to the doors or windows will trigger the alarm.
@ -117,9 +117,9 @@ The Alarm Decoder integration gives you access to several services for you to co
### Examples
Using a combination of the available services and attributes, you can create switch templates.
Using a combination of the available {% term services %} and attributes, you can create switch templates.
### Chime Status and Control
### Chime status and control
{% raw %}
@ -159,7 +159,7 @@ Using a combination of the available services and attributes, you can create swi
{% endraw %}
## Arming Key Sequences
## Arming key sequences
The tables below show the key press sequences used for arming for the different panel brands and configuration setting combinations. They are taken from the [adext](https://pypi.org/project/adext/) PyPI package.

4
source/_integrations/alert.markdown
View File

@ -149,7 +149,7 @@ alert:
- john_phone_sms
```
### Complex Alert Criteria
### Complex alert criteria
By design, the `alert` integration only handles very simple criteria for firing.
That is, it only checks if a single entity's state is equal to a value. At some
@ -184,7 +184,7 @@ This example will begin firing as soon as the entity `sensor.motion`'s `battery`
attribute falls below 15. It will continue to fire until the battery attribute
raises above 15 or the alert is acknowledged on the frontend.
### Dynamic Notification Delay Times
### Dynamic notification delay times
It may be desirable to have the delays between alert notifications dynamically
change as the alert continues to fire. This can be done by setting the `repeat`

20
source/_integrations/alexa.smart_home.markdown
View File

@ -41,7 +41,7 @@ Steps to Integrate an Amazon Alexa Smart Home Skill with Home Assistant:
- [Account Linking](#account-linking)
- [Alexa Smart Home Integration Configuration](#alexa-smart-home-integration-configuration)
- [Supported Platforms](#supported-platforms)
- [Alarm Control Panel](#alarm-control-panel)
- [Alarm control panel](#alarm-control-panel)
- [Arming](#arming)
- [Disarming](#disarming)
- [Alert, Automation, Group](#alert-automation-group)
@ -458,7 +458,7 @@ Home Assistant supports the following integrations through Alexa using a Smart H
The following platforms are currently supported:
- [Alarm Control Panel](#alarm-control-panel)
- [Alarm control panel](#alarm-control-panel)
- [Arming](#arming)
- [Disarming](#disarming)
- [Alert, Automation, Group](#alert-automation-group)
@ -510,9 +510,9 @@ The following platforms are currently supported:
- [Timer](#timer)
- [Vacuum](#vacuum)
### Alarm Control Panel
### Alarm control panel
Arm and disarm Alarm Control Panel entities. Ask Alexa for the state of the Alarm Control Panel entity.
Arm and disarm Alarm control panel entities. Ask Alexa for the state of the alarm control panel entity.
- _"Alexa, arm my home in away mode."_
- _"Alexa, arm my home."_
@ -521,27 +521,27 @@ Arm and disarm Alarm Control Panel entities. Ask Alexa for the state of the Alar
#### Arming
The Alarm Control Panel state must be in the `disarmed` state before arming. Alexa does not support switching from an armed state without first disarming, e.g., switching from `armed_home` to `armed_night`.
The alarm control panel state must be in the `disarmed` state before arming. Alexa does not support switching from an armed state without first disarming, e.g., switching from `armed_home` to `armed_night`.
The Alarm Control Panel state `armed_custom_bypass` isn't supported by Alexa and is treated as `armed_home`.
The alarm control panel state `armed_custom_bypass` isn't supported by Alexa and is treated as `armed_home`.
<div class="note">
Alexa does not support arming with voice PIN at this time. Therefore if the Alarm Control Panel requires a `code` for arming or the `code_arm_required` attribute is `true`, the entity will not be exposed during discovery.
The Alarm Control Panel may default the `code_arm_required` attribute to `true` even if the platform does not support or require it. Use the [Entity Customization Tool](/docs/configuration/customizing-devices/#customization-using-the-ui) to override `code_arm_required` to `false` and expose the Alarm Control Panel during discovery.
Alexa does not support arming with voice PIN at this time. Therefore if the alarm control panel requires a `code` for arming or the `code_arm_required` attribute is `true`, the entity will not be exposed during discovery.
The alarm control panel may default the `code_arm_required` attribute to `true` even if the platform does not support or require it. Use the [entity customization tool](/docs/configuration/customizing-devices/#customization-using-the-ui) to override `code_arm_required` to `false` and expose the alarm control panel during discovery.
</div>
#### Disarming
Users must opt-in to the disarm by voice feature in the Alexa App. Alexa will require a 4 digit voice personal identification number (PIN) for disarming. Configure a 4 digit PIN in the Alexa app, or use an existing 4 digit PIN code configured for the Alarm Control Panel.
Users must opt-in to the disarm by voice feature in the Alexa App. Alexa will require a 4 digit voice personal identification number (PIN) for disarming. Configure a 4 digit PIN in the Alexa app, or use an existing 4 digit PIN code configured for the alarm control panel.
<p class='img'>
<a href='/images/integrations/alexa/alexa_app_security_system_pin.png' target='_blank'>
<img height='460' src='/images/integrations/alexa/alexa_app_security_system_pin.png' alt='Screenshot: Alexa App Security System PIN'/></a>
</p>
To use the existing code configured for the Alarm Control Panel the `code` must be 4 digits and the `code_format` attribute must be `number`. After discovery, the Alexa app will offer the ability to use the existing `code`, or create an additional 4 digit PIN to use with Alexa.
To use the existing code configured for the alarm control panel the `code` must be 4 digits and the `code_format` attribute must be `number`. After discovery, the Alexa app will offer the ability to use the existing `code`, or create an additional 4 digit PIN to use with Alexa.
The existing code is never communicated to Alexa from Home Assistant. During disarming, Alexa will ask for a PIN. The PIN spoken to Alexa is relayed to Home Assistant and passed to the `alarm_control_panel.alarm_disarm` service. If the `alarm_control_panel.alarm_disarm` service fails for any reason, it is assumed the PIN was incorrect and reported to Alexa as an invalid PIN.

6
source/_integrations/amberelectric.markdown
View File

@ -18,11 +18,11 @@ ha_integration_type: integration
[Amber](https://www.amber.com.au/) is an Australian electricity retailer that provides access to wholesale electricity prices. Customers monitor the wholesale price and shift their energy usage to cheaper, greener times. This saves them money and supports the shift to a more renewably-powered Australia.
Using this integration, customers can go a step further - setting up devices to automatically shift energy usage to cheaper and greener times, based on real-time electricity prices and forecasts
Using the **Amber Electric** {% term integration %}, customers can go a step further - setting up devices to automatically shift energy usage to cheaper and greener times, based on real-time electricity prices and forecasts
## Getting an API Key
To use this integration, you will need to generate an API key.
To use this {% term integration %}, you will need to generate an API key.
1. Login to your Amber account at: <https://app.amber.com.au>
2. Click _Settings_
@ -41,7 +41,7 @@ Prices are split up into three channel types:
- **Controlled Load** - A special channel that is only activated during off-peak times. Often electric hot water systems are connected to the controlled load channel.
- **Feed In** - A channel that records exported power from solar panels and batteries.
It exposes the following sensors for each channel type:
It exposes the following {% term sensors %} for each channel type:
- **Price** - Your current electricity price in $/kWh
- **Forecast** - The forecasted prices for the next 12 hours

2
source/_integrations/ambiclimate.markdown
View File

@ -45,7 +45,7 @@ Note that you have to select manual mode from the Ambiclimate app to be able to
{% include integrations/config_flow.md %}
## Integration services
## Integration {% term services %}
Enable comfort mode on your AC:

4
source/_integrations/ambient_station.markdown
View File

@ -16,12 +16,12 @@ ha_platforms:
ha_integration_type: hub
---
The `Ambient Weather Station` integration retrieves local weather information
The **Ambient Weather Station** {% term integration %} retrieves local weather information
via personal weather stations from [Ambient Weather](https://ambientweather.net).
## Prerequisites
Using this integration requires both an Application Key and an API Key. To
Using this {% term integration %} requires both an Application Key and an API Key. To
generate both, simply utilize the profile section of
[your Ambient Weather dashboard](https://dashboard.ambientweather.net).

22
source/_integrations/amcrest.markdown
View File

@ -2,7 +2,7 @@
title: Amcrest
description: Instructions on how to integrate Amcrest (or Dahua) IP cameras within Home Assistant.
ha_category:
- Binary Sensor
- Binary sensor
- Camera
- Hub
- Sensor
@ -21,9 +21,9 @@ ha_integration_type: integration
The `amcrest` camera platform allows you to integrate your [Amcrest](https://amcrest.com/) or Dahua IP camera or doorbell in Home Assistant.
There is currently support for the following device types within Home Assistant:
There is currently support for the following {% term device %} types within Home Assistant:
- Binary Sensor
- Binary sensor
- Camera
- Sensor
@ -167,13 +167,13 @@ Newer Amcrest firmware may not work, then `rtsp` is recommended instead.
make sure to follow the steps mentioned at [FFmpeg](/integrations/ffmpeg/)
documentation to install the `ffmpeg`.
### Streaming vs Polled Binary Sensors
### Streaming vs polled binary sensors
Some binary sensors provide two choices for method of operation: streaming or polled. Streaming is more responsive and causes less network traffic because the camera will tell Home Assistant when the sensor's state has changed. Polled mode queries the camera periodically (every five seconds) to check the state of the sensor. Therefore streaming is the better option. However, some camera models and versions of camera firmware do not seem to implement the streaming method properly. Therefore the polled mode is also available. It is recommended to use the streaming mode (e.g., `motion_detected`) first, and if that doesn't work (e.g., results in constant errors), then try the polled mode instead (e.g., `motion_detected_polled`.)
## Events
Once loaded, the Amcrest integration will generate (Home Assistant) events when it receives event notifications in the stream sent by the camera. This is only possible if the camera model and firmware implement the streaming method (see [above](#streaming-vs-polled-binary-sensors)). The event type is `amcrest` and the data is as follows:
Once loaded, the Amcrest integration will generate (Home Assistant) {% term events %} when it receives event notifications in the stream sent by the camera. This is only possible if the camera model and firmware implement the streaming method (see [above](#streaming-vs-polled-binary-sensors)). The event type is `amcrest` and the data is as follows:
```json
{
@ -190,9 +190,9 @@ The event code is sent by Amcrest or Dahua devices in the payload as a "Code" me
## Services
Once loaded, the `amcrest` integration will expose services that can be called to perform various actions. The `entity_id` service attribute can specify one or more specific cameras, or `all` can be used to specify all configured Amcrest cameras.
Once loaded, the `amcrest` integration will expose {% term services %} that can be called to perform various actions. The `entity_id` service attribute can specify one or more specific cameras, or `all` can be used to specify all configured Amcrest cameras.
Available services:
Available {% term services %}:
`enable_audio`, `disable_audio`,
`enable_motion_recording`, `disable_motion_recording`,
`enable_recording`, `disable_recording`,
@ -202,7 +202,7 @@ Available services:
### Service `enable_audio`/`disable_audio`
These services enable or disable the camera's audio stream.
These {% term services %} enable or disable the camera's audio stream.
Service data attribute | Optional | Description
-|-|-
@ -210,7 +210,7 @@ Service data attribute | Optional | Description
### Service `enable_motion_recording`/`disable_motion_recording`
These services enable or disable the camera to record a clip to its configured storage location when motion is detected.
These {% term services %} enable or disable the camera to record a clip to its configured storage location when motion is detected.
Service data attribute | Optional | Description
-|-|-
@ -424,9 +424,9 @@ amcrest:
- ptz_preset
```
## Example Automation to Detect Button Presses on AD110 and AD410 Doorbells
## Example automation to detect button presses on AD110 and AD410 doorbells
Using this trigger in an automation will allow you to detect the press of the doorbell call button and create automations based upon it.
Using this {% term trigger %} in an {% term automation %} will allow you to detect the press of the doorbell call button and create automations based upon it.
```yaml
# Example automations.yaml entry

12
source/_integrations/android_ip_webcam.markdown
View File

@ -2,7 +2,7 @@
title: Android IP Webcam
description: Connect Android devices as an IP webcam to Home Assistant
ha_category:
- Binary Sensor
- Binary sensor
- Camera
- Hub
- Sensor
@ -21,13 +21,13 @@ ha_codeowners:
- '@engrbm87'
---
The Android IP Webcam integration connects with Android IP Webcam to turn any Android phone or tablet into a network camera with multiple viewing options.
The **Android IP Webcam** {% term integration %} connects with Android IP Webcam to turn any Android phone or tablet into a network camera with multiple viewing options.
The integration is setup as an MJPEG camera with all settings as switches inside Home Assistant. You can also integrate the sensors exposed by the app. If you have multiple phones, you can use all options inside a list.
The {% term integration %} is setup as an MJPEG camera with all settings as switches inside Home Assistant. You can also integrate the sensors exposed by the app. If you have multiple phones, you can use all options inside a list.
There is currently support for the following device types within Home Assistant:
There is currently support for the following {% term device %} types within Home Assistant:
- Binary Sensor
- Binary sensor
- Camera
- Sensor
- Switch
@ -40,6 +40,6 @@ Download [Android IP Webcam app](https://play.google.com/store/apps/details?id=c
<div class='note'>
You need to enable logging in the Android app (`Data logging` > `Enable data logging`) if you wish to see the sensor states in Home Assistant. The sensor states stay as `unknown`, until this is enabled.
You need to enable logging in the Android app (`Data logging` > `Enable data logging`) if you wish to see the sensor states in Home Assistant. The {% term sensor %} {% term states %} stay as `unknown`, until this is enabled.
</div>

12
source/_integrations/androidtv.markdown
View File

@ -2,7 +2,7 @@
title: Android Debug Bridge
description: Instructions on how to integrate Android and Fire TV devices into Home Assistant.
ha_category:
- Media Player
- Media player
ha_release: 0.7.6
ha_config_flow: true
ha_iot_class: Local Polling
@ -16,11 +16,11 @@ ha_platforms:
ha_integration_type: device
---
The Android Debug Bridge integration allows you to control an Android device or [Amazon Fire TV](https://www.amazon.com/b/?node=8521791011) device.
The **Android Debug Bridge** {% term integration %} allows you to control an Android device or [Amazon Fire TV](https://www.amazon.com/b/?node=8521791011) device.
<div class='note'>
When setting up this integration, it is recommended that you do NOT use an ADB server and instead use the built-in Python ADB implementation. This simplifies the setup and makes it easier to troubleshoot issues. If there are stability issues with this approach, then you may wish to try using an ADB server. See the [ADB Setup](#adb-setup) section for more information.
When setting up this {% term integration %}, it is recommended that you do NOT use an ADB server and instead use the built-in Python ADB implementation. This simplifies the setup and makes it easier to troubleshoot issues. If there are stability issues with this approach, then you may wish to try using an ADB server. See the [ADB Setup](#adb-setup) section for more information.
</div>
@ -108,7 +108,7 @@ If the setup for your Android or Fire TV device fails, then there is probably an
5. Some Android devices (e.g., Philips TVs running Android TV) only accept the initial ADB connection request over their Wi-Fi interface. If you have the TV wired, you need to connect it to Wi-Fi and try the initial connection again. Once the authentication has been granted via Wi-Fi, you can connect to the TV over the wired interface as well.
6. If your device drops off WiFi, breaking the ADB connection and causing the entity to become unavailable in Home Assistant, you could install a wake lock utility (such as [Wakelock](https://github.com/d4rken/wakelock-revamp)) to prevent this from happening. Some users have reported this problem with Xiaomi Mi Box devices.
6. If your device drops off WiFi, breaking the ADB connection and causing the {% term entity %} to become unavailable in Home Assistant, you could install a wake lock utility (such as [Wakelock](https://github.com/d4rken/wakelock-revamp)) to prevent this from happening. Some users have reported this problem with Xiaomi Mi Box devices.
7. If you are using the [Python ADB implementation](#1-python-adb-implementation) approach, as mentioned above, there may be some issues with newer devices. In this case, you should use the [ADB server](#2-adb-server) approach instead.
@ -227,9 +227,9 @@ Similarly, you can use the `androidtv.upload` service to upload a file from Home
| `device_path` | no | The filepath on the Android / Fire TV device.
| `local_path` | no | The filepath on your Home Assistant instance.
## Custom State Detection
## Custom state detection
The Android Debug Bridge integration works by polling the Android / Fire TV device at a regular interval and collecting a handful of properties. Unfortunately, there is no standard API for determining the state of the device to which all apps adhere. Instead, the backend `androidtv` package uses three of the properties that it collects to determine the state: `audio_state`, `media_session_state`, and `wake_lock_size`. The correct logic for determining the state differs depending on the current app, and the backend `androidtv` package implements app-specific state detection logic for a handful of apps. Of course, it is not feasible to implement custom logic for each and every app in the `androidtv` package. Moreover, the correct state detection logic may differ across devices and device configurations.
The Android Debug Bridge {% term integration %} works by polling the Android / Fire TV device at a regular interval and collecting a handful of properties. Unfortunately, there is no standard API for determining the state of the device to which all apps adhere. Instead, the backend `androidtv` package uses three of the properties that it collects to determine the state: `audio_state`, `media_session_state`, and `wake_lock_size`. The correct logic for determining the state differs depending on the current app, and the backend `androidtv` package implements app-specific state detection logic for a handful of apps. Of course, it is not feasible to implement custom logic for each and every app in the `androidtv` package. Moreover, the correct state detection logic may differ across devices and device configurations.
The solution to this problem is the `state_detection_rules` configuration parameter, which allows you to provide your own rules for state detection. The keys are app IDs, and the values are lists of rules that are evaluated in order. Valid rules are:

8
source/_integrations/androidtv_remote.markdown
View File

@ -2,7 +2,7 @@
title: Android TV Remote
description: Instructions on how to integrate Android TV Remote into Home Assistant.
ha_category:
- Media Player
- Media player
- Remote
ha_release: 2023.5
ha_iot_class: Local Push
@ -20,7 +20,7 @@ ha_platforms:
ha_integration_type: device
---
The Android TV Remote integration allows you to control an Android TV and launching apps. For this to work the Android TV device needs to have [Android TV Remote Service](https://play.google.com/store/apps/details?id=com.google.android.tv.remote.service) which is pre-installed on most devices (Fire TV devices are a notable exception).
The **Android TV Remote** {% term integration %} allows you to control an Android TV and launching apps. For this to work, the Android TV device needs to have [Android TV Remote Service](https://play.google.com/store/apps/details?id=com.google.android.tv.remote.service) which is pre-installed on most devices (Fire TV devices are a notable exception).
For a quick introduction on how to get started with Android TV Remote, check out this video:
@ -30,7 +30,7 @@ For a quick introduction on how to get started with Android TV Remote, check out
## Media player
This integration adds a `media_player` with basic playback and volume controls. The media player provides volume information and display name of current active app on the Android TV. Due to API limitations, the integration will not display the playback status. It is recommended to use this integration together with [Google Cast integration](/integrations/cast/). Two media players can be combined into one using the [Universal Media Player](/integrations/universal/) integration. See [Using with Google Cast](#using-with-google-cast) section for more details.
This {% term integration %} adds a `media_player` with basic playback and volume controls. The media player provides volume information and display name of current active app on the Android TV. Due to API limitations, the integration will not display the playback status. It is recommended to use this integration together with [Google Cast integration](/integrations/cast/). Two media players can be combined into one using the [Universal Media Player](/integrations/universal/) integration. See [Using with Google Cast](#using-with-google-cast) section for more details.
Using the `media_player.play_media` service, you can launch applications via `Deep Links` and switch channels. Only `url` and `channel` media types are supported.
@ -88,7 +88,7 @@ target:
### Using with Google Cast
Android TV Remote integration provides information about the power status of the device and gives you the ability to control playback. However, it does not provide information about the currently playing content (media title, duration, play/pause state, etc.). In turn, [Google Cast](/integrations/cast/) integration does not provide reliable information about the power status of the device (e.g. on Android TV Home Screen) and does not allow to control playback in Android apps without [MediaSession](https://developer.android.com/reference/android/media/session/MediaSession) support. However, it can display full information about the content being played in supported apps. For convenience, you can combine two media players into one using [Universal Media Player](/integrations/universal/) integration. Universal Media Player will automatically select the appropriate active media player entity.
Android TV Remote {% term integration %} provides information about the power status of the device and gives you the ability to control playback. However, it does not provide information about the currently playing content (media title, duration, play/pause state, etc.). In turn, [Google Cast](/integrations/cast/) integration does not provide reliable information about the power status of the device (e.g. on Android TV Home Screen) and does not allow to control playback in Android apps without [MediaSession](https://developer.android.com/reference/android/media/session/MediaSession) support. However, it can display full information about the content being played in supported apps. For convenience, you can combine two media players into one using [Universal Media Player](/integrations/universal/) integration. Universal Media Player will automatically select the appropriate active media player entity.
{% details "Example YAML configuration" %}

2
source/_integrations/anthemav.markdown
View File

@ -2,7 +2,7 @@
title: Anthem A/V Receivers
description: Instructions on how to integrate Anthem A/V Receivers into Home Assistant.
ha_category:
- Media Player
- Media player
ha_iot_class: Local Push
ha_release: 0.37
ha_domain: anthemav

4
source/_integrations/apache_kafka.markdown
View File

@ -11,13 +11,13 @@ ha_iot_class: Local Push
ha_integration_type: integration
---
The `apache_kafka` integration sends all state changes to a
The **Apache Kafka** {% term integration %} sends all state changes to a
[Apache Kafka](https://kafka.apache.org/) topic.
Apache Kafka is a real-time data pipeline that can read and write streams of data. It
stores its data safely in a distributed, replicated, fault-tolerant cluster.
To use the `apache_kafka` integration in your installation, add the following to your
To use the **Apache Kafka** {% term integration %} in your installation, add the following to your
`configuration.yaml` file:
```yaml

6
source/_integrations/apcupsd.markdown
View File

@ -2,9 +2,9 @@
title: APC UPS Daemon
description: Instructions on how to integrate apcupsd status with Home Assistant.
ha_category:
- Binary Sensor
- Binary sensor
- Sensor
- System Monitor
- System monitor
ha_release: 0.13
ha_iot_class: Local Polling
ha_domain: apcupsd
@ -21,7 +21,7 @@ ha_integration_type: integration
There is currently support for the following device types within Home Assistant:
- [Binary Sensor](#binary-sensor)
- [Binary sensor](#binary-sensor)
- [Sensor](#sensors)
## Home Assistant add-on installation

2
source/_integrations/apple_tv.markdown
View File

@ -2,7 +2,7 @@
title: Apple TV
description: Instructions on how to integrate Apple TV devices into Home Assistant.
ha_category:
- Media Player
- Media player
- Multimedia
- Remote
ha_iot_class: Local Push

2
source/_integrations/aprs.markdown
View File

@ -3,7 +3,7 @@ title: APRS
description: Instructions on how to use APRS to track devices in Home Assistant.
ha_release: 0.95
ha_category:
- Presence Detection
- Presence detection
ha_iot_class: Cloud Push
ha_codeowners:
- '@PhilRW'

2
source/_integrations/aquostv.markdown
View File

@ -2,7 +2,7 @@
title: Sharp Aquos TV
description: Instructions on how to integrate a Sharp Aquos TV into Home Assistant.
ha_category:
- Media Player
- Media player
ha_release: 0.35
ha_iot_class: Local Polling
ha_domain: aquostv

2
source/_integrations/arcam_fmj.markdown
View File

@ -2,7 +2,7 @@
title: Arcam FMJ Receivers
description: Instructions on how to integrate Arcam FMJ Receivers into Home Assistant.
ha_category:
- Media Player
- Media player
ha_release: 0.96
ha_iot_class: Local Polling
ha_config_flow: true

4
source/_integrations/arest.markdown
View File

@ -2,7 +2,7 @@
title: aREST
description: Instructions on how to integrate aREST within Home Assistant.
ha_category:
- Binary Sensor
- Binary sensor
- DIY
- Sensor
- Switch
@ -18,7 +18,7 @@ ha_integration_type: integration
There is currently support for the following device types within Home Assistant:
- [Binary Sensor](#binary-sensor)
- [Binary sensor](#binary-sensor)
- [Sensor](#sensor)
- [Switch](#switch)

2
source/_integrations/arris_tg2492lg.markdown
View File

@ -2,7 +2,7 @@
title: Arris TG2492LG
description: Instructions on how to integrate Arris TG2492LG routers into Home Assistant.
ha_category:
- Presence Detection
- Presence detection
ha_release: 0.109
ha_domain: arris_tg2492lg
ha_codeowners:

2
source/_integrations/aruba.markdown
View File

@ -2,7 +2,7 @@
title: Aruba
description: Instructions on how to integrate Aruba routers into Home Assistant.
ha_category:
- Presence Detection
- Presence detection
ha_release: 0.7
ha_iot_class: Local Polling
ha_domain: aruba

2
source/_integrations/asuswrt.markdown
View File

@ -3,7 +3,7 @@ title: ASUSWRT
description: Instructions on how to integrate ASUSWRT into Home Assistant.
ha_category:
- Hub
- Presence Detection
- Presence detection
- Sensor
ha_release: 0.83
ha_config_flow: true

6
source/_integrations/atag.markdown
View File

@ -4,7 +4,7 @@ description: Instructions on how to setup Atag integration.
ha_category:
- Climate
- Sensor
- Water Heater
- Water heater
ha_release: 0.109
ha_iot_class: Local Polling
ha_domain: atag
@ -22,7 +22,7 @@ The `Atag` integration allows Home Assistant to connect to [Atag One](https://ww
The integration implements the following platforms:
- Climate
- Water Heater
- Water heater
- Sensor
{% include integrations/config_flow.md %}
@ -64,7 +64,7 @@ Currently selection of custom timeframes in Extend, Away and boost modes is not
## Water heater
The Water Heater reports current and target temperature for Domestic Hot Water demand, as well as boiler status (heating or idle). This can be used to detect hot water demand, such as a running shower or tap water.
The water heater reports current and target temperature for Domestic Hot Water demand, as well as boiler status (heating or idle). This can be used to detect hot water demand, such as a running shower or tap water.
Setting target values is currently not supported.
## Sensor

10
source/_integrations/august.markdown
View File

@ -2,7 +2,7 @@
title: August
description: Instructions on how to integrate your August devices into Home Assistant.
ha_category:
- Binary Sensor
- Binary sensor
- Button
- Camera
- Doorbell
@ -29,7 +29,7 @@ The `august` integration allows you to integrate your [August](https://august.co
{% include integrations/config_flow.md %}
## Known Working Devices
## Known working devices
| Device | Requires [Connect Bridge](https://august.com/products/august-connect/) or Doorbell |
| --------------------------------- | ------------------------------------|
@ -52,7 +52,7 @@ Other devices not listed above have not been tested and may not function as expe
There is currently support for the following device types within Home Assistant:
- Doorbell
- Binary Sensor
- Binary sensor
- Button
- Sensor
- Camera
@ -62,7 +62,7 @@ There is currently support for the following device types within Home Assistant:
Most devices will need either August Connect Bridge or Doorbell to connect to Home Assistant.
</div>
## Known Issues with battery reporting
## Known issues with battery reporting
The August Wi-Fi Smart Lock (Gen 4) uses different battery technology (lithium-ion) than the other locks. The battery charge value reported by the lock detail API has frequently been reported as incorrect for these models.
@ -130,7 +130,7 @@ For locks that support the Yale Access system, the August integration can keep y
- If you do not know which account has the offline keys, configure August integration with each different Owner account until you find the one that holds the keys. You may need to make a new owner account and grant the account access to your lock to force the keys to synchronize with the cloud service.
- Ensure the lock is in range and discoverable by the [Yale Access Bluetooth integration](/integrations/yalexs_ble).
## Presence Detection with Lock Operation
## Presence detection with lock operation
Using the lock operation sensors, you can detect when a user operates a lock and is physically present (not remote). The below automation example (added to `automations.yaml`) will trigger when the user named “John Doe” in August locks or unlocks the door from the keypad (if present), via Bluetooth from their phone, or by auto-unlock. The state of the sensor will be the name of the party operating the lock as returned by August.

2
source/_integrations/august_ble.markdown
View File

@ -2,7 +2,7 @@
title: August Bluetooth
description: Connect and control your August Bluetooth devices using the Yale Access Bluetooth integration
ha_category:
- Binary Sensor
- Binary sensor
- Lock
- Sensor
ha_release: 2022.9

4
source/_integrations/aws.markdown
View File

@ -102,7 +102,7 @@ context:
type: string
{% endconfiguration %}
## Lambda Notify Usage
## Lambda notify usage
AWS Lambda is a notification platform and thus can be controlled by calling the `notify` service [as described here](/integrations/notify/). It will invoke a Lambda for all targets given in the notification payload. A target can be formatted as a function name, an entire ARN ([Amazon Resource Name](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html)) or a partial ARN. For more information, please see the [botocore documentation](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/services/lambda/client/invoke.html).
@ -130,7 +130,7 @@ The context will look like this:
}
```
## SNS Notify Usage
## SNS notify usage
AWS SNS is a notification platform and thus can be controlled by calling the `notify` service [as described here](/integrations/notify/). It will publish a message to all targets given in the notification payload. A target must be a SNS topic or endpoint ARN ([Amazon Resource Name](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html)). For more information, please see the [botocore documentation](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/services/sns/client/publish.html).

2
source/_integrations/axis.markdown
View File

@ -2,7 +2,7 @@
title: Axis
description: Integration between network devices from Axis Communications with Home Assistant.
ha_category:
- Binary Sensor
- Binary sensor
- Camera
- Light
- Switch