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-04-26 06:17:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

H-integrations: Rename component to integration (#27789)

Browse Source
This commit is contained in:
c0ffeeca7 2023-06-13 15:19:30 +02:00 committed by GitHub
parent b338caad8c
commit 31ee84cacb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
source/_integrations/history_stats.markdown
View File

@ -129,7 +129,7 @@ duration:
<div class='note'>
If the duration exceeds the number of days of history stored by the `recorder` component (`purge_keep_days`), the history statistics sensor will not have all the information it needs to look at the entire duration. For example, if `purge_keep_days` is set to 7, a history statistics sensor with a duration of 30 days will only report a value based on the last 7 days of history.
If the duration exceeds the number of days of history stored by the `recorder` integration (`purge_keep_days`), the history statistics sensor will not have all the information it needs to look at the entire duration. For example, if `purge_keep_days` is set to 7, a history statistics sensor with a duration of 30 days will only report a value based on the last 7 days of history.
</div>

12
source/_integrations/homekit.markdown
View File

@ -284,7 +284,7 @@ To enable the HomeKit integration in Home Assistant, add the following to your c
homekit:
```
After Home Assistant has started, the entities (depending on the filter) are exposed to HomeKit if they are [supported](#supported-components). To add them:
After Home Assistant has started, the entities (depending on the filter) are exposed to HomeKit if they are [supported](#supported-integrations). To add them:
1. Open the Home Assistant frontend. A new card will display the pairing QR code and the `pin code` as seen in the example below. Note: If pin code is not displayed, check "Notifications" (the bell icon) in the lower-left of the Home Assistant UI.
2. Open the Apple `Home` app.
@ -346,7 +346,7 @@ To add a single entity in accessory mode:
## Configure Filter
By default, all entities except categorized entities (config, diagnostic, and system entities) are included. To limit which entities are being exposed to `HomeKit`, you can use the `filter` parameter. Keep in mind only [supported components](#supported-components) can be added.
By default, all entities except categorized entities (config, diagnostic, and system entities) are included. To limit which entities are being exposed to `HomeKit`, you can use the `filter` parameter. Keep in mind only [supported integrations](#supported-integrations) can be added.
```yaml
# Example filter to include specified domains and exclude specified entities
@ -387,11 +387,11 @@ If you have a firewall configured on your Home Assistant system, make sure you o
- UDP: 5353
- TCP: 21063 (or the configured/used `port` in the integration settings).
## Supported Components
## Supported integrations
The following integrations are currently supported:
| Component | Type Name | Description |
| Integration | Type Name | Description |
| --------- | --------- | ----------- |
| alarm_control_panel | SecuritySystem | All security systems. |
| automation / input_boolean / remote / scene / script / vacuum | Switch | All represented as switches. |
@ -573,7 +573,7 @@ Pairing works fine when the filter is set to only include `demo.demo`, but fails
#### Pairing hangs - no error
1. Make sure that you don't try to add more than 150 accessories, see [device limit](#device-limit). In rare cases, one of your entities doesn't work with the HomeKit component. Use the [filter](#configure-filter) to find out which one. Feel free to open a new issue in the `home-assistant` repository, so we can resolve it.
1. Make sure that you don't try to add more than 150 accessories, see [device limit](#device-limit). In rare cases, one of your entities doesn't work with the HomeKit integration. Use the [filter](#configure-filter) to find out which one. Feel free to open a new issue in the `home-assistant` repository, so we can resolve it.
2. Check logs, and search for `Starting accessory Home Assistant Bridge on address`. Make sure Home Assistant Bridge connected to a correct interface. If it did not, explicitly set `homekit.ip_address` configuration variable.
### Issues during normal use
@ -584,7 +584,7 @@ Multiple users have reported that iOS 12 and earlier devices will spontaneously
#### My entity doesn't show up
Check if the domain of your entity is [supported](#supported-components). If it is, check your [filter](#configure-filter) settings. Make sure the spelling is correct, especially if you use `include_entities`.
Check if the domain of your entity is [supported](#supported-integrations). If it is, check your [filter](#configure-filter) settings. Make sure the spelling is correct, especially if you use `include_entities`.
#### HomeKit doesn't work on second Home Assistant instance

2
source/_integrations/homekit_controller.markdown
View File

@ -45,7 +45,7 @@ ha_integration_type: integration
The [HomeKit](https://developer.apple.com/apple-home/) controller integration allows you to connect accessories with the "Works with HomeKit" logo to Home Assistant. This integration should not be confused with the [HomeKit](/integrations/homekit/) integration, which allows you to control Home Assistant devices via HomeKit.
The integration will automatically detect HomeKit compatible devices that are ready to pair if the [`zeroconf`](/integrations/zeroconf/) integration is enabled. This is enabled by default on new installations via the [`default_config`](/integrations/default_config/) component.
The integration will automatically detect HomeKit compatible devices that are ready to pair if the [`zeroconf`](/integrations/zeroconf/) integration is enabled. This is enabled by default on new installations via the [`default_config`](/integrations/default_config/) integration.
To see which devices have been discovered see the "Integrations" page in your Home Assistant dashboard. When you click on "Configure" you can enter your HomeKit PIN and the device should be added to your Home Assistant instance. If your device is currently paired with an Apple device via HomeKit, you will need to reset it in order to pair it with Home Assistant. Once Home Assistant is configured to work with the device, you can export it back to Siri and Apple Home with the [`HomeKit`](/integrations/homekit/) integration.

8
source/_integrations/homematic.markdown
View File

@ -58,7 +58,7 @@ You can manually rename the created entities by using Home Assistant's [Customiz
## Configuration
To set up the component, add the following information to your `configuration.yaml` file:
To set up the integration, add the following information to your `configuration.yaml` file:
```yaml
homematic:
@ -201,7 +201,7 @@ homematic:
We use three approaches to fetch the names of devices. Each assumes you have properly named your devices in your existing Homematic setup. As a general advice: Use ASCII for your devices names. Home Assistant won't include non-ASCII characters in entity-names.
1. `json`: The CCU allows to fetch details of the paired devices via JSON-RPC. For this to work you need to add valid credentials to your component-configuration. Guest-access is sufficient to query for device names.
1. `json`: The CCU allows to fetch details of the paired devices via JSON-RPC. For this to work, you need to add valid credentials to your integration configuration. Guest-access is sufficient to query for device names.
2. `xml`: If you use a CCU, there is an add-on called the "XML-API". With it installed, you are able to fetch all kinds of information from you CCU using XML-RPC. We can leverage this and fetch the names of devices set within the CCU. We don't support authentication with this method. The `json` method should be preferred over `xml`. Support for the XML-API is only available for downwards compatibility and may be disabled in a future release.
3. `metadata`: Homegear provides device-names through the metadata devices internally have. When using an HM-CFG-LAN interface, you typically use a configuration software ("HomeMatic-Komponenten konfigurieren" is the name of the shortcut on your desktop by default) to pair and configure your devices. If you have paired devices, you'll see them listed in a table. The leftmost column (Name) is prefilled with default names. You can click such a name and enter whatever you like.
@ -215,7 +215,7 @@ This does *not* affect the entities in Home Assistant. They all use their own co
### Reading attributes of entities
Most devices have, besides their state, additional attributes like their battery state or valve position. These can be accessed using templates in automations, or even as their own entities using the [template sensor](/integrations/template) component. Here's an example of a template sensor that exposes the valve position of a thermostat.
Most devices have, besides their state, additional attributes like their battery state or valve position. These can be accessed using templates in automations, or even as their own entities using the [template sensor](/integrations/template) integration. Here's an example of a template sensor that exposes the valve position of a thermostat.
{% raw %}
@ -498,7 +498,7 @@ automation:
{% endraw %}
The important part is the `sensor.time` entity (from time_date component). This will update the binary sensor on every change of the sensor and every minute. If the Homematic sensor does not send any updates anymore, the `sensor.time` will set the binary sensor to `off` 10 minutes after the last sensor update. This will trigger the automation.
The important part is the `sensor.time` entity (from time_date integration). This will update the binary sensor on every change of the sensor and every minute. If the Homematic sensor does not send any updates anymore, the `sensor.time` will set the binary sensor to `off` 10 minutes after the last sensor update. This will trigger the automation.
- If you have a CCU you can also create a system variable on the CCU, which stores its last reboot time. Since Home Assistant can still refresh system variables from the CCU (even after a reboot) this is another option to call *homematic.reconnect*. Even though this option might look preferable to many since it does not rely on a sensor, **it is less fail-safe** than checking for updates of a sensor. Since the variable on the CCU is only changed on boot, any problem that causes the connection between Home Assistant and the CCU to break but will not result in a reboot will not be detected (eg. in case of networking issues). This is how this can be done:

6
source/_integrations/hydrawise.markdown
View File

@ -53,7 +53,7 @@ To get your API access token log into your [Hydrawise account](https://app.hydra
## Binary Sensor
Once you have enabled the `hydrawise` component, add the following to your `configuration.yaml` file:
Once you have enabled the `hydrawise` integration, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -87,7 +87,7 @@ The limit is 3 calls to start/stop/suspend a zone per 30 seconds and an addition
## Sensor
Once you have enabled the `hydrawise` component, add the following to your `configuration.yaml` file:
Once you have enabled the `hydrawise` integration, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -110,7 +110,7 @@ monitored_conditions:
## Switch
Once you have enabled the `hydrawise` component, add the following to your `configuration.yaml` file:
Once you have enabled the `hydrawise` integration, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry