Integracje ekey

Smart Home · KNX · HTTP(S) · API

Integracja czytnika linii papilarnych ekey pozwala wykorzystać rozpoznanie użytkownika nie tylko do otwarcia drzwi. Ten sam gest może uruchomić scenę powitalną, rozbroić alarm, włączyć oświetlenie, ustawić temperaturę, sterować roletami albo przekazać do systemu automatyki szczegółowe zdarzenie o tym, kto i którym palcem skorzystał z czytnika.

W ekosystemie ekey bionyx dostępnych jest kilka sposobów komunikacji. Różnią się ilością przekazywanych danych, wymaganym sprzętem i poziomem swobody po stronie integratora. Poniżej opisujemy je od najprostszego sygnału przewodowego po Notification API i rozwiązania dla KNX.

Jak to działa

Czytnik ekey jako element automatyki budynku

W klasycznej kontroli dostępu czytnik odpowiada na jedno pytanie: czy użytkownik ma prawo wejść? Po integracji z automatyką zdarzenie rozpoznania palca staje się również informacją wejściową dla Smart Home. System może zareagować inaczej na domownika, pracownika, serwisanta albo konkretny palec tej samej osoby.

01

Rozpoznanie użytkownika

ekey rozpoznaje zapisany palec i wykonuje przypisane reguły dostępu. W zależności od wybranej metody integracji do systemu zewnętrznego trafia prosty sygnał, wywołanie funkcji albo szczegółowe zdarzenie.

02

Różne palce, różne akcje

Funkcje HTTP(S) i function webhooks mogą być przypisywane do zapisanych palców. Dzięki temu np. palec wskazujący może otwierać drzwi i uruchamiać scenę „Powrót”, a inny wyłącznie sterować dodatkową funkcją.

03

Logika po stronie Smart Home

To centrala automatyki decyduje, co zrobić ze zdarzeniem: załączyć światło, rozbroić alarm, podnieść rolety, uruchomić muzykę, wysłać powiadomienie albo zapisać zdarzenie do historii.

04

Integracja lokalna

HTTP(S) Request i Notification API mogą komunikować się z usługą dostępną w sieci lokalnej. W praktyce pozwala to połączyć ekey z serwerem automatyki bez wysyłania każdego zdarzenia do zewnętrznej usługi.

Palecautoryzacja
ekey bionyxreguła / zdarzenie
Interfejsstyk · HTTP · API · APPMODULE
Smart Homescena / logika / alarm
Porównanie

Którą metodę integracji ekey wybrać?

Nie każda instalacja potrzebuje pełnego API. Jeżeli centrala ma tylko otrzymać informację o poprawnym dostępie, prosty sygnał jest wystarczający. Jeśli automatyka ma rozpoznawać użytkownika, palec i wynik próby, właściwym kierunkiem jest Notification API.

MetodaCo trafia do Smart HomeDodatkowy sprzętNajlepsze zastosowanie
Styk / wejście cyfrowepodstawowaSygnał poprawnej autoryzacjiNie, poza okablowaniem wejściaAlarm, PLC, prosta automatyka
HTTP(S) RequestelastycznaWywołanie jednej z przypisanych funkcjiNieLoxone, Grenton, urządzenia z API
APPMODULE IPgatewayFunkcje przez gotową warstwę integracyjnąTak, APPMODULE IPIntegracje IP / IoT, instalacje bez własnego middleware
APPMODULE KNXKNXFunkcje przekazywane do automatyki KNXTak, APPMODULE KNXDomy i obiekty oparte o magistralę KNX
Metody + wymagania

5 sposobów integracji ekey — co dokładnie jest potrzebne?

Najpierw pokazujemy pięć podstawowych dróg komunikacji ekey, a bezpośrednio pod nimi konkretne systemy i wymagane po ich stronie moduły, centrale, bramki lub licencje. Dzięki temu od razu widać nie tylko metodę integracji, ale również element potrzebny do jej wykonania.

01

Integracja podstawowa

Podstawowa
ekey xLine
Smart Home wejście cyfrowe

Sterownik ekey podaje do centrali Smart Home sygnał bezpotencjałowy informujący o poprawnej autoryzacji. Automatyka wie, że dostęp został przyznany, ale nie otrzymuje informacji o użytkowniku ani użytym palcu.

Informacje: poprawna autoryzacja Połączenie: przewodowe Poziom danych: podstawowy
Przykładowy system
Logo SATEL SATEL

Co zyskujesz?

Najprostszy i bardzo przewidywalny sposób połączenia. Centrala automatyki otrzymuje impuls na wejście i może uruchomić wcześniej przygotowaną logikę.

