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-14 21:06:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'current' into next

Browse Source
This commit is contained in:
Franck Nijhof 2021-02-16 07:32:20 +01:00
commit c30a460bd6
No known key found for this signature in database
GPG Key ID: D62583BA8AB11CA3
198 changed files with 332 additions and 2196 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
source/_includes/integrations/config_flow.md Normal file
View File

@ -0,0 +1,27 @@
{% capture name %}{{ include.name | default: page.title }}{% endcapture %}
## Configuration
Adding {{ name }} to your Home Assistant instance can be done via the user
interface, by taking the following steps:
- Browse to your Home Assistant instance.
- In the sidebar click on <i class="icon-cog"/> _**Configuration**_.
- From the configuration menu select: <i class="icon-puzzle-piece" /> _**Integrations**_.
{% if include.discovery or page.ha_dhcp or page.ha_homekit or page.ha_ssdp or page.ha_zeroconf %}
{{ name }} can be auto-discovered by Home Assistant. If an instance was found,
it will be shown in the top of the list of integrations as _"Discovered"_.
If that is the case click on the _**Configure**_ button to start setting up
the discovered instance.
If there wasn't any discovered automatically, don't worry! You can set up a
manual integration entry:
{% endif %}
- In the bottom right, click on the
<i class="icon-plus-sign" /> _**Add Integration**_ button.
- From the list, search and select _**"{{ name }}"**_.
- Follow the instruction on screen to complete the set up.
After completing, the {{ name }} integration will be immediately available for use.

29
source/_integrations/abode.markdown
View File

@ -44,34 +44,7 @@ There is currently support for the following device types within Home Assistant:
- **Switch**: Reports on `Power Switch` and `Water Valve` devices which can be turned on and off. Also reports on `Automations` set up in the Abode system and allows you to activate or deactivate them.
- **Sensor**: Reports on `Temperature`, `Humidity`, and `Light` sensors.
## Configuration
To use Abode devices in your installation, add your Abode account from the integrations page. Alternatively, Abode can be configured by adding the following `abode` section to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
abode:
username: abode_username
password: abode_password
```
{% configuration %}
username:
description: Username for your Abode account.
required: true
type: string
password:
description: Password for your Abode account.
required: true
type: string
polling:
description: >
Enable polling if cloud push updating is less reliable.
Will update the devices once every 30 seconds.
required: false
type: boolean
default: false
{% endconfiguration %}
{% include integrations/config_flow.md %}
## Events

6
source/_integrations/accuweather.markdown
View File

@ -15,15 +15,13 @@ ha_platforms:
- weather
---
The `accuweather` integration uses the [AccuWeather](https://accuweather.com/) web service as a source for weather data for your location.
The AccuWeather integration uses the [AccuWeather](https://accuweather.com/) web service as a source for weather data for your location.
## Setup
To generate an AccuWeather API key, go to [AccuWeather APIs](https://developer.accuweather.com/) page, register and create application with product **Limited Trial**.
## Configuration
To add AccuWeather to your installation, go to **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **AccuWeather**. By default, the values will be taken from the Home Assistant configuration. Weather forecast is not enabled by default. You can enable it in the integration options.
{% include integrations/config_flow.md %}
<div class="note warning">

4
source/_integrations/acmeda.markdown
View File

@ -19,9 +19,7 @@ The Rollease Acmeda Automate integration allows you to control and monitor cover
Devices are represented as a cover for monitoring and control as well as a sensor for monitoring battery condition.
To set up this integration, click the + icon in the lower right and find Rolelase Acmeda Automate. This will automatically discover any hubs on the local network and register them with Home Assistant. All devices are automatically discovered on the hub and you will have the opportunity to select the area each device is located.
Once registration is complete, you should see a `cover` and a `sensor` entity for each device. The integration automatically manages the addition/update/removal of any devices connected on the hub including device names unless manually specified in Home Assistant.
{% include integrations/config_flow.md %}
### Multiple hubs

10
source/_integrations/adguard.markdown
View File

@ -17,16 +17,10 @@ ha_platforms:
---
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 AdgGuard integration allows
you to control and monitor your AdGuard Home instance in Home Assistant.
## Configuration via the frontend
Menu: **Configuration** -> **Integrations**.
Click on the `+` sign to add an integration and click on **AdGuard Home**.
After completing the configuration flow, the AdGuard Home
integration will be available.
{% include integrations/config_flow.md %}
## Sensors

8
source/_integrations/advantage_air.markdown
View File

@ -19,15 +19,11 @@ ha_platforms:
The Advantage Air integration allows you to control [Advantage Air](https://www.advantageair.com.au/) Air Conditioning controllers into Home Assistant.
## Configuration
## Prerequisites
The wall-mounted Android table running the [MyPlace](https://play.google.com/store/apps/details?id=com.air.advantage.myair5), [e-zone](https://play.google.com/store/apps/details?id=com.air.advantage.ezone), or [zone10e](https://play.google.com/store/apps/details?id=com.air.advantage.zone10) must have a static IP, which you will enter on the integrations page in Home Assistant.
Menu: **Configuration** -> **Integrations**.
Click on the `+` sign to add an integration and click on **Advantage Air** (use typeahead if necessary).
Enter the IP address, and leave the port as the default value.
After completing the configuration flow, the Advantage Air integration will dynamically add relevant entities for each Air Conditioning system and controlled zones.
{% include integrations/config_flow.md %}
## Entities

5
source/_integrations/agent_dvr.markdown
View File

@ -19,10 +19,7 @@ ha_platforms:
You can add Agent DVR via integrations using the IP address and port of the server, e.g.,: `http://192.168.1.3:8090/`.
## Configuration
For configuration, go to the `Integrations panel` on your Home Assistant instance. Click on the + symbol and pick 'Agent DVR' from the list and enter your Agent DVR server address and port. You can then setup your devices using the Home Assistant UI.
{% include integrations/config_flow.md %}
<div class='note'>
Please ensure you are using Agent DVR v2.6.1.0 +

6
source/_integrations/airly.markdown
View File

