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-22 00:36:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Component(s) -> Integration(s) (#9705)

Browse Source
This commit is contained in:
Franck Nijhof 2019-06-28 05:10:56 +02:00 committed by Paulus Schoutsen
parent 2fe931c820
commit 4369499e89
438 changed files with 862 additions and 862 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
source/_components/abode.markdown
View File

@ -31,7 +31,7 @@ redirect_from:
- /components/sensor.abode/
---
The `abode` component will allow users to integrate their Abode Home Security systems into Home Assistant and use its alarm system and sensors to automate their homes.
The `abode` integration will allow users to integrate their Abode Home Security systems into Home Assistant and use its alarm system and sensors to automate their homes.
Please visit the [Abode website](https://goabode.com/) for further information about Abode Security.
@ -88,13 +88,13 @@ polling:
exclude:
description: >
A list of devices to exclude from Home Assistant by their Abode `device_id`
or `automation_id`, found within the component attributes.
or `automation_id`, found within the integration attributes.
required: false
type: list
lights:
description: >
A list of switch devices that Home Assistant should treat as lights by the
switches Abode `device_id`, found within the component attributes.
switches Abode `device_id`, found within the integration attributes.
required: false
type: list
{% endconfiguration %}
@ -159,16 +159,16 @@ Trigger a quick action automation on your Abode system.
### {% linkable_title Binary Sensor %}
This component will add `Door Contacts`, `Connectivity` sensors (remotes, keypads, and status indicators), `Moisture` sensors, and `Motion` or `Occupancy` sensors.
This integration will add `Door Contacts`, `Connectivity` sensors (remotes, keypads, and status indicators), `Moisture` sensors, and `Motion` or `Occupancy` sensors.
This component will also list all Abode `Quick Actions` that are set up. You can trigger these quick actions by passing the `entity_id` of your quick action binary sensor to the [trigger_quick_action service](/components/abode/#trigger_quick_action).
This integration will also list all Abode `Quick Actions` that are set up. You can trigger these quick actions by passing the `entity_id` of your quick action binary sensor to the [trigger_quick_action service](/components/abode/#trigger_quick_action).
### {% linkable_title Light %}
This component will automatically add `Lights` configured in your Abode account. You can reclassify `Switches` to show up within Home Assistant as lights by listing the Abode device ID in your [configuration](/components/abode/#configuration).
This integration will automatically add `Lights` configured in your Abode account. You can reclassify `Switches` to show up within Home Assistant as lights by listing the Abode device ID in your [configuration](/components/abode/#configuration).
### {% linkable_title Switch %}
This component will automatically add `Power Switches` configured in your Abode account. You can reclassify switches to show up within Home Assistant as `Lights` by listing the Abode device ID in your [configuration](/components/abode/#configuration).
This integration will automatically add `Power Switches` configured in your Abode account. You can reclassify switches to show up within Home Assistant as `Lights` by listing the Abode device ID in your [configuration](/components/abode/#configuration).
This component will also list all Abode `Automations` that are set up within the Abode system, allowing you to activate and deactivate the automations.
This integration will also list all Abode `Automations` that are set up within the Abode system, allowing you to activate and deactivate the automations.

2
source/_components/actiontec.markdown
View File

@ -52,4 +52,4 @@ password:
type: string
{% endconfiguration %}
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.
See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked.

2
source/_components/ads.markdown
View File

@ -62,7 +62,7 @@ ip_address:
## {% linkable_title Service %}
The ADS component will register the service `write_by_name` allowing you to write a value to a variable on your ADS device.
The ADS integration will register the service `write_by_name` allowing you to write a value to a variable on your ADS device.
```json
{

2
source/_components/aftership.markdown
View File

@ -70,5 +70,5 @@ api_key:
| `slug` | `True` | string | Carrier e.g. `fedex`
<p class='note info'>
This component retrieves data from AfterShip public REST API, but the component is not affiliated with AfterShip.
This integration retrieves data from AfterShip public REST API, but the integration is not affiliated with AfterShip.
</p>

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

@ -16,7 +16,7 @@ ha_iot_class: Configurable
The `mqtt` alarm panel platform enables the possibility to control MQTT capable alarm panels. The Alarm icon will change state after receiving a new state from `state_topic`. If these messages are published with *RETAIN* flag, the MQTT alarm panel will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state will be `unknown`.
The component will accept the following states from your Alarm Panel (in lower case):
The integration will accept the following states from your Alarm Panel (in lower case):
- `disarmed`
- `armed_home`
@ -25,7 +25,7 @@ The component will accept the following states from your Alarm Panel (in lower c
- `pending`
- `triggered`
The component can control your Alarm Panel by publishing to the `command_topic` when a user interacts with the Home Assistant frontend.
The integration can control your Alarm Panel by publishing to the `command_topic` when a user interacts with the Home Assistant frontend.
## {% linkable_title Configuration %}

4
source/_components/alarmdecoder.markdown
View File

@ -20,7 +20,7 @@ redirect_from:
- /components/sensor.alarmdecoder/
---
The `alarmdecoder` component will allow Home Assistant users who own either a DSC or Honeywell alarm panel to leverage their alarm system and its sensors to provide Home Assistant with rich information about their homes. Connectivity between Home Assistant and the alarm panel is accomplished through a device produced by Nu Tech Software Solutions, known as the AlarmDecoder. The AlarmDecoder devices provide a serial, TCP/IP socket or USB interface to the alarm panel, where it emulates an alarm keypad.
The `alarmdecoder` integration will allow Home Assistant users who own either a DSC or Honeywell alarm panel to leverage their alarm system and its sensors to provide Home Assistant with rich information about their homes. Connectivity between Home Assistant and the alarm panel is accomplished through a device produced by Nu Tech Software Solutions, known as the AlarmDecoder. The AlarmDecoder devices provide a serial, TCP/IP socket or USB interface to the alarm panel, where it emulates an alarm keypad.
Please visit the [AlarmDecoder website](https://www.alarmdecoder.com/) for further information about the AlarmDecoder devices.
@ -138,7 +138,7 @@ There are several attributes available on the alarm panel to give you more infor
## {% linkable_title Services %}
The Alarm Decoder component gives you access to several services for you to control your alarm with.
The Alarm Decoder integration gives you access to several services for you to control your alarm with.
- `alarm_arm_away`: Arms the alarm in away mode; all faults will trigger the alarm.
- `alarm_arm_home`: Arms the alarm in stay mode; faults to the doors or windows will trigger the alarm.

10
source/_components/alert.markdown
View File

@ -14,8 +14,8 @@ ha_release: 0.38
ha_qa_scale: internal
---
The `alert` component is designed to notify you when problematic issues arise.
For example, if the garage door is left open, the `alert` component can be used
The `alert` integration is designed to notify you when problematic issues arise.
For example, if the garage door is left open, the `alert` integration can be used
remind you of this by sending you repeating notifications at customizable
intervals. This is also used for low battery sensors,
water leak sensors, or any condition that may need your attention.
@ -25,7 +25,7 @@ This entity allows you to silence an alert until it is resolved.
### {% linkable_title Basic Example %}
The `alert` component makes use of any of the `notifications` components. To
The `alert` integration makes use of any of the `notifications` components. To
setup the `alert` component, first, you must setup a `notification` component.
Then, add the following to your configuration file:
@ -97,7 +97,7 @@ done_message:
required: false
type: template
notifiers:
description: "List of `notification` components to use for alerts."
description: "List of `notification` integrations to use for alerts."
required: true
type: list
data:
@ -145,7 +145,7 @@ alert:
### {% linkable_title Complex Alert Criteria %}
By design, the `alert` component only handles very simple criteria for firing.
By design, the `alert` integration only handles very simple criteria for firing.
That is, it only checks if a single entity's state is equal to a value. At some
point, it may be desirable to have an alert with a more complex criteria.
Possibly, when a battery percentage falls below a threshold. Maybe you want to

4
source/_components/alexa.intent.markdown
View File

@ -16,7 +16,7 @@ ha_release: "0.10"
## {% linkable_title I want to build custom commands to use with Echo %}
The built-in Alexa component allows you to integrate Home Assistant into Alexa/Amazon Echo. This component will allow you to query information and call services within Home Assistant by using your voice. Home Assistant offers no built-in sentences but offers a framework for you to define your own.
The built-in Alexa integration allows you to integrate Home Assistant into Alexa/Amazon Echo. This integration will allow you to query information and call services within Home Assistant by using your voice. Home Assistant offers no built-in sentences but offers a framework for you to define your own.
<div class='videoWrapper'>
<iframe width="560" height="315" src="https://www.youtube.com/embed/1Ke3mtWd_cQ" frameborder="0" allowfullscreen></iframe>
@ -90,7 +90,7 @@ This means that we can now ask Alexa things like:
## {% linkable_title Configuring Home Assistant %}
When activated, the Alexa component will have Home Assistant's native intent support handle the incoming intents. If you want to run actions based on intents, use the [`intent_script`](/components/intent_script) component.
When activated, the Alexa integration will have Home Assistant's native intent support handle the incoming intents. If you want to run actions based on intents, use the [`intent_script`](/components/intent_script) component.
To enable Alexa, add the following entry to your `configuration.yaml` file:

2
source/_components/alexa.smart_home.markdown
View File

@ -58,7 +58,7 @@ For Home Assistant Cloud Users, documentation can be found [here](https://www.na
### {% linkable_title Create Your Lambda Function %}
Alexa Smart Home skill will trigger a AWS Lambda function to process the request, we will write a small piece of code hosted as an Lambda function basically redirect the request to your Home Assistant instance, then Alexa integration component in Home Assistant will process the request and send back the response. Your Lambda function will delivery the response back to Alexa.
Alexa Smart Home skill will trigger a AWS Lambda function to process the request, we will write a small piece of code hosted as an Lambda function basically redirect the request to your Home Assistant instance, then Alexa integration integration in Home Assistant will process the request and send back the response. Your Lambda function will delivery the response back to Alexa.
<p class='info'>
There already are some great tutorials and solutions in our community to achieve same goal "Create your Alexa Smart Home Skill to connect Home Assistant", for example: [Haaska](https://github.com/mike-grant/haaska/wiki).

4
source/_components/ambient_station.markdown
View File

@ -14,12 +14,12 @@ redirect_from:
- /components/sensor.ambient_station/
---
The `Ambient Weather Station` component retrieves local weather information
The `Ambient Weather Station` integration retrieves local weather information
via personal weather stations from [Ambient Weather](https://ambientweather.net).
## {% linkable_title Setup %}
Using this component requires both an Application Key and an API Key. To
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).

2
source/_components/amcrest.markdown
View File

@ -177,7 +177,7 @@ documentation to install the `ffmpeg`.
## {% linkable_title Services %}
Once loaded, the `amcrest` component will expose services that can be called to perform various actions. The `entity_id` service attribute can specify one or more specific cameras, or `all` can be used to specify all configured Amcrest cameras.
Once loaded, the `amcrest` integration will expose services that can be called to perform various actions. The `entity_id` service attribute can specify one or more specific cameras, or `all` can be used to specify all configured Amcrest cameras.
Available services:
`enable_audio`, `disable_audio`,

4
source/_components/android_ip_webcam.markdown
View File

@ -23,7 +23,7 @@ redirect_from:
- /components/switch.android_ip_webcam/
---
The `android_ip_webcam` component turns any Android phone or tablet into a network camera with multiple viewing options.
The `android_ip_webcam` integration turns any Android phone or tablet into a network camera with multiple viewing options.
It's setup as an MJPEG camera and all settings as switches inside of Home Assistant. You can also expose the sensors. If you have multiple phones, you can use all options inside a list.
@ -193,7 +193,7 @@ binary_sensor:
## {% linkable_title Camera %}
The `android_ip_webcam` component adds a camera by default if you choose not to use the component but still want to see the video feed then the [`mjpeg` camera](/components/camera.mjpeg/) platform can be used.
The `android_ip_webcam` integration adds a camera by default if you choose not to use the integration but still want to see the video feed then the [`mjpeg` camera](/components/camera.mjpeg/) platform can be used.
## {% linkable_title Configuration %}

4
source/_components/androidtv.markdown
View File

@ -137,7 +137,7 @@ media_player:
## {% linkable_title ADB Setup %}
This component works by sending ADB commands to your Android TV / Fire TV device. There are two ways to accomplish this:
This integration works by sending ADB commands to your Android TV / Fire TV device. There are two ways to accomplish this:
### {% linkable_title 1. ADB Server %}
@ -180,7 +180,7 @@ If you receive the error message `Error while setting up platform androidtv` in
* Your key is not pre-authenticated. Before using the `adbkey` in Home Assistant, you _**must**_ connect to your device using the ADB binary and tell it to always allow connections from this computer. For more information, see the section [ADB Authentication](#adb-authentication) above.
* Home Assistant does not have the appropriate permissions for the `adbkey` file and so it is not able to use it. Once you fix the permissions, the component should work.
* Home Assistant does not have the appropriate permissions for the `adbkey` file and so it is not able to use it. Once you fix the permissions, the integration should work.
4. Some Android TV devices (e.g., Philips TVs running Android TV) only accept the initial ADB connection request over their Wi-Fi interface. If you have the TV wired, you need to connect it to WiFi and try the initial connection again. Once the authentication has been granted via Wi-Fi, you can connect to the TV over the wired interface as well.

4
source/_components/apcupsd.markdown
View File

@ -64,7 +64,7 @@ In addition to the [APCUPSd Sensor](#sensor) devices, you may also create a devi
### {% linkable_title Configuration %}
To enable this sensor, you first have to set up apcupsd component (above), and add the following lines to your `configuration.yaml` file:
To enable this sensor, you first have to set up apcupsd integration (above), and add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -86,7 +86,7 @@ name:
### {% linkable_title Configuration %}
To use this sensor platform, you first have to set up apcupsd component (above), and add the following to your `configuration.yaml` file:
To use this sensor platform, you first have to set up apcupsd integration (above), and add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry

2
source/_components/api.markdown
View File

@ -14,7 +14,7 @@ ha_qa_scale: internal
ha_release: 0.7
---
The `api` component exposes a RESTful API and allows one to interact with a Home Assistant instance that is running headless. This component depends on the [`http` component](/components/http/).
The `api` integration exposes a RESTful API and allows one to interact with a Home Assistant instance that is running headless. This integration depends on the [`http` component](/components/http/).
<p class='note warning'>
It is HIGHLY recommended that you set the `api_password`, especially if you are planning to expose your installation to the internet.

2
source/_components/aprs.markdown
View File

@ -13,7 +13,7 @@ ha_category: Presence Detection
ha_iot_class: Cloud Push
---
The `aprs` [(Automatic Packet Reporting System)](https://en.wikipedia.org/wiki/Automatic_Packet_Reporting_System) device tracker component connects to the [APRS-IS](http://aprs-is.net/) network for tracking amateur radio devices.
The `aprs` [(Automatic Packet Reporting System)](https://en.wikipedia.org/wiki/Automatic_Packet_Reporting_System) device tracker integration connects to the [APRS-IS](http://aprs-is.net/) network for tracking amateur radio devices.
## {% linkable_title Configuration %}

4
source/_components/aqualogic.markdown
View File

@ -19,7 +19,7 @@ redirect_from:
- /components/switch.aqualogic/
---
The AquaLogic component provides connectivity to a Hayward/Goldline AquaLogic/ProLogic pool controller. Note that an RS-485 to Ethernet adapter connected to the pool controller is required.
The AquaLogic integration provides connectivity to a Hayward/Goldline AquaLogic/ProLogic pool controller. Note that an RS-485 to Ethernet adapter connected to the pool controller is required.
There is currently support for the following device types within Home Assistant:
@ -28,7 +28,7 @@ There is currently support for the following device types within Home Assistant:
## {% linkable_title Configuration %}
To add the AquaLogic component to your installation, add the following to your `configuration.yaml` file:
To add the AquaLogic integration to your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry

2
source/_components/arduino.markdown
View File

@ -25,7 +25,7 @@ The equipment depends on the [type](https://www.arduino.cc/en/Main/Products) of
There are a lot of extensions (so-called [shields](https://www.arduino.cc/en/Main/ArduinoShields)) available. Those shields can be plugged-in into the existing connectors and stacked on top of each other. This makes it possible to expand the capabilities of the Arduino boards.
The `arduino` component is designed to let you use a directly attached board to your Home Assistant host over USB.
The `arduino` integration is designed to let you use a directly attached board to your Home Assistant host over USB.
There is currently support for the following device types within Home Assistant:

4
source/_components/arlo.markdown
View File

@ -59,7 +59,7 @@ It is recommended to create a dedicated user on Arlo website to be used within H
Finish its configuration by visiting the [Arlo sensor page](/components/sensor.arlo/) or [Arlo camera page](/components/camera.arlo/) or [Arlo control panel page](/components/alarm_control_panel.arlo/). Arlo also has a service call `arlo.update` that can be manually called to force an update prior to the regular scheduled interval.
The Arlo component also provides a camera service to enable/disable the motion detection sensor. The example below enables the motion detection every time the Home Assistant service starts.
The Arlo integration also provides a camera service to enable/disable the motion detection sensor. The example below enables the motion detection every time the Home Assistant service starts.
```yaml
#automation.yaml
@ -142,7 +142,7 @@ More examples and configuration options can be found on the [Manual Alarm Contro
## {% linkable_title Camera %}
This component is not yet able to live stream from your Arlo camera, but it will be able to playback the last video capture.
This integration is not yet able to live stream from your Arlo camera, but it will be able to playback the last video capture.
### {% linkable_title Configuration %}

2
source/_components/aruba.markdown
View File

@ -52,4 +52,4 @@ password:
type: string
{% endconfiguration %}
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.
See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked.

4
source/_components/asterisk_mbox.markdown
View File

@ -16,7 +16,7 @@ redirect_from:
- /components/mailbox.asterisk_mbox/
---
The `asterisk_mbox` Asterisk Voicemail integration for Home Assistant allows you to view, listen to, and delete voicemails from an Asterisk voicemail mailbox. The component includes a panel on the frontend that provides caller-id and speech-to-text transcription (using Google's API) of messages in addition to playback and message deletion. There is also an included sensor that indicates of the number of available messages. There is no requirement that the Asterisk PBX and Home Assistant are running on the same machine.
The `asterisk_mbox` Asterisk Voicemail integration for Home Assistant allows you to view, listen to, and delete voicemails from an Asterisk voicemail mailbox. The integration includes a panel on the frontend that provides caller-id and speech-to-text transcription (using Google's API) of messages in addition to playback and message deletion. There is also an included sensor that indicates of the number of available messages. There is no requirement that the Asterisk PBX and Home Assistant are running on the same machine.
To enable the component, a configuration is required in both Home Assistant as well as on the Asterisk server.
@ -52,5 +52,5 @@ port:
{% endconfiguration %}
<p class='note warning'>
Communication between the Asterisk PBX server and the Home Assistant server is password-protected, but the data transmission is not encrypted. It is recommended to only use this component when communication is contained within a local area network.
Communication between the Asterisk PBX server and the Home Assistant server is password-protected, but the data transmission is not encrypted. It is recommended to only use this integration when communication is contained within a local area network.
</p>

4
source/_components/asuswrt.markdown
View File

@ -19,7 +19,7 @@ redirect_from:
- /components/sensor.asuswrt/
---
The `asuswrt` component is the main component to connect to a [ASUSWRT](http://event.asus.com/2013/nw/ASUSWRT/) based router.
The `asuswrt` integration is the main integration to connect to a [ASUSWRT](http://event.asus.com/2013/nw/ASUSWRT/) based router.
There is currently support for the following device types within Home Assistant:
@ -120,7 +120,7 @@ The example above, creates the following sensors:
## {% linkable_title Padavan custom firmware (The rt-n56u project) %}
The [rt-n56u project](https://bitbucket.org/padavan/rt-n56u) does not store `dnsmasq.leases` which is used to track devices at `/var/lib/misc/` as `asuswrt` do. However this component can still be used for the rt-n56u project by linking `dnsmasq.leases` during the boot process of the router.
The [rt-n56u project](https://bitbucket.org/padavan/rt-n56u) does not store `dnsmasq.leases` which is used to track devices at `/var/lib/misc/` as `asuswrt` do. However this integration can still be used for the rt-n56u project by linking `dnsmasq.leases` during the boot process of the router.
Follow these steps to setup the link.

2
source/_components/august.markdown
View File

@ -21,7 +21,7 @@ redirect_from:
- /components/lock.august/
---
The `august` component allows you to integrate your [August](http://august.com) devices in Home Assistant.
The `august` integration allows you to integrate your [August](http://august.com) devices in Home Assistant.
There is currently support for the following device types within Home Assistant:

6
source/_components/auth.markdown
View File

@ -1,7 +1,7 @@
---
layout: page
title: "Auth"
description: "This component is responsible for providing the authentication endpoints."
description: "This integration is responsible for providing the authentication endpoints."
date: 2018-03-19 21:04
sidebar: true
comments: false
@ -14,5 +14,5 @@ ha_release: 0.73
ha_qa_scale: internal
---
This component creates the endpoints for the [authentication system](/docs/authentication/) that is built into Home Assistant.
There are no configuration options for this component directly as it relies on the auth system in the core.
This integration creates the endpoints for the [authentication system](/docs/authentication/) that is built into Home Assistant.
There are no configuration options for this integration directly as it relies on the auth system in the core.

2
source/_components/automatic.markdown
View File

@ -80,4 +80,4 @@ automation:
You can obtain the correct ID for your vehicle from your known_devices.yaml file. Be sure to lower-case any letters contained in your vehicle's ID when using it in an automation trigger.
</p>
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the cars to be tracked.
See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the cars to be tracked.

6
source/_components/aws.markdown
View File

@ -21,11 +21,11 @@ You have to have an AWS account to use Amazon Web Services, create one [here](ht
The `lambda`, `sns` and `sqs` services, used in the `aws` component, all provide an **Always Free** tier for all users even after the 12-month period. The general usage in Home Automation will most likely not reach the free tier limit. Please read [Lambda Pricing](https://aws.amazon.com/lambda/pricing/), [SNS Pricing](https://aws.amazon.com/sns/pricing/) and [SQS Pricing](https://aws.amazon.com/sqs/pricing/) for more details.
The `aws` component is using [botocore](https://botocore.amazonaws.com/v1/documentation/api/latest/index.html) to communicate with Amazon Web Services, which is also used by the [AWS Command Client Interface](https://aws.amazon.com/cli/) tool. Therefore, `aws` shares the same credential and profiles with `awscli` tool. Please read [Configuring the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html) to learn how to get access keys and how to manage them on your local system securely.
The `aws` integration is using [botocore](https://botocore.amazonaws.com/v1/documentation/api/latest/index.html) to communicate with Amazon Web Services, which is also used by the [AWS Command Client Interface](https://aws.amazon.com/cli/) tool. Therefore, `aws` shares the same credential and profiles with `awscli` tool. Please read [Configuring the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html) to learn how to get access keys and how to manage them on your local system securely.
## {% linkable_title Configuration %}
To use the `aws` component and the `notify` platform in your installation, add the following to your `configuration.yaml` file:
To use the `aws` integration and the `notify` platform in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -35,7 +35,7 @@ aws:
aws_access_key_id: AWS_ID
aws_secret_access_key: AWS_SECRET
notify:
# use the first credential defined in aws component by default
# use the first credential defined in aws integration by default
- service: lambda
region_name: us-east-1
```

4
source/_components/azure_event_hub.markdown
View File

@ -13,7 +13,7 @@ ha_category:
ha_release: 0.94
---
The `Azure Event Hub` component allows you to hook into the Home Assistant event bus and send events to [Azure Event Hub](https://azure.microsoft.com/en-us/services/event-hubs/) or to a [Azure IoT Hub](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-messages-read-builtin).
The `Azure Event Hub` integration allows you to hook into the Home Assistant event bus and send events to [Azure Event Hub](https://azure.microsoft.com/en-us/services/event-hubs/) or to a [Azure IoT Hub](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-messages-read-builtin).
## {% linkable_title First time setup %}
@ -23,7 +23,7 @@ You need to create a Event Hub namespace and a Event Hub in that namespace, you
You must then create a Shared Access Policy for the Event Hub with 'Send' claims or use the RootManageAccessKey from your namespace (this key has additional claims, including managing the event hub and listening, which are not needed for this purpose), for more details on the security of Event Hubs [go here](https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-authentication-and-security-model-overview).
Once you have the name of your namespace, instance, Shared Access Policy and the key for that policy, you can setup the component itself.
Once you have the name of your namespace, instance, Shared Access Policy and the key for that policy, you can setup the integration itself.
## {% linkable_title Configuration %}

4
source/_components/bbb_gpio.markdown
View File

@ -19,8 +19,8 @@ redirect_from:
- /components/switch.bbb_gpio/
---
The `bbb_gpio` component is the base for all [BeagleBone Black](https://beagleboard.org/black) related GPIO platforms in Home Assistant.
There is no setup needed for the component itself.
The `bbb_gpio` integration is the base for all [BeagleBone Black](https://beagleboard.org/black) related GPIO platforms in Home Assistant.
There is no setup needed for the integration itself.
## {% linkable_title Binary Sensor %}

2
source/_components/bbox.markdown
View File

@ -61,7 +61,7 @@ host:
For now and due to third party limitation, the Bbox must be on the same local network as the Home Assistant installation.
</p>
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.
See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked.
## {% linkable_title Sensor %}

2
source/_components/binary_sensor.knx.markdown
View File

@ -18,7 +18,7 @@ The `knx` sensor platform allows you to monitor [KNX](http://www.knx.org) binary
## {% linkable_title Configuration %}
The `knx` component must be configured correctly, see [KNX Component](/components/knx).
The `knx` integration must be configured correctly, see [KNX Component](/components/knx).
```yaml
# Example configuration.yaml entry

4
source/_components/binary_sensor.rflink.markdown
View File

@ -14,11 +14,11 @@ ha_iot_class: Local Push
ha_release: 0.81
---
The `rflink` component supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).
The `rflink` integration supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).
First, you have to set up your [RFLink hub](/components/rflink/).
The RFLink component does not know the difference between a `binary_sensor`, a `switch` and a `light`. Therefore all switchable devices are automatically added as `light` by default.
The RFLink integration does not know the difference between a `binary_sensor`, a `switch` and a `light`. Therefore all switchable devices are automatically added as `light` by default.
RFLink binary_sensor/switch/light ID's are composed of: protocol, id, switch/channel. For example: `newkaku_0000c6c2_1`.

8
source/_components/binary_sensor.rfxtrx.markdown
View File

@ -15,12 +15,12 @@ ha_release: 0.48
The `rfxtrx` platform support binary sensors that
communicate in the frequency range of 433.92 MHz.
The rfxtrx binary sensor component provides support for them.
The rfxtrx binary sensor integration provides support for them.
Many cheap sensors available on the web today are based on a particular RF chip
called *PT-2262*. Depending on the running firmware on the RFXcom box, some of
them may be recognized under the X10 protocol but most of them are recognized
under the *Lighting4* protocol. The rfxtrx binary sensor component provides
under the *Lighting4* protocol. The rfxtrx binary sensor integration provides
some special options for them, while other rfxtrx protocols should work too.
## {% linkable_title Setting up your devices %}
@ -95,7 +95,7 @@ automatic_add:
{% endconfiguration %}
<p class='note warning'>
This component and the [rfxtrx switch](/components/switch/rfxtrx/) can steal each other's devices when setting the `automatic_add` configuration parameter to `true`.
This integration and the [rfxtrx switch](/components/switch/rfxtrx/) can steal each other's devices when setting the `automatic_add` configuration parameter to `true`.
Set `automatic_add` only when you have some devices to add to your installation, otherwise leave it to `false`.
</p>
@ -188,7 +188,7 @@ devices:
command_off: 0x7
```
The *automatic_add* option makes the rfxtrx binary sensor component calculate
The *automatic_add* option makes the rfxtrx binary sensor integration calculate
and display the configuration options for you in the Home Assistant logs:
```text

2
source/_components/binary_sensor.xiaomi_aqara.markdown
View File

@ -186,7 +186,7 @@ As indicated in the table on top of this page there are 3 versions of the button
#### {% linkable_title Xiaomi Cube %}
Available events are `flip90`, `flip180`, `move`, `tap_twice`, `shake_air`, `swing`, `alert`, `free_fall` and `rotate`. The component stores the last action as the attribute `last_action`.
Available events are `flip90`, `flip180`, `move`, `tap_twice`, `shake_air`, `swing`, `alert`, `free_fall` and `rotate`. The integration stores the last action as the attribute `last_action`.
```yaml
- alias: Cube event flip90

4
source/_components/blink.markdown
View File

@ -23,7 +23,7 @@ redirect_from:
- /components/sensor.blink/
---
The `blink` component lets you view camera images and motion events from [Blink](http://blinkforhome.com) camera and security systems.
The `blink` integration lets you view camera images and motion events from [Blink](http://blinkforhome.com) camera and security systems.
## {% linkable_title Setup %}
@ -85,7 +85,7 @@ mode:
default: not set
{% endconfiguration %}
Once Home Assistant starts, the `blink` component will create the following platforms:
Once Home Assistant starts, the `blink` integration will create the following platforms:
- An `alarm_control_panel` to arm/disarm the whole blink system (note, `alarm_arm_home` is not implemented and will not actually do anything, despite it being an option in the GUI).
- A `camera` for each camera linked to your Blink sync module.

10
source/_components/bloomsky.markdown
View File

@ -19,7 +19,7 @@ redirect_from:
- /components/binary_sensor.bloomsky/
---
The `bloomsky` component allows you to access your [BloomSky](https://www.bloomsky.com/) weather station's.
The `bloomsky` integration allows you to access your [BloomSky](https://www.bloomsky.com/) weather station's.
There is currently support for the following device types within Home Assistant:
@ -81,11 +81,11 @@ monitored_conditions:
## {% linkable_title Camera %}
The `bloomsky` camera component allows you to view the current photo created by the camera in the [BloomSky](https://www.bloomsky.com) weather station. This can work in concert with [BloomSky sensors](#sensor).
The `bloomsky` camera integration allows you to view the current photo created by the camera in the [BloomSky](https://www.bloomsky.com) weather station. This can work in concert with [BloomSky sensors](#sensor).
### {% linkable_title Configuration %}
To enable this camera in your installation, set up the BloomSky component with your API key and add the following to your `configuration.yaml` file:
To enable this camera in your installation, set up the BloomSky integration with your API key and add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -95,11 +95,11 @@ camera:
## {% linkable_title Sensor %}
The `bloomsky` sensor component allows you to view the measurements made by sensors in the [BloomSky](https://www.bloomsky.com) weather station. This can work in concert with the [BloomSky camera](#camera).
The `bloomsky` sensor integration allows you to view the measurements made by sensors in the [BloomSky](https://www.bloomsky.com) weather station. This can work in concert with the [BloomSky camera](#camera).
### {% linkable_title Configuration %}
To enable these sensors in your installation, set up the BloomSky component with your API key add the following to your `configuration.yaml` file:
To enable these sensors in your installation, set up the BloomSky integration with your API key add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry

2
source/_components/bluesound.markdown
View File

@ -16,7 +16,7 @@ redirect_from:
- /components/media_player.bluesound/
---
The `bluesound` platform allows you to control your [Bluesound](http://www.bluesound.com/) HiFi wireless speakers and audio components from Home Assistant.
The `bluesound` platform allows you to control your [Bluesound](http://www.bluesound.com/) HiFi wireless speakers and audio integrations from Home Assistant.
If you want to automatically discover new devices, just make sure you have discovery: in your configuration.yaml file. To manually add a Bluesound device to your installation, add the following to your configuration.yaml file:

2
source/_components/bme680.markdown
View File

@ -99,7 +99,7 @@ gas_heater_duration:
default: 150
type: integer
aq_burn_in_time:
description: The duration to perform gas resistance measurements to establish a stable baseline measurements for Air Quality calculations in seconds. The burn in time is only performed when the sensor component is first initialized.
description: The duration to perform gas resistance measurements to establish a stable baseline measurements for Air Quality calculations in seconds. The burn in time is only performed when the sensor integration is first initialized.
required: false
default: 300
type: integer

12
source/_components/bmw_connected_drive.markdown
View File

@ -22,13 +22,13 @@ redirect_from:
- /components/sensor.bmw_connected_drive/
---
The `bmw_connected_drive` component lets you retrieve data of your BMW vehicle from the BMW Connected Drive portal. You need to have a working BMW Connected Drive account, and a Connected Drive enabled vehicle for this to work.
The `bmw_connected_drive` integration lets you retrieve data of your BMW vehicle from the BMW Connected Drive portal. You need to have a working BMW Connected Drive account, and a Connected Drive enabled vehicle for this to work.
The `bmw_connected_drive` component also works with (recent) Mini vehicles. You need to have a working Mini Connected account, and a Mini Connected enabled vehicle for this to work.
The `bmw_connected_drive` integration also works with (recent) Mini vehicles. You need to have a working Mini Connected account, and a Mini Connected enabled vehicle for this to work.
For compatibility with your BMW vehicle check the [bimmer_connected page](https://github.com/m1n3rva/bimmer_connected) on github.
This component provides the following platforms:
This integration provides the following platforms:
- Binary Sensors: Doors, windows, condition based services, check control messages, parking lights, door lock state, charging status (electric cars) and connections status (electric cars).
- Device tracker: The location of your car.
@ -38,7 +38,7 @@ This component provides the following platforms:
## {% linkable_title Configuration %}
To enable this component in your installation, add the following to your
To enable this integration in your installation, add the following to your
`configuration.yaml` file:
```yaml
@ -81,13 +81,13 @@ bmw_connected_drive:
## {% linkable_title Services %}
The `bmw_connected_drive` component offers several services. In case you need to provide the vehicle identification number (VIN) as a parameter, you can see the VIN in the attributes of the device tracker for the vehicle. The VIN is a 17 digit alphanumeric string, e.g., `WBANXXXXXX1234567`.
The `bmw_connected_drive` integration offers several services. In case you need to provide the vehicle identification number (VIN) as a parameter, you can see the VIN in the attributes of the device tracker for the vehicle. The VIN is a 17 digit alphanumeric string, e.g., `WBANXXXXXX1234567`.
Using these services will impact the state of your vehicle. So use these services with care!
### {% linkable_title Locking and unlocking %}
The vehicle can be locked and unlocked via the lock component that is created automatically for each vehicle. Before invoking these services, make sure it's safe to lock/unlock the vehicle in the current situation.
The vehicle can be locked and unlocked via the lock integration that is created automatically for each vehicle. Before invoking these services, make sure it's safe to lock/unlock the vehicle in the current situation.
### {% linkable_title Air condition %}

4
source/_components/browser.markdown
View File

@ -1,7 +1,7 @@
---
layout: page
title: "Browser"
description: "Instructions on how to setup the browser component with Home Assistant."
description: "Instructions on how to setup the browser integration with Home Assistant."
date: 2015-01-24 14:39
sidebar: true
comments: false
@ -14,7 +14,7 @@ ha_qa_scale: internal
ha_release: pre 0.7
---
The `browser` component provides a service to open URLs in the default browser on the host machine.
The `browser` integration provides a service to open URLs in the default browser on the host machine.
## {% linkable_title Configuration %}

2
source/_components/brunt.markdown
View File

@ -46,5 +46,5 @@ password:
{% endconfiguration %}
<p class='note warning'>
This component is not affiliated with Brunt and retrieves data from the endpoints of the mobile application. Use at your own risk.
This integration is not affiliated with Brunt and retrieves data from the endpoints of the mobile application. Use at your own risk.
</p>

2
source/_components/bt_home_hub_5.markdown
View File

@ -34,4 +34,4 @@ host:
type: string
{% endconfiguration %}
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.
See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked.

2
source/_components/bt_smarthub.markdown
View File

@ -37,4 +37,4 @@ host:
type: string
{% endconfiguration %}
See the [device tracker component page](/components/device_tracker/) for instructions on how to configure the people to be tracked.
See the [device tracker integration page](/components/device_tracker/) for instructions on how to configure the people to be tracked.

6
source/_components/buienradar.markdown
View File

@ -32,15 +32,15 @@ weather:
{% configuration %}
name:
description: "You can specify a name of the component, but do not have to. If you specify a name, the weather component will get an entity name of `weather.[name]`; if no name is specified, it will try to set its name to `weather.BR_[stationname]`. However at the moment in time, the entity is created, no data has been retrieved yet, so the entity will get named `weather.BR_unknown_station`. Later the station name will be known and get updated, but the entity name remains."
description: "You can specify a name of the component, but do not have to. If you specify a name, the weather integration will get an entity name of `weather.[name]`; if no name is specified, it will try to set its name to `weather.BR_[stationname]`. However at the moment in time, the entity is created, no data has been retrieved yet, so the entity will get named `weather.BR_unknown_station`. Later the station name will be known and get updated, but the entity name remains."
required: false
type: string
latitude:
description: Latitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration but can be overridden/changed in this component to select a different location for Buienradar.
description: Latitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration but can be overridden/changed in this integration to select a different location for Buienradar.
required: false
type: float
longitude:
description: Longitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration but can be overridden/changed in this component to select a different location for Buienradar.
description: Longitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration but can be overridden/changed in this integration to select a different location for Buienradar.
required: false
type: float
forecast:

4
source/_components/caldav.markdown
View File

@ -24,8 +24,8 @@ The WebDav calendar get updated roughly every 15 minutes.
### {% linkable_title Prerequisites %}
You need to have a CalDav server and credentials for it. This component was
tested against [Baikal](http://sabre.io/baikal/) but any component complying
You need to have a CalDav server and credentials for it. This integration was
tested against [Baikal](http://sabre.io/baikal/) but any integration complying
with the RFC4791 should work. [Nextcloud](https://nextcloud.com/)
and [Owncloud](https://owncloud.org/) work fine.

4
source/_components/calendar.google.markdown
View File

@ -17,7 +17,7 @@ ha_release: 0.33
The `google` calendar platform allows you to connect to your
[Google Calendars](https://calendar.google.com) and generate binary sensors.
The sensors created can trigger based on any event on the calendar or only for
matching events. When you first setup this component it will generate a new
matching events. When you first setup this integration it will generate a new
configuration file `google_calendars.yaml` that will contain information about
all of the calendars you can see.
It also exposes a service to add an event to one of your Google Calendars.
@ -177,7 +177,7 @@ Otherwise everything following the hash sign would be considered a YAML comment.
### {% linkable_title Service `google.add_event` %}
You can use the service `google.add_event` to create a new calendar event in a calendar. Calendar id's can be found in the file `google_calendars.yaml`. All dates and times are in your local time, the component gets your time zone from your `configuration.yaml` file.
You can use the service `google.add_event` to create a new calendar event in a calendar. Calendar id's can be found in the file `google_calendars.yaml`. All dates and times are in your local time, the integration gets your time zone from your `configuration.yaml` file.
| Service data attribute | Optional | Description | Example |
| ---------------------- | -------- | ----------- | --------|

2
source/_components/calendar.markdown
View File

@ -10,4 +10,4 @@ footer: true
ha_release: 0.33
---
The calendar component allows you to integrate your calendars into Home Assistant.
The calendar integration allows you to integrate your calendars into Home Assistant.

10
source/_components/camera.markdown
View File

@ -14,11 +14,11 @@ ha_qa_scale: internal
ha_release: 0.7
---
The camera component allows you to use IP cameras with Home Assistant.
The camera integration allows you to use IP cameras with Home Assistant.
### {% linkable_title Streaming Video %}
If your camera supports it, and the [`stream`](/components/stream) component is setup, you will be able to stream your cameras in the frontend and on supported media players.
If your camera supports it, and the [`stream`](/components/stream) integration is setup, you will be able to stream your cameras in the frontend and on supported media players.
This option will keep the stream alive, and preload the feed on Home Assistant startup. This will result in reduced latency when opening the stream in the frontend, as well as when using the `play_stream` service or Google Assistant integration. It does, however, utilize more resources on your machine, so it is recommended to check CPU usage if you plan to use this feature.
@ -36,13 +36,13 @@ Available services: `turn_on`, `turn_off`, `enable_motion_detection`, `disable_m
#### {% linkable_title Service `play_stream` %}
Play a live stream from a camera to selected media player(s). Requires [`stream`](/components/stream) component to be set up.
Play a live stream from a camera to selected media player(s). Requires [`stream`](/components/stream) integration to be set up.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | Name of entity to fetch stream from, e.g., `camera.living_room_camera`. |
| `media_player` | no | Name of media player to play stream on, e.g., `media_player.living_room_tv`. |
| `format` | yes | Stream format supported by `stream` component and selected `media_player`. Default: `hls` |
| `format` | yes | Stream format supported by `stream` integration and selected `media_player`. Default: `hls` |
For example, the following action in an automation would send an `hls` live stream to your chromecast.
@ -111,7 +111,7 @@ action:
#### {% linkable_title Service `record` %}
Make a `.mp4` recording from a camera stream. Requires `stream` component to be set up.
Make a `.mp4` recording from a camera stream. Requires `stream` integration to be set up.
Both `duration` and `lookback` options are suggestions, but should be consistent per camera. The actual length of the recording may vary. It is suggested that you tweak these settings to fit your needs.

2
source/_components/canary.markdown
View File

@ -20,7 +20,7 @@ redirect_from:
- /components/sensor.canary/
---
The `canary` component allows you to integrate your [Canary](https://canary.is) devices in Home Assistant.
The `canary` integration allows you to integrate your [Canary](https://canary.is) devices in Home Assistant.
There is currently support for the following device types within Home Assistant:

4
source/_components/cast.markdown
View File

@ -18,12 +18,12 @@ redirect_from: /components/media_player.cast/
Google Cast devices like Android TVs and Chromecasts will be automatically
discovered if you enable [the discovery component](/components/discovery/). If
you don't have the discovery component enabled, you can enable the Cast
you don't have the discovery integration enabled, you can enable the Cast
component by going to the Integrations page inside the config panel.
## {% linkable_title Advanced use %}
The Cast component has some extra configuration options available for advanced
The Cast integration has some extra configuration options available for advanced
users. You will still need to create a config entry to initialize the Cast
component.

2
source/_components/cisco_ios.markdown
View File

@ -75,4 +75,4 @@ password:
type: string
{% endconfiguration %}
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.
See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked.

2
source/_components/cisco_mobility_express.markdown
View File

@ -51,4 +51,4 @@ verify_ssl:
type: boolean
{% endconfiguration %}
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.
See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked.

2
source/_components/clementine.markdown
View File

@ -52,4 +52,4 @@ Remember that Clementine must be configured to accept connections through its ne
You can configure this through Clementine `Tools > Preferences > Network remote control` configuration menu. Enable `Use network remote control` and configure the other options for your use case.
This component does not implement the `play_media` service so you cannot add tracks to the playlist.
This integration does not implement the `play_media` service so you cannot add tracks to the playlist.

2
source/_components/climate.knx.markdown
View File

@ -16,7 +16,7 @@ ha_iot_class: Local Polling
The `knx` climate platform is used as in interface with KNX thermostats.
The `knx` component must be configured correctly, see [KNX Component](/components/knx).
The `knx` integration must be configured correctly, see [KNX Component](/components/knx).
To use your KNX thermostats in your installation, add the following lines to your `configuration.yaml` file:

2
source/_components/climate.markdown
View File

@ -14,7 +14,7 @@ ha_qa_scale: internal
ha_release: 0.19
---
The `climate` component is built for the controlling and monitoring of HVAC (heating, ventilating, and air conditioning) and thermostat devices.
The `climate` integration is built for the controlling and monitoring of HVAC (heating, ventilating, and air conditioning) and thermostat devices.
## {% linkable_title Services %}

2
source/_components/climate.mysensors.markdown
View File

@ -25,7 +25,7 @@ S_TYPE | V_TYPE
-------|-----------------------------------------------------------------------------
S_HVAC | V_HVAC_FLOW_STATE*, V_HVAC_SETPOINT_HEAT, V_HVAC_SETPOINT_COOL, V_HVAC_SPEED, V_TEMP
V_HVAC_FLOW_STATE is mapped to the state of the Climate component in Home Assistant as follows:
V_HVAC_FLOW_STATE is mapped to the state of the Climate integration in Home Assistant as follows:
Home Assistant State | MySensors State
---------------------|----------------

6
source/_components/cloudflare.markdown
View File

@ -13,9 +13,9 @@ ha_category:
ha_release: 0.74
---
With the `cloudflare` component can you keep your Cloudflare records up to date.
With the `cloudflare` integration can you keep your Cloudflare records up to date.
The component will run every hour, but can also be started manually by using the service `cloudflare.update_records` under services.
The integration will run every hour, but can also be started manually by using the service `cloudflare.update_records` under services.
## {% linkable_title Setup %}
@ -23,7 +23,7 @@ You will find your global API key in your Cloudflare account settings.
## {% linkable_title Configuration %}
To use the component in your installation, add the following to your `configuration.yaml` file:
To use the integration in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry

4
source/_components/coinbase.markdown
View File

@ -17,9 +17,9 @@ redirect_from:
- /components/sensor.coinbase/
---
The `coinbase` component lets you access account balances and exchange rates from [coinbase](https://coinbase.com).
The `coinbase` integration lets you access account balances and exchange rates from [coinbase](https://coinbase.com).
You will need to obtain an API key from coinbase's [developer site](https://www.coinbase.com/settings/api) to use this component. You need to give read access to `wallet:accounts` in order for the component to access relevant data.
You will need to obtain an API key from coinbase's [developer site](https://www.coinbase.com/settings/api) to use this component. You need to give read access to `wallet:accounts` in order for the integration to access relevant data.
## {% linkable_title Configuration %}

6
source/_components/comfoconnect.markdown
View File

@ -17,14 +17,14 @@ redirect_from:
- /components/sensor.comfoconnect/
---
The `comfoconnect` component lets you control Zehnder ComfoAir [Q350](http://www.international.zehnder-systems.com/products-and-systems/comfosystems/zehnder-comfoair-q350-st)/[450](http://www.international.zehnder-systems.com/products-and-systems/comfosystems/zehnder-comfoair-q450-st)/[600](http://www.international.zehnder-systems.com/products-and-systems/comfosystems/zehnder-comfoair-q600-st)
The `comfoconnect` integration lets you control Zehnder ComfoAir [Q350](http://www.international.zehnder-systems.com/products-and-systems/comfosystems/zehnder-comfoair-q350-st)/[450](http://www.international.zehnder-systems.com/products-and-systems/comfosystems/zehnder-comfoair-q450-st)/[600](http://www.international.zehnder-systems.com/products-and-systems/comfosystems/zehnder-comfoair-q600-st)
ventilation units from Home Assistant. You need a [ComfoConnect LAN C](http://www.zehnder.co.uk/products-and-systems/comfortable-indoor-ventilation/ms-comfoair-q/ideal-control#node-21233)
bridge to connect the unit to your local network.
There is an official iPhone and Android app to configure and control your unit. This platform connects with the help of
the unofficial [pycomfoconnect](https://github.com/michaelarnauts/comfoconnect) library.
The component has a fan platform to view and control the ventilation speed, and a sensors platform to read out the outdoor temperature and humidity, the indoor temperature and humidity, and the extract and supply air flow (in m³ per hour).
The integration has a fan platform to view and control the ventilation speed, and a sensors platform to read out the outdoor temperature and humidity, the indoor temperature and humidity, and the extract and supply air flow (in m³ per hour).
To set it up, add the following information to your `configuration.yaml` file:
@ -75,5 +75,5 @@ sensor:
```
<p class='note'>
Note that it's not possible to have multiple connection to the bridge at the same time. This component will keep the connection open, and if you open the app, it will ask you to disconnect Home Assistant. If you close the app again, Home Assistant will reconnect automatically.
Note that it's not possible to have multiple connection to the bridge at the same time. This integration will keep the connection open, and if you open the app, it will ask you to disconnect Home Assistant. If you close the app again, Home Assistant will reconnect automatically.
</p>

2
source/_components/config.markdown
View File

@ -14,7 +14,7 @@ ha_release: 0.39
ha_qa_scale: internal
---
The `config` component is designed to display panels in the frontend to configure and manage parts of Home Assistant.
The `config` integration is designed to display panels in the frontend to configure and manage parts of Home Assistant.
To enable the configuration panel, add the following to your `configuration.yaml` file:

6
source/_components/configurator.markdown
View File

@ -15,15 +15,15 @@ ha_release: 0.7
---
<p class='note'>
This component is intended for developers.
This integration is intended for developers.
</p>
The configurator component allows components to request information from the user. It is currently implemented as the minimum viable product:
The configurator integration allows integrations to request information from the user. It is currently implemented as the minimum viable product:
- It supports showing a text, image and button to the user
- Input fields can be defined with a description, and optional type
- It will trigger a callback when the button is pressed
The Hue component in [the demo](/demo) and Plex are implemented using the configurator. See [the source of the demo component](https://github.com/home-assistant/home-assistant/tree/dev/homeassistant/components/demo) for a simple example.
The Hue integration in [the demo](/demo) and Plex are implemented using the configurator. See [the source of the demo component](https://github.com/home-assistant/home-assistant/tree/dev/homeassistant/components/demo) for a simple example.
See [the source](https://github.com/home-assistant/home-assistant/tree/dev/homeassistant/components/configurator) for more details on how to use the configurator component.

4
source/_components/conversation.markdown
View File

@ -14,7 +14,7 @@ ha_qa_scale: internal
ha_release: 0.7
---
The conversation component allows you to converse with Home Assistant. You can either converse by pressing the microphone in the frontend (supported browsers only (no iOS)) or by calling the `conversation/process` service with the transcribed text.
The conversation integration allows you to converse with Home Assistant. You can either converse by pressing the microphone in the frontend (supported browsers only (no iOS)) or by calling the `conversation/process` service with the transcribed text.
<p class='img'>
<img src="/images/screenshots/voice-commands.png" />
@ -28,7 +28,7 @@ conversation:
{% configuration %}
intents:
description: Intents that the conversation component should understand.
description: Intents that the conversation integration should understand.
required: false
type: map
keys:

4
source/_components/counter.markdown
View File

@ -14,7 +14,7 @@ ha_release: 0.53
ha_qa_scale: internal
---
The `counter` component allows one to count occurrences fired by automations.
The `counter` integration allows one to count occurrences fired by automations.
## {% linkable_title Configuration %}
@ -72,7 +72,7 @@ Pick an icon that you can find on [materialdesignicons.com](https://materialdesi
### {% linkable_title Restore State %}
This component will automatically restore the state it had prior to Home Assistant stopping as long as you your entity has `restore` set to `true` which is the default. To disable this feature, set `restore` to `false`.
This integration will automatically restore the state it had prior to Home Assistant stopping as long as you your entity has `restore` set to `true` which is the default. To disable this feature, set `restore` to `false`.
If `restore` is set to `false`, the `initial` value will only be used when no previous state is found or when the counter is reset.

2
source/_components/cover.knx.markdown
View File

@ -17,7 +17,7 @@ ha_iot_class: Local Polling
The `knx` cover platform is used as in interface with KNX covers.
The `knx` component must be configured correctly, see [KNX Component](/components/knx).
The `knx` integration must be configured correctly, see [KNX Component](/components/knx).
To use your KNX covers in your installation, add the following to your `configuration.yaml` file:

2
source/_components/cover.rflink.markdown
View File

@ -14,7 +14,7 @@ ha_release: 0.55
---
The `rflink` component supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).
The `rflink` integration supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).
First, you have to set up your [RFLink hub](/components/rflink/).

2
source/_components/cover.template.markdown
View File

@ -15,7 +15,7 @@ logo: home-assistant.png
ha_qa_scale: internal
---
The `template` platform can create covers that combine components and provides
The `template` platform can create covers that combine integrations and provides
the ability to run scripts or invoke services for each of the open,
close, stop, position and tilt commands of a cover.

2
source/_components/cppm.markdown
View File

@ -50,4 +50,4 @@ api_key:
type: string
{% endconfiguration %}
See the [device tracker component page](/components/device_tracker/) for instructions on how to configure the people to be tracked.
See the [device tracker integration page](/components/device_tracker/) for instructions on how to configure the people to be tracked.

4
source/_components/daikin.markdown
View File

@ -20,7 +20,7 @@ redirect_from:
- /components/sensor.daikin/
---
The `daikin` component integrates Daikin air conditioning systems into Home Assistant.
The `daikin` integration integrates Daikin air conditioning systems into Home Assistant.
There is currently support for the following device types within Home Assistant:
@ -36,7 +36,7 @@ There is currently support for the following device types within Home Assistant:
## {% linkable_title Configuration %}
The Daikin component can be configured in three ways.
The Daikin integration can be configured in three ways.
- Automatically via the [discovery]({{site_root}}/components/discovery/) component.
- Via the Home Assistant user interface where it will let you enter the IP-address of your Daikin AC.

4
source/_components/danfoss_air.markdown
View File

@ -21,9 +21,9 @@ redirect_from:
- /components/switch.danfoss_air/
---
The `danfoss_air` component allows you to access information from your Danfoss Air HRV unit.
The `danfoss_air` integration allows you to access information from your Danfoss Air HRV unit.
*Note*: Danfoss Air CCM only accepts one TCP connection at a time. Due to this the component will not work while you have the HRV PC-Tool open.
*Note*: Danfoss Air CCM only accepts one TCP connection at a time. Due to this the integration will not work while you have the HRV PC-Tool open.
There is currently support for the following device types within Home Assistant:

6
source/_components/datadog.markdown
View File

@ -13,7 +13,7 @@ ha_category:
ha_release: 0.45
---
The `datadog` component sends all state changes to [Datadog](https://www.datadoghq.com/) using a [Datadog Agent](http://docs.datadoghq.com/guides/basic_agent_usage/).
The `datadog` integration sends all state changes to [Datadog](https://www.datadoghq.com/) using a [Datadog Agent](http://docs.datadoghq.com/guides/basic_agent_usage/).
Datadog allows you to analyze, monitor, cross-reference and alert upon your data. You can use it to detect statistical anomalies, see graphs across multiple sources in real-time, send critical alerts to Slack, etc.
@ -21,13 +21,13 @@ Datadog allows you to analyze, monitor, cross-reference and alert upon your data
<img src='{{site_root}}/images/screenshots/datadog-board-example.png' />
</p>
The component also sends events from the logbook into Datadog, allowing you to correlate these events with your data.
The integration also sends events from the logbook into Datadog, allowing you to correlate these events with your data.
<p class='img'>
<img src='{{site_root}}/images/screenshots/datadog-event-stream.png' />
</p>
To use the `datadog` component in your installation, add the following to your `configuration.yaml` file:
To use the `datadog` integration in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry

2
source/_components/ddwrt.markdown
View File

@ -59,4 +59,4 @@ wireless_only:
{% endconfiguration %}
By default Home Assistant pulls information about connected devices from DD-WRT every 5 seconds.
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.
See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked.

4
source/_components/deconz.markdown
View File

@ -61,9 +61,9 @@ If you don't have the API key, you can generate an API key for deCONZ by using t
You can manually add deCONZ by going to the integrations page.
## {% linkable_title Debugging component %}
## {% linkable_title Debugging integration %}
If you have problems with deCONZ or the component you can add debug prints to the log.
If you have problems with deCONZ or the integration you can add debug prints to the log.
```yaml
logger:

4
source/_components/default_config.markdown
View File

@ -1,7 +1,7 @@
---
layout: page
title: "Default Config"
description: "The default config component will initate a default configuration for Home Assistant."
description: "The default config integration will initate a default configuration for Home Assistant."
date: 2019-02-15 20:00
sidebar: true
comments: false
@ -13,7 +13,7 @@ ha_category:
ha_release: 0.88
---
This component is a meta-component and configures a default set of components for Home Assistant to load. The components that will be loaded can be found [here](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/components/default_config/manifest.json).
This integration is a meta-component and configures a default set of integrations for Home Assistant to load. The integrations that will be loaded can be found [here](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/components/default_config/manifest.json).
## {% linkable_title Configuration %}

4
source/_components/demo.markdown
View File

@ -15,7 +15,7 @@ ha_release: 0.7
---
The `demo` platform allows you to use components which are providing a demo of their implementation. The demo entities are dummies but show you how the actual platform looks like. This way you can run own demonstration instance like the online [Home Assistant demo](/demo/) or `hass --demo-mode` but combined with your own real/functional platforms.
The `demo` platform allows you to use integrations which are providing a demo of their implementation. The demo entities are dummies but show you how the actual platform looks like. This way you can run own demonstration instance like the online [Home Assistant demo](/demo/) or `hass --demo-mode` but combined with your own real/functional platforms.
Available demo platforms:
@ -50,7 +50,7 @@ To integrate a demo platform in Home Assistant, add the following section to you
{% configuration %}
"[component]":
description: The name of the component as stated in the listing above the configuration example.
description: The name of the integration as stated in the listing above the configuration example.
required: true
type: string
{% endconfiguration %}

4
source/_components/device_sun_light_trigger.markdown
View File

@ -14,13 +14,13 @@ ha_qa_scale: internal
ha_release: pre 0.7
---
Home Assistant has a built-in component called `device_sun_light_trigger` to help you automate your lights. The component will:
Home Assistant has a built-in integration called `device_sun_light_trigger` to help you automate your lights. The integration will:
* Fade in the lights when the sun is setting and there are people home
* Turn on the lights when people get home after the sun has set
* Turn off the lights when all people leave the house
This component requires the components [sun](/components/sun/), [device_tracker](/components/device_tracker/) and [light](/components/light/) to be enabled.
This integration requires the integrations [sun](/components/sun/), [device_tracker](/components/device_tracker/) and [light](/components/light/) to be enabled.
To enable this component, add the following lines to your `configuration.yaml` file:

2
source/_components/device_tracker.markdown
View File

@ -67,7 +67,7 @@ Multiple device trackers can be used in parallel, such as [Owntracks](/component
## {% linkable_title `known_devices.yaml` %}
<p class='note warning'>
As of 0.94 `known_devices.yaml` is being phased out, and no longer used by all trackers. Depending on the component you use this section may no longer apply. This includes the mobile app, OwnTracks, GeoFency, GPSLogger, and Locative.
As of 0.94 `known_devices.yaml` is being phased out, and no longer used by all trackers. Depending on the integration you use this section may no longer apply. This includes the mobile app, OwnTracks, GeoFency, GPSLogger, and Locative.
</p>
Once `device_tracker` is enabled, a file will be created in your config dir named `known_devices.yaml`. Edit this file to adjust which devices to be tracked.

2
source/_components/device_tracker.xiaomi.markdown
View File

@ -43,7 +43,7 @@ password:
type: string
{% endconfiguration %}
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.
See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked.
### {% linkable_title Compatibility test %}

4
source/_components/dialogflow.markdown
View File

@ -14,9 +14,9 @@ ha_release: 0.56
redirect_from: /components/apiai/
---
The `dialogflow` component is designed to be used with the [webhook](https://dialogflow.com/docs/fulfillment#webhook) integration of [Dialogflow](https://dialogflow.com/). When a conversation ends with a user, Dialogflow sends an action and parameters to the webhook.
The `dialogflow` integration is designed to be used with the [webhook](https://dialogflow.com/docs/fulfillment#webhook) integration of [Dialogflow](https://dialogflow.com/). When a conversation ends with a user, Dialogflow sends an action and parameters to the webhook.
To be able to receive messages from DialogFlow, your Home Assistant instance needs to be accessible from the web ([Hass.io instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP component ([docs](/components/http/#base_url)). Dialogflow will return fallback answers if your server does not answer or takes too long (more than 5 seconds).
To be able to receive messages from DialogFlow, your Home Assistant instance needs to be accessible from the web ([Hass.io instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP integration ([docs](/components/http/#base_url)). Dialogflow will return fallback answers if your server does not answer or takes too long (more than 5 seconds).
Dialogflow could be [integrated](https://dialogflow.com/docs/integrations/) with many popular messaging, virtual assistant and IoT platforms.

2
source/_components/digital_ocean.markdown
View File

@ -19,7 +19,7 @@ redirect_from:
- /components/switch.digital_ocean/
---
The `digital_ocean` component allows you to access the information about your [Digital Ocean](https://www.digitalocean.com/) droplets from Home Assistant.
The `digital_ocean` integration allows you to access the information about your [Digital Ocean](https://www.digitalocean.com/) droplets from Home Assistant.
There is currently support for the following device types within Home Assistant:

2
source/_components/digitalloggers.markdown
View File

@ -63,4 +63,4 @@ cycletime:
Your relays will be available in the form `switch.fantasticrelaydevice_individualrelayname`
**Note:** There is currently a limitation of the [dlipower library](https://github.com/dwighthubbard/python-dlipower) used by the `digitalloggers` component that communication is only available over port 80.
**Note:** There is currently a limitation of the [dlipower library](https://github.com/dwighthubbard/python-dlipower) used by the `digitalloggers` integration that communication is only available over port 80.

2
source/_components/discord.markdown
View File

@ -15,7 +15,7 @@ redirect_from:
- /components/notify.discord/
---
The [Discord service](https://discordapp.com/) is a platform for the notify component. This allows components to send messages to the user using Discord.
The [Discord service](https://discordapp.com/) is a platform for the notify component. This allows integrations to send messages to the user using Discord.
In order to get a token you need to go to the [Discord My Apps page](https://discordapp.com/developers/applications/me) and create a new application. Once the application is ready, create a [bot](https://discordapp.com/developers/docs/topics/oauth2#bots) user (**Create a Bot User**).

4
source/_components/discovery.markdown
View File

@ -14,7 +14,7 @@ ha_qa_scale: internal
ha_release: 0.7
---
Home Assistant can discover and automatically configure [zeroconf](https://en.wikipedia.org/wiki/Zero-configuration_networking)/[mDNS](https://en.wikipedia.org/wiki/Multicast_DNS) and [uPnP](https://en.wikipedia.org/wiki/Universal_Plug_and_Play) devices on your network. Currently the `discovery` component can detect:
Home Assistant can discover and automatically configure [zeroconf](https://en.wikipedia.org/wiki/Zero-configuration_networking)/[mDNS](https://en.wikipedia.org/wiki/Multicast_DNS) and [uPnP](https://en.wikipedia.org/wiki/Universal_Plug_and_Play) devices on your network. Currently the `discovery` integration can detect:
* [Apple TV](/components/apple_tv/)
* [Belkin WeMo switches](/components/wemo/)
@ -120,7 +120,7 @@ If running Home Assistant in a [Docker container](/docs/installation/docker/) us
### {% linkable_title Windows %}
#### {% linkable_title 64-bit Python %}
There is currently a <a href='https://bitbucket.org/al45tair/netifaces/issues/17/dll-fails-to-load-windows-81-64bit'>known issue</a> with running this component on a 64-bit version of Python and Windows.
There is currently a <a href='https://bitbucket.org/al45tair/netifaces/issues/17/dll-fails-to-load-windows-81-64bit'>known issue</a> with running this integration on a 64-bit version of Python and Windows.
#### {% linkable_title Python 3.5 %}

2
source/_components/dispatcher.markdown
View File

@ -24,7 +24,7 @@ The `dispatcher` camera platform allows developers to create virtual camera's.
## {% linkable_title Configuration %}
You would normally not add this camera to your configuration directly but have it be discovered by one of the components that uses it.
You would normally not add this camera to your configuration directly but have it be discovered by one of the integrations that uses it.
```yaml
# Example configuration.yaml entry

6
source/_components/dominos.markdown
View File

@ -14,9 +14,9 @@ ha_iot_class: Cloud Polling
ha_release: 0.59
---
The `dominos` component allows you to order Dominos Pizza from within your Home Assistant scripts and automations.
The `dominos` integration allows you to order Dominos Pizza from within your Home Assistant scripts and automations.
At present, this component only supports ordering within Canada and the US.
At present, this integration only supports ordering within Canada and the US.
## {% linkable_title Configuration %}
@ -24,7 +24,7 @@ To enable the component, you need to set up your customer information and define
Orders are a group of product codes. You can get these product codes by inspecting an order request from the Dominos web app, or you can [add this custom panel by following this readme](https://github.com/wardcraigj/hass-dominos-panel) to see the available product codes in a separate panel in your install.
Currently, there is no support in this component for toppings, coupons or order tracking.
Currently, there is no support in this integration for toppings, coupons or order tracking.
```yaml
dominos:

4
source/_components/dovado.markdown
View File

@ -19,14 +19,14 @@ redirect_from:
- /components/sensor.dovado/
---
The `dovado` component manages communication with the [Dovado](http://www.dovado.com/) router.
The `dovado` integration manages communication with the [Dovado](http://www.dovado.com/) router.
There is currently support for the following device types within Home Assistant:
- [Notifications](/components/dovado/#notifications)
- [Sensor](/components/dovado/#sensor)
To add a Dovado component to your installation, add the following to your `configuration.yaml` file:
To add a Dovado integration to your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry

4
source/_components/downloader.markdown
View File

@ -1,7 +1,7 @@
---
layout: page
title: "Downloader"
description: "Instructions on how to setup the downloader component with Home Assistant."
description: "Instructions on how to setup the downloader integration with Home Assistant."
date: 2015-01-24 14:39
sidebar: true
comments: false
@ -14,7 +14,7 @@ ha_release: pre 0.7
ha_qa_scale: internal
---
The `downloader` component provides a service to download files. It will raise an error and not continue to set itself up when the download directory does not exist. The directory needs to be writable for the user that is running Home Assistant.
The `downloader` integration provides a service to download files. It will raise an error and not continue to set itself up when the download directory does not exist. The directory needs to be writable for the user that is running Home Assistant.
To enable it, add the following lines to your `configuration.yaml` file:

4
source/_components/dsmr.markdown
View File

@ -27,7 +27,7 @@ A sensor platform for Dutch Smart Meters which comply to DSMR (Dutch Smart Meter
<img src='/images/screenshots/dsmr.png' />
</p>
This component is known to work for:
This integration is known to work for:
- Iskra ME382 / MT382 (DSMR 2.2)
- ISKRA AM550 (DSMR 5.0)
@ -149,6 +149,6 @@ DSMR is a standard to which Dutch smartmeters must comply. It specifies that the
The contents of this telegram differ between version but they generally consist of lines with 'obis' (Object Identification System, a numerical ID for a value) followed with the value and unit.
This module sets up an asynchronous reading loop using the `dsmr_parser` module which waits for a complete telegram, parser it and puts it on an async queue as a dictionary of `obis`/object mapping. The numeric value and unit of each value can be read from the objects attributes. Because the `obis` are know for each DSMR version the Entities for this component are create during bootstrap.
This module sets up an asynchronous reading loop using the `dsmr_parser` module which waits for a complete telegram, parser it and puts it on an async queue as a dictionary of `obis`/object mapping. The numeric value and unit of each value can be read from the objects attributes. Because the `obis` are know for each DSMR version the Entities for this integration are create during bootstrap.
Another loop (DSMR class) is setup which reads the telegram queue, stores/caches the latest telegram and notifies the Entities that the telegram has been updated.

6
source/_components/duckdns.markdown
View File

@ -13,11 +13,11 @@ ha_category:
ha_release: 0.55
---
With the DuckDNS component you can keep your DuckDNS record up to date. DuckDNS is a free dynamic DNS service that allows you to point a subdomain under `duckdns.org` at your computer.
With the DuckDNS integration you can keep your DuckDNS record up to date. DuckDNS is a free dynamic DNS service that allows you to point a subdomain under `duckdns.org` at your computer.
## {% linkable_title Configuration %}
To use the component in your installation, add the following to your `configuration.yaml` file:
To use the integration in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -38,5 +38,5 @@ duckdns:
{% endconfiguration %}
<p class='note'>
If you are running the Hass.io [DuckDNS add-on](/addons/duckdns/) this component is not required. The add-on will keep your IP updated with DuckDNS.
If you are running the Hass.io [DuckDNS add-on](/addons/duckdns/) this integration is not required. The add-on will keep your IP updated with DuckDNS.
</p>

4
source/_components/dweet.markdown
View File

@ -17,7 +17,7 @@ redirect_from:
- /components/sensor.dweet/
---
The `dweet` component makes it possible to transfer details collected with Home Assistant to [Dweet.io](http://dweet.io/) and visualize them with [freeboard.io](https://freeboard.io). Keep in mind that your information will be public!
The `dweet` integration makes it possible to transfer details collected with Home Assistant to [Dweet.io](http://dweet.io/) and visualize them with [freeboard.io](https://freeboard.io). Keep in mind that your information will be public!
<p class='img'>
<img src='{{site_root}}/images/screenshots/dweet-freeboard.png' />
@ -33,7 +33,7 @@ There is currently support for the following device types within Home Assistant:
## {% linkable_title Configuration %}
To use the `dweet` component in your installation, add the following to your `configuration.yaml` file:
To use the `dweet` integration in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry

6
source/_components/dyson.markdown
View File

@ -23,7 +23,7 @@ redirect_from:
- /components/sensor.dyson/
---
The `dyson` component is the main component to integrate all [Dyson](https://www.dyson.com) related platforms.
The `dyson` integration is the main integration to integrate all [Dyson](https://www.dyson.com) related platforms.
There is currently support for the following device types within Home Assistant:
@ -107,7 +107,7 @@ The `dyson` vacuum platform allows you to control your Dyson 360 Eye robot vacuu
### {% linkable_title Component services %}
This component support the following services (see [Vacuum Cleaner Robots](/components/vacuum/)):
This integration support the following services (see [Vacuum Cleaner Robots](/components/vacuum/)):
- [`turn_on`](/components/vacuum/#service-vacuumturn_on)
- [`turn_off`](/components/vacuum/#service-vacuumturn_off)
@ -124,7 +124,7 @@ The `dyson` climate platform allows you to control your Dyson Pure Hot+Cool Fan
### {% linkable_title Component services %}
This component supports the following services (see [Climate](/components/climate/)):
This integration supports the following services (see [Climate](/components/climate/)):
- [`turn_on`](/components/climate/#service-climateturn_on)
- [`turn_off`](/components/climate/#service-climateturn_off)

2
source/_components/ebusd.markdown
View File

@ -1,7 +1,7 @@
---
layout: page
title: "ebusd"
description: "The ebusd component allows the integration between eBUS heating system and Home Assistant."
description: "The ebusd integration allows the integration between eBUS heating system and Home Assistant."
date: 2018-12-27 15:00
sidebar: true
comments: false

2
source/_components/ecoal_boiler.markdown
View File

@ -17,7 +17,7 @@ redirect_from:
- /components/switch.ecoal_boiler/
---
The `ecoal_boiler` component is the base for pumps and sensors managed by [esterownik.pl eCoal boiler controller](https://esterownik.pl/nasze-produkty/ecoal).
The `ecoal_boiler` integration is the base for pumps and sensors managed by [esterownik.pl eCoal boiler controller](https://esterownik.pl/nasze-produkty/ecoal).
## {% linkable_title Configuration %}

10
source/_components/ecobee.markdown
View File

@ -25,7 +25,7 @@ redirect_from:
- /components/weather.ecobee/
---
The `ecobee` component lets you control a thermostats and view sensor data from [ecobee](https://ecobee.com) thermostats.
The `ecobee` integration lets you control a thermostats and view sensor data from [ecobee](https://ecobee.com) thermostats.
## {% linkable_title Configuration %}
@ -48,7 +48,7 @@ Now login to the regular consumer portal, and in the hamburger menu there will b
Now under the Name and Summary Section you will have an API key. Copy this key and use it in you configuration section below. Click the **X** to close the Developer section.
To add the Ecobee component to Home Assistant, add the following information to your [`configuration.yaml`](/docs/configuration/) file:
To add the Ecobee integration to Home Assistant, add the following information to your [`configuration.yaml`](/docs/configuration/) file:
```yaml
# Example configuration.yaml entry
@ -58,11 +58,11 @@ ecobee:
[Restart Home Assistant](https://www.home-assistant.io/docs/configuration/#reloading-changes) for the changes to take effect.
The first time you (re)run Home Assistant with this component it will give you a PIN code that you need to authorize in the [ecobee consumer portal](https://www.ecobee.com/consumerportal/index.html). You can do this by clicking **Add Application** in the **My Apps** section in the sidebar.
The first time you (re)run Home Assistant with this integration it will give you a PIN code that you need to authorize in the [ecobee consumer portal](https://www.ecobee.com/consumerportal/index.html). You can do this by clicking **Add Application** in the **My Apps** section in the sidebar.
The PIN can be found from the Home Assistant portal on the Ecobee card or from the **configurator.ecobee** entity in states in the portal.
- If you do not have an ecobee card, you may be using groups with `default_view` that don't show the card. To get around this you can temporarily comment out the `default_view` section or add the `configurator.ecobee` component to your `default_view` and restart Home Assistant.
- If you do not have an ecobee card, you may be using groups with `default_view` that don't show the card. To get around this you can temporarily comment out the `default_view` section or add the `configurator.ecobee` integration to your `default_view` and restart Home Assistant.
Once you enter the PIN on the ecobee site, wait approximately 5 minutes and then click on the **I have authorized the app** link at the bottom of the ecobee pop-up window. If everything worked correctly, you should now be able to restart Home Assistant again to see the full ecobee card with all of the sensors populated or see the list of sensors in the developer tools. Now you can re-enable your `default_view` (if you had to disable it) and add the ecobee sensors to a group and/or view.
@ -87,7 +87,7 @@ If for whatever reason you delete and re-create your ecobee app at ecobee.com su
## {% linkable_title Notifications %}
To get your Ecobee notifications working with Home Assistant, you must first have the main Ecobee component loaded and running. Once you have that configured, you can setup this component to send messages to your Ecobee device.
To get your Ecobee notifications working with Home Assistant, you must first have the main Ecobee integration loaded and running. Once you have that configured, you can setup this integration to send messages to your Ecobee device.
To use this notification platform in your installation, add the following to your `configuration.yaml` file:

4
source/_components/ecovacs.markdown
View File

@ -17,7 +17,7 @@ redirect_from:
- /components/vacuum.ecovacs/
---
The `ecovacs` component is the main component to integrate all [Ecovacs](https://www.ecovacs.com) (Deebot) vacuums. You will need your Ecovacs account information (username, password) to discover and control vacuums in your account.
The `ecovacs` integration is the main integration to integrate all [Ecovacs](https://www.ecovacs.com) (Deebot) vacuums. You will need your Ecovacs account information (username, password) to discover and control vacuums in your account.
There is currently support for the following device types within Home Assistant:
@ -62,7 +62,7 @@ The library that talks to the Ecovacs servers is in a very early state and still
Please see the [sucks library documentation](https://github.com/wpietri/sucks) for some more information about what has been tested, and check out the GitHub issues to see if the issue you're having is known or being worked on.
If you have an issue with the Ecovacs component, please file a [GitHub Issue](https://github.com/home-assistant/home-assistant/issues) and include your Home Assistant logs in the report. To get full debug output from both the Ecovacs component and the underlying `sucks` library, place this in your `configuration.yaml` file:
If you have an issue with the Ecovacs component, please file a [GitHub Issue](https://github.com/home-assistant/home-assistant/issues) and include your Home Assistant logs in the report. To get full debug output from both the Ecovacs integration and the underlying `sucks` library, place this in your `configuration.yaml` file:
```yaml
logger:

2
source/_components/edp_redy.markdown
View File

@ -19,7 +19,7 @@ redirect_from:
- /components/switch.edp_redy/
---
[EDP re:dy](https://www.edp.pt/particulares/servicos/redy/) is a Home Automation platform from Portuguese energy provider EDP, that allows control of appliances and other devices, as well as monitoring power consumption. This component allows integrating EDP re:dy into Home Assistant.
[EDP re:dy](https://www.edp.pt/particulares/servicos/redy/) is a Home Automation platform from Portuguese energy provider EDP, that allows control of appliances and other devices, as well as monitoring power consumption. This integration allows integrating EDP re:dy into Home Assistant.
## {% linkable_title Configuration %}

2
source/_components/ee_brightbox.markdown
View File

@ -51,4 +51,4 @@ version:
type: string
{% endconfiguration %}
See the [device tracker component page](/components/device_tracker/) for instructions on how to configure the people to be tracked.
See the [device tracker integration page](/components/device_tracker/) for instructions on how to configure the people to be tracked.

6
source/_components/egardia.markdown
View File

@ -106,7 +106,7 @@ There seem to be multiple versions of software running on GATE-02 devices; we ha
1. Log in to your alarm system's control panel. You will need to access http://[IP of your control panel]. You know this already since you need it in the basic configuration from above. Log in to the control panel with your Egardia/Woonveilig username and password.
2. Once logged in, go to *System Settings*, *Report* and change the Server Address for your primary server to the IP or hostname of your Home Assistant machine. You can leave the port number set to 52010 or change it to anything you like. **Make sure to change the settings of the primary server otherwise the messages will not come through. Note that this will limit (or fully stop) the number of alarm messages you will get through Egardia's / Woonveilig services.** Maybe, that is just what you want. Make sure to save your settings by selecting 'OK'.
3. The Egardia component relies on capturing the status codes that your alarm emits when something happens (status change or trigger). These codes will be unique for every situation - i.e. the code emitted by the alarm when a sensor is triggered is unique to that sensor. Also, if you have multiple users or remotes, each remote has unique codes that are emitted by the alarm when status is changed using that remote or by that user. For the Egardia component to work correctly you will need to capture the codes. To do this, on your Home Assistant machine run `$ sudo python3 egardiaserver.py`. Refer to the [python-egardia repository](https://github.com/jeroenterheerdt/python-egardia) for detailed documentation on parameters. This will receive status codes from your alarm control panel and display them. Record the codes shown as well as the status they relate to (see step 4 below). Make sure to change the status of your alarm to all states (disarm, arm, home) by all means possible (all users, remotes, web login, app) as well as trigger the alarm in all ways possible to get 100% coverage of all the codes the alarm system generates. You will need to run this script once and stop it once you have captured all the possible codes. Also, if you ever add users, remotes or sensors to your alarm system, make sure to re-run the script to capture the extra codes so you can update your configuration (see step 4 below). **For comfort, before triggering the alarm it might be good to disable the siren temporarily (can be done in Panel Settings).**
3. The Egardia integration relies on capturing the status codes that your alarm emits when something happens (status change or trigger). These codes will be unique for every situation - i.e. the code emitted by the alarm when a sensor is triggered is unique to that sensor. Also, if you have multiple users or remotes, each remote has unique codes that are emitted by the alarm when status is changed using that remote or by that user. For the Egardia integration to work correctly you will need to capture the codes. To do this, on your Home Assistant machine run `$ sudo python3 egardiaserver.py`. Refer to the [python-egardia repository](https://github.com/jeroenterheerdt/python-egardia) for detailed documentation on parameters. This will receive status codes from your alarm control panel and display them. Record the codes shown as well as the status they relate to (see step 4 below). Make sure to change the status of your alarm to all states (disarm, arm, home) by all means possible (all users, remotes, web login, app) as well as trigger the alarm in all ways possible to get 100% coverage of all the codes the alarm system generates. You will need to run this script once and stop it once you have captured all the possible codes. Also, if you ever add users, remotes or sensors to your alarm system, make sure to re-run the script to capture the extra codes so you can update your configuration (see step 4 below). **For comfort, before triggering the alarm it might be good to disable the siren temporarily (can be done in Panel Settings).**
4. Once you have the codes, update your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
@ -123,8 +123,8 @@ There seem to be multiple versions of software running on GATE-02 devices; we ha
triggered: XXXXXXXXXXXXXXXX, XXXXXXXXXXXXXXXX, XXXXXXXXXXXXXXXX
ignore: XXXXXXXXXXXXXXXX
```
Note that for all code groups (*arm*,*disarm*, etc) multiple codes can be entered since each sensor triggers with a different code and each user of the system has its own arm and disarm codes. Also note that your system will do regular system checks which will be reported as well. Since Home Assistant provides no way of handling them properly, you can enter those codes as *ignore* (again, multiple codes can be used here). The egardia component will ignore these codes and continue returning the old status if it receives any of the codes that are listed as ignore. This is useful for example when you have armed your alarm at night: normally a system check will occur at least once during the night and if that code is not specified anywhere Home Assistant will set the status of the alarm to its default, which is unarmed. This is in fact wrong. Listing the code as ignore changes this behavior and Home Assistant will continue to show the status the alarm is in (disarm, arm, home, triggered) even when system checks occur.
5. Test your setup and enjoy. The component will update if the alarm status changes, including triggers. You can use this to build your own automations and send notifications as you wish. *Note*: previous versions required a separate egardiaserver to be set up. This is no longer necessary and corresponding system services can be removed (using systemctl).
Note that for all code groups (*arm*,*disarm*, etc) multiple codes can be entered since each sensor triggers with a different code and each user of the system has its own arm and disarm codes. Also note that your system will do regular system checks which will be reported as well. Since Home Assistant provides no way of handling them properly, you can enter those codes as *ignore* (again, multiple codes can be used here). The egardia integration will ignore these codes and continue returning the old status if it receives any of the codes that are listed as ignore. This is useful for example when you have armed your alarm at night: normally a system check will occur at least once during the night and if that code is not specified anywhere Home Assistant will set the status of the alarm to its default, which is unarmed. This is in fact wrong. Listing the code as ignore changes this behavior and Home Assistant will continue to show the status the alarm is in (disarm, arm, home, triggered) even when system checks occur.
5. Test your setup and enjoy. The integration will update if the alarm status changes, including triggers. You can use this to build your own automations and send notifications as you wish. *Note*: previous versions required a separate egardiaserver to be set up. This is no longer necessary and corresponding system services can be removed (using systemctl).
## {% linkable_title Binary Sensor %}

2
source/_components/eight_sleep.markdown
View File

@ -19,7 +19,7 @@ redirect_from:
- /components/sensor.eight_sleep/
---
The `eight_sleep` component allows Home Assistant to fetch data from your [Eight Sleep](https://eightsleep.com/) smart cover or mattress.
The `eight_sleep` integration allows Home Assistant to fetch data from your [Eight Sleep](https://eightsleep.com/) smart cover or mattress.
There is currently support for the following device types within Home Assistant:

2
source/_components/emoncms.markdown
View File

@ -44,7 +44,7 @@ sensor:
## {% linkable_title Default naming scheme %}
The names of the sensors created by this component will use the feed names defined in EmonCMS if available,
The names of the sensors created by this integration will use the feed names defined in EmonCMS if available,
or the feed ID otherwise, and will be prefixed with "EmonCMS", e.g., "EmonCMS Total Power" or "EmonCMS Feed 5".
If the `id` property is anything but `1`, the ID will be shown as well, e.g., "EmonCMS 2 Feed 5".

4
source/_components/emoncms_history.markdown
View File

@ -14,9 +14,9 @@ ha_release: 0.31
---
The `emoncms_history` component makes it possible to transfer details collected with Home Assistant to [Emoncms.org](https://emoncms.org/) or your local running Emoncms instance. It will send the data to a specific input node on Emoncms with the entity IDs as a key. Afterwards you can create feeds and dashboards in Emoncms with the collected data.
The `emoncms_history` integration makes it possible to transfer details collected with Home Assistant to [Emoncms.org](https://emoncms.org/) or your local running Emoncms instance. It will send the data to a specific input node on Emoncms with the entity IDs as a key. Afterwards you can create feeds and dashboards in Emoncms with the collected data.
To use the `emoncms_history` component in your installation, add the following to your `configuration.yaml` file:
To use the `emoncms_history` integration in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry

6
source/_components/emulated_hue.markdown
View File

@ -19,7 +19,7 @@ ha_qa_scale: internal
Be aware that `emulated_hue` doesn't work for new users of **Google Home** with `emulated_hue`. If you've not previously set this up and had it working, use the [Google Assistant component](/components/google_assistant/) or [Nabu Casa cloud](https://www.home-assistant.io/components/cloud) component.
</p>
The `emulated_hue` component provides a virtual Philips Hue bridge, written entirely in software, which allows services that work with the Hue API to interact with Home Assistant
The `emulated_hue` integration provides a virtual Philips Hue bridge, written entirely in software, which allows services that work with the Hue API to interact with Home Assistant
entities. The driving use case behind for functionality is to allow Home Assistant to work with an Amazon Echo or Google Home with no setup cost outside of configuration changes.
The virtual bridge can turn entities on/off or change the brightness of dimmable lights. The volume level of media players can be controlled as brightness.
@ -61,7 +61,7 @@ type:
type: string
default: google_home
host_ip:
description: The IP address that your Home Assistant installation is running on. If you do not specify this option, the component will attempt to determine the IP address on its own.
description: The IP address that your Home Assistant installation is running on. If you do not specify this option, the integration will attempt to determine the IP address on its own.
required: false
type: string
listen_port:
@ -136,7 +136,7 @@ These attributes used to be found under the `customize` section of `homeassistan
### {% linkable_title Troubleshooting %}
You can verify that the `emulated_hue` component has been loaded and is responding by pointing a local browser to the following URL:
You can verify that the `emulated_hue` integration has been loaded and is responding by pointing a local browser to the following URL:
- `http://<HA IP Address>:8300/description.xml` - This URL should return a descriptor file in the form of an XML file.
- `http://<HA IP Address>:8300/api/pi/lights` - This will return a list of devices, lights, scenes, groups, etc.. that `emulated_hue` is exposing to Alexa.

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