NAV
http

Einleitung

Die nachfolgend beschriebene API ermöglicht es, die connectfähigen SYR Produkte im eigenen Smarthome System zu integrieren.

Produkte mit API Unterstützung

TrioDFR LS SafeTech +
Version >v134 >v134

Allgemeine Informationen

SYR-Geräte können entweder über den AccessPoint-Modus, als WLAN Client oder über LAN betrieben werden.

Befehle:

Die SYR Connect Produkte werden über HTTP-Requests angesprochen. Bei den Requests wird zwischen den folgenden Typen unterschieden:

Syntax / Aufbau der URL:

Die Befehlssyntax sieht für beide Requests wie folgt aus:

Gerätenamen:

Produkt Gerätename
TrioDFR LS trio
SafeTech + trio

Antworten:

Die Antworten auf die Requests erfolgen im JSON Format. Die Antwort beinhaltet die ursprüngliche Anfrage, sowie das Ergebnis.

Ports:

Die Anfragen erfolgen über den Port 5333.

Fehlercodes:

Fehler werden nicht als Statuscode sondern im Payload zurückgegeben. Folgende Fehler können zurückgegeben werden:

Schnittstellen der Geräte

TrioDFR LS SafeTech +
AP Modus
WLAN
LAN

Kommunikation / Steuerung

Die Steuerung der SYR Connect Produkte kann über die SYR Connect App, den Accesspoint des Produktes oder über das lokale Netzwerk per WLAN/LAN erfolgen.

Lokale Kommunikation über den Accesspoint

Das Einschalten des Accesspoints wird in der jeweiligen Gebrauchsanleitung des Produktes beschrieben. Die SSID des Accesspoints besteht aus „SYR{Seriennummer}. Ein Passwort ist nicht notwendig. Im Accesspoint-Modus muss folgende IP-Adresse verwendet werden:

Lokale Kommunikation im Netzwerk

Die LAN Verbindung kann über einstecken des Netzwerksteckers in das Gerät hergestellt werden. Hierzu sind keine weiteren Handlungen nötig.

Die WLAN Verbindung kann sowohl menügeführt über die SYR App als auch per Befehlskette im Accesspoint Modus hergestellt werden. Mehr dazu in der Rubrik „Netzwerk/Befehle“.

Im lokalen Netzwerk muss die IP Adresse der ausgewählten Schnittstelle des Gerätes wie folgt für den Platzhalter eingesetzt werden:

Geräteinformationen - Unterstützte Geräte

TrioDFR LS

Der SYR TRIO DFR LS Connect ist eine Kombination aus einem halbautomatischen, rückspülbaren Filter, einem Druckminderer und einem Leckageschutz. Er wird direkt hinter dem Wasserzähler auf einen SYR Universalflansch montiert.

SafeTech+

Der SafeTech+ Connect Leckageschutz wird direkt hinter dem Wasserzähler auf den SYR Universalflansch (DN20-32) montiert. Bei bereits bestehenden Universalflansch kann er zwischen diesen und einen Trinkwasserfilter aus dem Hause SYR montiert werden.

Leckageschutz

Bewegen der Absperrung

Beispiel Absperrung schließen

GET /set/ab/true

{
  "setAB":true
}

Beispiel Position der Absperrung abrufen

GET /get/vlv

{
  "getVLV":10
}

Die Absperrung kann auf die aktuelle Position abgefragt sowie geöffnet und geschlossen werden.

Gültigkeit

TrioDFR LS SafeTech +
Version > v134 > v134

Befehle

Befehl Typ Beschreibung Wertebereich GET SET
AB bool Absperrung Öffnen/Schließen true/false
VLV int Status der Absperrung 10-21 X

Zum Öffnen oder Schließen der Absperrung wird der Wert von AB auf true oder false gesetzt.

Die aktuelle Position der Absperrung kann mit VLV abgerufen werden.

Leckageprofile

