ASCII-Protokoll

ASCII-Protokoll am Extender-Port des ALLPOOL zum einfachen Lesen und Schreiben von Parametern mittels Leitrechner (z.B. Touchscreen). Siehe auch: Weitere Fernwartmöglichkeiten.                ©

	Zweck des ASCII-Protokolls

Simple digitale Schnittstelle am ALLPOOL:

Immer mehr Häuser verfügen über eine Hausautomatisation mit Bedienung über Touchscreen. Damit das ALLPOOL mit dem Leitrechner kommunizieren kann, unterstützt es ein einfaches ASCII-Protokoll. Somit können Parameter wie z.B. die Soll-Schwimmbadtemperatur oder Messwerte ausgelesen und geschrieben, also geändert werden. So kann das ALLPOOL unkompliziert von einem bestehenden Touchscreen aus bedient werden. Oder es meldet Messwerte und Relaiszustände automatisch an die Klimaanlage usw.

KNX (EIB):

Nutzbar seit:
Das ASCII-Protokoll ist ab der Firmwareversion 4.1 enthalten.

Updatemöglichkeit:
Sie können auch ein altes ALLPOOL updaten, um das ASCII-Protokoll verwenden zu können, wenn der ExtenderPort (runde dreipolige M8-Buchse auf der rechten Geräteseite) bereits montiert ist. Das ist bei allen ALLPOOL der Fall, die seit Anfang 2009 gefertigt wurden.

	Übersicht über das ASCII-Protokoll

Das ASCII-Protokoll am Extender Port ermöglicht:

• Über die serielle RS232 - Schnittstelle des Extender-Ports am ALLPOOL können digital Werte gelesen und geschrieben werden.
• Die Kommunikation erfolgt in Klartext mittels ASCII-Zeichensatz.
• Da das Protokoll sehr einfach ist, kann es schnell mit geringem Aufwand im Leitrechner integriert werden.
• Jeder Wert wird mittels seiner eindeutigen WerteID adressiert. Diese finden Sie in violetter Farbe in der Menüstruktur dokumentiert.
• So können zahlreiche Einstellungen wie Filterpumpe Auto/Aus/Ein oder Soll-Beckentemperatur für die konventionelle. Heizung ausgelesen oder verändert werden.
• Es können auch Hardwarezustände z.B. Position des Rückspülventils, gemessene Beckentemperatur oder Kollektortemperatur ausgelesen werden.
• Prüfsummen garantieren eine sichere Kommunikation.

	Die Schnittstelle der Extender Port

RS232 Interface: Mit dem Interface M8RS232 erhalten Sie eine vollwertige RS232-Schnittstelle auf einer DSUB-9 Buchse. Im Innern des Interfacegehäuses befinden sich Schraubklemmen. Hier können Sie ein geschirmtes Kabel anschließen, um die RS232 um bis zu 100m weit zum Leitrechner zu führen. USB Interfacekabel: Mit dem Interfacekabel M8USB eine USB-Schnittstelle zum direkten Anschließen z.B. an einen PC. Extender Port: Auf der rechten Seite des ALLPOOL befindet sich die wasserdichte 3polige M8-Buchse. Hier wird das M8PC bzw. M8USB Kabel angesteckt. Parameter: Kommunikationseinstellungen für die RS232 sind 19200 Baud, 8, 1, no parity, no handshake. Timeout: Zwischen 2 Zeichen dürfen maximal 250ms Zeit vergehen. Ansonsten werden die bisher gesendeten Zeichen der Zeile ignoriert. Geschwindigkeit: Vor Senden einer weiteren Befehlszeile auf die Antwort des ALPOOL oder min. 10ms lange warten.

	String zum ALLPOOL Syntax

Die Komponenten einer Zeile, die zum ALLPOOL geschickt wird im Überblick:

• Jede Zeile, die an das ALLPOOL geschickt wird, muss mit dem '#' oder '%' Startzeichen (35dez, 23hex oder 37dez, 25hex) beginnen.
• Unmittelbar danach folgt die WerteID. Dies ist eine 5stellige Dezimalzahl, die den gewünschten Wert adressiert. Details.
• Unmittelbar danach folgt das '?' Abfragezeichen, wenn sie vom ALLPOOL den aktuellen Wert erfahren wollen. Nach dem '?' kann auch alternativ die Abfragetype angegeben werden (minimal 'l' oder maximal 'h' erlaubter Wert). Details.
• Oder es folgt das '=' Schreibzeichen, gefolgt vom neuen Wert, den Sie setzen wollen. Details.
• Alternativ folgt ein '$' Prüfsummenzeichen mit einer Checksumme, damit Übertragungsfehler erkannt werden können. Details.
• Zuletzt folgt das '\n' Abschlußzeichen. Details.
   
  

