mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-12-10 00:30:02 -06:00
Standardize integration docs: H integrations (#42488)
This commit is contained in:
smarthome-10
GitHub
parent
dc8d3e67d6
commit
963dc4163d
@ -11,7 +11,7 @@ ha_domain: api
|
||||
ha_integration_type: system
|
||||
---
|
||||
|
||||
The `api` {% term integration %} exposes a RESTful API and allows one to interact with a Home Assistant instance that is running headless. This integration depends on the [HTTP integration](/integrations/http/).
|
||||
The **Home Assistant API** {% term integration %} exposes a RESTful API and allows one to interact with a Home Assistant instance that is running headless. This integration depends on the [HTTP integration](/integrations/http/).
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
||||
@ -35,7 +35,7 @@ related:
|
||||
ha_quality_scale: platinum
|
||||
---
|
||||
|
||||
The Habitica {% term integration %} enables you to monitor your adventurer's progress and stats from [Habitica](https://habitica.com/) in Home Assistant and seamlessly integrates your to-do's, daily tasks, and many more things.
|
||||
The **Habitica** {% term integration %} enables you to monitor your adventurer's progress and stats from [Habitica](https://habitica.com/) in Home Assistant and seamlessly integrates your to-do's, daily tasks, and many more things.
|
||||
|
||||
## About Habitica
|
||||
|
||||
|
||||
@ -11,6 +11,6 @@ ha_domain: hardware
|
||||
ha_integration_type: system
|
||||
---
|
||||
|
||||
The Hardware {% term integration %} provides an API which offers information about certain board types, USB dongles, and resource usage.
|
||||
The **Hardware** {% term integration %} provides an API which offers information about certain board types, USB dongles, and resource usage.
|
||||
|
||||
This integration is enabled by default.
|
||||
|
||||
@ -15,7 +15,7 @@ related:
|
||||
ha_quality_scale: legacy
|
||||
---
|
||||
|
||||
The `harman_kardon_avr` platform allows you to control Harman Kardon Network Receivers from Home Assistant.
|
||||
The **Harman Kardon AVR** {% term integration %} allows you to control Harman Kardon Network Receivers from Home Assistant.
|
||||
|
||||
Supported devices:
|
||||
|
||||
|
||||
@ -23,7 +23,7 @@ ha_codeowners:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
Supervisor integration allows you to monitor and control Supervisor add-ons and operating system from Home Assistant.
|
||||
The **Home Assistant Supervisor** {% term integration %} allows you to monitor and control Supervisor add-ons and operating system from Home Assistant.
|
||||
This integration is already installed if you run {% term "Home Assistant Operating System" %}. Please note that this integration
|
||||
cannot be installed on {% term "Home Assistant Container" %}.
|
||||
|
||||
|
||||
@ -15,7 +15,7 @@ related:
|
||||
ha_quality_scale: legacy
|
||||
---
|
||||
|
||||
The `haveibeenpwned` sensor {% term integration %} creates sensors that check for breached email accounts on [haveibeenpwned](https://haveibeenpwned.com).
|
||||
The **HaveIBeenPwned** {% term integration %} creates sensors that check for breached email accounts on [haveibeenpwned](https://haveibeenpwned.com).
|
||||
|
||||
## Configuration
|
||||
|
||||
|
||||
@ -15,7 +15,7 @@ related:
|
||||
ha_quality_scale: legacy
|
||||
---
|
||||
|
||||
The `hddtemp` sensor {% term integration %} is using the data provided by [HDDTemp](https://savannah.nongnu.org/projects/hddtemp).
|
||||
The **hddtemp** {% term integration %} is using the data provided by [HDDTemp](https://savannah.nongnu.org/projects/hddtemp).
|
||||
|
||||
## Setup
|
||||
|
||||
|
||||
@ -15,7 +15,7 @@ ha_codeowners:
|
||||
ha_quality_scale: legacy
|
||||
---
|
||||
|
||||
The `hdmi_cec` {% term integration %} provides actions that allow selecting the active device, powering on all devices, setting all devices to standby and creates switch entities for HDMI devices. Devices are defined in the configuration file by associating HDMI port number and a device name. Connected devices that provide further HDMI ports, such as sound-bars and AVRs are also supported. Devices are listed from the perspective of the CEC-enabled Home Assistant device. Any connected device can be listed, regardless of whether it supports CEC. Ideally the HDMI port number on your device will map correctly the CEC physical address. If it does not, use `cec-client` (part of the `libcec` package) to listen to traffic on the CEC bus and discover the correct numbers.
|
||||
The **HDMI-CEC** {% term integration %} provides actions that allow selecting the active device, powering on all devices, setting all devices to standby and creates switch entities for HDMI devices. Devices are defined in the configuration file by associating HDMI port number and a device name. Connected devices that provide further HDMI ports, such as sound-bars and AVRs are also supported. Devices are listed from the perspective of the CEC-enabled Home Assistant device. Any connected device can be listed, regardless of whether it supports CEC. Ideally the HDMI port number on your device will map correctly the CEC physical address. If it does not, use `cec-client` (part of the `libcec` package) to listen to traffic on the CEC bus and discover the correct numbers.
|
||||
|
||||
## CEC Setup
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ ha_integration_type: integration
|
||||
ha_quality_scale: legacy
|
||||
---
|
||||
|
||||
The `heatmiser` climate platform lets you control [Heatmiser DT/DT-E/PRT/PRT-E](https://www.heatmisershop.co.uk/room-thermostats/) thermostats from Heatmiser. The module itself is currently set up to work over a RS232 -> RS485 converter, therefore it connects over IP.
|
||||
The **Heatmiser** {% term integration %} lets you control [Heatmiser DT/DT-E/PRT/PRT-E](https://www.heatmisershop.co.uk/room-thermostats/) thermostats from Heatmiser. The module itself is currently set up to work over a RS232 -> RS485 converter, therefore it connects over IP.
|
||||
|
||||
Further work would be required to get this setup to connect over Wi-Fi, but the HeatmiserV3 Python module being used is a full implementation of the V3 protocol.
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The `here_travel_time` sensor provides travel time from the [HERE Routing API](https://www.here.com/docs/bundle/routing-api-developer-guide-v8/page/README.html).
|
||||
The **HERE Travel Time** {% term integration %} provides travel time from the [HERE Routing API](https://www.here.com/docs/bundle/routing-api-developer-guide-v8/page/README.html).
|
||||
|
||||
## Setup
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ ha_integration_type: integration
|
||||
ha_quality_scale: legacy
|
||||
---
|
||||
|
||||
The Hikvision Binary Sensor is a platform that parses the event stream of a
|
||||
The **Hikvision** {% term integration %} parses the event stream of a
|
||||
[Hikvision IP Camera or NVR](https://www.hikvision.com/) and presents the
|
||||
camera/nvr events to Home Assistant as binary sensors with either an "off" or
|
||||
"on" state.
|
||||
|
||||
@ -17,7 +17,7 @@ related:
|
||||
ha_quality_scale: legacy
|
||||
---
|
||||
|
||||
This `hikvisioncam` switch {% term integration %} allows you to control your motion detection setting on your [Hikvision](https://www.hikvision.com/) camera.
|
||||
This **Hikvision** {% term integration %} allows you to control your motion detection setting on your [Hikvision](https://www.hikvision.com/) camera.
|
||||
|
||||
{% important %}
|
||||
Currently works using default HTTPS port only.
|
||||
|
||||
@ -27,7 +27,7 @@ ha_integration_type: integration
|
||||
ha_homekit: true
|
||||
---
|
||||
|
||||
The Hive {% term integration %} for Home Assistant allows you to interact with supported devices and services offered by
|
||||
The **Hive** {% term integration %} for Home Assistant allows you to interact with supported devices and services offered by
|
||||
[hivehome.com](https://www.hivehome.com)
|
||||
|
||||
This Hive integration uses the same username and password you use on the [Hive website](https://sso.hivehome.com) to configure it within Home Assistant. 2FA authentication must be enabled to use this integration. Once configured, Home Assistant will detect and add all Hive devices, including support for multi-zone heating.
|
||||
|
||||
@ -14,7 +14,7 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The HKO {% term integration %} retrieves weather data from the [Hong Kong Observatory](https://www.hko.gov.hk/tc/index.html) [Open Data API](https://www.hko.gov.hk/en/abouthko/opendata_intro.htm) for meteorological data in HKSAR.
|
||||
The **Hong Kong Observatory** {% term integration %} retrieves weather data from the [Hong Kong Observatory](https://www.hko.gov.hk/tc/index.html) [Open Data API](https://www.hko.gov.hk/en/abouthko/opendata_intro.htm) for meteorological data in HKSAR.
|
||||
|
||||
There is currently support for the following platforms within Home Assistant:
|
||||
|
||||
|
||||
@ -33,7 +33,7 @@ ha_zeroconf: true
|
||||
ha_dhcp: true
|
||||
---
|
||||
|
||||
The Home Connect {% term integration %} allows users to integrate their home appliances supporting the Home Connect standard for Bosch and Siemens using the [official cloud API](https://developer.home-connect.com).
|
||||
The **Home Connect** {% term integration %} allows users to integrate their home appliances supporting the Home Connect standard for Bosch and Siemens using the [official cloud API](https://developer.home-connect.com).
|
||||
|
||||
## Use cases
|
||||
|
||||
|
||||
@ -11,7 +11,7 @@ ha_integration_type: system
|
||||
ha_quality_scale: internal
|
||||
---
|
||||
|
||||
The Home Assistant Alerts {% term integration %} integrates the
|
||||
The **Home Assistant Alerts** {% term integration %} integrates the
|
||||
[Home Assistant Alerts](https://alerts.home-assistant.io) website into
|
||||
your Home Assistant instance.
|
||||
|
||||
|
||||
@ -16,7 +16,7 @@ ha_platforms:
|
||||
ha_quality_scale: bronze
|
||||
---
|
||||
|
||||
The Home Assistant Connect ZBT-2 {% term integration %} provides hardware information for the hardware configuration page.
|
||||
The **Home Assistant Connect ZBT-2** {% term integration %} provides hardware information for the hardware configuration page.
|
||||
|
||||
For documentation on the Home Assistant Connect ZBT-2, please visit the [documentation page](https://support.nabucasa.com/hc/en-us/categories/29400540866973).
|
||||
If you are looking to buy one, please visit the [product page](https://home-assistant.io/connect/zbt-2/).
|
||||
|
||||
@ -10,7 +10,7 @@ ha_domain: homeassistant_green
|
||||
ha_integration_type: hardware
|
||||
---
|
||||
|
||||
The Home Assistant Green {% term integration %} provides hardware information for the hardware configuration page.
|
||||
The **Home Assistant Green** {% term integration %} provides hardware information for the hardware configuration page.
|
||||
|
||||
For documentation on the Home Assistant Green, please visit the [documentation page](https://support.nabucasa.com/hc/en-us/categories/24638797677853-Home-Assistant-Green).
|
||||
If you are looking to buy one, please visit the [product page](https://home-assistant.io/green).
|
||||
|
||||
@ -14,7 +14,7 @@ ha_platforms:
|
||||
- update
|
||||
---
|
||||
|
||||
The Home Assistant Hardware {% term integration %} provides functionality
|
||||
The **Home Assistant Hardware** {% term integration %} provides functionality
|
||||
shared between [Home Assistant Connect ZBT-2](/integrations/homeassistant_connect_zbt2/), [Home Assistant Connect ZBT-1](/integrations/homeassistant_sky_connect/), [Home Assistant Green](/integrations/homeassistant_green/), and [Home Assistant Yellow](/integrations/homeassistant_yellow/).
|
||||
|
||||
## Configuration
|
||||
|
||||
@ -15,7 +15,7 @@ ha_platforms:
|
||||
- update
|
||||
---
|
||||
|
||||
The Home Assistant Connect ZBT-1 {% term integration %} provides hardware information for the hardware configuration page.
|
||||
The **Home Assistant Connect ZBT-1** {% term integration %} provides hardware information for the hardware configuration page.
|
||||
|
||||
For documentation on the Home Assistant Connect ZBT-1, please visit the [documentation page](https://support.nabucasa.com/hc/en-us/categories/24734620813469).
|
||||
If you are looking to buy one, please visit the [product page](https://home-assistant.io/connectzbt1)
|
||||
|
||||
@ -16,7 +16,7 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The HomeKit Bridge {% term integration %} allows you to make your Home Assistant entities available in Apple HomeKit,
|
||||
The **HomeKit Bridge** {% term integration %} allows you to make your Home Assistant entities available in Apple HomeKit,
|
||||
so they can be controlled from Apple's Home app and Siri; even if those devices do not natively support HomeKit.
|
||||
|
||||
Please make sure that you have read the [considerations](#considerations) listed below to save you
|
||||
|
||||
@ -36,7 +36,7 @@ ha_codeowners:
|
||||
- '@hahn-th'
|
||||
---
|
||||
|
||||
The [HomematicIP](https://www.homematic-ip.com/) integration platform is used as an interface to the cloud server. Since there is no official documentation about this API, everything was done via reverse engineering. Use at your own risk.
|
||||
The [HomematicIP](https://www.homematic-ip.com/) {% term integration %} is used as an interface to the cloud server. Since there is no official documentation about this API, everything was done via reverse engineering. Use at your own risk.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
|
||||
@ -20,7 +20,7 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The Honeywell {% term integration %} integrates Home Assistant with _US-based_ [Honeywell Total Connect Comfort (TCC)](https://mytotalconnectcomfort.com/portal/) climate systems.
|
||||
The **Honeywell Total Connect Comfort** {% term integration %} integrates Home Assistant with _US-based_ [Honeywell Total Connect Comfort (TCC)](https://mytotalconnectcomfort.com/portal/) climate systems.
|
||||
|
||||
If your system is compatible with this integration, then you will be able access it via [https://mytotalconnectcomfort.com/portal/](https://mytotalconnectcomfort.com/portal/) (note the `/portal/`).
|
||||
|
||||
|
||||
@ -15,7 +15,7 @@ related:
|
||||
ha_quality_scale: legacy
|
||||
---
|
||||
|
||||
The `hp_ilo` {% term integration %} allows you to do an API call to the HP ILO (Integrated Lights-Out) sensor of your server, and use this data in Home Assistant sensors.
|
||||
The **HP Integrated Lights-Out** {% term integration %} allows you to do an API call to the HP ILO (Integrated Lights-Out) sensor of your server, and use this data in Home Assistant sensors.
|
||||
|
||||
If the ILO or specified jsonpath query returns only a single value (e.g., a temperature or state), it will be put in the state field. If a data structure is returned, it will be placed in the `ilo_data` attribute.
|
||||
|
||||
|
||||
@ -17,7 +17,7 @@ ha_codeowners:
|
||||
- '@alexyao2015'
|
||||
---
|
||||
|
||||
The `html5` notification {% term integration %} enables you to receive push notifications to Chrome or Firefox, no matter where you are in the world. `html5` also supports Chrome and Firefox on Android, which enables native-app-like integrations without actually needing a native app.
|
||||
The **HTML5 Push Notifications** {% term integration %} enables you to receive push notifications to Chrome or Firefox, no matter where you are in the world. `html5` also supports Chrome and Firefox on Android, which enables native-app-like integrations without actually needing a native app.
|
||||
|
||||
{% important %}
|
||||
HTML5 push notifications **do not** work on iOS versions below 16.4.
|
||||
|
||||
@ -12,7 +12,7 @@ ha_domain: http
|
||||
ha_integration_type: system
|
||||
---
|
||||
|
||||
The HTTP {% term integration %} serves all files and data required for the Home Assistant frontend. You only need to add this to your configuration file if you want to change any of the default settings.
|
||||
The **HTTP** {% term integration %} serves all files and data required for the Home Assistant frontend. You only need to add this to your configuration file if you want to change any of the default settings.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
|
||||
@ -30,7 +30,7 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The Huawei LTE router and modem integration for Home Assistant allows you to observe and control [Huawei LTE devices](https://consumer.huawei.com/en/routers/).
|
||||
The **Huawei LTE** router and modem {% term integration %} for Home Assistant allows you to observe and control [Huawei LTE devices](https://consumer.huawei.com/en/routers/).
|
||||
|
||||
There is currently support for the following platforms within Home Assistant:
|
||||
|
||||
|
||||
@ -30,7 +30,7 @@ ha_dhcp: true
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The Hunter Douglas PowerView {% term integration %} allows you to integrate your [Hunter Douglas PowerView](https://www.hunterdouglas.com/smart-automation) devices in Home Assistant. The product is also known by the brand name Luxaflex Powerview in Europe and Australia [as explained on their website](https://www.hunterdouglasgroup.com/worldwide-offices/), however this integration should work for both brands.
|
||||
The **Hunter Douglas PowerView** {% term integration %} allows you to integrate your [Hunter Douglas PowerView](https://www.hunterdouglas.com/smart-automation) devices in Home Assistant. The product is also known by the brand name Luxaflex Powerview in Europe and Australia [as explained on their website](https://www.hunterdouglasgroup.com/worldwide-offices/), however this integration should work for both brands.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
|
||||
@ -34,7 +34,7 @@ ha_domain: husqvarna_automower
|
||||
ha_quality_scale: silver
|
||||
---
|
||||
|
||||
The Husqvarna Automower {% term integration %} provides connectivity with Husqvarna Automowers lawn mowers through Husqvarna's cloud API. Only mowers with *Automower® Connect* or with the *Automower® Connect Module* are supported.
|
||||
The **Husqvarna Automower** {% term integration %} provides connectivity with Husqvarna Automowers lawn mowers through Husqvarna's cloud API. Only mowers with *Automower® Connect* or with the *Automower® Connect Module* are supported.
|
||||
|
||||
In order to use this integration you must properly configure OAuth2 credentials using your Husqvarna account. Refer to [this guide](https://developer.husqvarnagroup.cloud/docs/get-started) for general overview of the process.
|
||||
Your Husqvarna account username/password used for the *Automower® Connect* phone app is required. Most users probably created a Husqvarna account during initial mower setup.
|
||||
|
||||
@ -16,7 +16,7 @@ ha_integration_type: integration
|
||||
ha_domain: husqvarna_automower_ble
|
||||
---
|
||||
|
||||
The Husqvarna Automower BLE {% term integration %} provides connectivity with Husqvarna Automowers lawn mowers via a local Bluetooth connection. This allows connecting and controlling an Automower without any accounts, cloud, or network connection.
|
||||
The **Husqvarna Automower BLE** {% term integration %} provides connectivity with Husqvarna Automowers lawn mowers via a local Bluetooth connection. This allows connecting and controlling an Automower without any accounts, cloud, or network connection.
|
||||
|
||||
The integration is based on [AutoMower-BLE](https://github.com/alistair23/AutoMower-BLE), an unofficial reverse engineered Husqvarna Automower Connect BLE library.
|
||||
|
||||
|
||||
@ -15,7 +15,7 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The `hvv_departures` sensor will display the departures of buses, trains and ferries in Hamburg.
|
||||
The **HVV Departures** {% term integration %} will display the departures of buses, trains and ferries in Hamburg.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
|
||||
@ -23,7 +23,7 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The `hydrawise` {% term integration %} allows you to integrate your [Hunter Hydrawise](https://hydrawise.com) Wi-Fi irrigation controller system in Home Assistant.
|
||||
The **Hunter Hydrawise** {% term integration %} allows you to integrate your [Hunter Hydrawise](https://hydrawise.com) Wi-Fi irrigation controller system in Home Assistant.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
|
||||
@ -18,7 +18,7 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The Hyperion integration allows you to integrate your
|
||||
The **Hyperion** {% term integration %} allows you to integrate your
|
||||
[Hyperion](https://docs.hyperion-project.org/) into Home Assistant. Hyperion is
|
||||
an open source Ambilight implementation which runs on many platforms.
|
||||
|
||||
|
||||
@ -15,6 +15,6 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The `ios` integration is used by the Home Assistant Companion App for iOS to store and provide settings for [actionable notifications](https://companion.home-assistant.io/docs/notifications/actionable-notifications) and [actions](https://companion.home-assistant.io/docs/core/actions). Both of these can also be configured for a single device within the app, in which case the `ios` integration is not required.
|
||||
The **Home Assistant iOS** {% term integration %} is used by the Home Assistant Companion App for iOS to store and provide settings for [actionable notifications](https://companion.home-assistant.io/docs/notifications/actionable-notifications) and [actions](https://companion.home-assistant.io/docs/core/actions). Both of these can also be configured for a single device within the app, in which case the `ios` integration is not required.
|
||||
|
||||
For further details please check the [Companion App Documentation Site](https://companion.home-assistant.io).
|
||||
|
||||
@ -17,7 +17,7 @@ ha_dhcp: true
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The Honeywell Lyric {% term integration %} integrates the Lyric thermostat platform into Home Assistant.
|
||||
The **Honeywell Lyric** {% term integration %} integrates the Lyric thermostat platform into Home Assistant.
|
||||
|
||||
## Setup
|
||||
|
||||
|
||||
@ -13,7 +13,7 @@ ha_platforms:
|
||||
ha_integration_type: system
|
||||
---
|
||||
|
||||
The `websocket_api` {% term integration %} set up a WebSocket API and allows one to interact with a Home Assistant instance that is running headless. This integration depends on the [`http` integration](/integrations/http/).
|
||||
The **Home Assistant WebSocket API** {% term integration %} set up a WebSocket API and allows one to interact with a Home Assistant instance that is running headless. This integration depends on the [`http` integration](/integrations/http/).
|
||||
|
||||
## Configuration
|
||||
|
||||
|
||||
@ -15,7 +15,7 @@ related:
|
||||
ha_quality_scale: legacy
|
||||
---
|
||||
|
||||
The `x10` light {% term integration %} allows you to control your X10 based lights with Home Assistant.
|
||||
The **Heyu X10** {% term integration %} allows you to control your X10 based lights with Home Assistant.
|
||||
|
||||
Requires [Heyu x10](https://www.heyu.org/) and a CM11A or a CM17A "FireCracker" interface.
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user