Beispiel Profil 3 Aktivieren

GET /set/pa3/true

{
  "setPA3":true
}

Beispiel Volumenleckage in Profil 1 auf 500l ändern

GET /set/pv1/500

{
  "setPV1": 500
}

Beispiel Profilwechsel auf Profil2

GET /set/prf/2

{
  "setPRF": 2
}

Beispiel Prüfen welches Profil ausgewählt ist

GET /get/prf

{
  "getPRF": 2
}

Leckageprofile können angelegt, bearbeitet und zwischen ihnen hin und her gewechselt werden.

Gültigkeit

TrioDFR LS SafeTech +
Version >v134 >v134

Befehle

Befehl Typ Beschreibung Wertebereich GET SET
PAx bool Profil Verfügbarkeit true/false
PVx int Profil zulässiges Volumen in litern. Bei 0 ist die Volumenleckage deaktiviert 0-9000
PTx int Profil zulässige Zeit in min. Bei 0 ist die Zeitleckage deaktiviert 0-1500
PFx int Profil zulässiger Durchfluss in l/h. Bei 0 ist die Durchflussleckage deaktiviert 0-5000
PMx bool Mikroleckage Test Aktivieren/Deaktivieren true/false
PWx bool Leckagewarnung Aktivieren/Deaktivieren true/false
PBx bool Buzzer Aktivieren/Deaktivieren true/false
PRx int Rückkehrzeit zu Profil Anwesend(Profil1) in Stunden. Bei 0 bleibt das Profil dauerhaft aktiv 0-700
PRF int Aktuell ausgewähltes Profil 1-8

Das Gerät hat werksseitig die Profile Anwesend(Profil 1) und Abwesend(Profil 2) hinterlegt. Die Profile 3-8 müssen aktiviert und eingestellt werden.

Mikroleckage Test

Beispiel Mikroleckage Test Starten

GET /set/dex/true

{
  "setDEX":true
}

Beispiel Uhrzeit der Mikroleckage auf 04:00Uhr Einstellen

GET /set/dtt/04:00

{
  "setDTT": "04:00"
}

Der Mikroleckagetest kann manuell gestartet und im Intervall terminiert werden.

Gültigkeit

TrioDFR LS SafeTech +
Version >v134 >v134

Befehle

Befehl Typ Beschreibung Wertebereich GET SET
DEX bool Startet den Mikroleckage Test true X
DRP int Stellt das Test Intervall ein 1-3
DSV int Status der Mikroleckage. Prüft ober Test Aktiv ist oder nicht. 0-3 X
DTT string Stellt die Uhrzeit ein wann der Test ausgeführt wird. Format "00:00" -

Mit dem Befehl DSV wird der Status der Mikroleckage abgerufen.

Wird der Test nicht manuell gestartet, sondern durch das Test Intervall, prüft das Gerät ob 180min vorher Wasser entnommen wurde. Wurde in diesem Zeitraum Wasser entnommen, dann wird der Status (DSV) auf den Wert 3 gesetzt und der Test erst wieder zum nächsten Zeitpunkt ausgeführt.

Bei Geräten mit Drucksensor wird der Test abgebrochen und die Absperrung wieder geöffnet sobald Wasser entnommen wird. Der Status wir dann auf 2 gesetzt.

Der Test Intervall kann über DRP eingestellt werden.

Die Uhrzeit kann über DTT eingestellt werden. Die Uhrzeit wird als string im Format "HH:MM" übergeben.

Beispiel

Der Mikroleckage Test wird täglich um 04:00Uhr ausgeführt.

Eine Deaktivierung des Tests erfolgt in den Profilen in den man PMx auf false setzt.

Selbstlernphase

Beispiel Selbstlernphase für 7 Tage starten

GET /set/slp/7

{
  "setSLP7":"OK"
}

Beispiel Erlerntes Volumen abrufen

GET /get/slv

