jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 15:26:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

supla.markdown: Copyediting and updates (#29263)

Browse Source
This commit is contained in:
Sam Reed 2023-10-10 20:03:10 +01:00 committed by GitHub
parent b9637d1185
commit 0a1cb3be0b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
source/_integrations/supla.markdown
View File

@ -1,6 +1,6 @@
--- ---
title: Supla title: SUPLA
description: Instructions for integration with Supla Cloud's Web API description: Instructions for integration with SUPLA-CLOUD's Web API
ha_release: 0.92 ha_release: 0.92
ha_category: ha_category:
- Cover - Cover
@ -15,22 +15,25 @@ ha_platforms:
ha_integration_type: integration ha_integration_type: integration
--- ---
The [Supla](https://supla.org/) is an Open Source home automation system for ESP8266 based devices. It has its own set of protocols, its own firmware and commercially available devices (produced for example by [Zamel](https://zamel.pl/pl-PL/produkty/supla-sterowanie-wi-fi)). The SUPLA integration allows you to use [SUPLA](https://supla.org/) devices in Home Assistant.
Currently only covers (shutters in Supla's lingo), gates, garage doors and switches are supported, but, thanks to comprehensive and universal REST API, it's pretty easy to add more. 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](https://supla.zamel.com/en/).
Right now it's impossible to add a device -- all of them are discovered from Supla Cloud's servers or yours. 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.
Devices disabled on Supla Cloud will not be loaded into Home Assistant.
Right now, it's impossible to add a device -- all of them are discovered from SUPLA-CLOUD's servers or yours.
Devices disabled on SUPLA-CLOUD will not be loaded into Home Assistant.
## Configuration ## Configuration
To use Supla devices in your installation, add the following to your `configuration.yaml`: To use SUPLA devices in your installation, add the following to your `configuration.yaml`:
```yaml ```yaml
supla: supla:
servers: servers:
- server: svr1.supla.org - server: "svr1.supla.org"
access_token: YOUR_ACCESS_TOKEN access_token: "YOUR_ACCESS_TOKEN"
``` ```
{% configuration %} {% configuration %}
@ -40,11 +43,11 @@ servers:
type: list type: list
keys: keys:
server: server:
description: Address of your Supla Cloud server (either IP or DNS name). description: Address of the SUPLA-CLOUD server (either IP address or DNS name); can either be the (cloud hosted)[https://cloud.supla.org] instance, or a (self hosted)[https://github.com/SUPLA/supla-cloud] instance.
required: true required: true
type: string type: string
access_token: access_token:
description: An access token for REST API configuration. Under **Scopes** > **Channels**, at least **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](https://cloud.supla.org/security/personal-access-tokens) page or your server instance. description: 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](https://cloud.supla.org/security/personal-access-tokens) page, or from your own self hosted instance.
required: true required: true
type: string type: string
{% endconfiguration %} {% endconfiguration %}