Logikbaustein: E-Mail OAuth

Portreferenzen

Estimated reading: 4 minutes 54 views

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

  • Binary wird im Beispiel als KNX DPT 1.001 (Schalten) projektiert.
  • String wird 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/1 sind Beispiele, keine fest im Baustein hinterlegten Adressen.

Parameter

Bezeichnung im GPAPropertyPorttypPflichtStandard / WertebereichKNX / Beispiel-GABeschreibung
Empfänger / ToToStringJaleerNicht zutreffendMindestens eine Zieladresse. Mehrere Adressen mit Komma oder Semikolon trennen.
Kopie / CcCcStringNeinleerNicht zutreffendSichtbare Kopien; mehrere Adressen mit Komma oder Semikolon.
Blindkopie / BccBccStringNeinleerNicht zutreffendVerdeckte Kopien; mehrere Adressen mit Komma oder Semikolon.
Absenderadresse / FromFromStringJaleerNicht zutreffendSichtbarer Absender; muss mit Konto oder erlaubter Send-as-Adresse übereinstimmen.
Absendername / From nameFromNameStringNeinleerNicht zutreffendOptionaler Anzeigename des Absenders.
Betreff / SubjectSubjectStringNeinE-Mail from Gira X1Nicht zutreffendBetreffvorlage; unterstützt {{ValueN}}.
Nachrichtentext / BodyBodyStringNeinMessage from Gira X1Nicht zutreffendReiner Text; unterstützt {{ValueN}} und Zeilenumbrüche.
SMTP-ServerSmtpHostStringJasmtp.gmail.comNicht zutreffendVollständiger Hostname des SMTP-Dienstes.
SMTP-PortSmtpPortIntegerJa587; Bereich 1–65535Nicht zutreffendMuss zur Verschlüsselungsart passen.
VerschlüsselungEncryptionEnumJaSTARTTLSNoneSSL/TLSSTARTTLSAutoNicht zutreffendTransportverschlüsselung der SMTP-Verbindung. None nur in kontrollierten Sonderfällen.
AuthentifizierungAuthenticationEnumJaPasswordPasswordOAuth2 Refresh TokenNicht zutreffendWählt Kennwort-/App-Passwort oder OAuth-Refresh-Token.
SMTP-BenutzerSmtpUserStringJaleerNicht zutreffendVollständiger SMTP-/XOAUTH2-Benutzer, gewöhnlich die E-Mail-Adresse.
SMTP-Kennwort / App-PasswortSmtpPasswordStringJa, bei Passwordleer; geheimNicht zutreffendNormales SMTP-Kennwort oder Provider-App-Passwort. Bei OAuth nicht verwendet.
OAuth-Client-IDOAuthClientIdStringJa, bei OAuthleerNicht zutreffendID des Clients, mit dem der Refresh-Token erzeugt wurde.
OAuth-Client-SecretOAuthClientSecretStringJa bei Form/Basic; nein bei Noneleer; geheimNicht zutreffendGeheimnis eines vertraulichen OAuth-Clients.
OAuth-Refresh-TokenOAuthRefreshTokenStringJa, bei OAuthleer; geheimNicht zutreffendLangfristiger, extern erzeugter Offline-Token.
OAuth-Token-EndpunktOAuthTokenEndpointStringJa, bei OAuthhttps://oauth2.googleapis.com/tokenNicht zutreffendHTTPS-Endpunkt für grant_type=refresh_token.
OAuth-ScopeOAuthScopeStringNeinleerNicht zutreffendOptional beim Refresh erneut angeforderter SMTP-Scope.
OAuth-Client-AuthentifizierungOAuthClientAuthenticationEnumNeinFormFormBasicNoneNicht zutreffendArt, wie Client-ID/Secret am Token-Endpunkt übertragen werden.
ZeitüberschreitungTimeoutSecondsInteger, SekundenNein30 s; Bereich 5–120Nicht zutreffendTimeout für Token- und SMTP-Aufrufe.
LizenzschlüsselLicenseKeyStringBedingtleer; geheimNicht zutreffendAktivierungscode für ProductCode EmailController; alternativ kann ein Offline-Token verwendet werden.
Offline-TokenOfflineTokenParamStringBedingtleer; geheimNicht zutreffendSignierter Offline-Lizenztoken.
VeröffentlichungskanalReleaseChannelParamEnumNeinstablestablebetarcNicht zutreffendKanal für Updateinformationen des Lizenzservers.
Offline-ProfilOfflineProfileParamEnumNeinprivateprivatebusinesspartnerNicht zutreffendProfil für die Offline-Lizenzierung.
Anzahl WerteNumberOfValuesIntegerNein2; Bereich 1–99Nicht zutreffendErzeugt dynamisch Value1 bis ValueN; Zähler wird vor der Eingangsliste initialisiert.