{
  "setSLV": 2500
}

Die Selbstlernphase ermittelt die die maximal Werte für Volumen, Zeit und Durchfluss in einem einstellbaren Zeitraum. Die Selbstlernphase wird für eine Zeit x gestartet und wird nach Ablauf beendet. Die Ergebnisse können während oder am Ende der Phase abgerufen werden.

Gültigkeit

TrioDFR LS SafeTech +
Version >v134 >v134

Befehle

Befehl Typ Beschreibung Wertebereich GET SET
SLP int Startet die Selbstlernphase mit der angegebenen Dauer in Tagen. Bei 0 wird die Selbstlernphase beendet 0-28
SLV int Das ermittelte Volumen in L während der Selbstlernphase 0-9000 X
SLT int Die ermittelte Zeit in s während der Selbstlernphase 0-90000 X
SLF int Der ermittelte Durchfluss in l/h während der Selbstlernphase 0-5000 X
SLD bool Löscht die Werte wenn true gesendet wird true X
SLE int Die Restzeit in s einer aktiven Selbstlernphase 0-2419200 X

Netzwerk

Beispiel WLAN-Key des Netzwerks übermitteln

GET /set/wfk/Passwort

{
  "setWFKPasswort": "OK"
}

Beispiel WLAN-SSID Einstellen

GET /set/WFC/SYR-WLAN

{
  "setSYR-WLAN": "OK"
}

Beispiel Verbindungsstatus abfragen

GET /get/wfs

{
  "getWFS": "2"
}

Beispiel Netzwerkparameter zurücksetzen

GET /set/wfd

{
  "setWFD": "OK"
}

Gültigkeit

TrioDFR LS SafeTech +
Version >v134 >v134

Befehle

Befehl Typ Beschreibung Wertebereich GET SET
WFC string WLAN SSID true
WFD SSID und Key Löschen
WFK string WLAN Key X
WFL json Stellt eine Lister der Verfügbaren Netzwerke zur Verfügung - X
WFR int WLAN Signalstärke in % 1-100 X
WFS int WLAN Verbindungsstatus 0-2 X
WGW string WLAN IP X
WIP string WLAN Gateway X
EGW string Ethernet IP X
EIP string Ethernet Gateway X
MAC1 string MAC-Adresse WLAN Schnittstelle X
MAC2 string MAC-Adresse LAN Schnittstelle X

Die Verbindung zu einem WLAN Netzwerk kann über die Befehle WFK und WFC aufgebaut werden.

Nach dem WFC gesetzt wurde wird der Verbindungsversuch gestartet.

Mit dem Befehl WFS kann der Verbindungsstatus der WLAN Schnittstelle ausgelesen werden.

Um die Verbindungsdaten aus dem Gerät zu löschen wird der Befehl WFD verwendet. WFD bekommt keinen Wert übergeben set/WFD.

Sensorik & Statuswerte

Die Geräte stellen diverse Telemetrie und Status Werte bereit.

Gültigkeit

Befehle TrioDFR LS SafeTech+
AVO
BAR X
BAT
CEL X
CND X
FLO
LTV
NPS
SRN
VER
VOL

Befehle

Befehl Typ Beschreibung Wertebereich GET SET
AVO int Volumen aktuelle Entnahme in ml X
BAR int Eingangsdruck in mbar 0-16000 X
BAT int Batteriespannung in 1/100 V 0-1000 X
CEL int Temperatur in °C 0-1000 X
CND int Leitwert in uS/cm 0-5000 X
FLO int Aktueller Durchfluss in l/h 0-5000 X
LTV int Letztes gezapftes Volumen in Litern X
NPS int Keine Turbinenimpulse seit.. in s X
SRN string Seriennummer des Gerätes X
VER string Firmware Version des Gerätes X
VOL int Kumulatives Volumen in Litern X

Alarm Handling

Beispiel Abrufen des Alarmspeichers

GET /get/alm