Ograniczenie

Po stronie Smart Home nie ma informacji, który użytkownik ani który palec został rozpoznany. Dla centrali jest to po prostu sygnał binarny.

Kiedy warto?

Gdy system nie obsługuje HTTP/API albo priorytetem jest prosta, przewodowa integracja z alarmem, PLC lub wejściem cyfrowym.

02

Integracja HTTP Request

HTTP(S)
ekey xLine
Smart Home wybrana funkcja

W ekey można skonfigurować do pięciu funkcji wysyłających żądania HTTP(S). Funkcję przypisuje się do konkretnego palca lub użytkownika, a po autoryzacji ekey wywołuje wskazany adres w sieci lokalnej, np. adres centrali Smart Home.

Informacje: wybrana funkcja 1–5 Połączenie: sieć lokalna Mechanizm: HTTP(S) Request
Przykładowe systemy
Logo LoxoneLoxone Logo GrentonGrenton Logo SomfySomfy Logo GERDA Logo tedee GERDA / tedee

Jak konfiguruje się request?

W aplikacji ekey bionyx można określić m.in. nazwę funkcji, metodę HTTP, adres URL, nagłówki, body, sposób uwierzytelnienia i urządzenie wykonujące request. Przed zapisem żądanie można przetestować.

Ważna cecha

To komunikacja jednokierunkowa: po dopasowaniu palca ekey wywołuje wskazany endpoint. ekey nie wykorzystuje odpowiedzi serwera do sterowania własną logiką.

Praktyczne przykłady

Wyzwolenie wejścia w Loxone, sceny w Smart Home, przekaźnika Shelly, funkcji DoorBird, zamka z własnym API albo dowolnego lokalnego webhooka.

Limit: dokumentacja ekey podaje maksymalnie 5 skonfigurowanych HTTP requestów/funkcji w systemie. Zwykły HTTP(S) Request przypisuje się do zapisanego palca.
03

Notification API

Najbardziej zaawansowana
ekey xLine zdarzenie autoryzacji
HTTP(S) POST
Fragment przykładu ekey /api/notification/finger
{
  "type": 10,
  "result": 10,
  "time": "2024-05-29T15:47:42Z",
  "params": {
    "userId": "tKlLpvUa",
    "fingerIndex": 2
  }
}
Smart Home pełne zdarzenie JSON
Home Assistant
Home Assistant możliwa integracja lokalna; dostępna jest również oficjalna integracja ekey bionyx

Notification API wysyła z kontrolera ekey do lokalnego serwera HTTP(S) szczegółowe zdarzenia w formacie JSON. Dla zdarzeń palca używany jest endpoint /api/notification/finger. Oprócz poprawnego rozpoznania API może raportować również wynik odrzucony lub filtrowany, np. przez harmonogram albo brak reguły.

Informacje: użytkownik, palec, wynik, czas UTC, czytnik i kontroler Metoda: HTTP(S) POST Format: JSON Endpoint: /api/notification/finger Sieć: lokalna
Największa ilość informacji To wariant pozwalający budować logikę zależną nie tylko od samej autoryzacji, lecz także od konkretnego użytkownika, palca, urządzenia i wyniku zdarzenia.

Co przychodzi w JSON?

Dokumentacja ekey opisuje m.in. czas UTC, typ zdarzenia, wynik, szczegół wyniku, ID kontrolera, ID czytnika, ID użytkownika oraz indeks palca.

Nie tylko poprawne wejście

Notification API może zgłosić poprawne rozpoznanie, dopasowanie zablokowane przez filtr lub harmonogram, brak reguły oraz nierozpoznany palec — o ile jakość odczytu pozwala zakwalifikować próbę.

Dwa endpointy

Zdarzenia czytnika trafiają na /api/notification/finger, a zdarzenia wejścia cyfrowego kontrolera na /api/notification/input. Strukturę POST definiuje ekey.

Mapowanie ID: ekey pozwala wyeksportować z aplikacji plik JSON zawierający aktualnych użytkowników i urządzenia wraz z ich nazwami i identyfikatorami.
04

Integracja przez APPMODULE IP

Natywna IP
ekey bionyx
APPMODULE IP BAB TECHNOLOGIE
IoT Smart Home IP / KNXnet/IP

Natywna integracja przez dodatkowy APPMODULE IP z aplikacją ekey bionyx connect. Moduł łączy system ekey z obsługiwanymi rozwiązaniami IP i IoT, a także udostępnia interfejs KNXnet/IP.

Informacje: funkcje integracji natywnej Interfejs: IP / KNXnet/IP Urządzenie: APPMODULE IP
Przykładowe systemy i rozwiązania
Logo DenonDenon Logo Philips HuePhilips Hue Logo ModbusModbus Logo Home ConnectHome Connect