Eingänge

BezeichnungPropertyGPA-PorttypKNX-DPTBeispiel-GAPflichtBeschreibung
Senden / TriggerSendTriggerBinaryDPT 1.0011/0/1JaPositive Flanke startet den Versand. Während eines laufenden Versands wird ein weiterer Trigger abgewiesen. Beispiel: 0 = Ruhe1 = senden.
Wert 1 … Wert NValuesdynamische Liste StringDPT 16.0019/0/1 … 9/0/99NeinAnzahl 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:

PortBeispiel-GAKNX-DPTInhalt
Value19/0/1DPT 16.001Anlagenname, z. B. Pooltechnik
Value29/0/2DPT 16.001Temperaturtext, z. B. 27,4
Value39/0/3DPT 16.001Status, 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.

BezeichnungPropertyGPA-PorttypKNX-DPTBeispiel-GAOptionalBeschreibung
Erfolgreich / SuccessSuccessBinaryDPT 1.0011/1/1Ja1 nach erfolgreichem SMTP-Versand, sonst 0. Vor einem neuen Versuch wird auf 0 gesetzt.
StatusStatusStringDPT 16.0019/1/1JaReadySending...Message sent oder Fehlertext. Wegen möglicher Länge vorzugsweise intern/GPA verwenden.
LizenzstatusLicenseInfoStringDPT 16.0019/1/2JaErgebnis der zentralen Lizenzprüfung; kann länger als 14 Zeichen sein.
LizenzinhaberLicenseOwnerStringDPT 16.0019/1/3JaVom Lizenzserver gelieferter Inhaber.
X1-MAC-AdresseX1_MacAddressStringDPT 16.0019/1/4JaNormalisierte Geräteidentifikation; Diagnoseausgang, standardmäßig verborgen.
X1-SeriennummerX1_SerialStringDPT 16.0019/1/5JaSerien-/Geräteidentifikation für Lizenzierung; Diagnoseausgang.
Update verfügbarUpdateAvailableBinaryDPT 1.0011/1/2Ja1, wenn der Lizenzserver eine neuere Version meldet.
Neueste VersionLatestVersionStringDPT 16.0019/1/6JaVom Lizenzserver gemeldete Versionsnummer.
Download-URLDownloadUrlStringDPT 16.0019/1/7JaDownloadadresse; regelmäßig länger als KNX DPT 16 und daher primär intern verwenden.
Offline gültig bisOfflineExpiresAtStringDPT 16.0019/1/8JaLokalisierter Ablaufzeitpunkt des Offline-Tokens.

Vollständiges KNX-/GPA-Beispiel

Ziel: Bei einer Filterstörung wird eine E-Mail mit Anlagenname und Temperatur versendet.

FunktionPort / ParameterWert oder GruppenadresseTyp
AuslöserTrigger1/0/1DPT 1.001
AnlagennameValue19/0/1DPT 16.001
TemperaturValue29/0/2DPT 16.001
FehlertextValue39/0/3DPT 16.001
ErgebnisSuccess1/1/1DPT 1.001
KurzstatusStatus9/1/1DPT 16.001
AnzahlNumber of values3GPA-Parameter
BetreffSubjectStörung {{Value1}}: {{Value3}}GPA-Parameter String
TextBodyTemperatur: {{Value2}} °CGPA-Parameter String

Bei Value1 = PoolValue2 = 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.

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert

Share this Doc

Portreferenzen

Or copy link

CONTENTS