Portreferenzen
Port- und Parameterreferenz – E-Mail Controller 2.6.0
Diese Referenz ist der verbindliche Katalog aller GPA-Parameter, Eingänge und Ausgänge des Logikbausteins. Die Beispiel-Gruppenadressen dienen nur als Projektierungsvorschlag und müssen an das jeweilige KNX-Projekt angepasst werden.
Hinweise zu KNX-Typen
Binarywird im Beispiel als KNX DPT 1.001 (Schalten) projektiert.Stringwird im Beispiel als KNX DPT 16.001 (ISO-8859-1-Zeichenkette) projektiert. Ein KNX-Telegramm dieses DPT transportiert höchstens 14 Zeichen. Längere Status-, Lizenz- oder URL-Texte sind primär für interne Logikverbindungen und die GPA-Diagnose gedacht; bei Ausgabe auf KNX muss die Längenbegrenzung berücksichtigt werden.- Parameter werden im GPA gespeichert und besitzen keine KNX-Gruppenadresse.
- Gruppenadressen wie
1/0/1sind Beispiele, keine fest im Baustein hinterlegten Adressen.
Parameter
| Bezeichnung im GPA | Property | Porttyp | Pflicht | Standard / Wertebereich | KNX / Beispiel-GA | Beschreibung |
|---|---|---|---|---|---|---|
| Empfänger / To | To | String | Ja | leer | Nicht zutreffend | Mindestens eine Zieladresse. Mehrere Adressen mit Komma oder Semikolon trennen. |
| Kopie / Cc | Cc | String | Nein | leer | Nicht zutreffend | Sichtbare Kopien; mehrere Adressen mit Komma oder Semikolon. |
| Blindkopie / Bcc | Bcc | String | Nein | leer | Nicht zutreffend | Verdeckte Kopien; mehrere Adressen mit Komma oder Semikolon. |
| Absenderadresse / From | From | String | Ja | leer | Nicht zutreffend | Sichtbarer Absender; muss mit Konto oder erlaubter Send-as-Adresse übereinstimmen. |
| Absendername / From name | FromName | String | Nein | leer | Nicht zutreffend | Optionaler Anzeigename des Absenders. |
| Betreff / Subject | Subject | String | Nein | E-Mail from Gira X1 | Nicht zutreffend | Betreffvorlage; unterstützt {{ValueN}}. |
| Nachrichtentext / Body | Body | String | Nein | Message from Gira X1 | Nicht zutreffend | Reiner Text; unterstützt {{ValueN}} und Zeilenumbrüche. |
| SMTP-Server | SmtpHost | String | Ja | smtp.gmail.com | Nicht zutreffend | Vollständiger Hostname des SMTP-Dienstes. |
| SMTP-Port | SmtpPort | Integer | Ja | 587; Bereich 1–65535 | Nicht zutreffend | Muss zur Verschlüsselungsart passen. |
| Verschlüsselung | Encryption | Enum | Ja | STARTTLS; None, SSL/TLS, STARTTLS, Auto | Nicht zutreffend | Transportverschlüsselung der SMTP-Verbindung. None nur in kontrollierten Sonderfällen. |
| Authentifizierung | Authentication | Enum | Ja | Password; Password, OAuth2 Refresh Token | Nicht zutreffend | Wählt Kennwort-/App-Passwort oder OAuth-Refresh-Token. |
| SMTP-Benutzer | SmtpUser | String | Ja | leer | Nicht zutreffend | Vollständiger SMTP-/XOAUTH2-Benutzer, gewöhnlich die E-Mail-Adresse. |
| SMTP-Kennwort / App-Passwort | SmtpPassword | String | Ja, bei Password | leer; geheim | Nicht zutreffend | Normales SMTP-Kennwort oder Provider-App-Passwort. Bei OAuth nicht verwendet. |
| OAuth-Client-ID | OAuthClientId | String | Ja, bei OAuth | leer | Nicht zutreffend | ID des Clients, mit dem der Refresh-Token erzeugt wurde. |
| OAuth-Client-Secret | OAuthClientSecret | String | Ja bei Form/Basic; nein bei None | leer; geheim | Nicht zutreffend | Geheimnis eines vertraulichen OAuth-Clients. |
| OAuth-Refresh-Token | OAuthRefreshToken | String | Ja, bei OAuth | leer; geheim | Nicht zutreffend | Langfristiger, extern erzeugter Offline-Token. |
| OAuth-Token-Endpunkt | OAuthTokenEndpoint | String | Ja, bei OAuth | https://oauth2.googleapis.com/token | Nicht zutreffend | HTTPS-Endpunkt für grant_type=refresh_token. |
| OAuth-Scope | OAuthScope | String | Nein | leer | Nicht zutreffend | Optional beim Refresh erneut angeforderter SMTP-Scope. |
| OAuth-Client-Authentifizierung | OAuthClientAuthentication | Enum | Nein | Form; Form, Basic, None | Nicht zutreffend | Art, wie Client-ID/Secret am Token-Endpunkt übertragen werden. |
| Zeitüberschreitung | TimeoutSeconds | Integer, Sekunden | Nein | 30 s; Bereich 5–120 | Nicht zutreffend | Timeout für Token- und SMTP-Aufrufe. |
| Lizenzschlüssel | LicenseKey | String | Bedingt | leer; geheim | Nicht zutreffend | Aktivierungscode für ProductCode EmailController; alternativ kann ein Offline-Token verwendet werden. |
| Offline-Token | OfflineTokenParam | String | Bedingt | leer; geheim | Nicht zutreffend | Signierter Offline-Lizenztoken. |
| Veröffentlichungskanal | ReleaseChannelParam | Enum | Nein | stable; stable, beta, rc | Nicht zutreffend | Kanal für Updateinformationen des Lizenzservers. |
| Offline-Profil | OfflineProfileParam | Enum | Nein | private; private, business, partner | Nicht zutreffend | Profil für die Offline-Lizenzierung. |
| Anzahl Werte | NumberOfValues | Integer | Nein | 2; Bereich 1–99 | Nicht zutreffend | Erzeugt dynamisch Value1 bis ValueN; Zähler wird vor der Eingangsliste initialisiert. |
Eingänge
| Bezeichnung | Property | GPA-Porttyp | KNX-DPT | Beispiel-GA | Pflicht | Beschreibung |
|---|---|---|---|---|---|---|
| Senden / Trigger | SendTrigger | Binary | DPT 1.001 | 1/0/1 | Ja | Positive Flanke startet den Versand. Während eines laufenden Versands wird ein weiterer Trigger abgewiesen. Beispiel: 0 = Ruhe, 1 = senden. |
| Wert 1 … Wert N | Values | dynamische Liste String | DPT 16.001 | 9/0/1 … 9/0/99 | Nein | Anzahl 1–99 über NumberOfValues. Der Block steht durch DisplayOrder = 1000 ganz unten. Value1 ersetzt {{Value1}}, Value2 ersetzt {{Value2}} usw. Vorherige Zahlen-/Binärwerte müssen in String konvertiert werden. |
Beispiel für drei dynamische Werte:
| Port | Beispiel-GA | KNX-DPT | Inhalt |
|---|---|---|---|
Value1 | 9/0/1 | DPT 16.001 | Anlagenname, z. B. Pooltechnik |
Value2 | 9/0/2 | DPT 16.001 | Temperaturtext, z. B. 27,4 |
Value3 | 9/0/3 | DPT 16.001 | Status, z. B. Filterdruck |
Ausgänge
Alle Ausgänge sind für den Versand selbst optional. Sie sollten für Diagnose und Visualisierung mindestens während der Inbetriebnahme verbunden werden.
| Bezeichnung | Property | GPA-Porttyp | KNX-DPT | Beispiel-GA | Optional | Beschreibung |
|---|---|---|---|---|---|---|
| Erfolgreich / Success | Success | Binary | DPT 1.001 | 1/1/1 | Ja | 1 nach erfolgreichem SMTP-Versand, sonst 0. Vor einem neuen Versuch wird auf 0 gesetzt. |
| Status | Status | String | DPT 16.001 | 9/1/1 | Ja | Ready, Sending..., Message sent oder Fehlertext. Wegen möglicher Länge vorzugsweise intern/GPA verwenden. |
| Lizenzstatus | LicenseInfo | String | DPT 16.001 | 9/1/2 | Ja | Ergebnis der zentralen Lizenzprüfung; kann länger als 14 Zeichen sein. |
| Lizenzinhaber | LicenseOwner | String | DPT 16.001 | 9/1/3 | Ja | Vom Lizenzserver gelieferter Inhaber. |
| X1-MAC-Adresse | X1_MacAddress | String | DPT 16.001 | 9/1/4 | Ja | Normalisierte Geräteidentifikation; Diagnoseausgang, standardmäßig verborgen. |
| X1-Seriennummer | X1_Serial | String | DPT 16.001 | 9/1/5 | Ja | Serien-/Geräteidentifikation für Lizenzierung; Diagnoseausgang. |
| Update verfügbar | UpdateAvailable | Binary | DPT 1.001 | 1/1/2 | Ja | 1, wenn der Lizenzserver eine neuere Version meldet. |
| Neueste Version | LatestVersion | String | DPT 16.001 | 9/1/6 | Ja | Vom Lizenzserver gemeldete Versionsnummer. |
| Download-URL | DownloadUrl | String | DPT 16.001 | 9/1/7 | Ja | Downloadadresse; regelmäßig länger als KNX DPT 16 und daher primär intern verwenden. |
| Offline gültig bis | OfflineExpiresAt | String | DPT 16.001 | 9/1/8 | Ja | Lokalisierter Ablaufzeitpunkt des Offline-Tokens. |
Vollständiges KNX-/GPA-Beispiel
Ziel: Bei einer Filterstörung wird eine E-Mail mit Anlagenname und Temperatur versendet.
| Funktion | Port / Parameter | Wert oder Gruppenadresse | Typ |
|---|---|---|---|
| Auslöser | Trigger | 1/0/1 | DPT 1.001 |
| Anlagenname | Value1 | 9/0/1 | DPT 16.001 |
| Temperatur | Value2 | 9/0/2 | DPT 16.001 |
| Fehlertext | Value3 | 9/0/3 | DPT 16.001 |
| Ergebnis | Success | 1/1/1 | DPT 1.001 |
| Kurzstatus | Status | 9/1/1 | DPT 16.001 |
| Anzahl | Number of values | 3 | GPA-Parameter |
| Betreff | Subject | Störung {{Value1}}: {{Value3}} | GPA-Parameter String |
| Text | Body | Temperatur: {{Value2}} °C | GPA-Parameter String |
Bei Value1 = Pool, Value2 = 27,4 und Value3 = Filterdruck entsteht:
Betreff: Störung Pool: Filterdruck
Text: Temperatur: 27,4 °C
Die KNX-Stringbegrenzung ist bei den Beispielwerten einzuhalten oder durch interne Logikverbindungen zu umgehen.