Einleitung

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

Produkte mit API Unterstützung

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:

• GET-Request: Wert lesen
• SET-Request: Wert schreiben

Syntax / Aufbau der URL:

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

• http://{IP}:5333/{Gerätename}/get/Befehl
• http://{IP}:5333/{Gerätename}/set/Befehl/Wert

Gerätenamen:

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:

• {getXYZ:“NSC“} NSC - Befehl existiert nicht
• {setPRF9:“MIMA} MIMA - Wert außerhalb des Einstellbereiches

Schnittstellen der Geräte

Kommunikation / Steuerung

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

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:

• http://{IP}:5333/

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.

• Verhindert Lochfraß und Korrosion
• Regelt zuverlässig den Wasserdruck
• Schützt zuverlässig vor teuren Wasserschäden und –verschwendung
• Leckageschutz-Selbstlernphase aktivierbar
• Bis zu 8 verschiedene Profile einstellbar
• Regelmäßige Durchführung eines Mikroleckagetests
• Manuelle Not-Auf Funktion
• Bei Stromausfall Notbetrieb durch Batterie

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.

• Schützt zuverlässig vor teuren Wasserschäden und –verschwendung
• Ermittelt den Härtebereich, misst Wasserdruck und -temperatur
• Leckageschutz-Selbstlernphase aktivierbar
• Bis zu 8 verschiedene Profile einstellbar
• Regelmäßige Durchführung eines Mikroleckagetests
• Manuelle Not-Auf Funktion
• Bei Stromausfall Notbetrieb durch Batterie

NeoSoft 2500

Die NeoSoft 2500 Connect ist eine Einzelenthärtungsanlage mit modernster Kommunikationstechnologie und arbeitet nach dem bewährten Ionenaustauschverfahren. Die Kapazität der NeoSoft 2500 Connect ist so ausgelegt, dass der komplette Wasserverbrauch eines Einfamilienhauses teilenthärtet werden kann.

• spürbar weiches Wasser, schützt die Hausinstallation vor Kalk attraktives Design
• Touchscreen für intuitive Steuerung
• automatische Wahl des Betriebsmodus (Eco, Standard, Power)
• Salzstandanzeige
• gut sichtbare Statusanzeige
• anschlussfertig vormontiert
• neues Ein-Schlauch-System
• verwindungssicherer Anschluss durch innovatives Stecksystem
• passt auf den SYR Universalflansch DN 20 bis 32
• Sandwichflansch für SafeTech+ Connect, DRUFI+ und/oder TRIO DFR/LS

NeoSoft 5000

Die NeoSoft 5000 Connect begründet eine neue Generation von SYR Enthärtungsanlagen mit modernster Kommunikationstechnologie und 7“ Touchscreen. Die NeoSoft 5000 Connect kann rund um die Uhr bis zu acht Wohneinheiten zuverlässig mit Weichwasser versorgen. Durch die automatische, verbrauchsabhängige Auswahl des Betriebsmodus (ECO, Standard oder Power) ist ein sparsamer Betrieb jederzeit gewährleistet.

• spürbar weiches Wasser, schützt die Hausinstallation vor Kalk
• attraktives Design
• 7“ Touchscreen mit Wischfunktion für intuitive Steuerung
• automatische Wahl des Betriebsmodus (Eco, Standard, Power)
• automatische Salzstanderkennung
• gut sichtbare Statusanzeige
• anschlussfertig vormontiert
• verwindungssicherer Anschluss durch innovatives Stecksystem
• potentialfreier Störmeldekontakt
• passt auf den SYR Universalflansch DN 20 bis 32
• Sandwichflansch für SafeTech+ Connect, DRUFI+ und/oder TRIO DFR/LS

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

Befehle

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

• FALSE Absperrung geöffnet
• TRUE Absperrung geschlossen

Die aktuelle Position der Absperrung kann mit VLV abgerufen werden.

• 10 Absperrung geschlossen
• 11 Absperrung schließt
• 20 Absperrung offen
• 21 Absperrung öffnet

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

Befehle

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

