2024.11.0
Home ▸ Integrations ▸

SUPLA

The SUPLA integration allows you to use SUPLA devices in Home Assistant.

SUPLA-DEV is an open source home automation system for Raspberry Pi, Arduino or ESP8266-based devices. It has its own protocols, firmware and commercially available devices, such as those produced by Zamel.

Currently, only covers (shutters in SUPLA’s terminology), gates, garage doors, and switches are supported, but thanks to comprehensive and universal REST API, it’s pretty easy to add more.

Right now, it’s impossible to add a device – all of them are discovered from SUPLA-CLOUD’s servers or yours.

For more complete Home Assistant support based on MQTT autodiscovery, consider switching your Supla devices to MQTT (through the setup interface). Or use the MQTT broker provided by Supla Cloud.

Configuration

To use SUPLA devices in your installation, add the following to your configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more]:

supla:
  servers:
    - server: "svr1.supla.org"
      access_token: "YOUR_ACCESS_TOKEN"

Configuration Variables

Looking for your configuration file?
servers list

List of server configurations.

server string Required

Address of the SUPLA-CLOUD server (either IP address or DNS name); can either be the cloud hosted instance, or a self hosted instance.

access_token string Required

An access token for REST API configuration. Under Scopes > Channels, at least the Read and Action execution permissions are required to be enabled. A token can be obtained from the Security section of SUPLA-CLOUD for Personal Access Token page, or from your own self hosted instance.