Beispiele für Strings, die an das ALLPOOL gesendet werden können:

Abfragen von Werten:

Setzen von Werten:

Setzen von Alternativen:

'%33010=1$3D\n'		Filterpumpe auf Automatik schalten.
'%33010=2$3E\n'		Filterpumpe auf Hand AUS schalten.
'%33010=3$3F\n'		Filterpumpe auf Hand EIN schalten.
'%30010=2$3D\n'		Ausschalten aller Regler des ALLPOOL (Hauptschalter).
'%30010=1$3E\n'		Wieder Einschalten des ALLPOOL (Hauptschalter).

Die Antworten des ALLPOOL sind hier nicht dargestellt.

	String vom ALLPOOL Syntax

Die Komponenten einer Zeile, die als Antwort vom ALLPOOL zurück kommen:

• Jede Zeile, die vom ALLPOOL als Antwort kommt, beginnt mit dem '>' OK-Zeichen oder dem 'X' ERROR-Zeichen. Details.
• Unmittelbar nach dem '>' OK-Zeichen folgt die angefragte ('?') bzw. geschriebene ('=') Information (siehe Datenformate). Die Antwort schaut also nach dem Schreiben genau gleich aus wie nach dem Lesen. Es wird die erfolgreich geschriebene Information bzw. die erfolgreich abgefragte Information geantwortet. Details.
• Unmittelbar nach dem 'X' Fehler-Zeichen folgt ein Fehlerbeschreibungszeichen.  Details.
• Danach folgt ein '$' Prüfsummenzeichen mit einer Checksumme, damit Übertragungsfehler erkannt werden können.  Details.
• Zuletzt folgt das '\n' Abschlußzeichen.  Details.

Beispiele für Strings, die vom ALLPOOL kommen:

Fehlerfreie Antworten vom ALLPOOL:

Die Fragen an das ALLPOOL sind hier nicht dargestellt.

	Beispiele Senden & Empfangen

Hier nun Beispiele mit Strings die zum ALLPOOL geschickt und vom ALLPOOL beantwortet werden:

	# oder % Startzeichen im Detail

Jede Zeile, die an das ALLPOOL geschickt wird, muss mit dem '#' oder '%' Startzeichen (35dez, 23hex oder 37dez, 25hex) beginnen. Es signalisiert dem ALLPOOL, dass es sich bei den empfangenen Daten um das ASCII-Protokoll handelt. Das ALLPOOL unterstützt ja verschiedene Protokolle. Details.

Da manche Leitrechner Probleme haben das '#' Zeichen zu senden, kann ab v4.13 (SerNr XJ-34023) auch das '%' Zeichen verwendet werden.

	ID Werte ID im Detail

Jeder Wert im ALLPOOL wird über diese eindeutige ID adressiert. Es handelt sich um einen String, der eine maximal 5stellige Dezimalzahl darstellt. Voranstehende Nullen können weggelassen werden ('00120' ist gleich '120'). Die WerteID's finden Sie in der Menüstruktur in violetter Farbe neben jedem Wert, der mittels ASCII-Protokoll erreichbar ist.

Anfangs stehen noch nicht alle IDs zur Verfügung. So werden z.B. alle für die Statistik, Dosiermenge usw. zu einem späteren Zeitpunkt nutzbar sein. Die wichtigsten IDs wie AUTO|AUS|EIN usw. sind bereits alle verfügbar.

Übersicht über die ID-Bereiche:

00000 - 00099 ... reserviert
00100 - 00199 ... Grundlegende Geräteinfos (Gerätetype, Firmwareversion)
00300 - 00399 ... Kommunikationseinstellungen (RS232 Speed, Prüfsummen bei Antwort ja/nein, ausführliche Antworten ja/nein)
01000 - 01999 ... Hardwarezustände: Ausgänge (Relais)
02000 - 02999 ... Hardwarezustände: Eingänge
03000 - 03999 ... Hardwarezustände: Fehler (Trockenlauf, Motorschutz, ...)
04000 - 05999 ... Interne Zustände und Flags (Rücksp. wartet auf Füll., RestwNachl., Uhr ein/aus).
07000 - 07999 ... Bedienelemente (Tasten, LCD)
08000 - 08999 ... AdHoc Filter

