Skip to content

Docs for TIS Control integration #37071

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 27 commits into
base: next
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
8372f2d
add documentation for TIS control integration
KarimTIS Jan 18, 2025
2df962d
Update CIFS Authentication Documentation (#36767)
HartD92 Jan 22, 2025
3a86125
aquacell.markdown: Expand documentation (#37044)
reedy Jan 22, 2025
86f1968
Add Landis+Gyr E360 to known working meters, with additional elaborat…
NanoBob Jan 22, 2025
57287d9
Fix website builds (#37057)
frenck Jan 22, 2025
81f160d
Fix Acaia headers (#37058)
joostlek Jan 22, 2025
4b8ad45
Add debugging steps for nest integration. (#37050)
mijoharas Jan 23, 2025
aa8494b
build(deps-dev): bump sorbet-runtime from 0.5.11766 to 0.5.11778 (#37…
dependabot[bot] Jan 23, 2025
1a3f3b2
build(deps-dev): bump rubocop from 1.70.0 to 1.71.0 (#37068)
dependabot[bot] Jan 23, 2025
378391e
Update weather.markdown (#37066)
SpencerDub Jan 23, 2025
7bd4ed0
Update squeezebox.markdown Clarification of LMS server usage (#37030)
pssc Jan 23, 2025
734875d
Merge branch 'home-assistant:current' into current
KarimTIS Jan 23, 2025
c026e13
Add note to P1 Monitor integration (#37072)
klaasnicolaas Jan 23, 2025
2377f05
Update seventeentrack.markdown (#37077)
nstallons Jan 24, 2025
f60e27c
2025.1.4 (#37084)
frenck Jan 24, 2025
26c530f
Update manual setup to reflect current Google Developer Console (#37085)
c0ffeeca7 Jan 24, 2025
933f7cc
Fix typo in Roomba front matter (#37089)
joostlek Jan 24, 2025
2531e40
Update TP-Link integration troubleshooting section (#37091)
sdb9696 Jan 25, 2025
0940d5b
Fix HomeLink casing in existing integrations (#37100)
ryanjones-gentex Jan 26, 2025
cf6d90a
build(deps-dev): bump sorbet-runtime from 0.5.11778 to 0.5.11781 (#37…
dependabot[bot] Jan 27, 2025
59423af
build(deps): bump actions/setup-node from 4.1.0 to 4.2.0 (#37136)
dependabot[bot] Jan 27, 2025
6e29ef5
Add removal docs to Onkyo (#37131)
arturpragacz Jan 27, 2025
98d1d83
Improvements to incomfort documentation (#37101)
jbouwh Jan 27, 2025
cb2cb6c
Add note about dense section placement (#37133)
schoenwaldnils Jan 27, 2025
f942b82
Rework actions section to use-cases and examples for Plugwise (#36518)
CoMPaTech Jan 27, 2025
5dffba3
update docs
KarimTIS Jan 27, 2025
6de8c0b
Merge branch 'current' into current
KarimTIS Jan 27, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
- name: Check out files from GitHub
uses: actions/[email protected]
- name: Setting up Node.js
uses: actions/setup-node@v4.1.0
uses: actions/setup-node@v4.2.0
with:
node-version: 20
cache: "npm"
Expand All @@ -27,7 +27,7 @@ jobs:
- name: Check out files from GitHub
uses: actions/[email protected]
- name: Setting up Node.js
uses: actions/setup-node@v4.1.0
uses: actions/setup-node@v4.2.0
with:
node-version: 20
cache: "npm"
Expand Down
2 changes: 1 addition & 1 deletion Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ group :development do
# > 2.1.0 causes slowdowns https://github.com/sass/sassc-ruby/issues/189
gem 'sassc', '2.1.0'
gem 'sass-embedded', '1.83.4'
gem 'rubocop', '1.70.0'
gem 'rubocop', '1.71.0'
gem 'ruby-lsp', '0.23.6'
gem 'rackup', '2.2.1'
end
Expand Down
6 changes: 3 additions & 3 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ GEM
regexp_parser (2.10.0)
rexml (3.4.0)
rouge (4.5.1)
rubocop (1.70.0)
rubocop (1.71.0)
json (~> 2.3)
language_server-protocol (>= 3.17.0)
parallel (~> 1.10)
Expand Down Expand Up @@ -152,7 +152,7 @@ GEM
rack-protection (= 4.1.1)
rack-session (>= 2.0.0, < 3)
tilt (~> 2.0)
sorbet-runtime (0.5.11766)
sorbet-runtime (0.5.11781)
stringex (2.8.6)
terminal-table (3.0.2)
unicode-display_width (>= 1.1.1, < 3)
Expand All @@ -178,7 +178,7 @@ DEPENDENCIES
nokogiri (= 1.18.2)
rackup (= 2.2.1)
rake (= 13.2.1)
rubocop (= 1.70.0)
rubocop (= 1.71.0)
ruby-lsp (= 0.23.6)
sass-embedded (= 1.83.4)
sass-globbing (= 1.1.5)
Expand Down
4 changes: 2 additions & 2 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -108,8 +108,8 @@ social:
# Home Assistant release details
current_major_version: 2025
current_minor_version: 1
current_patch_version: 3
date_released: 2025-01-20
current_patch_version: 4
date_released: 2025-01-24

# Either # or the anchor link to latest release notes in the blog post.
# Must be prefixed with a # and have double quotes around it.
Expand Down
1 change: 1 addition & 0 deletions source/_dashboards/sections.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ You can group cards without using horizontal or vertical stack cards.
3. Under **Max number of sections wide**, select the maximum number of columns you want to see in the new sections view.
4. Under **Dense section placement**, select if you want to allow the cards to be arranged automatically in order to fill gaps between cards.
- This will remove some gaps, but it also means you have less control over the order of the cards.
- Note that this only applies to horizontal gaps if you used sections more than one column wide.
5. When you are done, select **Save**.
- You are now presented with a new, empty view.
- If you chose a background image, the page is filled with that image.
Expand Down
2 changes: 1 addition & 1 deletion source/_includes/common-tasks/network_storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Server:
"[NFS]<sup>1</sup> Remote share path":
description: The path used to connect to the remote storage server.
"[CIFS]<sup>2</sup> Username":
description: The username to use when connecting to the storage server.
description: "The username to use when connecting to the storage server. Use User Principal Name for domain accounts. For example: `[email protected]`."
"[CIFS]<sup>2</sup> Password":
description: The password to use when connecting to the storage server.
"[CIFS]<sup>2</sup> Share":
Expand Down
8 changes: 4 additions & 4 deletions source/_integrations/acaia.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -34,19 +34,19 @@ Device:
description: "The Bluetooth device that is your scale."
{% endconfiguration_basic %}

# Available platforms & entities
## Available platforms & entities

## Binary sensors
### Binary sensors

- **Timer running**: Whether the timer is currently running on the scale

## Buttons
### Buttons

- **Tare**: Tares the scale.
- **Reset timer**: Resets the timer. If the timer is running, it will continue to run.
- **Start/stop timer**: Starts or stops the timer, depending on whether the timer is currently running. Does not reset, but continue the timer.

## Sensors
### Sensors

- **Battery**: Current battery level of the scale.
- **Volume flow rate**: Calculates the current flow rate (in mL/s) while brewing.
Expand Down
8 changes: 5 additions & 3 deletions source/_integrations/aquacell.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,19 @@ ha_platforms:
ha_integration_type: device
---

AquaCell is a water-softening device. The [AquaCell](https://www.aquacell-waterontharder.nl/) {% term integration %} allows you to monitor your AquaCell device in Home Assistant.
AquaCell is a water-softening device made by [Culligan](https://culliganinternational.com). The [AquaCell](https://www.aquacell-waterontharder.nl/) {% term integration %} allows you to monitor your AquaCell device in Home Assistant.
You will need your Aquacell account information as used in the **AquaCell** app.

This integration also supports [Harvey](https://www.harveywatersofteners.co.uk/) softeners.
This integration also supports other [Culligan brands](https://culliganinternational.com/brands) of water softener, such as [Harvey](https://www.harveywatersofteners.co.uk/) and [TwinTec](https://www.twintec.com/) (made by Harvey) softeners.

## Supported devices

This integration only works for softener models which have an **i-Lid** and are configured through the 'Mijn AquaCell' or 'My Harvey' mobile app.
This integration only works for softener models which have an **i-Lid** and are configured through the 'Mijn AquaCell' or 'myHarvey' mobile app.
These models are also recognizable by the required curved salt blocks.

- [AquaCell](https://www.aquacell-waterontharder.nl/aquacell)
- [HarveyArc Water Softener](https://www.harveywatersofteners.co.uk/products/water-softeners/harveyarc-water-softener)
- [TwinTec Cobalt](https://www.twintec.com/our-products/tt-cobalt/)

## Prerequisites

Expand Down
5 changes: 4 additions & 1 deletion source/_integrations/dsmr.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@ This integration is known to work for:

- Iskra ME382 / MT382 (DSMR 2.2)
- ISKRA AM550 (DSMR 5.0)
- Landis+Gyr E350 (DMSR 4)
- Landis+Gyr E350 (DSMR 4)
- Landis+Gyr E360 (DSMR 5)*
- Landis+Gyr ZCF110 / ZM F110 (DSMR 4.2)
- Kaifa E0026
- Kaifa MA304C (DSMR 4.2)
Expand All @@ -64,6 +65,8 @@ This integration is known to work for:
- Ziv E0058 ESMR5
- EasyMeter Q3D

Remarks:
\* The E360 requires a special P1 cable, various webstores sell these specific to the E360.
### M-Bus support

A smart meter can have multiple subdevices, also known as [M-Bus](https://m-bus.com/) devices.
Expand Down
99 changes: 48 additions & 51 deletions source/_integrations/google_assistant.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -29,65 +29,62 @@ For Home Assistant Cloud users, documentation can be found [here](https://www.na

The Google Assistant integration (without Home Assistant Cloud) requires a bit more setup than most due to the way Google requires Assistant Apps to be set up.

{% important %}
To use Google Assistant, your Home Assistant configuration has to be [externally accessible with a hostname and SSL certificate](/docs/configuration/remote/). If you haven't already configured that, you should do so before continuing. If you make DNS changes to accomplish this, please ensure you have allowed up to the full 48 hours for DNS changes to propagate, otherwise, Google may not be able to reach your server. Once you have confirmed you can reach your Home Assistant from outside your home network, you can set up the Google integration:
{% endimportant %}
### Prerequisites

To use Google Assistant, your Home Assistant configuration has to be [externally accessible with a hostname and SSL certificate](/docs/configuration/remote/).

- If you haven't already configured that, you should do so before continuing.
- If you make DNS changes to accomplish this, ensure you have allowed up to the full 48 hours for DNS changes to propagate, otherwise, Google may not be able to reach your server.
- Once you have confirmed you can reach your Home Assistant from outside your home network, you can set up the Google integration:

### Google Cloud Platform configuration

1. Create a new project in the [Actions on Google console](https://console.actions.google.com/).
1. Select **New Project** and give your project a name.
2. Select the **Smart Home** card, then select the **Start Building** button.
3. Under **Quick Setup**, select **Name your Smart Home action**. Give your Action a name - Home Assistant will appear in the Google Home app as `[test] <Action Name>`
4. Select the **Overview** tab at the top of the page to go back.
5. Select **Build your Action**, then select **Add Action(s)**.
6. Add your Home Assistant URL: `https://[YOUR HOME ASSISTANT URL:PORT]/api/google_assistant` in the **Fulfillment URL** textbox, replace the `[YOUR HOME ASSISTANT URL:PORT]` with the domain / IP address and the port under which your Home Assistant is reachable.
7. Select **Save**.
8. Select the three little dots (more) icon in the upper right corner, select **Project settings**.
9. Make note of the **Project ID** that are listed on the **General** tab of the **Settings** page.
2. **Account linking** is required for your app to interact with Home Assistant.
1. Start by going back to the **Overview** tab.
2. Select on **Setup account linking** under the **Quick Setup** section of the **Overview** page.
3. If asked, leave options as they default **No, I only want to allow account creation on my website** and select **Next**.
4. Then if asked, for the **Linking type** select **OAuth** and **Authorization Code**. Select **Next**.
5. Enter the following:
1. Client ID: `https://oauth-redirect.googleusercontent.com/r/[YOUR_PROJECT_ID]`. (Replace `[YOUR_PROJECT_ID]` with your project ID from above)
2. Client Secret: Anything you like, Home Assistant doesn't need this field.
3. Authorization URL: `https://[YOUR HOME ASSISTANT URL:PORT]/auth/authorize`. (Replace `[YOUR HOME ASSISTANT URL:PORT]` with your values.)
4. Token URL (replace with your actual URL): `https://[YOUR HOME ASSISTANT URL:PORT]/auth/token`. (Replace `[YOUR HOME ASSISTANT URL:PORT]` with your values.)
Select **Next**, then **Next** again.
6. In the **Configure your client** **Scopes** textbox, type `email` and select **Add scope**, then type `name` and select **Add scope** again.
7. Do **NOT** check **Google to transmit clientID and secret via HTTP basic auth header**.
8. Select **Next**, then select **Save**.

<img src='/images/integrations/google_assistant/accountlinking.png' alt='Screenshot: Account linking'>

3. Select the **Develop** tab at the top of the page, then, in the upper right hand corner, select the **Test** button to generate the draft version Test App. If you don't see this option, go to the **Test** tab instead, select the **Settings** button in the top right below the header, and ensure **On device testing** is enabled (if it isn't, enable it).

4. Enable device sync ([see below for more information](#enable-device-sync)).
1. Go to [Google Cloud Platform](https://console.cloud.google.com/).
2. Go to **Select a project**.
3. In the window that popped up, select your newly created project from step 1.
4. Go to the menu and select **APIs and Services** and next **Credentials**.
5. In the **Credentials** view, select **Create credentials** and next **Service account**.
1. Create a new project in the [Google Developer Console](https://console.home.google.com/projects).
1. Select **Create a Project**
2. On the **Get started** page, select **Create project**.
- Give your project a name and select **Create project**.
3. Save your Project ID (it's under the main project name) for use below.
4. Select **Add a Cloud-to-Cloud integration**.
5. In the bottom right corner, select **Next: Develop**, then select **Next: Setup**.
6. Select all applicable device types (you can select them all).
7. Create an app icon 144 x 144 pixels and upload it.
8. Under **Account Linking**, in the **OAuth Client ID** field, enter `https://oauth-redirect.googleusercontent.com/r/[YOUR_PROJECT_ID]`.
9. Replace `[YOUR_PROJECT_ID]` with your project ID from above.
10. Fill in the details:
- In the **Client Secret** field, add any string (without special characters).Home Assistant doesn't need this field.
- In the **Authorization URL** field, enter `https://[yourdomain:port]/auth/authorize`.
- In the **Token URL** field, enter `https://[yourdomain:port]/auth/token`.
- In the **Cloud fulfillment URL** field, enter `https://[yourdomain:port]/api/google_assistant`.
- For now, skip **Local fulfillment** and **App Flip**.
- Under **Scope(s)**, enter `email`. Select **Add scope** and enter `name`.
- Leave the checkbox **Have Google transmit Client ID and secret via HTTP basic auth header** unchecked/cleared.
- Select **Save**.
- **Result**: You will see your project saved with the status **Draft**.
- You do not need to test.

2. In the left hand menu of your project, select the **Analytics** link.
- Select the hamburger {% icon "mdi:hamburger-menu" %} menu and select **APIs and Services**.
3. Enable device sync ([see below for more information](#enable-device-sync)).
1. In the left hand menu, select **Credentials**.
2. In the **Credentials** view, select **Create credentials** and next **Service account**.
1. **Service account name**: Give your account a self-selected name.
2. Select **Create and Continue**.
3. Under **Select a role**, select **Service Accounts** > **Service Account Token Creator**.
4. Select **Continue** and then **Done**.
6. Under **Service Accounts**, there should now be an account called [name from 5.1]@[projectname].iam.gserviceaccount.com.
7. Select the pencil button of that service account.
8. Go to **Keys** and **Add key**.
9. Create a private key in JSON format.
10. This will start a download of a JSON file.
3. Under **Service Accounts**, there should now be an account called [name from 3.2.1]@[projectname].iam.gserviceaccount.com.
4. Select the pencil button of that service account.
5. Go to **Keys** and **Add key**.
6. Create a private key in JSON format.
7. This will start a download of a JSON file.
1. Rename the file to `SERVICE_ACCOUNT.JSON`.
2. Add this file to your config-folder. This will be the same folder as your{% term "`configuration.yaml`" %}.
11. Go back to [Google Cloud Platform](https://console.cloud.google.com/) and select **Close**.
12. Then select **Save**.
13. Go to the **Search products and resources** and search for **Homegraph API** and select it.
14. Enable the HomeGraph API.

5. Add the `google_assistant` integration configuration to your{% term "`configuration.yaml`" %} file and restart Home Assistant following the [configuration guide](#yaml-configuration) below.
6. Add services in the Google Home App (note that app versions may be slightly different).
2. In Home Assistant, add this file to your config-folder. This will be the same folder as your {% term "`configuration.yaml`" %}.
8. Go back to [Google Cloud Platform](https://console.cloud.google.com/) and select **Close**.
9. Then select **Save**.
10. Go to the **Search products and resources** and search for **Homegraph API** and select it.
11. Enable the HomeGraph API.

4. Add the `google_assistant` integration configuration to your {% term "`configuration.yaml`" %} file and restart Home Assistant following the [configuration guide](#yaml-configuration) below.
5. Add services in the Google Home App (note that app versions may be slightly different).
1. Open the Google Home app.
2. Select the `+` button on the top left corner, select **Set up device**. In the **Set up a device** screen, select **Works with Google**. You should have `[test] <Action Name>` listed under **Add new**. Selecting that should lead you to a browser to login your Home Assistant instance, then redirect back to a screen where you can set rooms and nicknames for your devices if you wish.

Expand Down
27 changes: 24 additions & 3 deletions source/_integrations/incomfort.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,10 @@ ha_integration_type: integration
ha_config_flow: true
---

The `incomfort` {% term integration %} links Home Assistant with your Intergas Lan2RF gateway, including the boiler and any room thermostats attached to it.
The integration uses the [incomfort](https://pypi.org/project/incomfort-client/) client library.
This integration links Home Assistant with your Intergas Lan2RF gateway, including the boiler and any room thermostats attached to it.
The integration uses the [incomfort-client](https://pypi.org/project/incomfort-client/) library.

### Supported devices

The Intergas Lan2RF Gateway connects thermostats based on the OpenTherm standard. An example of such a thermostat is the [Comfort Touch Thermostat](https://www.intergas-verwarming.nl/en/consumer/products/comfort-touch-thermostat/). The thermostats and LAN2RF gateway are often sold as a set. The gateway is suitable for use with Intergas Kombi Kompakt HRE and HReco appliances from year of manufacture 2014. If the Comfort Touch thermostat is used together with the gateway, then this will work in combination with Intergas Kombi Kompakt HRE, HReco, or Xtreme devices from year of manufacture 2017.

Expand All @@ -39,11 +41,30 @@ Any room thermostats (there can be 0, 1 or 2) are represented as **Climate** dev

{% include integrations/config_flow.md %}

{% configuration_basic %}
host:
description: "Hostname or IP-address of the Intergas InComfort Lan2RF Gateway."
required: true
type: string
username:
description: "The username to log into the gateway. This is `admin` in most cases."
required: false
type: string
password:
description: "The password to log into the gateway, is printed at the bottom of the Lan2RF Gateway or is `intergas` for some older devices."
required: false
type: string
{% endconfiguration_basic %}

The hub does not have to be in the same network as HA, but must be reachable via port 80/HTTP.

## Troubleshooting

In case setting up an older gateway type fails, then try to leave `username` and `password` fields empty.

## Data updates

The `incomfort` {% term integration %} will fetch state data from the gateway every 30 seconds. When the target temperature on the thermostat is changed, it might take some time for the set point to be updated on the Home Assistant climate {% term entity %}.
The Intergas Lan2RF Gateway will fetch state data from the gateway every 30 seconds. When the target temperature on the thermostat is changed, it might take some time for the set point to be updated on the Home Assistant climate {% term entity %}.

## Remove integration

Expand Down
6 changes: 6 additions & 0 deletions source/_integrations/nest.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -625,3 +625,9 @@ logger:
```

- *Not receiving camera motion and person events*: assuming the integration is correctly configured (for example, the oauth and SDM API are set up correctly, you can see camera streams, and permissions are correctly set in [Partner Connections Manager](https://nestservices.google.com/partnerconnections)): If you are then still not seeing events, it's possible you need to adjust the Google Home App settings. Refer to the [Google Home App Notification Settings](#google-home-app-notification-settings) for details.

- **Configuration error: Failed to create subscriber `subscription/name` was not found** - By default, Google pub/sub subscriptions will be deleted after 31 days of inactivity ([reference](https://cloud.google.com/knowledge/kb/pub-sub-subscriptions-disappeared-without-any-deletion-logs-000004170)). If this happens, then the integration will fail, and you will see the preceding log line in your Home Assistant logs. If that is the case, then:

1. Go to the [Device Access Console](https://console.nest.google.com/device-access/project-list) and re-enable the Pub/Sub Topic.
2. The Nest integration may need to be recreated to pick up the new Pub/Sub topic.
3. (Optional) To prevent future expirations, go to your [Google Cloud Console Pub/Sub subscription page](https://console.cloud.google.com/cloudpubsub/subscription/list) and edit the Pub/Sub subscription created by Nest to not expire by default.
6 changes: 6 additions & 0 deletions source/_integrations/onkyo.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -102,3 +102,9 @@ script:
## Supported devices

Network receivers from Onkyo and Integra are supported starting with models from the year 2011. Pioneer network receivers are supported starting with models from 2016.

## Removing the integration

This integration follows standard integration removal. No extra steps are required.

{% include integrations/remove_device_service.md %}
Loading