{
  "getALM":"ff,ff,ff,a3,ff,a6,ff,ff,a5,ff"
}

Beispiel Quittieren der Alarme

GET /set/ala/255

{
  "setALA255":"OK"
}

Gültigkeit

TrioDFR LS SafeTech +
Version >v134 >v134



Befehle

Befehl Typ Beschreibung Wertebereich GET SET
ALA hex Abrufen des aktuellen Alarms - X
ALA int Quittieren des anliegenden Alarms 255 X
ALM json Abrufen der letzten 8 Alarme - X
WRN hex Abrufen der aktuellen Warnung - X
WRN int Quittieren der aktuellen Warnung 255 X
ALW json Abrufen der letzten 8 Warnungen - X
NOT hex Abrufen der aktuellen Notification - X
NOT int Quittieren der anliegenden Notification 255 X
ALN json Abrufen der letzten 8 Notifications - X



Die Geräte unterrichten den Anwender über Neuigkeiten, Warnungen sowie Alarme und Fehlfunktionen per Push-Nachricht in der App oder per Mail.

Dabei wird zwischen Alarmen, Warnungen und Notifications unterschieden.

Die Meldungspeicher der Geräte können zusätzlich per Befehl abgerufen werden. Die Meldung an erster Stelle des ausgegeben Arrays stellt immer die aktuellste Meldung dar.

Alarme

Alarm Ursache Beschreibung Abhilfe
A1 Endschalter Die Absperrung kann nicht betätigt werden. Evtl. liegt eine Verschmutzung oder ein Defekt des Motors oder der Endschalter vor. Achtung: Eingeschränkter Leckageschutz! Bitte prüfen Sie die Funktion indem Sie die Absperrung manuell betätigen.
A2 Motorstrom Der Grenzwert für den Motorstrom wurde überschritten. Eventuell liegt eine Verschmutzung oder ein Defekt des Motors vor. Bitte überprüfen sie die Funktion indem Sie die Absperrung manuell betätigen.
A3 Volumenleckage Das maximal zulässige Volumen wurde überschritten. Evtl. liegt eine Volumenleckage vor. Bitte beseitigen Sie die Leckage oder passen Sie die Schutzstufe an. Quittieren Sie den Alarm, um die Absperrung wieder zu öffnen.
A4 Zeitleckage Die maximal zulässige Zeit wurde überschritten. Evtl. liegt eine Zeitleckage vor. Bitte beseitigen Sie die Leckage oder passen Sie die Schutzstufe an. Quittieren Sie den Alarm, um die Absperrung wieder zu öffnen.
A5 Durchflussleckage Der maximal zulässige Durchfluss wurde überschritten. Evtl. liegt eine Durchflussleckage z.B. Rohrbruch vor. Bitte beseitigen Sie die Leckage oder passen Sie die Schutzstufe an. Quittieren Sie den Alarm, um die Absperrung wieder zu öffnen.
A6 Mikroleckageverdacht Das Pulslimit wurde überschritten. Evtl. liegt eine Mikroleckage z.B. in der WC-Spülung vor. Prüfen Sie ihre Installation auf Leckagen wie z.B. tropfende Auslaufarmaturen oder WC-Spülungen.
A7 Bodensensorleckage Eine Leckage am Bodensensor wurde erkannt. Bitte beseitigen Sie die Leckage und prüfen Sie den Bodensensor bzw. den Aufstellungsort.
A8 Störung Durchflusssensor Es wurde über einen längeren Zeitraum keine Turbinenimpulse erfasst. Evtl. liegt eine Verschmutzung oder ein Defekt der Turbine oder des Sensors vor. Achtung: Eingeschränkter Leckageschutz! Öffnen Sie eine Wasserentnahmestelle und überprüfen Sie, ob an der Steuerung (LED)Turbinenimpulse angezeigt werden. Verständigen Sie den Service.
A9 Störung Drucksensor Der Drucksensor meldet keine Informationen. Evtl. liegt ein Defekt vor. Bitte verständigen Sie den Service.
AA Störung Temperatursensor Der Temperatursensor meldet keine Informationen. Evtl. liegt ein Defekt vor. Bitte verständigen Sie den Service.
AB Störung Leitwertsensor Der Leitwertsensor meldet keine Informationen. Evtl. liegt ein Defekt vor. Bitte verständigen Sie den Service.
AC Störung Leitwertsensor Der Leitwertsensor meldet keine Informationen. Evtl. liegt ein Defekt vor. Bitte verständigen Sie den Service.
AD Erhöhte Wasserhärte Der Grenzwert für die Wasserhärte wurde überschritten. Der Einsatz einer Weichwasseranlage wird empfohlen. Bitte kontaktieren Sie den Service.
FF Kein Alarm Es liegt kein Alarm im Alarmspeicher an. Es sind keine weiteren Maßnahmen nötig.



