Integrujte a tvorte so SUPLA

Prepojte SUPLA s Home Assistant, používajte MQTT a REST API, spustite vlastný server alebo vytvárajte vlastné zariadenia.

SUPLA je otvorená platforma. Môžete využívať hotové integračné mechanizmy, vytvárať vlastné riešenia a podieľať sa na vývoji projektu.

Zobraziť na GitHube Diskusné fórum

Čo chcete robiť?

Vyberte oblasť, v ktorej chcete začať.

Home Assistant a MQTT

Prepojte SUPLA s Home Assistant prostredníctvom MQTT. MQTT Discovery dokáže automaticky rozpoznať väčšinu podporovaných funkcií zariadení.

Preskúmať integráciu

Vytvoriť vlastné zariadenie

Vytvárajte vlastné zariadenia inteligentnej domácnosti pomocou SDK supla-device.

Začať tvoriť zariadenie

REST API

Vytvárajte aplikácie, automatizácie a prepojenia s ďalšími systémami pomocou REST API, OAuth 2.0 a MQTT.

Preskúmať API

Spustiť vlastný server SUPLA

Spustite vlastnú inštanciu SUPLA a spravujte infraštruktúru vo svojom prostredí.

Preskúmať self-hosting

Integrujte SUPLA s ďalšími systémami

SUPLA ponúka MQTT a REST API na prepojenie zariadení a údajov s ďalšími automatizačnými systémami, aplikáciami a vlastnými službami.

Home Assistant cez MQTT

SUPLA odporúča MQTT ako hlavný spôsob integrácie s Home Assistant.

SUPLA podporuje dva scenáre MQTT: MQTT pre celý účet poskytované serverom SUPLA a priame lokálne MQTT dostupné v podporovaných zariadeniach.

MQTT pre celý účet sprístupňuje prostredníctvom servera SUPLA zariadenia a kanály z vášho účtu SUPLA a podporuje MQTT Discovery.

Niektoré zariadenia SUPLA sa môžu na lokálnu komunikáciu pripojiť aj priamo k vášmu vlastnému MQTT brokeru.

MQTT pre celý účet SUPLA
MQTT Discovery
Home Assistant
lokálne MQTT v podporovaných zariadeniach

Viac o Home Assistant a MQTT vo FAQ

Vytvárajte vlastné zariadenia so supla-device

supla-device je otvorené SDK na tvorbu zariadení spolupracujúcich s ekosystémom SUPLA.

Využite hotové komponenty, príklady a komunikačné mechanizmy namiesto vytvárania integrácie so SUPLA od začiatku.

ESP32ESP8266ArduinoLinux

Knižnica obsahuje hotové komponenty pre relé, tlačidlá, snímače a ďalšie bežné funkcie zariadení inteligentnej domácnosti.

Zobraziť supla-device na GitHube

Príklad: logika jednoduchého prepínača Wi-Fi

Nasledujúci úryvok ukazuje logiku relé a tlačidla. Úplný príklad obsahuje aj konfiguráciu Wi-Fi a siete.

#include <SuplaDevice.h>
#include <supla/control/button.h>
#include <supla/control/relay.h>

void setup() {
    auto relay = new Supla::Control::Relay(12);
    relay->setDefaultFunction(SUPLA_CHANNELFNC_POWERSWITCH);

    auto button = new Supla::Control::Button(0, true, true);
    button->addAction(Supla::TOGGLE, relay, Supla::ON_CLICK_1);

    SuplaDevice.begin();
}

void loop() {
    SuplaDevice.iterate();
}

Zobraziť úplný príklad s konfiguráciou Wi-Fi

REST API

REST API a OAuth

Pomocou REST API môžete čítať stavy zariadení a kanálov, ovládať podporované funkcie, získavať merania a vytvárať aplikácie alebo integrácie využívajúce váš účet SUPLA.

Prístup možno autorizovať pomocou OAuth 2.0 a dokumentácia API je k dispozícii vo formáte OpenAPI.

REST API
OAuth 2.0
OpenAPI
vlastné aplikácie a automatizácie

Zobraziť dokumentáciu API

Spustite vlastný server SUPLA

Chcete infraštruktúru spravovať sami? Môžete spustiť vlastnú inštanciu SUPLA vo svojom prostredí.

Odporúčaným základom na self-hosting je projekt supla-docker, ktorý umožňuje spustiť potrebné komponenty pomocou Docker Compose. Vlastný server vám poskytne väčšiu kontrolu nad infraštruktúrou a údajmi, ale znamená aj prevzatie zodpovednosti za jeho údržbu.

Docker Compose
vlastná infraštruktúra a doména
aktualizácie a monitoring
certifikáty TLS
zálohovanie a obnova
zabezpečenie servera

Nepredpokladajte, že všetky externé služby budú na súkromnej inštancii fungovať úplne rovnako ako v oficiálnom cloude. Niektoré funkcie môžu vyžadovať ďalšie kľúče, certifikáty alebo konfiguráciu.

supla-docker na GitHube

SUPLA je open source

Zdrojový kód hlavných komponentov platformy je verejne dostupný. Môžete ho prezerať, spúšťať, upravovať a prispievať doň v súlade s licenciami jednotlivých projektov.

Hlavné repozitáre

supla-device

SDK na tvorbu zariadení IoT a inteligentnej domácnosti (Arduino, ESP32, ESP8266, Linux)

C++

supla-cloud

Webová aplikácia na správu (PHP, Symfony)

PHP, JavaScript, Vue.js, Symfony

supla-core

Hlavný komunikačný server (C++)

C++

supla-docker

Odporúčané riešenie na self-hosting (Docker)

Docker

supla-android

Natívna aplikácia pre Android

Java/Kotlin

supla-ios

Natívna aplikácia pre iOS

Swift, Objective-C

Zobraziť všetky projekty na GitHube

Použité technológie

Hlavné technológie používané v projektoch SUPLA

Firmware

C/C++

Hlavný programovací jazyk

Arduino IDE, PlatformIO, Visual Studio Code

Vývojové prostredia

ESP-IDF

Natívny framework pre ESP32

Server

C++

Hlavný jazyk komunikačného servera (supla-core)

PHP/Symfony, JavaScript/Vue.js

Webová aplikácia (supla-cloud)

MySQL/MariaDB

Hlavná databáza

TimescaleDB

Databáza na ukladanie historických údajov

Docker

Kontajnerizácia

Klientske aplikácie

Java, Kotlin

Aplikácia pre Android

Objective-C, Swift

Aplikácia pre iOS

C++

Klientske knižnice

Podieľajte sa na vývoji SUPLA

SUPLA sa vyvíja ako open-source projekt. Môžete hlásiť chyby, navrhovať zmeny, odosielať pull requesty alebo vyvíjať vlastné projekty využívajúce SUPLA. Na fóre sa stretávajú používatelia, vývojári, domáci majstri a ľudia vytvárajúci vlastné zariadenia a integrácie.

SUPLA na GitHube Navštíviť fórum