30000 - 32999 ... System (die ersten 500 für den Easymodus).
33000 - 35999 ... Filter (die ersten 500 für den Easymodus).
36000 - 38999 ... Dosierung (die ersten 500 für den Easymodus).
39000 - 41999 ... lokale Rückspülung (die ersten 500 für den Easymodus).
42000 - 44999 ... konv. Heizung (die ersten 500 für den Easymodus).
45000 - 47999 ... Solarheizung (die ersten 500 für den Easymodus).
48000 - 50999 ... Niveau (die ersten 500 für den Easymodus).

Für alle PAUSCH-Geräte gültige IDs:

00110 ... Gerätetype: Z.B. '10' bei ALLPOOL, '50' bei TELCONvoice
00120 ... Firmwareversion z.B. '401' für Version 4.01

Alle für das ALLPOOL implementierten ID's:

In der Firmwareversion 4.1 sind diese ID's erreichbar. In dieser Tabelle sehen Sie die ID, den minimal erlaubten Wert, den maximal erlaubten Wert, die erlaubte Schrittweite, ob der Wert gelesen werden kann (R), ob der Wert geschrieben werden darf (W), und eine Beschreibung.

Hinweise zu Werten:

Schaltzustände: Bei Relaiszuständen usw. erhalten Sie '0' für Aus und '1' für Ein.

Universalausgänge: Ein Universalausang kann nur dann über seine ID ein/ausgeschaltet werden, wenn er auf manuell schalten konfiguriert ist ("System / Anschlussklemmen / Universalausgang x / Funktion / Haendisch"). Beim Abfragen und Schreiben, gilt '0' für Aus und '1' für Ein, wobei dies nur dann auch für den Relaiszustand gilt, wenn "System / Anschlussklemmen / Universalausgang x / Ausgangslogik / normal schalten" eingestellt ist. Bei "invers schalten" entspricht dann '1' einem ausgeschalteten Relais. Für die Universalausgänge 2 bis 5 stehen explizit keine Relais zur Verfügung. Diese Ausgänge sind also nur dann nutzbar, wenn sie Relais (im ALLPOOL oder im EXTENDER) zugeordnet ("System / Anschlussklemmen / Universalausgang x / Relaiszuordnung") sind.

Universaleingänge: Wenn ein Universaleingang als Temperaturmesser konfiguriert ist ("System / Anschlussklemmen / Universaleingang x / Anschlussart / Temperaturfuehler"), kann neben dem Schaltzustand Ein/Aus auch der Temperaturmesswert abgefragt werden. Daher gibt es für jeden Universaleingang, an den auch ein Temperaturfühler angeschlossen werden kann, zwei WerteID's.

Temperaturen: Alle Temperaturen werden in der Einheit Grad Celsius (°C) mit einer Nachkommastalle angegeben. Im String darf '°C' nicht enthalten sein.

	? Abfragezeichen im Detail

Das '?' Abfragezeichen wird verwendet, um einen aktuellen Wert vom ALLPOOL abzufragen. Es folgt hinter der WerteID.

Wenn unmittelbar nach dem '?' ein 'L' bzw 'l' (low) folgt, antwortet das ALLPOOL nicht mit dem aktuell eingestellten, sondern mit dem minimal erlaubten Wert.

Wenn unmittelbar nach dem '?' ein 'H' bzw 'h' (high) folgt, antwortet das ALLPOOL nicht mit dem aktuell eingestellten, sondern mit dem maximal erlaubten Wert.

	= Schreibzeichen im Detail

Das '=' Schreibzeichen wird verwendet, um einen neuen Wert im ALLPOOL zu setzen. Unmittelbar nach dem '=' muss der zu schreibende Wert folgen.

 Der zu schreibende Wert muss im richtigen Format und im erlaubten Bereich sein. Siehe Formate.

	Werte im Detail

Die Information, die gelesen '?' oder geschrieben '=' wird kann in diesen Formaten vorliegen. Bitte die korrekten Trennzeichen ('.' bzw. ':' verwenden). Beim Schreiben von Werten den erlaubten Wertebereich beachten. Den Bereich sehen Sie für jeden Wert in der Menüstruktur oder direkt am ALLPOOL probieren. Die erlaubten Bereiche können auch zwischen den Firmwareversionen unterschiedlich sein. Hier erahlten Sie auch detaillierte Infos zu Werten.