Rola APPMODULE

APPMODULE pełni rolę bramy integracyjnej. System ekey komunikuje się z modułem po IP w tej samej sieci, a aplikacja „ekey bionyx connect” udostępnia funkcje do dalszej integracji.

Wersja IP

APPMODULE IP wykorzystuje Ethernet i zasilanie 12–24 V DC. Jest rozwiązaniem dla instalacji, w których chcemy korzystać z ekosystemu aplikacji BAB bez bezpośredniego podłączenia do magistrali KNX/TP.

Kiedy warto?

Gdy integrator preferuje gotową bramę i aplikacje producenta zamiast budowania własnego endpointu, webhooków i logiki pośredniczącej.

05

Integracja KNX przez APPMODULE KNX

KNX
ekey bionyx
APPMODULE KNX KNX/TP
KNX Automatyka KNX magistrala KNX/TP

Dedykowana integracja z KNX poprzez APPMODULE KNX z aplikacją ekey bionyx connect. Moduł posiada bezpośredni interfejs KNX/TP, dzięki czemu funkcje ekey mogą być przekazywane do magistrali KNX.

Informacje: funkcje integracji KNX Interfejs: KNX/TP Urządzenie: APPMODULE KNX
Przykładowy system
Logo KNX KNX

Bezpośrednio do KNX/TP

Wersja APPMODULE KNX posiada złącze magistrali KNX, Ethernet oraz zasilanie. Dzięki temu ekey może zostać włączony do istniejącej architektury KNX przez dedykowaną warstwę integracyjną.

Dlaczego to wygodne?

Logika automatyki pozostaje po stronie KNX: zdarzenie z czytnika można wykorzystać do scen, oświetlenia, rolet, HVAC czy funkcji bezpieczeństwa bez tworzenia własnego serwera webhooków.

Rozwój integracji

BAB TECHNOLOGIE i ekey rozwijają integrację KNX również w oparciu o nowe możliwości Notification API, dzięki czemu kierunek ten jest przeznaczony dla bardziej rozbudowanych instalacji budynkowych.

Konkretne systemy

Jak pięć metod przekłada się na realne systemy Smart Home?

Poniższe przykłady są przypisane do opisanych wyżej sposobów integracji. Przy każdym systemie wskazujemy konkretny element, który musi znaleźć się po jego stronie — np. Grenton Gate HTTP, Loxone Miniserver, APPMODULE dla KNX albo odpowiedni driver i licencję.

SystemCo jest potrzebne po stronie systemuMetodaDodatkowa bramka?
GrentonGate HTTP INT-211-E-01HTTP(S) → Http ListenerTak
LoxoneMiniserver + Virtual InputHTTP(S) do Web ServicesNie
Home AssistantDziałająca instancja HA + integracja ekey bionyxThird-Party API / Local PushNie
KNXAPPMODULE KNX z ekey bionyx connectIP ekey → APPMODULE → KNX/TPTak
KNX po IPAPPMODULE IP + KNXnet/IP Router lub EIBPORTKNXnet/IPTak
Gira HomeServerHomeServer ≥ 4.11 + CASAVIONE ekey bionyx Interface + licencjaEthernet / Notification APINie, programowo
Control4Kontroler Control4 + ekey Control4 drivers + licencjaNotification APIOpcjonalnie ekey Wi-Fi Bridge
CrestronCrestron 4-Series lub Crestron Home + sterownik ekey + licencjaNotification APINie wskazana jako obowiązkowa

Loxone

Miniserver + Virtual Input
Metoda 02 · HTTP(S) Request
Wymagany elementLoxone Miniserver

W Loxone nie trzeba dokładać odpowiednika Gate HTTP. Funkcję endpointu sieciowego realizuje sam Miniserver. W projekcie Loxone Config przygotowuje się Virtual Input, który następnie może być wywołany przez Web Services / HTTP API Miniservera.

  • potrzebny Miniserver dostępny z tej samej sieci co ekey,
  • w Loxone Config przygotowujemy Virtual Input dla wybranej funkcji,
  • ekey wysyła skonfigurowany HTTP(S) Request na adres Miniservera,
  • można przygotować osobne requesty dla różnych palców i różnych scen,
  • oficjalny przykład ekey korzysta z Basic Authentication.
Tor komunikacjiekey → HTTP(S) → Miniserver / Virtual Input → logika Loxone
Przykład ekey + Loxone →

Home Assistant

oficjalna integracja ekey bionyx
Integracja API · Local Push
Wymagany elementInstancja Home Assistant + integracja „ekey bionyx”