@ -15,15 +15,13 @@ ha_platforms:
- sensor
---
The `airly` integration uses the [Airly](https://airly.eu/) web service as a source for air quality data for your location.
The Airly integration uses the [Airly](https://airly.eu/) web service as a source for air quality data for your location.
## Setup
To generate an Airly API key, go to [Airly for developers](https://developer.airly.eu/register) page.
## Configuration
To add Airly to your installation, go to **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **Airly**. By default, the values will be taken from the Home Assistant configuration.
{% include integrations/config_flow.md %}
<div class="note warning">

4
source/_integrations/airnow.markdown
View File

@ -20,9 +20,7 @@ as a source for air quality data for your location.
To generate an AirNow API key, go to the [AirNow Developer Tools Page](https://docs.airnowapi.org/account/request/) page.
## Configuration
To add AirNow to your installation, go to **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **AirNow**. By default, the values will be taken from the Home Assistant configuration.
{% include integrations/config_flow.md %}
<div class="note">

5
source/_integrations/airvisual.markdown
View File

@ -38,10 +38,7 @@ For example:
The integration can communicate to Node/Pro units over the local network. You will need the IP address/hostname of the unit and its Samba password (which can be found on the unit; instructions here: https://support.iqair.com/en/articles/3029331-download-the-airvisual-node-pro-s-data-using-samba).
## Configuration
This integration can be configured via the Home Assistant UI by navigating to
**Configuration** -> **Integrations**.
{% include integrations/config_flow.md %}
## Example Configurations

4
source/_integrations/alarmdecoder.markdown
View File

@ -29,9 +29,7 @@ There is currently support for the following device types within Home Assistant:
This is a fully event-based component. Any event sent by the AlarmDecoder device will be immediately reflected within Home Assistant.
## Configuration
AlarmDecoder can be set up via the **Integrations** section of the **Configuration** page. Click the `+` sign and select _AlarmDecoder_ from the list.
{% include integrations/config_flow.md %}
You will be prompted to select a protocol (i.e. `socket` or `serial`). Depending on your selection, you will be asked for the following connection information:

2
source/_integrations/ambiclimate.markdown
View File

@ -41,6 +41,8 @@ client_secret:
Note that you have to select manual mode from the Ambiclimate app to be able to control the A/C from Home Assistant.
{% include integrations/config_flow.md %}
## Component services
Enable comfort mode on your AC:

6
source/_integrations/ambient_station.markdown
View File

@ -17,14 +17,12 @@ ha_platforms:
The `Ambient Weather Station` integration retrieves local weather information
via personal weather stations from [Ambient Weather](https://ambientweather.net).
## Setup
## Prerequisites
Using this 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).
## Configuration
To add your Ambient Weather PWS to your Home Assistant installation, add the
following to your `configuration.yaml` file:
@ -46,6 +44,8 @@ app_key:
type: string
{% endconfiguration %}
{% include integrations/config_flow.md %}
## Local API Option
This integration communicates with Ambient Weather PWS units via the Ambient Weather

8
source/_integrations/apple_tv.markdown
View File

@ -25,13 +25,7 @@ There is currently support for the following device types within Home Assistant:
- Media Player
- [Remote](#remote)
## Configuration
Menu: *Configuration* > *Integrations*
Press on **Apple TV** and configure the integration:
* Enter either an IP address or a device name and follow the next few steps
{% include integrations/config_flow.md %}
## FAQ

7
source/_integrations/arcam_fmj.markdown
View File

@ -20,12 +20,7 @@ Supported devices:
- AVR 750
- Likely other AVRs
## Configuration
Menu: **Configuration** -> **Integrations**.
Click on the `+` sign to add an integration and click on **Arcam FMJ**.
Follow the configuration flow, after finishing, the receivers will be available.
{% include integrations/config_flow.md %}
## Power state

4
source/_integrations/atag.markdown
View File

@ -24,9 +24,7 @@ The integration implements the following platforms:
- Water Heater
- Sensor
## Configuration
The Atag integration can be enabled directly from Home Assistant. Navigate to `configuration`, then `integrations` and click `add`. Click `Atag` to initiate the configuration.
{% include integrations/config_flow.md %}
{% configuration %}
host:

8
source/_integrations/august.markdown
View File

@ -35,13 +35,7 @@ There is currently support for the following device types within Home Assistant:
August Lock 2nd Gen will need either August Connect or Doorbell to connect to Home Assistant.
</div>
## Configuration
You will need your August login information (username (either phone# or email), and password) to use this module.
To add `August` to your installation, go to **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **August**.
Once Home Assistant is started, a configurator will pop up asking you to enter verification code that is sent to your phone number or email.
{% include integrations/config_flow.md %}
### Binary Sensor

8
source/_integrations/aurora.markdown
View File

@ -17,13 +17,7 @@ The `aurora` platform uses the [NOAA Aurora Forecast](https://www.swpc.noaa.gov/
This service gives a number 0-100 representing the current likelihood of visible auroras at your latitude/longitude. By default this sensor is set up to trigger when the reported likelihood for your location is > 75. It updates every 5 minutes.
## Configuration
To add the aurora binary sensor to your installation, search for the Aurora integration through the Configuration -> Integrations menu.
Enter a name for your Aurora location as well as the longitude and latitude of the location (default to your Home Assistant location).
Click Submit to add the integration to your environment.
{% include integrations/config_flow.md %}
You can configure multiple locations by adding the integration multiple times.

6
source/_integrations/awair.markdown
View File

@ -18,11 +18,7 @@ The Awair integration will fetch data from your [Awair devices](https://getawair
You will need to request access to the Awair API and obtain an access token from the Awair [Developer Console](https://developer.getawair.com/). It is free, but getting a token can take up to 24 hours.
## Configuring the Platform
To enable the Awair integration, add your Awair account from the integrations page.
If you previously configured this integration via configuration.yaml, then your configuration will be imported for you. Only the `access_token` key is imported, and all other configuration is ignored.
{% include integrations/config_flow.md %}
## Available Sensors

6
source/_integrations/axis.markdown
View File

@ -26,11 +26,7 @@ ha_platforms:
[Axis Communications](https://www.axis.com/) devices are surveillance cameras, speakers, access control and other security-related network connected hardware. Event API works with firmware 5.50 and newer.
Home Assistant will automatically discover their presence on your network. Discovery utilizes both DHCP, SSDP and Zeroconf protocols to discover devices.
## Configuration
For configuration go to the `Integrations pane` on your Home Assistant instance.
{% include integrations/config_flow.md %}
<div class='note'>
It is recommended that you create a user on your Axis device specifically for Home Assistant. For sensor functionality, it is enough to create a user with viewer privileges. If you want additional functional control you will need admin privileges.

10
source/_integrations/azure_devops.markdown
View File

@ -13,16 +13,10 @@ ha_platforms:
- sensor
---
The `azure_devops` integration allows you to control and monitor your
The Azure DevOps integration allows you to control and monitor your
Azure DevOps instance in Home Assistant.
## Configuration
Menu: **Configuration** -> **Integrations**.
Click on the `+` sign to add an integration and click on **Azure DevOps**.
After completing the configuration flow, the Azure DevOps
integration will be available.
{% include integrations/config_flow.md %}
## Sensors

11
source/_integrations/blebox.markdown
View File

@ -20,19 +20,10 @@ ha_platforms:
[BleBox](https://blebox.eu/?lang=en) produces small, low-power, surprisingly affordable, feature-rich WiFi devices for serverless home automation.
## Configuration
{% include integrations/config_flow.md %}
For the best experience, make sure your BleBox devices have the most recent available firmware installed.
This integration can be configured using the integrations in the
Home Assistant frontend.
Menu: **Configuration** -> **Integrations**.
Click on the `+` sign to add an integration and click on **BleBox**.
After completing the configuration flow, the BleBox
integration will be available.
Additionally, if you are configuring a gateBox, it may be useful to set the second button as "stop" in your device's settings (via website or phone app).
## Covers

7
source/_integrations/bond.markdown
View File

@ -30,14 +30,11 @@ Supported devices (see Requirements section below):
- Shades
- Fireplaces
## Configuration
## Prerequisites
To use Bond controlled devices in your installation, add your Bond hub host and access token from the integrations page. Instructions for how to obtain an access token can be found on the [Bond Local API](http://docs-local.appbond.com/#section/Getting-Started/Get-Device-Information) documentation, which includes a section for how to obtain the [IP address of the device](http://docs-local.appbond.com/#section/Getting-Started/Finding-the-Bond-IP) which you will need to obtain the access token.
Menu: **Configuration** -> **Integrations**.
Click on the `+` sign to add an integration and click on **Bond** (use typeahead if necessary).
After completing the configuration flow, the Bond integration will be available.
{% include integrations/config_flow.md %}
## Requirements

4
source/_integrations/braviatv.markdown
View File

@ -15,9 +15,7 @@ The `braviatv` platform allows you to control a [Sony Bravia TV](https://www.son
Almost all [Sony Bravia TV 2013 and newer](https://info.tvsideview.sony.net/en_ww/home_device.html#bravia) are supported. A more generic method for older TVs connected to a Raspberry Pi with HDMI-CEC is explained further [below](#for-tvs-older-than-2013).
## Configuration
You can setup the Sony Bravia TV via **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select Sony Bravia TV.
{% include integrations/config_flow.md %}
## Common Issues

4
source/_integrations/broadlink.markdown
View File

@ -26,9 +26,7 @@ The Broadlink integration allows you to control and monitor Broadlink universal
- Universal Remotes: `RM mini`, `RM mini 3`, `RM pro`, `RM pro+`, `RM plus`, `RM4 mini`, `RM4 pro` and `RM4C mini`
- Wi-Fi Controlled Switches: `BG1`, `SC1`
## Configuration
To set up a Broadlink device, click _Configuration_ in the sidebar and click _Integrations_. If you see your device there, click _Configure_. If not, click the + icon in the lower right, select Broadlink from the list, enter the hostname or IP address of the device and follow the instructions to complete the setup.
{% include integrations/config_flow.md %}
### Entities and subdomains

4
source/_integrations/brother.markdown
View File

@ -20,9 +20,7 @@ The `Brother Printer` integration allows you to read current data from your loca
It usually provides information about the device's state, the left amount of ink or toner and the remaining life of the drum or other parts of the printer.
The integration monitors every supported part.
## Configuration
To add `Brother Printer` to your installation, go to **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **Brother Printer**.
{% include integrations/config_flow.md %}
<div class="note warning">

16
source/_integrations/bsblan.markdown
View File

@ -23,20 +23,10 @@ of heating systems such as `Elco Thision`, `Brötje` and similar systems.
It can interface with the heating system over Boiler-System-Bus, Local Process Bus and PPS (Punkt-zu-Punkt Schnittstelle)
For more information of which system it supports, have a look at their [documentation](https://1coderookie.github.io/BSB-LPB-LAN_EN/).
## Configuration
{% include integrations/config_flow.md %}
This integration can be configured using the integrations in the
Home Assistant frontend.
Menu: **Configuration** -> **Integrations**.
Click on the `+` sign to add an integration and click on **BSBLan**.
Fill in the IP address of the device in your network and, if needed,
the port number. The default value should be `80`.
For authentication passkey is supported and also HTTP authentication with username and password.
After completing the configuration flow, the BSBLan Climate integration will be
available.
For authentication HTTP authentication using a username and password,
or using a passkey is supported. Use either one.
For more documentation of the BSBLan device, check the [manual](https://1coderookie.github.io/BSB-LPB-LAN_EN/).

8
source/_integrations/canary.markdown
View File

@ -23,13 +23,9 @@ There is currently support for the following device types within Home Assistant:
- [Camera](#camera)
- [Sensor](#sensor)
## Configuration
{% include integrations/config_flow.md %}
You will need your Canary login information (username, usually your email address, and password) to use this module.
Go to the integrations page in your configuration and click on new integration -> Canary.
Once loaded, your front end will have the following integrations:
Once loaded, your front end will have the following entities:
- A camera image triggered by motion for each camera.
- An alarm control panel for each location.

27
source/_integrations/cert_expiry.markdown
View File

@ -16,32 +16,7 @@ ha_platforms:
The `cert_expiry` integration fetches the certificate from a configured host and displays its expiration in a timestamp sensor.
## Configuration
There are 2 options in configuring the `cert_expiry` sensor:
- Via the Home Assistant user interface where it will let you enter a host and port for the certificate to check.
- Via the Home Assistant `configuration.yaml` file.
```yaml
# Example configuration.yaml entry
sensor:
- platform: cert_expiry
host: home-assistant.io
```
{% configuration %}
host:
description: The host FQDN (or IP) to retrieve certificate from.
required: true
type: string
port:
description: The port number where the server is running.
required: false
default: 443
type: integer
{% endconfiguration %}
{% include integrations/config_flow.md %}
## Attributes

4
source/_integrations/cloudflare.markdown
View File

@ -44,9 +44,7 @@ An easy way to create this is to start with the "Edit zone DNS" template then ad
[Cloudflare API Tokens Guide](https://developers.cloudflare.com/api/tokens/create)
## Configuration
Go to the integrations page in your configuration and click on new integration -> Cloudflare.
{% include integrations/config_flow.md %}
## Additional information

7
source/_integrations/control4.markdown
View File

@ -15,14 +15,11 @@ ha_platforms:
The Control4 integration allows you to control and monitor lights from your local Control4 system. Your Control4 controller must be running OS 3.0+.
## Configuration
## Prerequisites
Before setting up, you should assign a static IP address/DHCP reservation on your router to your Control4 controller. Home Assistant must be able to communicate with the controller over the local network; 4Sight remote access is not supported.
Setup the Control4 integration by going to **Configuration** -> **Integrations** -> **Control4**.
Enter the IP address of your controller and your Control4 username and password, then continue. Home Assistant will automatically add all lights it discovers in your Control4 system.
{% include integrations/config_flow.md %}
## Options
The Control4 integration offers additional options in **Configuration** -> **Integrations** -> **Control4** -> **Options**:

10
source/_integrations/coolmaster.markdown
View File

@ -15,12 +15,4 @@ ha_platforms:
The `coolmaster` climate platform lets you control HVAC through [CoolMasterNet](https://coolautomation.com/products/coolmasternet/).
## Configuration via the frontend
Menu: **Configuration** -> **Integrations**.
Click on the `+` sign to add an integration and click on **CoolMasterNet**.
Select the host and port of your instance, and check the box for the modes
supported by your HVAC units. The units you have configured in CoolMasterNet
will be automatically added to Home Assistant as Climate entities and
matching devices.
{% include integrations/config_flow.md %}

22
source/_integrations/coronavirus.markdown
View File

@ -27,24 +27,4 @@ recovered from, and deceased caused by the virus in your country, or worldwide.
The data is sourced from the [Johns Hopkins University](https://www.arcgis.com/apps/opsdashboard/index.html#/bda7594740fd40299423467b48e9ecf6).
## Configuration
This integration can be configured via the Home Assistant frontend.
- Go to **Configuration** -> **Integrations**.
- Click on the `+` in the bottom right corner to add a new integration.
- Search and select the **Coronavirus** integration from the list.
- Follow the instruction on screen to add the sensors. Either choose to add
world-wide sensors, or a specific set of sensors for your country.
If you want to track both world-wide and one or more countries at the same time,
you can repeat the configuration process described above to add multiple
instances of the integration.
<div class='note'>
This integration is released in a special release of Home Assistant Core:
0.106.3.
While this integration is marked as released in 0.106, it is only available
on Home Assistant Core 0.106.3 or newer.
</div>
{% include integrations/config_flow.md %}

4
source/_integrations/daikin.markdown
View File

@ -42,9 +42,7 @@ There is currently support for the following device types within Home Assistant:
</div>
## Configuration
The Daikin integration can be configured via the Home Assistant user interface where it will let you enter the IP-address of your Daikin AC (SKYFi based devices need to provide a password and BRP072Cxx devices need to provide a key).
{% include integrations/config_flow.md %}
<div class='note'>

8
source/_integrations/deconz.markdown
View File

@ -54,13 +54,7 @@ Otherwise, use [community container](https://hub.docker.com/r/marthoc/deconz/) b
See [deCONZ wiki](https://github.com/dresden-elektronik/deconz-rest-plugin/wiki/Supported-Devices) for a list of supported devices.
## Configuration
Home Assistant will automatically discover deCONZ presence on your network, if `discovery:` is present in your `configuration.yaml` file.
If you don't have the API key, you can generate an API key for deCONZ by using the one-click functionality similar to Philips Hue. Go to **Settings** → **Gateway** → **Advanced** → **Authenticate app** in the Phoscon App and then use the deCONZ configurator in Home Assistant frontend to create an API key. When you're done setting up deCONZ it will be stored as a configuration entry.
You can manually add deCONZ by going to the integrations page.
{% include integrations/config_flow.md %}
## Debugging integration

17
source/_integrations/denonavr.markdown
View File

@ -77,29 +77,18 @@ If your model is not on the list then give it a test, if everything works correc
If you have something else using the IP controller for your Denon AVR 3808CI, such as your URC controller, it will not work! There is either a bug or security issue with some models where only one device could be controlling the IP functionality.
</div>
To add a Denon Network Receiver to your installation, click Configuration in the sidebar, then click Integrations. Denon and Marantz receivers should be discovered automatically and should show up in the overview. Hit configure and go through the steps to specify the optional settings. If your receiver does not show up automatically, click the + icon in the lower right. Then search for "denonavr" and enter the setup.
{% include integrations/config_flow.md %}
{% configuration %}
{% configuration_basic %}
host:
description: IP address of the device, e.g., 192.168.1.32. If not set, auto-discovery is used.
required: false
type: string
show_all_sources:
description: If True all sources are displayed in sources list even if they are marked as deleted in the receiver. If False deleted sources are not displayed. Some receivers have a bug that marks all sources as deleted in the interface. In this case, this option could help.
required: false
default: false
type: boolean
zone1:
description: Specifies if zone 1 should be activated. Zones are displayed as additional media players with the same functionality as the Main Zone of the device supports.
required: false
default: false
type: boolean
zone2:
description: Specifies if zone 2 should be activated. Zones are displayed as additional media players with the same functionality as the Main Zone of the device supports.
required: false
default: false
type: boolean
{% endconfiguration %}
{% endconfiguration_basic %}
A few notes:

6
source/_integrations/devolo_home_control.markdown
View File

@ -27,11 +27,7 @@ ha_platforms:
devolo Home Control is a Z-Wave ecosystem with a Z-Wave to IP gateway in the center. The integration allows you to control devices connected to the gateway.
## Configuration
Menu: **Configuration** -> **Integrations**.
Click on the `+` sign to add an integration and click on **devolo Home Control**. You will be asked for your [mydevolo](https://www.mydevolo.com) credentials. After entering them, the devolo Home Control integration will be available. Please do not change the URLs provided in the advanced mode unless you know what you are doing.
{% include integrations/config_flow.md %}
## Switches

10
source/_integrations/dexcom.markdown
View File

@ -15,16 +15,16 @@ ha_platforms:
The Dexcom integration allows you to view your CGM data from [Dexcom](https://www.dexcom.com/) in Home Assistant.
## Configuration
## Prerequisites
You will need to set up the [Dexcom Share](https://provider.dexcom.com/education-research/cgm-education-use/videos/setting-dexcom-share-and-follow) feature in your Dexcom G6 App to use this integration.
{% include integrations/config_flow.md %}
<div class='note warning'>
Some people have had problems with connecting when their Dexcom passwords are entirely numeric. If you have connection issues in that case, try changing your password to something with a mix of numbers and letters.
</div>
You will need to set up the [Dexcom Share](https://provider.dexcom.com/education-research/cgm-education-use/videos/setting-dexcom-share-and-follow) feature in your Dexcom G6 App to use this integration. Once you have done that, perform the following steps.
To add `Dexcom` to your installation, go to **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **Dexcom**.
#### Server
There are two Dexcom Share servers, `US` for United States customers, and `OUS` for all customers outside of the United States.

25
source/_integrations/directv.markdown
View File

@ -18,7 +18,7 @@ ha_platforms:
The DirecTV platform allows you to control a [DirecTV](https://www.directv.com) receiver and its client devices.
### Requirements
## Requirements
For proper integration with Home Assistant, your DirecTV device settings should allow "External Access".
@ -28,28 +28,7 @@ This is done via series of settings found via "Menu > Settings & Help > Settings
- Current Program: Allow
- Recordings: Allow
### Configuration
Go to the integrations page in your configuration and click on new integration -> DirecTV.
If your DirecTV device is on, it has likely been discovered already and you just have to confirm the detected device.
### YAML Configuration
Manual configuration of your DirecTV device is also possible, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
directv:
- host: IP_ADDRESS
```
{% configuration %}
host:
description: "The hostname or IP of the DirecTV receiver, e.g., `192.168.0.10`."
required: true
type: string
{% endconfiguration %}
{% include integrations/config_flow.md %}
## Services

80
source/_integrations/doorbird.markdown
View File

@ -34,87 +34,11 @@ It is recommended to set up a new account on your Doorbird App for use with Home
- "Motion" (last motion)
- "API-Operator" (this needed to be enabled as a minimum)
## Configuration
To add `DoorBird` to your installation, go to **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **DoorBird**. After filling out UI prompts, click the gear icon to edit device settings. Enter device event names here to associate with a schedule in DoorBird app. See [Schedules](#schedules)
Alternatively, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
doorbird:
devices:
- host: DOORBIRD_IP_OR_HOSTNAME
username: YOUR_USERNAME
password: YOUR_PASSWORD
token: YOUR_DOORBIRD_TOKEN
```
{% configuration %}
devices:
description: List of Doorbird devices.
required: true
type: list
keys:
host:
description: The LAN IP address or hostname of your device. You can find this by going to the [DoorBird Online check](https://www.doorbird.com/checkonline) and entering the information from the paper that was included in the box.
required: true
type: string
username:
description: The username of a non-administrator user account on the device ([User setup](/integrations/doorbird/#setup))
required: true
type: string
password:
description: The password for the user specified.
required: true
type: string
token:
description: Token to be used to authenticate Doorbird calls to Home Assistant. This is a user defined value and should be unique across all Doorbird devices.
required: true
type: string
name:
description: Custom name for this device.
required: false
type: string
hass_url_override:
description: If your DoorBird cannot connect to the machine running Home Assistant because you are using dynamic DNS or some other HTTP configuration (such as HTTPS), specify the LAN IP of the machine here to force a LAN connection.
required: false
type: string
events:
description: Custom event names to be registered on the device. User defined values. Special characters should be avoided.
required: false
type: list
{% endconfiguration %}
## Full example
```yaml
doorbird:
devices:
- host: DOORBIRD_IP_OR_HOSTNAME
username: YOUR_USERNAME
password: YOUR_PASSWORD
token: CUSTOM_TOKEN_1
hass_url_override: HASS_URL
name: Front Door
- host: DOORBIRD_IP_OR_HOSTNAME
username: YOUR_USERNAME
password: YOUR_PASSWORD
token: CUSTOM_TOKEN_2
name: Driveway Gate
events:
- doorbell_1
- somebody_pressed_the_button
- relay_unlocked
- unit_2_bell
- rfid_card_scanned
```
{% include integrations/config_flow.md %}
## Events
Events can be defined for each configured DoorBird device independently. These events will be registered on the device and can be attached to a schedule via the DoorBird app.
Events can be defined for each configured DoorBird device independently. These events will be registered on the device and can be attached to a schedule via the DoorBird app.
See [Schedules](#schedules) section below for details on how to configure schedules.

27
source/_integrations/dunehd.markdown
View File

@ -15,29 +15,4 @@ The `Dune HD` integration allows you to control a [Dune HD media player](https:/
Devices with firmware 110127_2105_beta or above are supported. Some functions may depend on the version of the protocol (volume / mute control is only available with version 2 onwards).
## Configuration
To add `Dune HD` to your installation, go to **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **Dune HD**.
If you have following configuration in your `configuration.yaml` file it will be imported to the Integrations:
```yaml
# Example configuration.yaml entry
media_player:
- platform: dunehd
host: IP_ADDRESS
```
{% configuration %}
host:
description: IP address or hostname of the device, e.g., 192.168.1.32.
required: true
type: string
name:
description: Name of the device.
required: false
default: Dune HD
type: string
{% endconfiguration %}
After importing, you can safely remove this configuration from the `configuration.yaml` file.
{% include integrations/config_flow.md %}

5
source/_integrations/econet.markdown
View File

@ -18,7 +18,4 @@ ha_platforms:
The `econet` water heater platform is consuming the information provided by a [EcoNet enabled Rheem water heater](https://www.rheem.com/EcoNet/Home). This platform allows you to set the temperature, the operation mode, and away mode. It also provides access to several device sensors depending on your model of water heater.
## Configuration
1. From the Home Assistant front-end, navigate to 'Configuration' then 'Integrations'. Under 'Set up a new integration' locate 'Rheem EcoNet Products' and click 'Configure'.
2. Enter the information requested, email and password, and click 'Submit'.
{% include integrations/config_flow.md %}

18
source/_integrations/elgato.markdown
View File

@ -23,23 +23,7 @@ bar for high-end studio lightning. With 80 LEDs, that put out a massive
The LED light panel is created specifically, and designed for streamers
and content creators, many of whom operate on platforms like YouTube and Twitch.
## Configuration
This integration can be configured using the integrations in the
Home Assistant frontend.
Menu: **Configuration** -> **Integrations**.
In most cases, Elgato Key Lights devices will be automatically discovered by
Home Assistant. Those automatically discovered devices are listed
on the integrations page.
If for some reason (e.g., due to lack of mDNS support on your network),
the Elgato Key Light isn't discovered, it can be added manually.
Click on the `+` sign to add an integration and click on **Elgato Key Light**.
After completing the configuration flow, the Key Light integration will be
available.
{% include integrations/config_flow.md %}
## Lights

4
source/_integrations/elkm1.markdown
View File

@ -124,9 +124,9 @@ The complete list of trouble statuses are:
- Display Message In Keypad Line 2
- Fire (zone is part of status)
## Configuration
{% include integrations/config_flow.md %}
To add `ElkM1` to your installation, go to **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **Elk-M1 Control**.
## Manual configuration
Alternatively, configuration through the `configuration.yaml` file
is supported (example below).

4
source/_integrations/emulated_roku.markdown
View File

@ -28,9 +28,9 @@ Using a proxy with whitelisted IP addresses is recommended. (set `advertise_ip`
</div>
## Configuration
{% include integrations/config_flow.md %}
The integration is configurable through the frontend. (**Configuration** -> **Integrations** -> **Emulated Roku**)
## Manual configuration
If you wish to configure advanced options, you can add the following entry in `configuration.yaml`.

25
source/_integrations/enocean.markdown
View File

@ -51,33 +51,10 @@ Support for tech-in messages is not implemented.
## Configuration
To integrate an EnOcean controller with Home Assistant, add the integration from the UI.
Menu: **Configuration** -> **Integrations**.
If your hub is detected automatically, you will be able to select its path from a list. Most often, this list should only contain one path, and a "manual" option.
If your hub is not detected, you will have to manually enter the path.
{% include integrations/config_flow.md %}
Despite the UI-based configuration of the hub, the entities are still configured using YAML see mext chapters).
### Text based configuration (deprecated)
If you have an enocean entry in your `configuration.yaml` file, the setup will be imported.
Note that once imported in the ui-based configuration, the text-based configuration will be ignored. Changing it will have no effect, unless you delete the integration from the UI.
```yaml
# Example configuration.yaml entry
enocean:
device: /dev/ttyUSB0
```
{% configuration %}
device:
description: The port where your device is connected to your Home Assistant host.
required: true
type: string
{% endconfiguration %}
## Binary Sensor
This can typically be one of those batteryless wall switches.

30
source/_integrations/epson.markdown
View File

@ -13,35 +13,7 @@ ha_config_flow: true
The `epson` platform allows you to control a Epson projector from Home Assistant.
To add Epson to your installation go to Integration page and add Epson Projector or configure via `configuration.yaml`.
### Configuration
Add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
media_player:
- platform: epson
host: 192.168.0.123
```
{% configuration %}
host:
description: The host name or address of the Epson projector
required: true
type: string
port:
description: The HTTP port number.
required: false
type: integer
default: 80
name:
description: The name of the device used in the frontend.
required: false
type: string
default: "EPSON Projector"
{% endconfiguration %}
{% include integrations/config_flow.md %}
### Supported features

11
source/_integrations/esphome.markdown
View File

@ -24,13 +24,4 @@ ha_platforms:
This integration allows [ESPHome](https://esphome.io) devices to connect directly to Home Assistant with the [native ESPHome API](https://esphome.io/components/api.html).
## Configuration
An ESPHome device can be set up via the **Integrations** menu: **Configuration** > **Integrations**:
* Click the orange `+` on the lower-right of the screen and select **ESPHome**
* Complete the dialog box and click `SUBMIT`.
* **Host**: If the device is called `livingroom` in ESPHome, the hostname would be `livingroom.local`
* **Port**: The default port is `6053`
* If the node has a password set, Home Assistant prompt for it.
{% include integrations/config_flow.md %}

8
source/_integrations/fireservicerota.markdown
View File

@ -38,13 +38,7 @@ This integration provides the following platforms:
On how to write automations using these platform read the 'Advanced Configuration' section below.
## Configuration
1. From Home Assistant, navigate to ‘Configuration’ then ‘Integrations’. Click the plus icon and type/select ‘FireServiceRota’.
1. Choose your platform `BrandweerRooster` or `FireServiceRota`.
1. Enter your login credentials.
1. Click the Save button.
{% include integrations/config_flow.md %}
## Entities

9
source/_integrations/flick_electric.markdown
View File

@ -15,14 +15,7 @@ ha_platforms:
[Flick Electric Co](https://www.flickelectric.co.nz/) is a power company in New Zealand, based around a transparent pricing model where each component of pricing is provided. This integration uses the mobile app's API from Flick Electric Co to get the current power price as well as each of the components price.
## Configuration
This integration can be configured via the Home Assistant frontend.
- Go to **Configuration** -> **Integrations**.
- Click on the `+` in the bottom right corner to add a new integration.
- Search and select the **Flick Electric** integration form the list.
- Follow the instruction on screen to add the sensor.
{% include integrations/config_flow.md %}
<div class='note'>

5
source/_integrations/flo.markdown
View File

@ -26,10 +26,7 @@ There is currently support for the following device types within Home Assistant:
- **Sensor**: reports on the device's system mode, water flow rate, temperature, water pressure, and daily water consumption.
- **Switch**: allows the user to open and close the valve on the water shutoff device.
## Configuration
This integration can be configured via the Home Assistant UI by navigating to
**Configuration** -> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **Flo**.
{% include integrations/config_flow.md %}
## Services

41
source/_integrations/flume.markdown
View File

@ -19,50 +19,13 @@ The `flume` sensor will show you the current [flume](https://portal.flumewater.c
Flume monitors the real-time status of your home water meter. Allowing the end-user to detect small leaks, gain real-time information on household water consumption, set water goals and budgets, and receive push notifications when suspicious water activities occur.
## Configuration
{% include integrations/config_flow.md %}
You can find your Client ID and Client Secret under "API Access" on the [settings page](https://portal.flumewater.com/#settings).
To add `Flume` to your installation, go to **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **Flume**.
Alternatively, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
# Flume
- platform: flume
username: YOUR_FLUME_USERNAME
password: YOUR_FLUME_PASSWORD
client_id: YOUR_FLUME_CLIENT_ID
client_secret: YOUR_FLUME_CLIENT_SECRET
```
{% configuration %}
username:
description: Your flume user id.
required: true
type: string
password:
description: Your flume password.
required: true
type: string
client_id:
description: Your flume Client ID.
required: true
type: string
client_secret:
description: Your flume Client Secret.
required: true
type: string
name:
description: A name to display on the sensor.
required: false
default: Flume Sensor
type: string
{% endconfiguration %}
# Configuration for Binary Sensor
## Configuration for Binary Sensor
The following YAML creates a binary sensor. This requires the default sensor to be configured successfully.

5
source/_integrations/flunearyou.markdown
View File

@ -18,10 +18,7 @@ territories to get information regarding reported flu symptoms from [Flu Near
You](https://flunearyou.org/). The platform can return user-reported information as well reports from the
Center for Disease Control (CDC).
## Configuration
This integration can be configured via the Home Assistant UI by navigating to
**Configuration** -> **Integrations**.
{% include integrations/config_flow.md %}
## Sensor Types

4
source/_integrations/forked_daapd.markdown
View File

@ -18,9 +18,7 @@ The `forked_daapd` integration allows you to control your [forked-daapd](http://
The `forked_daapd` integration requires a forked-daapd server built with libwebsockets enabled, version >= 27.0.
## Configuration
To add `forked-daapd` to your installation, go to **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **forked-daapd**.
{% include integrations/config_flow.md %}
## Outputs

4
source/_integrations/foscam.markdown
View File

@ -15,9 +15,7 @@ ha_platforms:
The `foscam` platform allows you to watch the live stream of your [Foscam](https://www.foscam.com) IP camera in Home Assistant.
## Configuration
Home Assistant offers Foscam IP Cameras integration through **Configuration** -> **Integrations** -> **Foscam**. Follow the instructions to get it set up.
{% include integrations/config_flow.md %}
<div class='note'>
There seems to be some issues within Foscam with lengthy passwords and passwords containing certain symbols. Be sure to check your camera's documentation.

5
source/_integrations/freebox.markdown
View File

@ -27,10 +27,7 @@ There is currently support for the following device types within Home Assistant:
* [Device tracker](#presence-detection) for connected devices
* [Switch](#switch) to control Wi-Fi
## Configuration
If you have enabled the [discovery integration](/integrations/discovery/), your Freebox should be detected automatically.
Otherwise, you can set it up manually via the frontend or via your `configuration.yaml` file.
{% include integrations/config_flow.md %}
You can find out your Freebox host and port by opening this address <http://mafreebox.freebox.fr/api_version> in your browser.
The returned JSON should contain an `api_domain` (`host`) and a `https_port` (`port`).

40
source/_integrations/fritzbox.markdown
View File

@ -38,45 +38,7 @@ There is currently support for the following device types within Home Assistant:
- [FRITZ!DECT 301](https://en.avm.de/products/fritzdect/fritzdect-301/)
- [Eurotronic Comet DECT](https://eurotronic.org/produkte/elektronische-heizkoerperthermostate/sparmatic-comet/)
## Configuration
To add the AVM FRITZ!SmartHome integration to your installation, go to **Configuration** -> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **AVM FRITZ! SmartHome**.
If you have enabled SSDP discovery, it’s likely that you just have to confirm the detected device with username and password.
### Configuration via YAML
YAML configuration is still around for people that prefer YAML, but it's deprecated and you should not use it anymore.
```yaml
# Example configuration.yaml entry
fritzbox:
devices:
- password: YOUR_PASSWORD
```
{% configuration %}
devices:
description: A list of FRITZ! devices.
type: map
keys:
host:
description: The hostname or IP address of the FRITZ!Box. (e.g. fritz.box or 192.168.178.1)
required: false
type: string
default: fritz.box
username:
description: The username for Smart Home access. **(User needs "Smart Home" persmission!)**
required: false
type: string
default: admin
password:
description: The password of the user.
required: true
type: string
{% endconfiguration %}
{% include integrations/config_flow.md %}
## Switches & Thermostats

4
source/_integrations/fritzbox_callmonitor.markdown
View File

@ -31,9 +31,7 @@ To use the FRITZ!Box call monitor in your installation, a user with at least `FR
To activate the call monitor on your FRITZ!Box, dial **#96\*5\*** from any phone connected to it.
## Configuration
To add the AVM FRITZ!Box Call Monitor integration to your installation, go to **Configuration** -> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **AVM FRITZ!Box Call Monitor**.
{% include integrations/config_flow.md %}
## Examples

6
source/_integrations/garmin_connect.markdown
View File

@ -15,11 +15,9 @@ ha_platforms:
The Garmin Connect sensor allows you to expose data from [Garmin Connect](https://connect.garmin.com) to Home Assistant.
## Configuration
{% include integrations/config_flow.md %}
To add Garmin Connect to your installation, go to Configuration >> Integrations in the UI and enable the Garmin Connect integration by entering your credentials.
After successful login a standard set of sensors are enabled.
After successful set up a standard set of sensors are enabled.
You can enable more if needed by using the Integrations page.
Please be aware that Garmin Connect has very low rate limits, max. once every ~10 minutes.

33
source/_integrations/gdacs.markdown
View File

@ -44,38 +44,7 @@ Please refer to the [creator's disclaimer and terms of use notice](https://www.g
</div>
## Configuration
To integrate the GDACS feed use the "Integrations" feature
in the GUI, you find it under Configurations - Integrations, or add the
following line to your `configuration.yaml`.
```yaml
# Example configuration.yaml entry
gdacs:
```
{% configuration %}
categories:
description: The categories of alerts to be included. Valid categories are 'Drought', 'Earthquake', 'Flood', 'Tropical Cyclone', 'Tsunami', 'Volcano'.
required: false
type: list
radius:
description: The radius around your location to monitor; defaults to 500 km or mi (depending on the unit system defined in your `configuration.yaml`).
required: false
type: float
default: 500.0
latitude:
description: Latitude of the coordinates around which alerts are considered.
required: false
type: float
default: Latitude defined in your configuration.
longitude:
description: Longitude of the coordinates around which alerts are considered.
required: false
type: float
default: Longitude defined in your configuration.
{% endconfiguration %}
{% include integrations/config_flow.md %}
## State Attributes

39
source/_integrations/geonetnz_quakes.markdown
View File

@ -43,44 +43,7 @@ We acknowledge the New Zealand GeoNet project and its sponsors EQC, GNS Science
</div>
## Configuration
To integrate the GeoNet New Zealand Quakes feed use the "Integrations" feature
in the GUI, you find it under Configurations - Integrations, or add the
following line to your `configuration.yaml`.
```yaml
# Example configuration.yaml entry
geonetnz_quakes:
```
{% configuration %}
mmi:
description: Request quakes that may have caused shaking greater than or equal to the [MMI](https://www.geonet.org.nz/earthquake/mmi) value. Allowable values are -1..8 inclusive. Value -1 is used for quakes that are too small to calculate a stable MMI value for.
required: false
type: integer
default: 2
minimum_magnitude:
description: The minimum magnitude of an earthquake to be included.
required: false
type: float
default: 0.0
radius:
description: The radius around your location to monitor; defaults to 50 km or mi (depending on the unit system defined in your `configuration.yaml`).
required: false
type: float
default: 50.0
latitude:
description: Latitude of the coordinates around which quakes are considered.
required: false
type: float
default: Latitude defined in your configuration.
longitude:
description: Longitude of the coordinates around which quakes are considered.
required: false
type: float
default: Longitude defined in your configuration.
{% endconfiguration %}
{% include integrations/config_flow.md %}
## State Attributes

29
source/_integrations/geonetnz_volcano.markdown
View File

@ -44,34 +44,7 @@ We acknowledge the New Zealand GeoNet project and its sponsors EQC, GNS Science
</div>
## Configuration
To integrate the GeoNet New Zealand Volcanic Alert Level feed use the **Integrations** feature
in the GUI, you find it under **Configurations** -> **Integrations**, or add the
following line to your `configuration.yaml`.
```yaml
# Example configuration.yaml entry
geonetnz_volcano:
```
{% configuration %}
radius:
description: The radius around your location to monitor; defaults to 50 km or mi (depending on the unit system defined in your configuration).
required: false
type: float
default: 50.0
latitude:
description: Latitude of the coordinates around which volcanoes are considered.
required: false
type: float
default: Latitude defined in your configuration.
longitude:
description: Longitude of the coordinates around which volcanoes are considered.
required: false
type: float
default: Longitude defined in your configuration.
{% endconfiguration %}
{% include integrations/config_flow.md %}
## State Attributes

13
source/_integrations/gios.markdown
View File

@ -20,18 +20,11 @@ The `gios` integration uses the [GIOŚ](http://powietrze.gios.gov.pl/pjp/current
To obtain `station_id` of the measuring station, go to [GIOŚ](http://powietrze.gios.gov.pl/pjp/current) page, select the measuring station on the map and click the "More Info" link. The address of the opened page will look like this: `http://powietrze.gios.gov.pl/pjp/current/station_details/chart/291` and `291` will be `station_id` of measuring station.
## Configuration
{% include integrations/config_flow.md %}
To add GIOŚ to your installation, go to **Configuration** >> **Integrations** in the UI and enable the GIOŚ integration.
{% configuration %}
{% configuration_basic %}
name:
description: Manually specify Name.
required: false
type: string
default: GIOŚ
station_id:
description: Specify ID of the measuring station.
required: true
type: integer
{% endconfiguration %}
{% endconfiguration_basic %}

51
source/_integrations/glances.markdown
View File

@ -39,56 +39,7 @@ If this doesn't work, try changing the `3` to `2`, if you don't have the latest
For details about auto-starting `glances`, please refer to [Start Glances through Systemd](https://github.com/nicolargo/glances/wiki/Start-Glances-through-Systemd).
## Configuration
Set up the integration through **Configuration -> Integrations -> Glances**. To import the configuration from `configuration.yaml` remove any previously configured sensors with platform type `glances` and add the following lines:
```yaml
# Example configuration.yaml entry
glances:
- host: IP_ADDRESS
```
{% configuration %}
host:
description: IP address of the host where Glances is running.
required: false
type: string
default: localhost
port:
description: The port where Glances is listening.
required: false
type: integer
default: 61208
name:
description: The prefix for the sensors.
required: false
type: string
default: Glances
username:
description: Your username for the HTTP connection to Glances.
required: false
type: string
password:
description: Your password for the HTTP connection to Glances.
required: false
type: string
ssl:
description: "If `true`, use SSL/TLS to connect to the Glances system."
required: false
type: boolean
default: false
verify_ssl:
description: Verify the certification of the system.
required: false
type: boolean
default: true
version:
description: "The version of the Glances API. Supported version: `2` and `3`."
required: false
type: integer
default: 3
{% endconfiguration %}
{% include integrations/config_flow.md %}
## Integration Entities

4
source/_integrations/goalzero.markdown
View File

@ -15,9 +15,7 @@ ha_platforms:
This `goalzero` integration pulls data from a Wifi enabled Goal Zero Yeti.
## Configuration
Go to the integrations page in your configuration and click on new integration -> Goal Zero Yeti.
{% include integrations/config_flow.md %}
## Integration Entities

5
source/_integrations/gogogate2.markdown
View File

@ -17,7 +17,4 @@ ha_platforms:
The `gogogate2` cover platform lets you control Gogogate2 and iSmartGate enabled garage doors and gates through Home Assistant. Device names in Home Assistant are generated based on the names defined in the GogoGate2 or iSmartGate mobile app.
## Configuration
1. From the Home Assistant front-end, navigate to 'Configuration' then 'Integrations'. Under 'Set up a new integration' locate 'GogoGate2 or iSmartGate' and click 'Configure'.
2. Enter the information appropriate for the server and click 'Submit'.
{% include integrations/config_flow.md %}

6
source/_integrations/gree.markdown
View File

@ -21,11 +21,7 @@ There is currently support for the following device types within Home Assistant:
- [Climate](#climate)
- [Switch](#switch)
## Configuration
Go to the integrations page in your configuration and click on **new integration** -> **Gree**.
Gree Smart compatible devices are detected and added automatically.
{% include integrations/config_flow.md %}
<div class='note'>
Devices must first be bound to WiFi using the Gree+ app, or app provided by the device manufacturer. It is not possible to connect devices to WiFi using this integration at the current time.

19
source/_integrations/griddy.markdown
View File

@ -20,26 +20,11 @@ There is currently support for the following device types within Home Assistant:
- Sensor
## Configuration
## Prerequisites
You will need your Griddy Load Zone to use this module.
To add `Griddy` to your installation, go to **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **Griddy**.
Alternatively, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
griddy:
loadzone: YOUR_LZ
```
{% configuration %}
loadzone:
description: Your Load Zone is in your Griddy account under “Account > Meter > Load Zone.”
required: true
type: string
{% endconfiguration %}
{% include integrations/config_flow.md %}
### Sensor

7
source/_integrations/guardian.markdown
View File

@ -27,12 +27,7 @@ There is currently support for the following device types within Home Assistant:
- **Sensor**: reports on the device's detected temperature and uptime
- **Switch**: allows the user to open and close the valve
## Configuration
This integration can be configured via the Home Assistant UI by navigating to
**Configuration** -> **Integrations**. If you have the `zeroconf` integration enabled,
Home Assistant will automatically discover any Guardian devices already connected to the
network.
{% include integrations/config_flow.md %}
## Services

9
source/_integrations/hangouts.markdown
View File

@ -18,14 +18,7 @@ There is currently support for the following device types within Home Assistant:
- [Notifications](#notifications)
## Setup the integration via the frontend
Menu: *Configuration* -> *Integrations*
Configure the integration:
* Enter your **Google Mail Address** and **Password**
* In the authentication form there is an Optional Field: **Authorization Code** which should only be used if you get an invalid login error with email and password (see note below for details).
* If you secured your account with 2-factor authentication you will be asked for a 2-factor authentication token.
{% include integrations/config_flow.md %}
## Manual Authentication

4
source/_integrations/harmony.markdown
View File

@ -28,9 +28,9 @@ Supported units:
- Harmony Elite
- Harmony Pro 2400
The preferred way to setup the Harmony remote for your installation is via **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **Logitech Harmony Hub**.
{% include integrations/config_flow.md %}
Once `Logitech Harmony Hub` has been configured, the default activity and duration in seconds between sending commands to a device can be adjusted in the settings via **Configuration** >> **Integrations** >> **Your Logitech Harmony Hub**
Once the Logitech Harmony Hub has been configured, the default activity and duration in seconds between sending commands to a device can be adjusted in the settings via **Configuration** >> **Integrations** >> **Your Logitech Harmony Hub**
### Configuration file

17
source/_integrations/heos.markdown
View File

@ -20,22 +20,7 @@ The HEOS integration adds support for [HEOS](https://www.denon.com/en-gb/shop/am
- Clear playlist
- Select source from device physical inputs and HEOS favorites
## Configuration
HEOS devices are discovered and setup automatically when the [discovery](/integrations/discovery) integration is enabled. Alternatively, the integration can be setup through the frontend control panel integrations page or manually by adding the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
heos:
host: IP_ADDRESS
```
{% configuration %}
host:
description: "Address of the device. Example: 192.168.1.32."
required: true
type: string
{% endconfiguration %}
{% include integrations/config_flow.md %}
<div class='note info'>
A connection to a single device enables control for all devices on the network. If you have multiple HEOS devices, enter the host of one that is connected to the LAN via wire or has the strongest wireless signal.

29
source/_integrations/hisense_aehw4a1.markdown
View File

@ -19,31 +19,4 @@ Later AC models use other Wi-Fi modules (like AEH-W4B1 and AEH-W4E1) that are no
It is highly recommended not to use one of the official smartphone applications and this integration at the same time, to avoid problems related to command collision.
## Configuration
To integrate one or more Hisense AEH-W4A1 controlled ACs with Home Assistant, use the Configuration/Integrations or add the following section to your `configuration.yaml` file:
```yaml
# Automatic discovery
hisense_aehw4a1:
```
Alternately, devices that are not discoverable can be statically configured.
The use of static configuration disables automatic discovery.
{% configuration %}
ip_address:
description: One or more static IP addresses
required: false
type: list
{% endconfiguration %}
## Full configuration example
```yaml
# Static configured devices
hisense_aehw4a1:
ip_address:
- 192.168.5.10
- 192.168.5.20
```
{% include integrations/config_flow.md %}

6
source/_integrations/hlk_sw16.markdown
View File

@ -16,8 +16,4 @@ ha_platforms:
The [HLK-SW16](http://www.hlktech.net/product_detail.php?ProId=48) by [Hi-Link](http://www.hlktech.net/) is a simple networkable 16 port relay device.
## Configuration
To add a Hi-Link HLK-SW16 to your installation, go to **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **Hi-Link HLK-SW16**.
Enter the host and port for the HLK-SW16 TCP socket control interface and hit submit, if the connection is successful this will automatically populate the 16 relay switches as switch entities.
{% include integrations/config_flow.md %}

15
source/_integrations/home_connect.markdown
View File

@ -33,9 +33,7 @@ The integration will add one Home Assistant device for each connected home appli
Note that it depends on the appliance and on API permissions which of the features are supported. A notable limitation is that oven programs cannot be started currently.
## Installation
### Installation using a developer account
## Prerequisites
1. Visit [https://developer.home-connect.com](https://developer.home-connect.com) and sign up for a developer account.
2. Enter the email of your login for the original Home Connect App from Bosch/Siemens under "Default Home Connect User Account for Testing" in the sign up process.
@ -46,14 +44,7 @@ Note that it depends on the appliance and on API permissions which of the featur
- Redirect URI: "`<INTERNAL_HOME_ASSISTANT_URL>/auth/external/callback`
Use your internal Home Assistant URL, if you didn't configure one manually, use your local IP address. Examples: `http://192.168.0.2:8123/auth/external/callback`, `http://homeassistant.local:8123/auth/external/callback`."
4. Add the client ID and client secret to your `configuration.yaml` (see below).
5. Once Home Assistant has restarted, go to Configuration > Integrations.
6. Select the Home Connect integration.
7. You will be prompted to open a web page and authenticate your app with Home Connect.
8. Use your Home Connect account details associated with your developer app. It must be the login for the Home Connect account you entered in Step 2.
9. You will know it works when you are prompted to allow Home Assistant to access your Home Connect data, including the list of devices accessible to the original Home Connect app.
### Configuration
Next, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -73,3 +64,5 @@ client_secret:
required: true
type: string
{% endconfiguration %}
{% include integrations/config_flow.md %}

5
source/_integrations/homekit.markdown
View File

@ -20,9 +20,10 @@ The HomeKit Bridge integration allows you to make your Home Assistant entities a
</div>
To add `HomeKit Bridge` to your installation, go to **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **HomeKit Bridge**.
{% include integrations/config_flow.md %}
If you need to use the `entity_config`, `ip_address`, or `advertise_ip` configuration options, `HomeKit Bridge` must be configured via your `configuration.yaml` file:
If you need to use the `entity_config`, `ip_address`, or `advertise_ip` configuration options, HomeKit Bridge must be configured via your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry configuring HomeKit

14
source/_integrations/homematicip_cloud.markdown
View File

@ -41,19 +41,9 @@ There is currently support for the following device types within Home Assistant:
* Switch
* Weather
## Setup the integration via the frontend
{% include integrations/config_flow.md %}
Menu: *Configuration* -> *Integrations*
Fill the form:
* Your **access point ID** (SGTIN)
* Optional a **name** to identify your access point, this will be used to prefix your device names.
* The **PIN**, mandatory if one is used in the native HomematicIP App.
The authentification token will be generated and stored internally.
## Setup the integration using the configuration files
## Manual configuration
Generate the authentication token:

2
source/_integrations/huawei_lte.markdown
View File

@ -52,7 +52,7 @@ integration will try to use all configured ones and fail gracefully if
it detects one requiring authentication in unauthenticated mode.
Only a subset of the entities provided by the target device by
default:
default:
- WAN IP address sensor
- LTE signal sensors RSRQ, RSRP, RSSI, and SINR

6
source/_integrations/hue.markdown
View File

@ -33,11 +33,7 @@ There is currently support for the following device types within Home Assistant:
- Hue Smart Button
- Friends of Hue Switch
To set up this integration, click Configuration in the sidebar and then click Integrations. You should see "Philips Hue" in the discovered section (if you do not, click the + icon in the lower right and find Philips Hue). Click configure and you will be presented with the initiation dialog. This will prompt you select the Hue hub to configure and next to press the button on your Hue bridge to register the hub with Home Assistant. After you click submit, you will have the opportunity to select the area that your bridge is located.
When you configure the Hue bridge from Home Assistant, it writes a token to a file in your Home Assistant [configuration directory](/docs/configuration/). That token authenticates the communication with the Hue bridge. This token uses the IP address of the bridge. If the IP address for the bridge changes, you will need to register it with Home Assistant again. To avoid this, you may set up a DHCP reservation on your router for your Hue bridge so that it always has the same IP address.
Once registration is complete you should see the Hue lights listed as `light` entities, the Hue motion sensors listed as `binary_sensor` entities, and the Hue temperature and light level sensors (which are built in to the motion sensors) listed as `sensor` entities. If you don't, you may have to restart Home Assistant once more.
{% include integrations/config_flow.md %}
## Using Hue Groups in Home Assistant

9
source/_integrations/huisbaasje.markdown
View File

@ -17,14 +17,7 @@ ha_platforms:
The Huisbaasje integrations allows you to track your energy consumption collected
by the monitoring device installed on your energy meters.
## Configuration
Menu: **Configuration** -> **Integrations**.
Click on the `+` sign to add an integration and click on **Huisbaasje**.
Log in using your Huisbaasje account. After finishing, the Huisbaasje integration
will be available.
{% include integrations/config_flow.md %}
## Sensors
This integration provides the following sensors:

2
source/_integrations/hunterdouglas_powerview.markdown
View File

@ -25,7 +25,7 @@ There is currently support for the following device types within Home Assistant:
- Scene
- Sensor
To add `Hunter Douglas PowerView` to your installation, go to **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **Hunter Douglas PowerView**.
{% include integrations/config_flow.md %}
## Example Automations

12
source/_integrations/hvv_departures.markdown
View File

@ -16,18 +16,10 @@ ha_platforms:
The `hvv_departures` sensor will display the departures of busses, trains and ferries in Hamburg.
## Configuration
{% include integrations/config_flow.md %}
Menu: *Configuration* > *Integrations*
Press on **HVV Departures** and configure the integration:
- You can keep the default host (only change it if you know what you are doing)
- Enter your API credentials (see [How to get the API credentials](#how-to-get-the-api-credentials))
- Enter your station. You can also enter your address or a point of interest.
- Select the station/address/poi you want
After that, you will get a sensor showing the time until the next departure.
Need your API credentials? See [how to get the API credentials](#how-to-get-the-api-credentials).
## Options

19
source/_integrations/hyperion.markdown
View File

@ -16,7 +16,7 @@ ha_platforms:
- switch
---
The `hyperion` platform allows you to integrate your
The Hyperion 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.
@ -24,22 +24,7 @@ an open source Ambilight implementation which runs on many platforms.
supported, the original [discontinued Hyperion](https://github.com/hyperion-project/hyperion) is not supported by
this integration.
## Configuration
This integration can be configured using the integrations in the
Home Assistant frontend.
Menu: **Configuration** -> **Integrations**.
In most cases, Hyperion servers will be automatically discovered by
Home Assistant. Those automatically discovered devices are listed
on the integrations page.
If for some reason Hyperion isn't discovered, it can be added manually.
Click on the `+` sign to add an integration and click on **Hyperion**.
After completing the configuration flow, the Hyperion integration will be
available.
{% include integrations/config_flow.md %}
### Extra configuration of the integration

24
source/_integrations/iaqualink.markdown
View File

@ -31,29 +31,7 @@ There is currently support for the following device types within Home Assistant:
- Sensor
- Switch
## Configuration
Home Assistant offers Jandy iAqualink integration through **Configuration** -> **Integrations** -> **Jandy iAqualink**. Simply enter `username` and `password` when prompted.
You can also configure the component via `configuration.yaml`:
```yaml
# Example configuration.yaml entry
iaqualink:
username: YOUR_USERNAME
password: YOUR_PASSWORD
```
{% configuration %}
username:
description: The username for accessing your iAqualink account
type: string
required: true
password:
description: The password for accessing your iAqualink account
type: string
required: true
{% endconfiguration %}
{% include integrations/config_flow.md %}
## Known limitations

52
source/_integrations/icloud.markdown
View File

@ -25,57 +25,7 @@ There is currently support for the following platforms within Home Assistant:
It does require that your devices are registered with the [Find My](https://www.apple.com/uk/icloud/find-my/) service.
## Setup the integration
There is two ways to integrate iCloud in Home Assistant
### Via the frontend
Menu: *Configuration* -> *Integrations*. Search for "iCloud", add your credentials, click submit.
If you add the integration for the first time for an account, and two-factor authentication is enabled:
1. After clicking submit, you will receive a verification code on your trusted iCloud devices.
2. Press Allow on your device, and enter the 6 digit code in Home Assistant. Finally, click Submit.
3. You are done!
If you already added the integration before, you are done!
### Via the configuration file
Add the following section to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
icloud:
- username: USERNAME
password: PASSWORD
```
{% configuration %}
username:
description: Your iCloud account email.
required: true
type: string
password:
description: Your iCloud account password.
required: true
type: string
with_family:
description: If you want to fetch your family devices.
required: false
default: false
type: boolean
max_interval:
description: Maximum interval in minutes between subsequent location updates. This tracker uses dynamic intervals for requesting location updates. When the iPhone is stationary, the interval will eventually be set to `max_interval` to save battery. When the iPhone starts moving again, the interval will be dynamically updated to 1 min. Note that updating interval to 1 min might be delayed by maximum `max_interval` minutes. Minimum value is 1 min.
required: false
default: 30
type: integer
gps_accuracy_threshold:
description: iCloud location updates come with some gps_accuracy varying from 10 to 5000 meters. This setting defines the accuracy threshold in meters for a location update. Less accurate updates will be discarded by this tracker. This allows for more precise location monitoring and fewer false-positive zone changes.
required: false
default: 500
type: integer
{% endconfiguration %}
{% include integrations/config_flow.md %}
<div class='note warning'>
Low `max_interval` may cause battery drainage as it wakes up your device to get the current location.

6
source/_integrations/ifttt.markdown
View File

@ -13,13 +13,11 @@ ha_platforms:
[IFTTT](https://ifttt.com) is a web service that allows users to create chains of simple conditional statements, so-called "Applets". With the IFTTT component, you can trigger applets through the **"Webhooks"** service (which was previously the **"Maker"** channel).
## Sending events from IFTTT to Home Assistant
## Prerequisites
To be able to receive events from IFTTT, your Home Assistant instance needs to be accessible from the web and you need to have the external URL [configured](/docs/configuration/basic).
### Setting up the integration
To set it up, go to the integrations page in the configuration screen and find IFTTT. Click on configure. Follow the instructions on the screen to configure IFTTT.
{% include integrations/config_flow.md %}
### Using the incoming data

33
source/_integrations/ipma.markdown
View File

@ -16,35 +16,4 @@ ha_platforms:
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.
## Configuration
To add the IPMA weather platform to your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
weather:
- platform: ipma
```
{% configuration %}
name:
description: The name you would like to give to the weather station.
required: false
type: string
default: The name of the used station
latitude:
description: Latitude of the location for which you want weather information.
required: false
type: string
default: Home Assistant global latitude configuration
longitude:
description: Longitude of the location for which you want weather information.
required: false
type: string
default: Home Assistant global longitude configuration
mode:
description: "The forecast type. Can be `hourly` or `daily`."
required: false
type: string
default: "`daily`"
{% endconfiguration %}
{% include integrations/config_flow.md %}

5
source/_integrations/iqvia.markdown
View File

@ -22,10 +22,7 @@ Data measured includes:
* Current outlook
* more!
## Configuring the Integration
This integration can be configured via the Home Assistant UI by navigating to
**Configuration** -> **Integrations**.
{% include integrations/config_flow.md %}
## Understanding the Indices

25
source/_integrations/islamic_prayer_times.markdown
View File

@ -22,23 +22,7 @@ This platform calculates prayer times using the following calculation methods:
- Muslim World League
- Umm Al-Qura University in Makkah
## Configuration
Set up the integration through **Configuration -> Integrations -> Islamic Prayer Times**. To import the configuration from `configuration.yaml` remove any previously configured sensors with platform type `islamic_prayer_times` and add the following lines:
```yaml
# Example configuration.yaml entry
islamic_prayer_times:
```
{% configuration %}
calculation_method:
required: false
default: "isna"
type: string
description: "The calculation method used for prayer times. Must be one of: `karachi`, `isna`, `mwl`, `makkah`."
{% endconfiguration %}
{% include integrations/config_flow.md %}
## Integration Sensors
@ -52,10 +36,3 @@ sensors:
- maghrib: Show the maghrib prayer time for today.
- isha: Show the isha prayer time for today.
- midnight: Show the midnight for today which is the end of isha prayer. This is a calculated field and is not the same as 12AM.
```yaml
# Example configuration.yaml using a non-default calculation method
islamic_prayer_times:
calculation_method: makkah
```

5
source/_integrations/isy994.markdown
View File

@ -44,11 +44,10 @@ There is currently support for the following device types within Home Assistant:
- Sensor
- Switch
### Basic Configuration
Home Assistant is capable of communicating with any binary sensor, cover, fan, light, lock, sensor and switch that is configured on the controller. Using the programs on the controller, custom binary sensors, cover, fan, lock, and switches can also be created.
To integrate your ISY994 controller with Home Assistant, Go to the **integrations page** in your configuration and click on new **integration** -> **Universal Devices ISY994**.
{% include integrations/config_flow.md %}
## Manual configuration
You may also configure the integration manually by adding the following section to your `configuration.yaml` file:

12
source/_integrations/izone.markdown
View File

@ -20,16 +20,14 @@ The `iZone` integration allows access of control of a local [iZone](https://izon
Any current iZone unit with ducted reverse cycle airconditioning and the CB wired or wireless bridge device installed should currently work. There is currently no support for the iZone lights, reticulation, or other devices.
## Configuration
{% include integrations/config_flow.md %}
The iZone component can be configured in two ways.
- Via the integrations configuration of the Home Assistant user interface.
- Or via the `configuration.yaml` file by adding the following:
## Manual configuration
If you load the integration from the integrations window, all local iZone instances are added. The integration will discover any new instances added to the local area later on as well.
Alternately if there is more than one iZone system on the local network and one or more must be excluded use manual configuration:
Alternatively, the iZone integration can be configured manually via the
`configuration.yaml` file if there is more than one iZone system on the local
network and one or more must be excluded use manual configuration:
```yaml
# Full manual example configuration.yaml entry

19
source/_integrations/juicenet.markdown
View File

@ -19,24 +19,7 @@ ha_platforms:
The `juicenet` platform pulls data from a [JuiceNet](https://evcharging.enelx.com/products/juicebox) charging station equipped with a Wi-Fi connection. It will access and make available all of the devices attached to your account. It also exposes a switch allowing you to charge your car now instead of waiting for the pre-set schedule.
## Configuration
To add `JuiceNet` go to **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **JuiceNet**.
Alternatively, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
juicenet:
access_token: ACCESS_TOKEN
```
{% configuration %}
access_token:
description: "Your JuiceNet API Token can be found in the [dashboard](https://home.juice.net/Manage)."
required: true
type: string
{% endconfiguration %}
{% include integrations/config_flow.md %}
## Sensor

6
source/_integrations/kodi.markdown
View File

@ -25,11 +25,7 @@ There is currently support for the following device types within Home Assistant:
- [Media Player](#configuration)
- [Notifications](#notifications)
## Configuration
The Kodi media player is configured through the integrations screen. If your Kodi is discovered, you'll see it there and can click to set it up.
If you do not see your device, you can click on the `+` button and choose Kodi.
The flow will guide you through the setup. Most of the settings are advanced, and the defaults should work.
{% include integrations/config_flow.md %}
If you previously had Kodi configured through `configuration.yaml`, it's advisable to remove it, and configure from the UI.
If you do not remove it, your configuration will be imported with the following limitations:

10
source/_integrations/kulersky.markdown
View File

@ -15,15 +15,7 @@ ha_platforms:
This integration connects Brightech Kuler Sky floor lamps to Home Assistant.
## Configuration
This integration can be configured using the integrations page in Home Assistant.
Menu: **Configuration** -> **Integrations**.
Click on the `+` sign to add an integration and search for **Kuler Sky**.
The integration will scan for nearby Bluetooth devices, and ask you to select your lamp.
{% include integrations/config_flow.md %}
## Additional information for Home Assistant Core on Python environments

6
source/_integrations/life360.markdown
View File

@ -15,11 +15,13 @@ ha_platforms:
The `life360` integration allows you to detect presence using the [unofficial API](#disclaimer) of [Life360](https://www.life360.com/).
## Life360 Account
## Prerequisites
You must first [create a Life360 account](https://www.life360.com/websignup).
Then in the Home Assistant user interface (UI), click on Configuration in the left pane, then on Integrations and then on the yellow circle in the lower-right corner to "Set up a new integration." Scroll through the list and click on Life360. Enter your Life360 username and password and click SUBMIT. You can add as many Life360 accounts as you like.
{% include integrations/config_flow.md %}
## Advanced configuration
If you would like to set any advanced options, see the following section. You may want to do this before entering your Life360 account information in the UI, or you can change it at any time. Any of the advanced options you want to set from the section below will need to be set manually in your `configuration.yaml` file. They are not able to be set from the UI. You can also enter your account information in the configuration file (in addition to, or instead of, the UI) if you prefer.

2
source/_integrations/lifx.markdown
View File

@ -16,7 +16,7 @@ The `lifx` integration allows you to integrate your [LIFX](https://www.lifx.com)
_Please note, the `lifx` integration does not support Windows. The `lifx_legacy` light platform (supporting basic functionality) can be used instead._
You can configure the LIFX integration by going to the integrations page inside the configuration panel.
{% include integrations/config_flow.md %}
## Set state

9
source/_integrations/local_ip.markdown
View File

@ -15,11 +15,4 @@ ha_platforms:
The `local_ip` sensor will expose the local (LAN) IP address of your Home Assistant instance. This can be useful when your instance has a static public hostname (for example, if you use the Nabu Casa service), but have a dynamically allocated local LAN address (for example, configured via DHCP).
The sensor can be added via the user interface or using the `configuration.yaml` file. To enable this sensor, via the `configuration.yaml` file, add the following minimal configuration:
```yaml
# Example configuration.yaml entry
local_ip:
```
To configure via the user interface, select the `Local IP Address` integration.
{% include integrations/config_flow.md %}

9
source/_integrations/luftdaten.markdown
View File

@ -22,14 +22,7 @@ The `luftdaten` integration will query the open data API of [luftdaten.info](htt
- To get the ID of a particle sensor you need to select it on the [Feinstaub map](https://deutschland.maps.luftdaten.info/) and find it in the sidebar (Column "Sensor ID").
- To get the ID of a temperature/humidity sensor you need to find it on the map hosted on [Madavi](https://www.madavi.de/sensor/feinstaub-map-dht/).
## Configuration via the frontend
Menu: **Configuration** -> **Integrations**
Configure the integration:
- Enter the **Sensor ID**
- Choose if you want to show the sensor's location on the map.
{% include integrations/config_flow.md %}
## Manual Configuration

4
source/_integrations/lutron_caseta.markdown
View File

@ -45,7 +45,9 @@ Additionally RA2 Select Main Repeater (`RR-SEL-REP2-BL`) or Lutron Caséta Smart
- Pico Remotes as [device triggers](/integrations/device_automation/)
- Shade Remotes as [device triggers](/integrations/device_automation/)
If you have physical access to the Lutron Bridge, to add `Lutron Caséta` to your installation, go to **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **Lutron Caséta**.
{% include integrations/config_flow.md %}
## Manual configuration
Alternatively, if you already have `caseta.key`, `caseta.crt`, `caseta-bridge.crt`, and cannot physically access the bridge to press the button, pairing can be done manually using the following steps:

25
source/_integrations/melcloud.markdown
View File

@ -24,30 +24,7 @@ The `melcloud` integration integrates Mitsubishi Electric's [MELCloud](https://w
- Energy recovery ventilators - **Not supported**
- Other - **Not supported**
## Configuration
The integration should be configured through the user interface ("Configurations -> Integrations") using the MELCloud login details. While not optimal, **the provided password is not stored**.
An expired token needs to be updated manually by adding the MELCloud integration again with the same email address.
Configuration is also possible through `configuration.yaml`. The required authentication token can be found in `X-MitsContextKey` header when logged into the MELCloud. The language needs to be set to English and the "Remember me" option needs to be selected.
```yaml
melcloud:
username: xxxx@xxxxxxx
token: xxxxxxxxxxxxxxxxxxx
```
{% configuration %}
username:
description: Email address used to login to MELCloud
required: true
type: string
token:
description: X-MitsContextKey access token
required: true
type: string
{% endconfiguration %}
{% include integrations/config_flow.md %}
## Air-to-Air device

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