Warnungen

Warnung Ursache Beschreibung Abhilfe
1 Stromunterbrechung Die Stromzufuhr wurde unterbrochen. Bitte stellen Sie sicher, dass Ihr Gerät an einen unterbrechungsfreien Stromkreis angeschlossen ist.
7 Leckagewarnung Das maximal zulässige Volumen wurde annähernd erreicht. Bitte denken Sie daran rechtzeitig die Zapfstelle zu schließen und Quittieren Sie die Warnung.
8 Batterien erschöpft Die Batterien sind erschöpft Bitte wechseln Sie die Batterien
FF Kein Warnung Es liegt keine Warnung im Warnungsspeicher an. Es sind keine weiteren Maßnahmen nötig.



Notifications

Notification Ursache Beschreibung Abhilfe
1 Neues Software Update Verfügbar! Es steht ein neues Softwareupdate für Ihr Gerät zum Download bereit. Bitte Installieren Sie das Softwareupdate, um einen einwandfreien Betrieb zu gewährleisten.
4 Neues Software Update installiert! Es wurde eine neues Softwareupdate installiert. Die Softwareupdates können Sie im Menü unter "Einstellungen / Softwareupdate" verwalten.
FF Kein Notification Es liegt kein Notification im Notificationsspeicher an. Es sind keine weiteren Maßnahmen nötig.

SYR API Schlusswort

Nutzung

Der Nutzer erklärt sein Einverständnis zu dem nachfolgend aufgeführten Gewährleistungsausschluss und den Haftungsbeschränkungen, in dem er die API verwendet. Der Hersteller hat das Recht die API jederzeit zu aktualisieren oder zu ändern.

Gewährleistungsausschluss

Die API wird ohne Mängelgewähr, d.h. in ihrem jeweiligen Zustand und nach Verfügbarkeit ohne irgendeine Gewährleistung bereitgestellt. Der Hersteller schließt ausdrücklich sämtliche Gewährleistungen und Garantien aus, einschließlich der stillschweigenden Garantie in Bezug auf den gewöhnlichen Gebrauch, Verfügbarkeit und Sicherheit. Der Hersteller garantiert nicht, dass die API frei von Ungenauigkeiten, Fehlern, Bugs oder Unterbrechungen ist oder dass sie zuverlässig, einwandfrei, vollständig oder anderweitig valid ist. Die Nutzung der API erfolgt nach eigenem Ermessen und auf eigenes Risiko. Der Nutzer ist allein für alle Schäden verantwortlich, die aus der Verwendung der API hervorgehen.

Haftungsbeschränkung

Der Hersteller schließt jegliche Haftung soweit zulässig für indirekte oder beiläufig entstandene Schäden, Folgeschäden aus, die aus oder in Verbindung mit der Verwendung der API entstehen.

Support / Hilfestellung

Anmerkungen, Rückfragen und Wünsche bitte an IoT-Development@syr.de senden.