Tu nie jest potrzebny dodatkowy moduł DIN. Po stronie Home Assistant wystarczy działająca instancja HA i oficjalna integracja ekey bionyx. Po stronie ekey wymagany jest tryb Plus oraz aktywne Third-Party API.

  • integrację dodaje się w Ustawienia → Urządzenia i usługi,
  • Home Assistant zaleca użycie lokalnego adresu IP,
  • funkcje ekey pojawiają się jako zdarzenia do użycia w automatyzacjach,
  • obecnie limit wynosi 5 funkcji na system ekey,
  • do jednego systemu ekey nie można podłączyć kilku instancji HA tą integracją.
Tor komunikacjiekey bionyx Third-Party API → Home Assistant → event → automation
Dokumentacja Home Assistant →

KNX

APPMODULE KNX / APPMODULE IP
Metoda 04/05 · APPMODULE
Wymagany elementBAB TECHNOLOGIE APPMODULE z ekey bionyx connect

Dla klasycznej magistrali KNX najprostsza gotowa droga to APPMODULE KNX. Ma własny interfejs KNX/TP, Ethernet i zasilanie 12–24 V DC. ekey i APPMODULE komunikują się po IP w tej samej sieci, a APPMODULE przekazuje zdarzenia do KNX.

  • APPMODULE KNX — gdy chcemy wejść bezpośrednio na KNX/TP,
  • APPMODULE IP — gdy projekt KNX jest dostępny przez KNXnet/IP; wtedy potrzebny jest dodatkowo KNXnet/IP Router lub EIBPORT,
  • na APPMODULE używana jest aplikacja ekey bionyx connect,
  • aktualna wersja integracji BAB obsługuje również Notification API.
Tor komunikacjiekey → Ethernet → APPMODULE KNX → KNX/TP → aktory / sceny

Gira HomeServer

CASAVIONE ekey bionyx Interface
Metoda 03 · Notification API
Wymagany elementGira HomeServer 4.11+ + moduł logiczny CASAVIONE

To integracja programowa przygotowana specjalnie dla Gira HomeServer. ekey wskazuje moduł logiczny CASAVIONE ekey bionyx Interface; logika pozostaje w HomeServerze i jest konfigurowana w HS/FS Expert.

  • zgodność ekey deklarowana jest od Gira HomeServer 4.11,
  • potrzebny jest moduł logiczny CASAVIONE ekey bionyx Interface,
  • do stałego użycia wymagana jest odpowiednia licencja ekey dla Gira HomeServer,
  • można obrabiać zdarzenia użytkownika, urządzenia i autoryzacji.
Tor komunikacjiekey → Ethernet / Notification API → CASAVIONE Interface → Gira HomeServer → logika
Integracja ekey + Gira →

Control4

dedykowane sterowniki ekey
Metoda 03 · Notification API
Wymagany elementKontroler Control4 + ekey Control4 Bridge Driver / device drivers

W Control4 integracja opiera się na dedykowanych sterownikach ekey. ekey Wi-Fi Bridge jest opcjonalny: ułatwia wykrycie przez SDDP i przekazanie wyeksportowanej konfiguracji bionyx, ale według aktualnej dokumentacji nie jest obowiązkowy — konfigurację można wpisać ręcznie w Bridge Driver.

  • potrzebny działający kontroler Control4 i projekt Composer,
  • instalowane są sterowniki ekey dla Control4,
  • do długotrwałej pracy potrzebna jest licencja ekey Control4,
  • opcjonalny Wi-Fi Bridge automatyzuje discovery i import konfiguracji,
  • zdarzenia mogą rozróżniać użytkownika, palec, urządzenie i wejście cyfrowe kontrolera ekey.
Tor komunikacjiekey → Notification API → ekey Control4 drivers → Controller → sceny / automatyzacje
Integracja ekey + Control4 →

Crestron

driver ekey dla 4-Series / Crestron Home
Metoda 03 · Notification API
Wymagany elementCrestron 4-Series lub Crestron Home + licencja drivera ekey

ekey oferuje dedykowany sterownik dla Crestron 4-Series oraz Crestron Home. Licencja jest przypisywana do kontrolera na podstawie jego adresu MAC.

  • po stronie Crestron potrzebny kompatybilny kontroler 4-Series lub środowisko Crestron Home,
  • potrzebny dedykowany driver ekey,
  • wymagana jest licencja ekey bionyx Notification API dla Crestron,
  • integracja pozwala wyzwalać sceny na podstawie palca, użytkownika oraz wejść cyfrowych ekey.