Befehle

Mit dem Befehl DSV wird der Status der Mikroleckage abgerufen.

• 0 Test nicht Aktiv
• 1 Test Aktiv
• 2 Abgebrochen durch Druckabfall
• 3 Test übersprungen

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.

• 1 Der Test startet Täglich
• 2 Der Test startet Wöchentlich
• 3 Der Test startet Monatlich

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

Beispiel

• DTT = 04:00
• DRP = 1

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

Befehle

Enthärtung

Regnerationsparameter

Mit den folgenden Befehlen können die Enthärtungsparameter ausgelesen werden. Diese Werte können nur gelesen und nicht verändert werden.

Abfrage der Eingangshärte

GET /get/iwh

{
  "getIWH":12
}

Abfrage der nächsten halbjährlichen Wartung

GET /get/srh

{
  "getSRH":"23.08.2025"
}

Gültigkeit

Befehle

Regenerationseinstellungen

Regenerationsmodus auf Automatik stellen

GET /set/rmo/4

{
  "setRMO4":true
}

Regenerationsperiode auf 2 Tage stellen

GET /set/rpd/2

{
  "setRPD2":true
}

Gültigkeit

Befehle

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

Befehle

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

• Der Befehl WFK setzt den WLAN Key des Netzwerks

• Der Befehl WFC setzt die SSID

Nach dem WFC gesetzt wurde wird der Verbindungsversuch gestartet.

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

• 0 nicht Verbunden
• 1 Verbindung wird aufgebaut
• 2 Verbunden

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

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

Befehle

Der Rückgabewert von ALarmen, Warnungen oder Benachrichtgigungen ist immer in Hexadezimal formatiert. Wenn ein Alarm zurück gesetzt werden soll muss dieser in dezimal formatiert werden (/set/ala/255).

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.

• Alarme können sowohl aufgrund einer Leckage als auch durch systemkritische Fehler ausgelöst werden. Alarme führen immer zur Absperrung des Systems.
• Warnungen werden ausgelöst wenn Ereignisse eintreten welche den reibungslosen Betrieb gefährden. Beispielsweise wenn die Batterien am Ende ihrer Lebensdauer angelangt sind.
• Notifications dienen der Information des Anwenders, wird ein neues Update bereitgestellt oder die Filterrückspülung ist überfällig, so wird der Anwender in Kenntnis gesetzt.

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

Warnungen

Notifications

Firewall-Konfiguration

Damit Ihre SYR-Geräte erfolgreich mit den SYR Azure-Diensten kommunizieren und Firmware-Updates herunterladen können, müssen folgende Domains, IP-Adressbereiche und Ports in Ihrer Firewall freigegeben werden.

Azure IoT Hub Kommunikation

Ermöglicht die zentrale Kommunikation der Geräte mit Azure IoT Hub.

• FQDN: *.azure-devices.net
• Ports:
  • 443 (MQTT über WebSocket / HTTPS)
  • 8883 (MQTT über TLS)
  • 5671 (AMQP über TLS)

IP-Adressbereiche: - Verwenden Sie den Service Tag AzureIoTHub in der folgenden Datei: - Azure IP Ranges and Service Tags – Public Cloud

Azure Blob Storage (Firmware-Download)

• FQDN: *.blob.core.windows.net
• Port: 443, 80 (Port 80 als Backup)

IP-Adressbereiche: - Service Tag: Storage

Azure App Service

• FQDN: *.azurewebsites.net
• Port: 443

IP-Adressbereiche: - Service Tag: AppService

Zeitsynchronisation (optional)

• FQDN / IP: pool.ntp.org
• Port: 123/UDP

Empfohlene Vorgehensweise

Whitelist nach FQDNs (empfohlen)

Wenn Ihre Firewall FQDN-basierte Regeln unterstützt, verwenden Sie ausschließlich Domainnamen.

Alternative: IP-Adressen

Nutzen Sie die regelmäßig aktualisierte Datei: - Azure IP Ranges and Service Tags – Public Cloud

Beispiel: FQDN-Freigabeliste

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.