Onboarding, adding integrations- update (#33967)

This commit is contained in:
c0ffeeca7 2024-07-30 18:00:52 +02:00 committed by GitHub
parent f0e4d1248b
commit ec3236191f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
13 changed files with 65 additions and 14 deletions

View File

@ -1,31 +1,82 @@
---
title: "Adding Integrations"
title: "Adding integrations"
description: "Instructions to add an integration."
---
Let's start by adding your first {% term integration %} so that you can see and change a smart home {% term device %}.
Let's start by adding your first {% term integration %}. In this tutorial, we will use the **Workday** integration. It can be used to automate based on workdays, days off, or holidays. No smart device is needed for this tutorial.
From the sidebar, select {% my integrations title="Settings > Devices & Services" %}. At this screen you will be able to set up integrations with Home Assistant. You might notice a **Discovered** section. This section contains integrations that were found on your network and can easily be added with a few clicks. If your integrations are not discovered, click the **Add integration** button in the lower right and search for your integration in that list.
## Prerequisites
In this example, we'll add a Chromecast to Home Assistant. Chromecast uses the [Google Cast integration](/integrations/cast). Although the below example has already discovered the device, let's add it manually.
This tutorial assumes that you have [installed Home Assistant](/installation/) and have at least completed the [onboarding steps](/getting-started/onboarding/).
First, press the **Add integration** button in the lower right and search for your integration in that list.
## Adding integrations
![Search for Google Cast](/images/getting-started/add-google-cast-integration.png)
1. Go to {% my integrations title="**Settings** > **Devices & services**" %}.
- The integrations page shows all the integrations you have already installed. Some of them were installed automatically.
- If devices were discovered in your network, you will see them in the **Discovered** section.
Select **Google Cast** from the list. Because my Chromecast device was already discovered, it asks if I want to add the discovered one or a different one. I will choose the latter and setup another instance.
![Screenshot of the integrations page, with discovered devices](/images/getting-started/integrations_page_discovered.png)
2. If there are any devices discovered for you, you can add them now.
- Under **Discovered**, on the integration, select **Configure**.
- Follow the steps in the UI if additional configuration is required.
- If no devices were discovered, don't worry, we will add an integration in the next step.
3. In the bottom-right corner, select **Add integration**.
4. Type `workd` and select the **Workday** integration.
![Google Cast discovered confirmation](/images/getting-started/google-cast-discovered.png)
![Screenshot of the add integrations dialog](/images/getting-started/add_workday_integration.png)
It now asks for the network IP address of the device. Describing how to identify a devices IP address is beyond the scope of this article because each network is different. However, the router is usually a good place to look. In this example, it's *192.168.1.99*.
5. Give it a name, for example `Workday tomorrow`, and select the country.
- The country is used to determine the local Holidays.
- Select **Submit**, then **Finish**.
6. Configure the options.
- For example, if Monday is not a workday for you, select the "x" to remove it.
- To check if tomorrow is workday, under **Offset**, enter `1`.
- Fill in all other options as needed. At a minimum, define the **Holidays** and **Language**.
- Select **Submit**.
![Manually setup Google Cast device](/images/getting-started/google-cast-manual-details.png)
![Screenshot of the configuration options](/images/getting-started/workday_configure.png)
7. Select the {% term area %}, for example, office, and select **Finish**.
8. You now see the **Workday** integration in the list.
- {% icon "mdi:party-popper" %} Congratulations! You've added your first integration. Job done.
If it was successful, it will show a message and allow you to set the {% term area %} it belongs to.
![Screenshot of the workday integration on the integrations page](/images/getting-started/workday_select_integration.png)
![Search for Google Cast](/images/getting-started/google-cast-integration-added.png)
## Looking at integration details
When you're done, navigate back to the web interface and voila, your devices are ready for you to control. You can always go back to add and remove integrations in the future.
1. Select the integration.
If you get stuck, need more information, or want to see what the setup process is like, use the [integration documentation](/integrations).
![Screenshot of the workday integration on the integrations page](/images/getting-started/workday_select_integration.png)
- This opens the integration details page.
- On the details page, we see that this integration has one {% term service %} and one {% term entity %}.
![Screenshot of the workday integration details page](/images/getting-started/workday_sensor_details.png)
2. Select **Service**, to open the service info page.
- In the **Logbook**, you can see the timeline of that {% term sensor %}.
- Under **Sensors**, you can see all the sensors an integration provides. Here, we have only one, but if you have a climate device, for example, you might see temperature, humidity, and battery status here.
- You can also see that **Workday** is not used (yet) in any {% term automations %}, {% term scripts %}, or {% term scenes %}.
![Screenshot of the workday sensor info page](/images/getting-started/workday_service_info.png)
3. Select the back button {% icon "mdi:arrow-back" %}. Then, select **Entity** to open the list of {% term entities %}.
- Although your Home Assistant already has many entities, you see only 1 entry in the entities table.
- This is because it is [filtered](/docs/organizing/tables#filtering-items-in-a-table).
- You see the entity ID, which consist of the domain (a technical term for device type) and the entity name, in the following format: `domain.entity_name`.
![Screenshot of the entities list, filtered for workday](/images/getting-started/workday_entities_list.png)
## Modifying the integration
1. To change the name, select the three dots {% icon "mdi:dots-vertical" %} menu, and select **Rename**.
![Screenshot of the entities list, filtered for workday](/images/getting-started/workday_three_dots.png)
2. You can also add another Workday {% term sensor %}. For example, if you want to know when your colleagues have a holiday.
- Select **Add entry**, give it a name and define your options.
- Select the country of interest.
3. That's it! {% icon "mdi:party-popper" %}
- {% icon "mdi:checkbox-outline" %} You have gained an overview of the integrations page and know where to find the integration details page, the sensor info page, and the entities table.
- {% icon "mdi:checkbox-outline" %} You have learned to rename, modify, and delete an integration.
- If you want to find more integrations, checkout the [integration documentation](/integrations/workday/).
- We are now ready to use **Workday** in an automation.
{% include getting-started/next_step.html step="Automate Home Assistant" link="/getting-started/automation/" %}

Binary file not shown.

Before

Width:  |  Height:  |  Size: 60 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 120 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 64 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 61 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 59 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 169 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 158 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 86 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 60 KiB