Tor komunikacjiekey bionyx → Notification API → ekey driver → Crestron → scena / automatyzacja
Driver / licencja Crestron →
Bez centrali automatyki

Urządzenia, do których ekey może wysłać request bezpośrednio

W wielu przypadkach nie potrzeba dodatkowej centrali Smart Home. Jeżeli urządzenie ma osiągalne API HTTP(S), ekey może wykonać request bezpośrednio. Oficjalne przykłady ekey obejmują m.in. poniższe urządzenia.

Shelly Plus 1Potrzebny element: sam przekaźnik Shelly Plus 1 w tej samej sieci LAN.

ekey wywołuje lokalny endpoint Shelly; dodatkowa bramka nie jest potrzebna.

Dokumentacja ekey →
DoorBirdPotrzebny element: stacja DoorBird z dostępnym HTTP API.

Request ekey może bezpośrednio przełączyć przekaźnik interkomu DoorBird w sieci lokalnej.

Dokumentacja ekey →
SomfyPotrzebny element: Somfy TaHoma Box.

ekey pokazuje lokalne wywołanie TaHoma z tokenem w nagłówku requestu.

Dokumentacja ekey →
NukiPotrzebny element zależy od generacji zamka.

Dla Smart Lock 3.0 ekey dokumentuje lokalną integrację przez Nuki Bridge. Dla Go / Pro / Ultra opisuje wariant przez Nuki Web API i token.

Nuki Bridge →
TedeePotrzebny element: Tedee Smart Bridge + Personal Access Key.

W przykładzie ekey integracja korzysta z API Tedee i wymaga połączenia obu systemów z internetem.

Dokumentacja ekey →
FAQ

Najczęstsze pytania o integracje ekey

Czy każdy palec może uruchamiać inną funkcję?

Tak. W ekey bionyx funkcje mogą być przypisywane do zapisanych palców użytkownika. Pozwala to rozdzielić np. zwykłe wejście od dodatkowej sceny Smart Home.

Czy nierozpoznany palec może wywołać reakcję automatyki?

Nie przez zwykły HTTP(S) Request przypisywany do zapisanego palca. Do obsługi odrzuconych prób lepiej nadaje się Notification API, które potrafi zgłosić zdarzenie „No Match” wraz z kodem wyniku.

Czy ekey działa z Home Assistant bez dodatkowego modułu?

Tak. Home Assistant ma oficjalną integrację ekey bionyx. Wymaga ona trybu Plus oraz aktywnego Third‑Party API w aplikacji ekey.

Czy do Loxone potrzebny jest APPMODULE?

Nie. ekey publikuje przykład bezpośredniej integracji z Miniserverem przez HTTP(S) Request. APPMODULE jest osobną drogą integracji i nie jest wymagany w takim wariancie.

Jaki moduł jest potrzebny do integracji ekey z Grenton?

Po stronie Grenton potrzebny jest moduł Gate HTTP (INT-211-E-01). W konfiguracji tworzy się obiekt Http Listener, który odbiera żądanie wysyłane przez ekey i przekazuje zdarzenie do logiki systemu Grenton.

Co jest potrzebne do integracji ekey z KNX?

Najprostsza gotowa droga to APPMODULE KNX z aplikacją ekey bionyx connect. APPMODULE ma bezpośrednie złącze KNX/TP. Alternatywnie APPMODULE IP może pracować przez KNXnet/IP Router lub EIBPORT.

Czy lokalna integracja wymaga internetu?

Same requesty do urządzenia dostępnego w LAN mogą być wykonywane lokalnie. W przykładzie Loxone ekey wskazuje, że do codziennego działania requestu internet nie jest konieczny, natomiast konfiguracja, funkcje trybu Plus i zarządzanie systemem mogą mieć własne wymagania usługowe.

Czy Third‑Party API pozwala sterować czytnikiem ekey z zewnątrz?

Nie w tym sensie. Aktualna dokumentacja ekey wymienia jako ograniczenie, że API nie pozwala sterować urządzeniem ekey. Interfejs służy przede wszystkim do dodawania funkcji integratora i wywoływania ich przez ekey.

Nie wiesz, który wariant integracji wybrać?

Możemy dobrać sposób komunikacji, przygotować logikę po stronie Smart Home i uruchomić integrację z Loxone, KNX, Home Assistant lub systemem posiadającym własne API.

Zapytaj nas o integrację ekey
Opracowanie na podstawie dokumentacji producenta ekey, dokumentacji technicznej ekey, dokumentacji Home Assistant oraz materiałów BAB TECHNOLOGIE. Funkcje i wymagania mogą zmieniać się wraz z aktualizacjami ekey bionyx.
TOP