Alternativen:

Eine Alternative ist eine Auswahl verschiedener Möglichkeiten wie z.B. 'Auto | Aus | Ein' oder 'Ja | Nein' oder 'Dosierfreigabe | Sauerstoff | Intervall'.

Die gewünschte Alternative wird mittels String, der eine dezimalen Zahl laut der Position der Alternative darstellt angegeben, wobei mit 1 begonnen wird. Also bei 'Auto | Aus | Ein' bedeutet '1' Auto, '2' Aus und '3' Ein. Alle Alternativen und Reihenfolgt finden Sie in der Menüstruktur. Zur Sicherheit bitte auch direkt im ALLPOOL nachprüfen! Unterschiede zwischen Firmwareversionen sind möglich!

Temperaturen

Ein String, der eine dezimale Zahl mit einer Nachkommastelle darstellt. Also für 27,5°C '27.5'. Bitte nicht ',' statt '.' verwenden!

Uhrzeit

Ein String, der mit 2 dezimalen Zahlen, getrennt durch einen Doppelpunkt Stunden und Minuten enthält. Also für 22 Uhr 45 '22:45'.

Datum

Ein String, der mit 3 dezimalen Zahlen, getrennt durch Punkte Tag Monat Jahr enthält. Also für 28. Mai 2010 '28.05.10'.

	> OK-Zeichen im Detail

Wenn die Antwort des ALLPOOL mit dem '>' OK-Zeichen beginnt, war die zuvor gesendete Abfrage bzw. Schreibbefehl erfolgreich. Bei einer Abfrage erhält man unmittelbar nach dem '>' den angefragten Wert. Bei einem Schreibbefehl erhält man unmittelbar nach dem '>' den erfolgreich geschriebenen Wert.

	X Fehlerzeichen im Detail

Jede Antwort vom ALLPOOL beginnt entweder mit dem OK-Zeichen, oder mit dem 'X' Fehlerzeichen. Wenn der Antwortstring mit dem Fehlerzeichen beginnt, folgt unmittelbar dahinter der Grund für den Fehler in Form eines Fehlerbeschreibungszeichens.

Fehlerbeschreibungszeichen:

'c'...Prüfsumme stimmt nicht: Es liegt ein Übertragungsfehler vor. Siehe Prüfsumme.

'u'...WerteID ist unbekannt: Prüfen Sie korrekte ID laut der Menüstruktur und der WerteID-Tabelle. Fragen Sie die Firmwarenummer des ALLPOOL ab, und prüfen Sie, ob die ID bereits implementiert ist.

'l'...Wert ist zu klein: Minimal erlaubten Wert vor dem Schreiben mit '?l' abfragen. Wenn dieser Fehler beim Abfragen eines Temperaturmesswertes geantwortet wird, ist der Temperatursensor kurzgeschlossen.

'h'...Wert ist zu groß: Maximal erlaubten Wert vor dem Schreiben mit '?h' abfragen. Wenn dieser Fehler beim Abfragen eines Temperaturmesswertes geantwortet wird, ist der Temperatursensor unterbrochen.

's'...Wert ist außerhalb der erlaubten Schritte ('20.3' statt '20.0' oder '20.5'). Siehe Spalte 'Step' in der WerteID-Tabelle.

'i'...Wert kann nicht interpretiert werden. Z.B. Zahl erwartet, Buchstabe bekommen, ',' statt '.' angegeben.

'r'...Wert darf nur abgefragt, jedoch nicht geändert werden (Read only, z.B. Firmware-Versionsnummer, Messwerte). Siehe Spalte 'R|W' in der WerteID-Tabelle.

'x'...Zugriff verweigert: Wenn z.B. das ALLPOOL in den Expertenmodus geschaltet werden soll, jedoch ein falscher PIN angegeben wurde.

	$ Prüfsummenzeichen im Detail

Das '$' Prüfsummenzeichen teilt mit, dass die nächsten beiden Zeichen eine Prüfsumme sind. Die Prüfsumme ist eine hexadezimale Zahl, die als ASCII-String übertragen wird: '00' bis 'FF'. Im Dezimalsystem ausgedrückt also 0 bis 255. Sie können Groß– oder Kleinbuchstaben für die Hexzahl (A-F bzw. a-f) verwenden.

