mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-12-10 00:30:02 -06:00
Standardize integration docs: I integrations (#42489)
This commit is contained in:
smarthome-10
GitHub
parent
5e95383947
commit
7066ca3376
@ -10,7 +10,7 @@ related:
|
||||
title: Configuration file
|
||||
---
|
||||
|
||||
The `ifttt` {% term integration %} allows you to integrate security systems that have no open API but can be controlled through [IFTTT](https://ifttt.com/explore).
|
||||
The **IFTTT** {% term integration %} allows you to integrate security systems that have no open API but can be controlled through [IFTTT](https://ifttt.com/explore).
|
||||
|
||||
This {% term integration %} depends on the [IFTTT](/integrations/ifttt/) Home Assistant integration. See the integrations documentation to set it up.
|
||||
|
||||
|
||||
@ -18,7 +18,7 @@ ha_codeowners:
|
||||
ha_quality_scale: bronze
|
||||
---
|
||||
|
||||
The IKEA IDÅSEN {% term integration %} allows you to connect your [IKEA Idåsen](https://www.ikea.com/us/en/cat/idasen-system-47424/) motorized desk to Home Assistant, making it possible to control the desk height and also monitor height changes from the physical controller.
|
||||
The **IKEA IDÅSEN** {% term integration %} allows you to connect your [IKEA Idåsen](https://www.ikea.com/us/en/cat/idasen-system-47424/) motorized desk to Home Assistant, making it possible to control the desk height and also monitor height changes from the physical controller.
|
||||
|
||||
{% tip %}
|
||||
|
||||
|
||||
@ -15,7 +15,7 @@ related:
|
||||
ha_quality_scale: legacy
|
||||
---
|
||||
|
||||
The `iglo` {% term integration %} allows you to integrate your [iGlo Lights](https://www.youtube.com/watch?v=oHTS9ji_v-s) into Home Assistant.
|
||||
The **iGlo** {% term integration %} allows you to integrate your [iGlo Lights](https://www.youtube.com/watch?v=oHTS9ji_v-s) into Home Assistant.
|
||||
|
||||
To use your iGlo light in your installation, add the following to your {% term "`configuration.yaml`" %} file.
|
||||
{% include integrations/restart_ha_after_config_inclusion.md %}
|
||||
|
||||
@ -17,7 +17,7 @@ related:
|
||||
ha_quality_scale: legacy
|
||||
---
|
||||
|
||||
The `ign_sismologia` {% term integration %} lets you integrate a GeoRSS feed provided by the
|
||||
The **IGN Sismología** {% term integration %} lets you integrate a GeoRSS feed provided by the
|
||||
Spanish [Instituto Geográfico Nacional](https://www.ign.es/) with information
|
||||
about seismic events like earthquakes on the Iberian Peninsula and Canary
|
||||
Islands. It retrieves incidents from a feed and shows information of those
|
||||
|
||||
@ -22,7 +22,7 @@ related:
|
||||
ha_quality_scale: legacy
|
||||
---
|
||||
|
||||
IHC Controller {% term integration %} for Home Assistant allows you to connect the LK IHC controller to Home Assistant. The controller is sold under other names in different countries - "ELKO Living system" in Sweden and Norway.
|
||||
The **IHC Controller** {% term integration %} for Home Assistant allows you to connect the LK IHC controller to Home Assistant. The controller is sold under other names in different countries - "ELKO Living system" in Sweden and Norway.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
|
||||
@ -15,7 +15,7 @@ ha_codeowners:
|
||||
ha_config_flow: true
|
||||
---
|
||||
|
||||
The IMAP {% term integration %} is observing your [IMAP server](https://en.wikipedia.org/wiki/Internet_Message_Access_Protocol). It can report the number of unread emails and can send a custom event that can be used to trigger an automation. Other search criteria can be used, as shown in the example below.
|
||||
The **IMAP** {% term integration %} is observing your [IMAP server](https://en.wikipedia.org/wiki/Internet_Message_Access_Protocol). It can report the number of unread emails and can send a custom event that can be used to trigger an automation. Other search criteria can be used, as shown in the example below.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
|
||||
@ -21,7 +21,7 @@ ha_platforms:
|
||||
ha_ssdp: true
|
||||
---
|
||||
|
||||
The Imeon Energy Inverter {% term integrations %} will poll an [Imeon](https://imeon-energy.com/) solar inverter in Home Assistant.
|
||||
The **Imeon Inverter** {% term integration %} will poll an [Imeon](https://imeon-energy.com/) solar inverter in Home Assistant.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
|
||||
@ -16,7 +16,7 @@ ha_integration_type: integration
|
||||
ha_quality_scale: platinum
|
||||
---
|
||||
|
||||
IMGW-PIB {% term integration %} uses hydrological data from [Institute of Meteorology and Water Management - National Research Institute](https://hydro.imgw.pl) to present information about rivers and water reservoirs in Poland.
|
||||
The **IMGW-PIB** {% term integration %} uses hydrological data from [Institute of Meteorology and Water Management - National Research Institute](https://hydro.imgw.pl) to present information about rivers and water reservoirs in Poland.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
|
||||
@ -20,7 +20,7 @@ ha_integration_type: service
|
||||
ha_quality_scale: silver
|
||||
---
|
||||
|
||||
This integration allows adding an [Immich](https://immich.app/) user account to Home Assistant.
|
||||
This {% term integration %} allows adding an [Immich](https://immich.app/) user account to Home Assistant.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
|
||||
@ -13,7 +13,7 @@ ha_iot_class: Local Polling
|
||||
ha_config_flow: true
|
||||
---
|
||||
|
||||
The Improv via BLE {% term integration %} allows connecting devices implementing Improv via BLE to Wi-Fi.
|
||||
The **Improv via BLE** {% term integration %} allows connecting devices implementing Improv via BLE to Wi-Fi.
|
||||
|
||||
For documentation on Improv via BLE, please visit the [documentation](https://www.improv-wifi.com/ble/).
|
||||
|
||||
|
||||
@ -18,7 +18,7 @@ related:
|
||||
ha_quality_scale: legacy
|
||||
---
|
||||
|
||||
The `influxdb` {% term integration %} makes it possible to transfer all state changes to an external [InfluxDB](https://influxdb.com/) database. See the [official installation documentation](https://docs.influxdata.com/influxdb/v1.7/introduction/installation/) for how to set up an InfluxDB database.
|
||||
The **InfluxDB** {% term integration %} makes it possible to transfer all state changes to an external [InfluxDB](https://influxdb.com/) database. See the [official installation documentation](https://docs.influxdata.com/influxdb/v1.7/introduction/installation/) for how to set up an InfluxDB database.
|
||||
|
||||
Additionally, you can now make use of an InfluxDB 2.0 installation with this {% term integration %}. See the [official installation instructions](https://v2.docs.influxdata.com/v2.0/) for how to set up an InfluxDB 2.0 database. Or you can sign up for their [cloud service](https://cloud2.influxdata.com/signup) and connect Home Assistant to that. Note that the configuration is significantly different for a 2.xx installation, the documentation below will note when fields or defaults apply to only a 1.xx installation or a 2.xx installation.
|
||||
|
||||
|
||||
@ -12,7 +12,7 @@ ha_domain: input_boolean
|
||||
ha_integration_type: helper
|
||||
---
|
||||
|
||||
The **Input boolean** helper integration allows you to define boolean values that
|
||||
The **Input boolean** helper {% term integration %} allows you to define boolean values that
|
||||
can be controlled via the user interface and can be used within conditions of
|
||||
an {% term automation %}. This can for example be used to disable or enable certain
|
||||
automations by using them in their {% term conditions %}.
|
||||
|
||||
@ -12,7 +12,7 @@ ha_domain: input_button
|
||||
ha_integration_type: helper
|
||||
---
|
||||
|
||||
The **Input button** helper integration allows you to define buttons that
|
||||
The **Input button** helper {% term integration %} allows you to define buttons that
|
||||
can be pressed via the user interface, and can be used to trigger things,
|
||||
like an automation.
|
||||
|
||||
|
||||
@ -12,7 +12,7 @@ ha_domain: input_datetime
|
||||
ha_integration_type: helper
|
||||
---
|
||||
|
||||
The `input_datetime` {% term integration %} allows the user to define date and time values
|
||||
The **Input Datetime** {% term integration %} allows the user to define date and time values
|
||||
that can be controlled via the frontend and can be used within automations and
|
||||
templates.
|
||||
|
||||
|
||||
@ -31,7 +31,7 @@ ha_dhcp: true
|
||||
The Insteon apps (Director or Insteon for Hub) are a paid service utilizing the Insteon cloud to control an Insteon Hub. Home Assistant does not require the use of the Insteon app but can operate in conjunction with the app if desired.
|
||||
{% endimportant %}
|
||||
|
||||
This integration adds support for integrating your Insteon network with Home Assistant. It has been tested with all USB and serial PowerLinc Modems (PLM) including [2413U], [2448A7], [2413S] and [2412S] models. It has also been tested to work with the [2242] and [2245] Hubs.
|
||||
This {% term integration %} adds support for integrating your Insteon network with Home Assistant. It has been tested with all USB and serial PowerLinc Modems (PLM) including [2413U], [2448A7], [2413S] and [2412S] models. It has also been tested to work with the [2242] and [2245] Hubs.
|
||||
|
||||
_If you have factory reset your device, please see the instructions [Recovering After Factory Resetting The Hub](#recovering-after-factory-resetting-the-hub) for how to proceed._
|
||||
|
||||
|
||||
@ -18,7 +18,7 @@ ha_platforms:
|
||||
ha_integration_type: helper
|
||||
---
|
||||
|
||||
This integration provides the [Riemann sum](https://en.wikipedia.org/wiki/Riemann_sum)
|
||||
This {% term integration %} provides the [Riemann sum](https://en.wikipedia.org/wiki/Riemann_sum)
|
||||
of the values provided by a source sensor. The Riemann sum is an approximation
|
||||
of an **integral** by a finite sum.
|
||||
|
||||
|
||||
@ -9,7 +9,7 @@ ha_domain: intent_script
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The `intent_script` integration allows users to configure actions and responses to intents. Intents can be fired by any integration that supports it. Examples are [Alexa](/integrations/alexa/) (Amazon Echo), [Dialogflow](/integrations/dialogflow/) (Google Assistant) and [Snips](/integrations/snips/). Internally they can be fired by [custom sentences](https://www.home-assistant.io/voice_control/custom_sentences_yaml/).
|
||||
The **Intent Script** integration allows users to configure actions and responses to intents. Intents can be fired by any integration that supports it. Examples are [Alexa](/integrations/alexa/) (Amazon Echo), [Dialogflow](/integrations/dialogflow/) (Google Assistant) and [Snips](/integrations/snips/). Internally they can be fired by [custom sentences](https://www.home-assistant.io/voice_control/custom_sentences_yaml/).
|
||||
|
||||
If you are using intent script with LLMs and have parameters, make sure to mention the parameters and their types in the description.
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ ha_integration_type: integration
|
||||
ha_quality_scale: legacy
|
||||
---
|
||||
|
||||
The `IntesisHome` climate platform lets you control [IntesisHome](https://www.intesishome.com), [Airconwithme](https://airconwithme.com) and [anywAIR](https://www.fujitsugeneral.com.au/anywair) devices. IntesisHome provides integrations with air conditioners, including Panasonic, Daikin, Fujitsu, Toshiba, LG and more.
|
||||
The **IntesisHome** {% term integration %} lets you control [IntesisHome](https://www.intesishome.com), [Airconwithme](https://airconwithme.com) and [anywAIR](https://www.fujitsugeneral.com.au/anywair) devices. IntesisHome provides integrations with air conditioners, including Panasonic, Daikin, Fujitsu, Toshiba, LG and more.
|
||||
|
||||
Note: IntesisHome products are a separate product line to IntesisBox. This platform does not support IntesisBox devices (which can be controlled locally using the WMP protocol).
|
||||
|
||||
|
||||
@ -16,7 +16,7 @@ ha_platforms:
|
||||
ha_integration_type: device
|
||||
---
|
||||
|
||||
The iotty {% term integration%} lets you integrate iotty devices into Home Assistant. The iotty family includes the smart switch for lights and gates, the smart shades switch for blinds and shutters, and the smart outlet.
|
||||
The **iotty** {% term integration%} lets you integrate iotty devices into Home Assistant. The iotty family includes the smart switch for lights and gates, the smart shades switch for blinds and shutters, and the smart outlet.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
|
||||
@ -18,7 +18,7 @@ related:
|
||||
ha_quality_scale: legacy
|
||||
---
|
||||
|
||||
The `iperf3` sensor {% term integration %} allows you to measure network bandwidth performance against a private or public [Iperf3](https://software.es.net/iperf/index.html) server.
|
||||
The **Iperf3** {% term integration %} allows you to measure network bandwidth performance against a private or public [Iperf3](https://software.es.net/iperf/index.html) server.
|
||||
|
||||
Enabling this {% term integration %} will automatically create the Iperf3 sensors for the monitored conditions (below). By default, it will run every hour. The user can change the update frequency in the configuration by defining the `scan_interval` for a Iperf3 test to run.
|
||||
|
||||
|
||||
@ -16,7 +16,7 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The `ipma` weather platform uses the [Instituto Português do Mar e Atmosfera](https://www.ipma.pt/) as a source for current and forecast meteorological data.
|
||||
The **IPMA** {% term integration %} uses the [Instituto Português do Mar e Atmosfera](https://www.ipma.pt/) as a source for current and forecast meteorological data.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
|
||||
@ -16,7 +16,7 @@ ha_zeroconf: true
|
||||
ha_integration_type: device
|
||||
---
|
||||
|
||||
The `Internet Printing Protocol (IPP)` integration allows you to read current data from your networked printer that supports the [Internet Printing Protocol](https://www.pwg.org/ipp/everywhere.html).
|
||||
The **Internet Printing Protocol (IPP)** {% term integration %} allows you to read current data from your networked printer that supports the [Internet Printing Protocol](https://www.pwg.org/ipp/everywhere.html).
|
||||
|
||||
It provides information about the printer's state and remaining ink levels.
|
||||
|
||||
|
||||
@ -15,7 +15,7 @@ ha_platforms:
|
||||
ha_integration_type: service
|
||||
---
|
||||
|
||||
The `iqvia` sensor platform collects and displays allergy, asthma and disease
|
||||
The **IQVIA** {% term integration %} collects and displays allergy, asthma and disease
|
||||
information (based on a U.S. ZIP code) from [IQVIA](https://www.iqvia.com/).
|
||||
Data measured includes:
|
||||
|
||||
|
||||
@ -17,7 +17,7 @@ related:
|
||||
ha_quality_scale: legacy
|
||||
---
|
||||
|
||||
The `irish_rail_transport` sensor will give you the time until the next two departures (within 90 minutes) from an Irish Rail station using the RTPI information.
|
||||
The **Irish Rail Transport** {% term integration %} will give you the time until the next two departures (within 90 minutes) from an Irish Rail station using the RTPI information.
|
||||
|
||||
A station name is the full station name as specified on the Irish Rail search site, for example, `Tara Street` or `Dublin Connolly`.
|
||||
|
||||
|
||||
@ -15,7 +15,7 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The Islamic Prayer Times (`islamic_prayer_times`) integration displays the various prayer times for Muslims as sensors.
|
||||
The **Islamic Prayer Times** {% term integration %} displays the various prayer times for Muslims as sensors.
|
||||
|
||||
This platform calculates prayer times using the following calculation methods:
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The Israel rail {% term integration %} will give you the next three departure times from a given location to another one in Israel rail.
|
||||
The **Israel Railways** {% term integration %} will give you the next three departure times from a given location to another one in Israel rail.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ ha_config_flow: true
|
||||
ha_integration_type: service
|
||||
---
|
||||
|
||||
The International Space Station (ISS) {% term integration %} uses the
|
||||
The **International Space Station (ISS)** {% term integration %} uses the
|
||||
[Open Notify API](http://open-notify.org/Open-Notify-API/ISS-Location-Now/)
|
||||
to let you know where the station is.
|
||||
|
||||
|
||||
@ -18,7 +18,7 @@ related:
|
||||
title: Configuration file
|
||||
---
|
||||
|
||||
The `iZone` {% term integration %} allows access of control of a local [iZone](https://izone.com.au/) ducted reverse-cycle climate control devices. These are largely available in Australia.
|
||||
The **iZone** {% term integration %} allows access of control of a local [iZone](https://izone.com.au/) ducted reverse-cycle climate control devices. These are largely available in Australia.
|
||||
|
||||
## Supported hardware
|
||||
|
||||
|
||||
@ -8,4 +8,4 @@ ha_iot_class: Local Push
|
||||
ha_domain: ios
|
||||
---
|
||||
|
||||
The `ios` sensor platform is the Home Assistant part for using the iOS companion app. For further details please check the [iOS section](/docs/ecosystem/ios/) in the documentation for further details.
|
||||
The **iOS** sensor {% term integration %} is the Home Assistant part for using the iOS companion app. For further details please check the [iOS section](/docs/ecosystem/ios/) in the documentation for further details.
|
||||
|
||||
@ -23,7 +23,7 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The IKEA TRÅDFRI integration allows you to connect your IKEA Trådfri Gateway to Home Assistant. The gateway can control compatible Zigbee-based lights (certified Zigbee Light Link products) connected to it.
|
||||
The **IKEA TRÅDFRI** {% term integration %} allows you to connect your IKEA Trådfri Gateway to Home Assistant. The gateway can control compatible Zigbee-based lights (certified Zigbee Light Link products) connected to it.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
|
||||
@ -17,7 +17,7 @@ related:
|
||||
ha_quality_scale: legacy
|
||||
---
|
||||
|
||||
The `watson_tts` text-to-speech {% term integration %} that works with [IBM Watson Cloud](https://www.ibm.com/watson/services/text-to-speech/) to create the spoken output.
|
||||
The **IBM Watson TTS** text-to-speech {% term integration %} that works with [IBM Watson Cloud](https://www.ibm.com/watson/services/text-to-speech/) to create the spoken output.
|
||||
Watson is a paid service via IBM Cloud but there is a decent [free tier](https://www.ibm.com/cloud/watson-text-to-speech/pricing) which offers 10000 free characters every month.
|
||||
|
||||
## Setup
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user