Skip to content

Commit dcf3f16

Browse files
astrandbklaasnicolaasc0ffeeca7
authored
Rewrite myuplink docs for new quality scale (#36017)
* Rewrite myuplink for new quality scale * Apply review comments * Update source/_integrations/myuplink.markdown Co-authored-by: Klaas Schoute <klaas_schoute@hotmail.com> * Corrected data update interval * Delete Gemfile.lock * Revert "Delete Gemfile.lock" This reverts commit 6e2b08d. * Revert "Corrected data update interval" This reverts commit 7f0199b. * Correct data update interval * tiny tweak --------- Co-authored-by: Klaas Schoute <klaas_schoute@hotmail.com> Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
1 parent e115796 commit dcf3f16

File tree

1 file changed

+30
-5
lines changed

1 file changed

+30
-5
lines changed

‎source/_integrations/myuplink.markdown

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,18 +26,22 @@ ha_platforms:
2626
ha_integration_type: integration
2727
---
2828

29-
The myUplink integration lets you get information about the devices supporting myUplink using the [official cloud API](https://dev.myuplink.com).
29+
The **myUplink** {% term integration %} lets you get information about and control heat-pump devices supporting myUplink using the [official cloud API](https://dev.myuplink.com).
3030

31-
Depending on the type of devices in your system, one or more entities are added to Home Assistant. Currently, there is support for reading sensor states. There is also support for switch, select and number entities if suitable data points are discovered in the system. Note that you may need a valid subscription with MyUplink to control your equipment with switch, select, and number entities.
31+
The integration will connect to your account and download all available data from the API. The downloaded information will be used to create devices and entities in Home Assistant. There can be from a few entities up to many hundreds depending on the type of equipment. The integration will make the best effort to map the data-points in the API to sensors, switches, number, and select entities.
32+
33+
{% note %}
34+
You may need a valid subscription with myUplink to control your equipment with switch, select, and number entities.
35+
{% endnote %}
3236

3337
## Prerequisites
3438

3539
1. Visit [https://myuplink.com/register](https://myuplink.com/register) and sign up for a user account.
3640
2. Go to [**Applications**](https://dev.myuplink.com/apps), and register a new App:
3741

38-
- **Application ID**: Home Assistant (or whatever name makes sense to you)
39-
- **OAuth Flow**: Authorization Code Grant Flow
40-
- **Redirect URI**: `https://my.home-assistant.io/redirect/oauth`
42+
- **Application Name**: Home Assistant (or whatever name makes sense to you)
43+
- **Description**: A brief description of how you'll use this application (e.g., "Home Assistant integration for controlling my heat pump")
44+
- **Callback URL**: `https://my.home-assistant.io/redirect/oauth`
4145

4246
{% details "I have manually disabled My Home Assistant" %}
4347

@@ -55,3 +59,24 @@ Internal examples: `http://192.168.0.2:8123/auth/external/callback`, `http://hom
5559
{% include integrations/config_flow.md %}
5660

5761
The integration configuration will require the **Client ID** and **Client Secret** created above. See [Application Credentials](/integrations/application_credentials) for more details.
62+
63+
## Data updates
64+
65+
The integration will poll the API for data every 60 seconds. This polling interval is designed to work within the rate limits of myUplink APIs while providing timely updates.
66+
67+
## Known limitations
68+
69+
- The integration makes the best effort to map data-points from the API to relevant entities in Home Assistant. However, some sensors may not appear for certain heat-pump models, or in other cases, numerous irrelevant entities might be created. Please create an issue on GitHub and include a diagnostic download file from your installation if you believe that the mapping can be improved.
70+
- Entity names are available in English and cannot be automatically translated by Home Assistant. The reason is that the names are defined by the API and can be changed by updates of the API or the firmware in the appliance. However, most entity names are self-explanatory, e.g., "Room temperature (BT50)".
71+
72+
## Troubleshooting
73+
74+
{% details "Can't log in to myUplink API" %}
75+
Make sure that you have entered the application credentials correctly. A common problem is that leading or trailing spaces are included in the entered credential strings. You may have to delete the application credentials from Home Assistant and install the integration again to get everything right.
76+
{% enddetails %}
77+
78+
## Removing the integration
79+
80+
After removing the integration, go to the myUplink [developer site](https://dev.myuplink.com/apps) and remove the credentials unless you will use them again.
81+
82+
{% include integrations/remove_device_service.md %}

0 commit comments

Comments
 (0)