2024.12.3
Home ▸ Integrations ▸

myUplink

The myUplink integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] lets you get information about and control heat-pump devices supporting myUplink using the official cloud API.

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.

Note

You may need a valid subscription with myUplink to control your equipment with switch, select, and number entities.

Prerequisites

  1. Visit https://myuplink.com/register and sign up for a user account.
  2. Go to Applications, and register a new App:
  • Application Name: Home Assistant (or whatever name makes sense to you)
  • Description: A brief description of how you’ll use this application (e.g., “Home Assistant integration for controlling my heat pump”)
  • Callback URL: https://my.home-assistant.io/redirect/oauth
I have manually disabled My Home Assistant

If you don’t have My Home Assistant on your installation, you can use <HOME_ASSISTANT_URL>/auth/external/callback as the redirect URI instead.

The <HOME_ASSISTANT_URL> must be the same as used during the configuration/ authentication process.

Internal examples: http://192.168.0.2:8123/auth/external/callback, http://homeassistant.local:8123/auth/external/callback.”

Configuration

To add the myUplink integration to your Home Assistant instance, use this My button:

Manual configuration steps

If the above My button doesn’t work, you can also perform the following steps manually:

  • Browse to your Home Assistant instance.

  • Go to Settings > Devices & Services.

  • In the bottom right corner, select the Add Integration button.

  • From the list, select myUplink.

  • Follow the instructions on screen to complete the setup.

The integration configuration will require the Client ID and Client Secret created above. See Application Credentials for more details.

Supported heat-pump systems

The integration supports all heat-pump devices that can be connected to the myUplink cloud service. See Works with myUplink. However, the representation in Home Assistant depends on how and to what extent the manufacturer has implemented the service.

Use cases / Examples

Common use cases include:

  • System Monitoring: Display the current operation state of the pump (heating house, pool, or hot water)
  • Smart Notifications: Get alerts when the water temperature is low in the heater tank
  • Automation: Adjust the temperature curve offset during holiday mode
  • Analytics: View long-term statistics and graphs for the relevant sensors

Data updates

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.

Known limitations

  • 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.
  • 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)”.

Troubleshooting

Can't log in to myUplink API
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.

Removing the integration

After removing the integration, go to the myUplink developer site and remove the credentials unless you will use them again.

To remove an integration instance from Home Assistant

  1. Go to Settings > Devices & services and select the integration card.
  2. From the list of devices, select the integration instance you want to remove.
  3. Next to the entry, select the three-dot menu. Then, select Delete.

Related links