Die Prüfsumme wird aus allen Zeichen des Strings zwischen dem Startzeichen und '$' Prüfsummenzeichen errechnet. So kann der Empfänger prüfen, ob auch alle Zeichen fehlerfrei eingetroffen sind.

Die Prüfsumme wird so errechnet:

• Der ASCII-Wert des ersten Zeichens (eine Hex-Zahl zwischen 00 und FF) wird als aktuelle Prüfsumme gespeichert. 
• Das nächste Zeichen wird XOR (Exklusiv Oder) mit der aktuellen Prüfsumme verknüpft und als aktuelle Prüfsumme gespeichert. 
• Dies wiederholt sich solange, bis das letzte Zeichen erreicht ist.

In die Prüfsumme dürfen ausschließlich die Zeichen der Nutzdaten einbezogen werden. Also alle Zeichen zwischen dem Startzeichen '#' bzw. '%' oder '*' oder '>' oder 'X' und dem Prüfsumme-Startzeichen '$'.

Beispiel zur Berechnung einer Prüfsumme:

Angenommen, für den String '#120?\n' soll eine Prüfsumme ermittelt werden. Das '#' bzw. '%' Startzeichen wird ignoriert. Unser erstes Zeichen zur Berechnung der Prüfsumme ist die '1'. Sein ASCII-Wert ist hin Hex 31. Der ASCII-Wert des nächsten Zeichens '2' ist 32. Nun berechnen wir 31 XOR 32 und erhalten die Hex-Zahl 03. Der ASCII-Wert des nächsten Zeichens '0' ist 30. Somit berechnen wir 03 XOR 30 und erhalten 33. Der ASCII-Wert des nächsten Zeichens '?' ist 3F. Somit berechnen wir 33 XOR 3F und erhalten 0C. Dies ist unsere Prüfsumme. Somit schicken wir diesen String zum ALLPOOL: '#120?$0C\n'.

Übertragungsfehler erkennen:

Der Empfänger eines Strings kann mit Hilfe der Prüfsumme mit einer Sicherheit von 99.6% erkennen, ob der Empfangene String dem gesendeten entspricht. Also ob der String unverändert angekommen ist.

Wenn Sie dem ALLPOOL einen String mit Prüfsumme schicken, und das ALLPOOL erkennt, dass die Prüfsumme nicht stimmt, antwortet es mit einem Prüfsummenfehler: 'Xc'. Den String führt es in diesem Fall nicht aus.

Wenn Sie vom ALLPOOL einen String mit falscher Prüfsumme empfangen, dürfen Sie dieser Antwort nicht vertrauen, sondern müssen erneut anfragen.

Prüfsummenfunktion nutzen | nicht nutzen:

Wenn Sie Probleme mit dem Berechnen der Prüfsummen zum ALLPOOL haben, und keine Prüfsummen vom ALLPOOL erhalten wollen, lassen Sie die Prüfsumme inklusive dem '$' Prüfsummenzeichen einfach beim Senden weg. Das ALLPOOL antwortet in diesem Fall dann auch ohne Prüfsumme.

Wir empfehlen die Prüfsumme immer zu verwenden, da Übertragungsfehler erkannt werden können.

	\n Abschlußzeichen im Detail

Jede Zeile an das ALLPOOL muss mit dem CarriageReturn ('\n', CR, Hex-Zahl 0D) oder Linefeed ('\r', LF, Hex-Zahl 0A) - Zeichen abgeschlossen werden. Es können auch beide Zeichen hintereinander angegeben werden. Das zweite wird dann ignoriert.

Das ALLPOOL schließt seine Antwort immer mit beiden Zeichen ab: CR + LF (0D + 0A).

Eine unvollständige Zeile kann mit dem Abschlußzeichen abgebrochen werden. Wenn innerhalb der Timeout-Zeit seit Senden des Startzeichens '#' bzw. '%' kein Abschlußzeichen folgt, wird diese Zeile ignoriert.

	© UrheberrechtAchtung

Unsere Werke wie unsere Produkte und diese Homepage bzw. infoCD mit allen Texten, Grafiken, Fotos,  Konzepten, Prospekten, Betriebsanleitungen sowie das Design, Software und Konzept unserer Produkte sind Urheberrechtlich geschützt. So sind z.B. insbesondere der Infomodus, Universalein– & Universalausgang und die Bedienung des ALLPOOL rechtlich geschützt! Verstöße werden geahndet!