HGP 2.1 SMGW - Http Gateway Protocol - Erweiterung für SMARTY iQ-IO / Steuerbox

Die Seite wird erstellt Susanne Westphal
 
WEITER LESEN
HGP 2.1 SMGW - Http Gateway Protocol - Erweiterung für SMARTY iQ-IO / Steuerbox
Referenzen
Dr. Neuhaus

HGP 2.1
SMGW - Http Gateway Protocol
Erweiterung für SMARTY iQ-IO / Steuerbox

                                         Autor:         Sagemcom Dr. Neuhaus GmbH
                                                        (Herrmann Jürgen)

Zusammenfassung:
Das Dokument beschreibt die die Erweiterung des http Gateway Protokolls für die Kommunikation
Kommunikation zwischen des externen Markteilnehmern mit der Schaltbox.
Version:   1.9.1                      Datenmodel für Steuerbox
Datum:     20.02.2020                        SMARTY iQ-IO
Autor:     DNT                      HGP 2.1 (HTTP Gateway Protocol)

Sagemcom Dr. Neuhaus GmbH                                    Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                 Seite 2/46
Version:        1.9.1                                          Datenmodel für Steuerbox
 Datum:          20.02.2020                                            SMARTY iQ-IO
 Autor:          DNT                                          HGP 2.1 (HTTP Gateway Protocol)

Inhaltsverzeichnis
1     EINLEITUNG ..................................................................................................................................... 5
 1.1  Einführung ............................................................................................................................... 5
2 OFFENE PUNKTE ............................................................................................................................ 6
3 STEUERBOX – ERWEITERUNG ..................................................................................................... 7
4 POC LSG .......................................................................................................................................... 9
    4.1   lsg/hgp/cls – Knoten ................................................................................................................ 9
5     NETWORK – KNOTEN ................................................................................................................... 11
 5.1  han-cls - Netzwerkprofil ......................................................................................................... 11
6 SYSTEM - KNOTEN ....................................................................................................................... 14
 6.1   System – Status .................................................................................................................... 14
 6.2   Update – Status ..................................................................................................................... 14
 6.3   Firmware Update ................................................................................................................... 14
7 CLS DATEN OBJEKTE .................................................................................................................. 15
 7.1  Time ....................................................................................................................................... 15
 7.2  User-Profile ............................................................................................................................ 16
 7.3  Role-Profile ............................................................................................................................ 19
 7.4  Inputs ..................................................................................................................................... 21
 7.5  Test Button ............................................................................................................................ 22
 7.6  Remote Input ......................................................................................................................... 23
 7.7  Magnetic Sensor .................................................................................................................... 24
 7.8  Frequency Input ..................................................................................................................... 26
 7.9  Alive - Message ..................................................................................................................... 27
8 RELAYS DATEN OBJEKTE .......................................................................................................... 28
 8.1  Relays-Switch-All ................................................................................................................... 28
 8.2  Relay-Status-All ..................................................................................................................... 31
 8.4  Relays-Profile ........................................................................................................................ 34
 8.5  Swt-Profile ............................................................................................................................. 37
9 HAN – KNOTEN ............................................................................................................................. 43
  9.1        hanProfile – Kommunikationsprofil ........................................................................................ 43
10         ABKÜRZUNGSVERZEICHNIS ................................................................................................. 45
11         MITGELTENDE DOKUMENTE................................................................................................. 46

Sagemcom Dr. Neuhaus GmbH                                                                        Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                                                     Seite 3/46
Version:   1.9.1                            Datenmodel für Steuerbox
Datum:     20.02.2020                              SMARTY iQ-IO
Autor:     DNT                            HGP 2.1 (HTTP Gateway Protocol)

Änderungsverzeichnis
 Version     Datum        Wer   Kapitel              Änderung
 0.1         09.03.2015   DNT   alle                 Initial

 0.2         07.04.2015   DNT   alle                 Alle Kapitell überarbeitet

 0.3         09.04.2015   DNT   6.x                  User und Passwort wird nun immer im URI mitgege-
                                                     ben.
 0.4         14.04.2015   DNT   6.x                  Anpassung der Relais Methoden
                                7
 0.5         29.04.2015   DNT   7                    Überarbeitung der Relais Methoden

 1.0         31.07.2015   DNT   alle                 Überarbeitung HGP Baum, Relais Funktion, Userpro-
                                                     file und Rollenprofile
 1.1         10.09.2015   DNT   7                    Parameter Beschreibung angepasst

 1.2         01.08.2016   DNT   alle                 LSG durch Steuerbox ersetzt
                                                     Kapitel 5 Firmware Update ergänzt
                                                     Kopfzeile geändert

 1.3         10.11.2016   DNT   7.4                  Beispiel für Post Befehl ergänzt.

 1.4         01.09.2017   DNT   7.

 1.6         09.11.2017   DNT   3,7.5                Einführung switchtables, Knoten: swt

 1.7         05.02.2018   DNT   3,4.1,5              Einführung Netzwerkprofil, Knoten: network

 1.8         22.02.2018   DNT   8.1,8.5              Einführung Schaltstufen der fixen Codierung

 1.9         08.11.2019   DNT   3,7.9,9.1            Einführung der Alive-Message

Sagemcom Dr. Neuhaus GmbH                                          Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                       Seite 4/46
Version:    1.9.1                         Datenmodel für Steuerbox
Datum:      20.02.2020                           SMARTY iQ-IO
Autor:      DNT                         HGP 2.1 (HTTP Gateway Protocol)

1          Einleitung
1.1 Einführung
In einer Smart-Meter Architektur nach BSI Vorgaben kommunizieren Schaltboxen mit den externen
Marktteilnehmern. Das hier beschriebene Http Gateway Protocol beschreibt die Kommunikation zwi-
schen diesen Komponenten.
Das Dokument erweitert das Dokument „HGP 2.1 SMGW – http Gateway Protocol“ um die Kommuni-
kation des EMT mit der Schaltbox.
Es werden nicht alle Funktionen des HGP 2.1 SMGW Protokolls übernommen. Die aufgenommen wer-
den hier explizit aufgeführt.
Des Weiteren werden hier alle Funktionen für die Steuerbox mit aufgenommen, auch die die nicht von
Anfang an in der Steuerbox unterstützt werden, sondern erst im Laufe der weiteren Entwicklung in der
Software implementiert werden.

Sagemcom Dr. Neuhaus GmbH                                        Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                     Seite 5/46
Version:    1.9.1                          Datenmodel für Steuerbox
Datum:      20.02.2020                            SMARTY iQ-IO
Autor:      DNT                          HGP 2.1 (HTTP Gateway Protocol)

2          Offene Punkte
Der Abschnitt zeigt offene Punkte auf.

Sagemcom Dr. Neuhaus GmbH                                         Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                      Seite 6/46
Version:    1.9.1                           Datenmodel für Steuerbox
Datum:      20.02.2020                             SMARTY iQ-IO
Autor:      DNT                           HGP 2.1 (HTTP Gateway Protocol)

3          Steuerbox – Erweiterung
Die Grafik zeigt den Aufbau des HGP-Baumes in der Funktionalität der Steuerbox. Die Struktur wurde
um die Funktionalität der Schaltbox erweitert. Aus Sicht des SMGW ist die Struktur nur für den Empfang
von Messwerten aus der Push-Funktionalität der Auswertungsprofile vorgesehen. Ein Auslesen durch
das SMGW ist nicht vorgesehen.
Die TLS-Verbindung wird immer durch das SMGW aufgebaut, die inhaltliche Serverkomponente wird
durch die Steuerbox-Funktion bereitgestellt.

Sagemcom Dr. Neuhaus GmbH                                          Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                       Seite 7/46
Version:   1.9.1                           Datenmodel für Steuerbox
Datum:     20.02.2020                             SMARTY iQ-IO
Autor:     DNT                           HGP 2.1 (HTTP Gateway Protocol)

Übersicht Steuerbox Erweiterung:

             lsg                                                                                    statisches Objekt

                                                                                                 dynamisches Objekt
                        hgp
                                                                                                           Methode
                                   cls                                CLS Funktionen

                                          time                        Zeit lesen / ändern

                                         lsgrole                      Rollen

                                                        EMT
                                                       Kunde
                                                   Netzbetreiber
                                                    Notbetreiber
                                                       Update

                                         lsguser                      Benutzer

                                                         EM
                                                         KU
                                                         NE
                                                         NO
                                                         UP

                                          relays                      Relais

                                                   relay-switch-all              Schalthandlung aller Relais durchführen

                                                   relay-status-all              aktueller Status aller Relais

                                                   relays_profile

                                                                   relay-status                  aktueller Status des Relais

                                                                   relay-switch                  aktueller Status aller Relais

                                                         swt                                     Schalttabellen (switchtables)

                                                                                            Profil mit 

                              network                                                       Profil mit 

                                         han-cls                      Netzwerkkonfiguration CLS-1/CLS-2

                               han

                                         service                      HAN Kommunikationsprotokoll Profil

Sagemcom Dr. Neuhaus GmbH                                                Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                             Seite 8/46
Version:      1.9.1                            Datenmodel für Steuerbox
Datum:        20.02.2020                              SMARTY iQ-IO
Autor:        DNT                            HGP 2.1 (HTTP Gateway Protocol)

4          PoC LSG
Die Objekte unterhalb des PoC sind in den Steuerbox Funktionen vorhanden. Die Objekte können nicht
per GET ausgelesen werden.
Die Datenstruktur ist nur für den Empfang von Messwerten über die Push-Funktion der Auswertungs-
profile vorgesehen.

4.1 lsg/hgp/cls – Knoten

Beschreibung
Die Objekte bilden die Baumstruktur auf Steuerbox-Seite ab. Die Zusammenfassung der Objekte in
einer URI bildet die Ordnungsstruktur für das Entgegennehmen von Methoden oder Parameter ab.

Envelope
Envelope-lsg-out

URI
/lsg/hgp/cls/

XML-Elemente und Attribute

rev                   integer = 1...n
                      Version des Objektes

description           string

Sagemcom Dr. Neuhaus GmbH                                             Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                          Seite 9/46
Version:   1.9.1                      Datenmodel für Steuerbox
Datum:     20.02.2020                        SMARTY iQ-IO
Autor:     DNT                      HGP 2.1 (HTTP Gateway Protocol)

XML-Notation

      method
      time config
   
      ccHgpInputs
      inputs Folder
   
      ccHgpLsgRole
      Lsg Role Profile Folder
   
      ccHgpLsgUser
      Lsg User Profile Folder
   
      ccHgpRelays
      relay Folder
   
Sagemcom Dr. Neuhaus GmbH                                    Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                Seite 10/46
Version:    1.9.1                         Datenmodel für Steuerbox
Datum:      20.02.2020                           SMARTY iQ-IO
Autor:      DNT                         HGP 2.1 (HTTP Gateway Protocol)

5          network – Knoten
5.1 han-cls - Netzwerkprofil

Beschreibung
Das Netzwerkprofil han-cls enthält alle notwendigen Parameter, um das physikalische Netzwerkinter-
face CLS-1/CLS-2 am Lsg zu konfigurieren. Zum Betrieb des Lsg an einem SMGW müssen Netzwerk-
profil han-cls und han Kommunikationsprofil im SMGW äquivalent konfiguriert werden. Dieses Profil
kann nicht gelöscht oder deaktiviert werden. Bei Erstinbetriebnahme des Lsg wird der Betriebsmodus
BONJOUR hergestellt.

Envelope
Envelope-lsg-out / Envelope-lsg-in
URI
GET /lsg/hgp/network/han-cls
POST /lsg/hgp/network/han-cls

Sagemcom Dr. Neuhaus GmbH                                        Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                    Seite 11/46
Version:    1.9.1                               Datenmodel für Steuerbox
Datum:      20.02.2020                                 SMARTY iQ-IO
Autor:      DNT                               HGP 2.1 (HTTP Gateway Protocol)

XML-Elemente und Attribute

network-profile

rev                      integer = 1...n
                         Version des Objektes
id                       Objectid = han-cls
                         Eindeutiger Bezeichner (ObjectID)
description              string (optional)
                         Beschreibung

mode                     string = FIXEDIP | BONJOUR
                         Der Parameter bestimmt die Betriebsart des Interfaces.
                         FIXEDIP wired LAN mit fester IP-Adresse
                         BONJOUR wired LAN mit MDNS und Auto-IP (default)

ip4                      IPv4Address (nur für mode = FIXEDIP)
                         feste IPv4-Adresse

netmask                  IPv4-Netmask (nur für mode = FIXEDIP)
                         Netzwerkmaske für die zu benutzende feste IPv4-Adresse
gateway                  IPv4Adress (nur für mode = FIXEDIP, optional)
                         Default gateway für die zu benutzende feste IP-Adresse
dnsserver                IPv4Adress (nur für mode = FIXEDIP, optional)
                         Angabe von max. 2 DNS Servern

XML-Notation BONJOUR

Das Beispiel zeigt das Netzwerkprofil han-cls zur Konfiguration der Lsg Schnittstelle CLS-1/CLS-2 im
Modus BONJOUR (default).

      BONJOUR
   
Sagemcom Dr. Neuhaus GmbH                                              Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                          Seite 12/46
Version:   1.9.1                            Datenmodel für Steuerbox
Datum:     20.02.2020                              SMARTY iQ-IO
Autor:     DNT                            HGP 2.1 (HTTP Gateway Protocol)

XML-Notation FIXEDIP

Das Beispiel zeigt das Netzwerkprofil han-cls zur Konfiguration der Lsg Schnittstelle CLS-1/CLS-2 mit
fester IPv4-Adresse.

      FIXEDIP
      192.168.200.1
      255.255.255.0
      192.168.200.254
      172.24.100.1
      172.24.100.2
   
Sagemcom Dr. Neuhaus GmbH                                          Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                      Seite 13/46
Version:    1.9.1                           Datenmodel für Steuerbox
Datum:      20.02.2020                             SMARTY iQ-IO
Autor:      DNT                           HGP 2.1 (HTTP Gateway Protocol)

6          system - Knoten

6.1 System – Status
Beschreibung
Siehe HGP 2.1 SMGW – http Gateway Protocol „7.16 system - Knoten“

6.2 Update – Status
Beschreibung
Siehe HGP 2.1 SMGW – http Gateway Protocol „7.16 system - Knoten“

6.3 Firmware Update
Beschreibung
Siehe auch HGP 2.1 SMGW – http Gateway Protocol „7.16 system - Knoten“

Mit der POST Methode wird eine Update-Datei in die Steuerbox geladen und installiert.
Über die GET Methode kann die aktuelle Version der Steuerbox ausgelesen werden.

URI
GET /lsg/hgp/system?method=update&user=&password=
POST /lsg/hgp/system?method=update&filename=

GET update       keine Parameter
Die Methode liefert die aktuellen Versionen von Anwendung, Betriebssystem und Betriebssystemkernel
im Update-Status Objekt (siehe HGP 2.1 SMGW – http Gateway Protocol 10.3, Seite 86).

POST update filename=
Mit der Methode wird eine Update-Datei in die Steuerbox geladen und installiert. Die binäre Updatedatei
wird ohne XML-Umfassung im POST-Content als „Content-Type=application/update“ per HTTP über-
tragen.

Sagemcom Dr. Neuhaus GmbH                                          Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                      Seite 14/46
Version:     1.9.1                           Datenmodel für Steuerbox
Datum:       20.02.2020                             SMARTY iQ-IO
Autor:       DNT                           HGP 2.1 (HTTP Gateway Protocol)

7           CLS Daten Objekte

7.1 Time
Beschreibung
Das Objekt wird durch den Methodenaufruf time geliefert. Es muss zu jedem Aufruf eine Authentifizie-
rung des Users mit dem Passwort mitgeschickt werden. Wird ein Zeit Objekt an die Steuerbox mit der
richtigen Berechtigung (user / pass) geschickt, wird die Uhrzeit aktualisiert.

Envelope
Envelope-lsg-out / Envelope-lsg-in

URI
GET /lsg/hgp/cls?method=time&user=&password=
POST /lsg/hgp/cls?method=time&user=&password=

XML-Elemente und Attribute

switch

    rev              integer = 1...n
                    Version des Objektes

    utc              dateTime
                     Aktuelle UTC Zeit Information

    local            dateTime
                     Gibt die aktuelle Lokale Zeit an. (Sommer- Winterzeit)

XML-Notation

      2015-03-10T00:00:00Z
      2015-03-10T01:00:00
  
Sagemcom Dr. Neuhaus GmbH                                           Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                       Seite 15/46
Version:   1.9.1                        Datenmodel für Steuerbox
Datum:     20.02.2020                          SMARTY iQ-IO
Autor:     DNT                        HGP 2.1 (HTTP Gateway Protocol)

7.2 User-Profile
Beschreibung
Das Objekt wird durch den Methodenaufruf usermanagement geliefert, oder verändert. Es muss zu
jedem Aufruf eine Authentifizierung des Users mit dem Passwort mitgeschickt werden.

Envelope
Envelope-lsg-out / Envelope-lsg-in

URI
GET /lsg/hgp/cls/lsguser/?user=&password=
POST /lsg/hgp/cls/lsguser/?user=&password=
DELETE /lsg/hgp/cls/lsguser/?user=&password=

XML-Elemente und Attribute

Sagemcom Dr. Neuhaus GmbH                                      Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                  Seite 16/46
Version:      1.9.1                              Datenmodel für Steuerbox
Datum:        20.02.2020                                SMARTY iQ-IO
Autor:        DNT                              HGP 2.1 (HTTP Gateway Protocol)

 rev                       integer = 1...n
                           Version des Objektes
 user-name                 string
                           Benutzername der in der Schaltbox hinterlegt werden soll oder ist.
 full-user-name            string
                           Der komplette Name des Benutzers
 company                   string
                           Firmenname des Benutzers
 system-defined            bool
                            wenn der Benutzer standardmäßig in der Software vorgegeben ist.
                            wenn der Benutzer hinzugefügt wurde
 password                  string
                           Zugehöriges Passwort zum Benutzer
 role-name                 string
                           Eintrag aus der Rollen Tabelle
                           Dem Benutzer muss eine Rolle zugewiesen werden um Prioritäten verwalten zu
                           können.
 password                  string
                           nicht lesbar;
                           wird durch schreiben gesetzt
 user-right                bool
 granted                    wenn das Recht erlaubt ist;
                            wenn das Recht nicht erlaubt ist;
 user-right                bool
 exclusive                  wenn das Recht nicht übersteuert werden kann
                            wenn das Recht übersteuert werden kann
                           (exclusive Rollenrechte haben Vorrang)

Sagemcom Dr. Neuhaus GmbH                                               Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                           Seite 17/46
Version:   1.9.1                            Datenmodel für Steuerbox
Datum:     20.02.2020                              SMARTY iQ-IO
Autor:     DNT                            HGP 2.1 (HTTP Gateway Protocol)

XML-Notation

      generic LSG USER Profile
      
         EM
         Emil Mt
         
         true
         EMT
         *****
         
            Relay_Switch_Allowed
            Relay_GetStatus_Allowed
            Relay_SetConfig_Allowed
         
Sagemcom Dr. Neuhaus GmbH                                          Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                      Seite 18/46
Version:     1.9.1                               Datenmodel für Steuerbox
Datum:       20.02.2020                                 SMARTY iQ-IO
Autor:       DNT                               HGP 2.1 (HTTP Gateway Protocol)

7.3 Role-Profile
Beschreibung
Das Objekt wird durch den jeweiligen Knoten unter lsgrole geliefert, oder verändert. Es muss zu jedem
Aufruf eine Authentifizierung des Users mit dem Passwort mitgeschickt werden.

Envelope
Envelope-lsg-out / Envelope-lsg-in

URI
GET /lsg/hgp/cls/lsgrole/?user=&password=
POST /lsg/hgp/cls/lsgrole/?user=&password=
DELETE /lsg/hgp/cls/lsgrole/?user=&password=

XML-Elemente und Attribute

rev                       integer = 1...n
                          Version des Objektes
role-name                 string
                          Rollenname der in der Schaltbox hinterlegt werden soll oder ist.
system-defined            bool
                           wenn die Rolle standardmäßig in der Software vorgegeben ist.
                           wenn die Rolle hinzugefügt wurde
priority                  integer = 0 .. 4
                          Priorität der Rolle
                          0 == niedrigste Priorität
                          4 == höchste Priorität
user-right                bool
granted                    wenn das Recht erlaubt ist;
                           wenn das Recht nicht erlaubt ist;
user-right                bool
exclusive                  wenn das Recht nicht übersteuert werden kann
                           wenn das Recht übersteuert werden kann
                          (exclusive Rollenrechte haben Vorrang)

Sagemcom Dr. Neuhaus GmbH                                               Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                           Seite 19/46
Version:   1.9.1                            Datenmodel für Steuerbox
Datum:     20.02.2020                              SMARTY iQ-IO
Autor:     DNT                            HGP 2.1 (HTTP Gateway Protocol)

XML-Notation

      generic LSG ROLE Profile
      
         EMT
         true
         1
         
            Relay_Switch_Allowed
            Relay_GetStatus_Allowed
            Relay_SetConfig_Allowed
         
Sagemcom Dr. Neuhaus GmbH                                          Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                      Seite 20/46
Version:   1.9.1                           Datenmodel für Steuerbox
Datum:     20.02.2020                             SMARTY iQ-IO
Autor:     DNT                           HGP 2.1 (HTTP Gateway Protocol)

7.4 Inputs
Beschreibung
Das Objekt wird durch den Knoten inputs geliefert. Es muss zu jedem Aufruf eine Authentifizierung des
Users mit dem Passwort mitgeschickt werden.

Envelope
Envelope-lsg-out / Envelope-lsg-in

URI
GET /lsg/hgp/cls/inputs/?user=&password=

XML-Elemente und Attribute

      inputs Folder
   
Sagemcom Dr. Neuhaus GmbH                                         Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                     Seite 21/46
Version:    1.9.1                           Datenmodel für Steuerbox
 Datum:      20.02.2020                             SMARTY iQ-IO
 Autor:      DNT                           HGP 2.1 (HTTP Gateway Protocol)

7.5 Test Button
Beschreibung
Das Objekt wird durch den Methodenaufruf testbutton geliefert. Es muss zu jedem Aufruf eine Authen-
tifizierung des Users mit dem Passwort mitgeschickt werden. Das Testbutton Objekt gibt den aktuellen
Zustand des Testknopfes zurück.

Envelope
Envelope-lsg-out / Envelope-lsg-in

URI
GET /lsg/hgp/cls/inputs?method=testbutton&user=&password=

XML-Elemente und Attribute

switch

   rev               integer = 1...n
                    Version des Objektes

   pressed           bool
                     Aktueller Zustand des Testknopfes
   short             bool
                     Kurze Betätigung des Testknopfes erkannt
   long              bool
                     Langer Betätigung (>10s) des Testknopfes erkannt
   test              bool
                     Testprogramm aktiv

XML-Notation

   false
      false
      false
      false
  
Sagemcom Dr. Neuhaus GmbH                                           Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                       Seite 22/46
Version:   1.9.1                           Datenmodel für Steuerbox
 Datum:     20.02.2020                             SMARTY iQ-IO
 Autor:     DNT                           HGP 2.1 (HTTP Gateway Protocol)

7.6 Remote Input
Beschreibung
Das Objekt wird durch den Methodenaufruf rm1geliefert. Es muss zu jedem Aufruf eine Authentifizierung
des Users mit dem Passwort mitgeschickt werden. Das rm1 Objekt gibt den aktuellen Zustand des
Rückmeldeeingangs zurück.

Envelope
Envelope-lsg-out / Envelope-lsg-in

URI
GET /lsg/hgp/cls/inputs?method=rm1&user=&password=

XML-Elemente und Attribute

switch

   rev              integer = 1...n
                   Version des Objektes

   rm1              bool
                    Aktueller Zustand des Rückmeldeeingangs
XML-Notation

   false
  
Sagemcom Dr. Neuhaus GmbH                                          Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                      Seite 23/46
Version:   1.9.1                           Datenmodel für Steuerbox
Datum:     20.02.2020                             SMARTY iQ-IO
Autor:     DNT                           HGP 2.1 (HTTP Gateway Protocol)

7.7 Magnetic Sensor
Beschreibung
Das Objekt wird durch den Methodenaufruf magsensor geliefert. Es muss zu jedem Aufruf eine Authen-
tifizierung des Users mit dem Passwort mitgeschickt werden. Das magsensor Objekt gibt die aktuellen
Werte des magnetischen Sensors zurück.

Envelope
Envelope-lsg-out / Envelope-lsg-in

URI
GET /lsg/hgp/cls/inputs?method=magsensor&user=&password=

XML-Elemente und Attribute

switch

   rev             integer = 1...n
                  Version des Objektes

   bx              integer
                   Aktueller Wert der Flußdichte in der X-Richtung in µTesla

   by              integer
                   Aktueller Wert der Flußdichte in der Y-Richtung in µTesla

   bz              integer
                   Aktueller Wert der Flußdichte in der Z-Richtung in µTesla

   temp            integer
                   Aktuelle Temperatur am magnetischen Sensor

   fusetripped     bool
                   Zeigt an ob eine magnetische Manipulation erkannt wurde

Sagemcom Dr. Neuhaus GmbH                                         Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                     Seite 24/46
Version:   1.9.1                      Datenmodel für Steuerbox
Datum:     20.02.2020                        SMARTY iQ-IO
Autor:     DNT                      HGP 2.1 (HTTP Gateway Protocol)

XML-Notation

C:\Users\herrmann\AppData\Local\Temp\smgw_wansim.xml 
    196 uT
    196 uT
    -98 uT
     19 Grad
     true
  
Sagemcom Dr. Neuhaus GmbH                                    Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                Seite 25/46
Version:   1.9.1                           Datenmodel für Steuerbox
 Datum:     20.02.2020                             SMARTY iQ-IO
 Autor:     DNT                           HGP 2.1 (HTTP Gateway Protocol)

7.8 Frequency Input
Beschreibung
Das Objekt wird durch den Methodenaufruf frequency geliefert. Es muss zu jedem Aufruf eine Authen-
tifizierung des Users mit dem Passwort mitgeschickt werden. Das frequency Objekt gibt den aktuellen
Wert der Netzfrequenz zurück.

Envelope
Envelope-lsg-out / Envelope-lsg-in

URI
GET /lsg/hgp/cls/inputs?method=frequency&user=&password=

XML-Elemente und Attribute

switch

   rev              integer = 1...n
                   Version des Objektes

   frequency        double
                    Aktueller Wert der Netzfrequenz
XML-Notation

   50.0
  
Sagemcom Dr. Neuhaus GmbH                                          Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                      Seite 26/46
Version:   1.9.1                            Datenmodel für Steuerbox
Datum:     20.02.2020                              SMARTY iQ-IO
Autor:     DNT                            HGP 2.1 (HTTP Gateway Protocol)

7.9 Alive - Message
Beschreibung
Das Objekt wird bei bestehender HAN-TLS Verbindung in einem konstanten Intervall erzeugt und ver-
sendet. Die Aktivierung und Konfiguration der Alive-Message erfolgt im hanProfile – Kommunikations-
profil (siehe Kap. 9.1). Die Alive-Message wird immer unkomprimiert übertragen.

Envelope
Envelope-lsg-out

URI
POST /emt/hgp/service?method=alive

XML-Elemente und Attribute

alive

   rev             integer = 1
                   Version des Objektes

   device-id       string
                   Herstellerübergreifende Identifikationsnummer der versendenden Schaltbox (14-
                   stellig).

XML-Notation

        EDNT0016083838
    
Sagemcom Dr. Neuhaus GmbH                                          Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                      Seite 27/46
Version:    1.9.1                          Datenmodel für Steuerbox
Datum:      20.02.2020                            SMARTY iQ-IO
Autor:      DNT                          HGP 2.1 (HTTP Gateway Protocol)

8          Relays Daten Objekte

8.1 Relays-Switch-All
Beschreibung
Das Objekt wird durch den Methodenaufruf relay-switch-all geliefert. Durch Aufruf dieser Methode wer-
den die Relais direkt geschaltet. Durch Angabe der Schaltstufenkombination und einem Leistungswert
werden die zugehörenden Schaltausgänge zu einer Schaltstufe gem. fixer Codierung geschaltet. Es
muss zu jedem Aufruf eine Authentifizierung des Users mit dem Passwort mitgeschickt werden.

Schaltstufenkombination und Zustand der Schaltstufen:
power_4
    Schaltstufe entsprechend der                        Zustand der Schaltausgänge
           Leistung P in %               S1                 S2              W1               W2
             0 =< P < 30                 on                 off             off              off
            30  P < 100                off                off             on               off
              P = 100                    off                off             off              on

power_s
    Schaltstufe entsprechend der                        Zustand der Schaltausgänge
           Leistung P in %                        S1                                 S2
            0 =< P < 100                          on                                 off
              P = 100                             off                                on

power_w
    Schaltstufe entsprechend der                        Zustand der Schaltausgänge
           Leistung P in %                        W1                                 W2
            0 =< P < 100                          on                                 off
              P = 100                             off                                on

Sagemcom Dr. Neuhaus GmbH                                         Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                     Seite 28/46
Version:      1.9.1                              Datenmodel für Steuerbox
Datum:        20.02.2020                                SMARTY iQ-IO
Autor:        DNT                              HGP 2.1 (HTTP Gateway Protocol)

Envelope
Envelope-lsg-out / Envelope-lsg-in

URI
POST /lsg/hgp/cls/relays?method=relay-switch-all&user=&password=

XML-Elemente und Attribute

switch

   rev                integer = 1...n
                     Version des Objektes
   state              string = on | off | discard | xxx
                      Schaltet das zugehörige Relais oder alle einer Schaltstufenkombination zugehörigen
                      Relais in den angegebenen Zustand. Bei Bezug auf eine Schaltstufenkombination
                      muss hier der Leistungswert P im Bereich von 0…100 angegeben werden.
   priority           string = Prioritätsnummer (Optional)
                      die gewünschte Priorität für den Schaltbefehl. Kann nur kleiner-gleich der Priorität
                      der dem User zugeordneten Rolle sein
   duration           string = xxxs | xxxm | xxxh | xxxd | inf
                      Mit dem Parameter duration kann eine gültige Zeit für die vorgenommene Schalt-
                      handlung angegeben werden. Die Kürzel hinter dem Zeitparameter kann „s“ Sekun-
                      den, „m“ Minuten, „h“ Stunden oder „d“ Tage annehmen. Wenn der Parameter mit
                      „inf“ angegeben wird, wird der Schaltzustand bis zur nächsten Änderung beibehal-
                      ten.
   activationDelay string = xxxs | xxxm | xxxh | xxxd
                      Mit dem Parameter activationDelay kann ein Zeitbereich angegeben werden inner-
                      halb dessen der Schaltvorgang aktiviert wird. Die genaue Aktivierungszeit wird zu-
                      fällig in diesem Bereich gewählt. Soll der Schaltvorgang sofort aktiviert werden ist „“
                      oder „0s“ anzugeben.

Sagemcom Dr. Neuhaus GmbH                                               Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                           Seite 29/46
Version:   1.9.1                         Datenmodel für Steuerbox
Datum:     20.02.2020                           SMARTY iQ-IO
Autor:     DNT                         HGP 2.1 (HTTP Gateway Protocol)

XML-Notation
Schalten der einzelnen Relais:

Schalten der Schaltstufenkombination power_4 auf 75% (Schaltausgang W1=on), nur ein Eintrag zu-
lässig:

Schalten der Schaltstufenkombinationen power_s und power_w, keine weiteren Einträge möglich:

Schalten der Schaltstufenkombination power_s und der beiden Relais W1 und W2:

Sagemcom Dr. Neuhaus GmbH                                       Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                   Seite 30/46
Version:   1.9.1                            Datenmodel für Steuerbox
Datum:     20.02.2020                              SMARTY iQ-IO
Autor:     DNT                            HGP 2.1 (HTTP Gateway Protocol)

8.2 Relay-Status-All
Beschreibung
Das Objekt wird durch den Methodenaufruf relay-status-all geliefert. Es muss zu jedem Aufruf eine Au-
thentifizierung des Users mit dem Passwort mitgeschickt werden.

Envelope
Envelope-lsg-out / Envelope-lsg-in

URI
GET /lsg/hgp/cls/relays?method=relay-status-all&user=&password=

XML-Elemente und Attribute

switch

   rev             integer = 1...n
                   Version des Objektes

   relay_s1        string
                   Bezeichnet das Relais für das der Zeichensatz gültig ist..

   relay_s2        string
                   Bezeichnet das Relais für das der Zeichensatz gültig ist.

   relay_w1        string
                   Bezeichnet das Relais für das der Zeichensatz gültig ist.

   relay_w2        string
                   Bezeichnet das Relais für das der Zeichensatz gültig ist.

   actualState     XML Struktur
                   Beschreibt den aktuellen Schaltzustand des Relais.

   delayedStates   XML Struktur
                   Beinhaltet Schaltbefehle, welche noch in der Schaltverzögerung liegen. Nach Ablauf
                   der Verzögerung wird der entsprechende Schaltbefehl in die Liste „activeStates“ ver-
                   schoben, wobei er einen evtl. bereits vorhandenen Schaltbefehl überschreibt.

   activeStates    XML Struktur
                   Beinhaltet Schaltbefehle, welche zu Schalthandlungen herangezogen werden. Es
                   wird immer der Schaltbefehl mit der höchsten Priorität am Relais ausgeführt. Ist der
                   Schaltbefehl nicht „infinite“, wird er nach der „endTime“ aus der Liste gelöscht.

Sagemcom Dr. Neuhaus GmbH                                          Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                      Seite 31/46
Version:      1.9.1                             Datenmodel für Steuerbox
Datum:        20.02.2020                               SMARTY iQ-IO
Autor:        DNT                             HGP 2.1 (HTTP Gateway Protocol)

   relayCommand string = on | off
                      Gibt den Schaltzustand des Relais an.

   priority           string = 0 … 4
                      Gibt die Priorität für den Schaltbefehl an.

   activationTime string Zeit UTC
                      Gibt an, ab welcher Systemzeit der Befehl gültig ist

   endTime            string Zeit UTC
                      Gibt an, ab wann der Befehl gelöscht wird. Wenn „infinite“ auf „true“ steht, ist diese
                      Zeit ohne Bedeutung

   infinite           string = true | false
                      Gibt an, ob der Befehl unendlich gültig ist oder einen Ablauf-Zeitpunkt („endTime“)
                      hat.

XML-Notation

         relay_s1
         
               on
               0
               2015-07-14T09:15:45Z
               2015-07-14T09:15:43Z
               true
            
               on
               0
               2015-07-14T09:15:45Z
               2015-07-14T09:15:43Z
               true
            
         relay_s2
         
               on
               0
               2015-07-14T09:15:44Z
               2015-07-14T09:15:43Z
               true
            
Sagemcom Dr. Neuhaus GmbH                                              Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                          Seite 32/46
Version:   1.9.1                            Datenmodel für Steuerbox
Datum:     20.02.2020                              SMARTY iQ-IO
Autor:     DNT                            HGP 2.1 (HTTP Gateway Protocol)

               on
               0
               2015-07-14T09:15:44Z
               2015-07-14T09:15:43Z
               true
            
         relay_w1
         
               on
               0
               2015-07-14T09:15:45Z
               2015-07-14T09:15:43Z
               true
            
               on
               0
               2015-07-14T09:15:45Z
               2015-07-14T09:15:43Z
               true
            
         relay_w2
         
               on
               0
               2015-07-14T09:15:43Z
               2015-07-14T09:15:43Z
               true
            
               on
               0
               2015-07-14T09:15:43Z
               2015-07-14T09:15:43Z
               true
            
Sagemcom Dr. Neuhaus GmbH                                          Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                      Seite 33/46
Version:   1.9.1                           Datenmodel für Steuerbox
Datum:     20.02.2020                             SMARTY iQ-IO
Autor:     DNT                           HGP 2.1 (HTTP Gateway Protocol)

8.4 Relays-Profile
Beschreibung
Das Objekt wird durch den Knoten relays-profile geliefert. Es muss zu jedem Aufruf eine Authentifizie-
rung des Users mit dem Passwort mitgeschickt werden.

Envelope
Envelope-lsg-out / Envelope-lsg-in

URI
GET /lsg/hgp/cls/relays/relays_profile?user=&password=
POST /lsg/hgp/cls/relays/relays_profile?user=&password=

Sagemcom Dr. Neuhaus GmbH                                         Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                     Seite 34/46
Version:    1.9.1                             Datenmodel für Steuerbox
Datum:      20.02.2020                               SMARTY iQ-IO
Autor:      DNT                             HGP 2.1 (HTTP Gateway Protocol)

XML-Elemente und Attribute

rev                       integer = 1...n
                          Version des Objektes
relayMgr-config           globale Konfiguration des Relais Managers

startupSwitchDelay-       integer
RandomRangeSeconds        Gibt den Sekundenbereich an in dem die zufällige Schaltverzögerung nach
                          dem booten liegt
useStartupSwitchDelay     bool
                          Gibt an ob die Schaltverzögerung nach dem booten benutzt werden soll
relay-configs             Konfiguration einzelner Relais

relayName                 string
                          Gibt den Namen des Relais an
                          (relay_s1 | relay_s2 | relay_w1 | relay_w2)
de-                       string
faultStartupSwitchState   Gibt den vordefinierten Schaltzustand nach dem booten an
                          (on | off)
defaultShut-              string
downSwitchState           Gibt den vordefinierten Schaltzustand beim shutdown an
                          (on | off)
activationDelayRan-       integer
domRangeSecondsDe-        Gibt den Sekundenbereich an in dem die zufällige Schaltverzögerung wäh-
fault                     rend der Laufzeit liegt
useDe-                    bool
faultStartupSwitchState   Gibt an ob der vordefinierte Schaltzustand nach dem booten benutzt wer-
                          den soll.
                          Bei  wird der letzte Schaltzustand benutzt
useDefaultShut-           bool
downSwitchState           Gibt an ob der vordefinierte Schaltzustand beim shutdown benutzt werden
                          soll
saveSwitchStatesDur-      bool
ingPowerOff               Gibt an ob die interne Prioritätstabelle mit den Schaltzuständen beim shut-
                          down gespeichert oder verworfen werden soll
waitForSwitchCom-         bool
mandAfterPowerOn          Gibt an ob die Schaltbox nach dem booten auf einen Schaltbefehl warten
                          soll, bevor die evtl. gespeicherte Prioritätstabelle wieder verarbeitet wird.

Sagemcom Dr. Neuhaus GmbH                                            Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                        Seite 35/46
Version:   1.9.1                            Datenmodel für Steuerbox
Datum:     20.02.2020                              SMARTY iQ-IO
Autor:     DNT                            HGP 2.1 (HTTP Gateway Protocol)

XML-Notation

         20
         false
         
               relay_s1
               off
               off
               0
               false
               true
               true
               false
            
               relay_s2
               off
               off
               0
               false
               true
               true
               false
            
               relay_w1
               off
               off
               0
               false
               true
               true
               false
            
               relay_w2
               off
               off
               0
               false
               true
               true
               false
            
Sagemcom Dr. Neuhaus GmbH                                          Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                      Seite 36/46
Version:   1.9.1                              Datenmodel für Steuerbox
Datum:     20.02.2020                                SMARTY iQ-IO
Autor:     DNT                              HGP 2.1 (HTTP Gateway Protocol)

8.5 Swt-Profile
Beschreibung
Das Objekt wird durch den jeweiligen Knoten swt geliefert. Es muss zu jedem Aufruf eine Authentifizie-
rung des Users mit dem Passwort mitgeschickt werden.
Es können mehrere Schalttabellen als Profil eingespielt werden, die Identifikation erfolgt anhand der
eindeutigen . 24h nach Ablauf des Datumparameters  wird die Schalttabelle aus dem
Gerät entfernt.
Die Definition der Schaltzeitpunkte ist identisch mit den Parametern einer crontab Steuerdatei. Zur De-
finition eines Schaltvorganges  sind immer 5 Zeitparameter anzugeben. Ein einzelner Zeitpunkt
wird durch Angabe eines numerischen Einzelwertes definiert. Mehrere Zeitangaben können als Aufzäh-
lung getrennt durch „,“ angegeben werden. Ein Zeitraum wird definiert durch „-„. Zeitintervalle können
durch „/“ definiert werden. Mit „*“ erfolgt zu jeder Zeiteinheit ein Schaltvorgang. Die zeitliche Definition
des Schaltvorganges erfolgt als local time.
Zeitschaltpläne können für einzelne Relais und auch Schaltstufenkombinationen erstellt und als Profil
eingespielt werden. Die Definition der Schaltstufen ist Kap. 8.1 zu entnehmen.

Envelope
Envelope-lsg-out / Envelope-lsg-in

URI
GET /lsg/hgp/cls/relays/swt/?user=&password=
POST /lsg/hgp/cls/relays/swt/?user=&password=
DELETE /lsg/hgp/cls/relays/swt/?user=&password=

Sagemcom Dr. Neuhaus GmbH                                            Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                        Seite 37/46
Version:   1.9.1                               Datenmodel für Steuerbox
Datum:     20.02.2020                                 SMARTY iQ-IO
Autor:     DNT                               HGP 2.1 (HTTP Gateway Protocol)

Beispiele für die Konfiguration der cron – Zeitparameter:

                        Zeitparameter                                               Zeitpunkte
 Minutes    Hours         Days      Months       Weekday
 15         20            23        02           *           Am 23.02., Uhr 20:15

 15         20            *         02           *           Im Februar täglich um Uhr 20:15

 *          *             *         *            *           Zu jeder vollen Minute, jede Stunde, jeder Tag und Mo-
                                                             nat
 */2        *             *         *            *           Zu jeder geraden Minute, jede Stunde, jeder Tag und
                                                             Monat
 *          */2           *         *            *           Jede Minute innerhalb jeder geraden Stunde

 *          *             */2       *            *           Jede Minute eines geraden Tages im Monat, also am
                                                             2.,4.,6. Usw.
 *          *             *         */2          *           Jede Minute innerhalb der geraden Monate (Feb, Apr,
                                                             Jun… etc.)
 *          *             *         *            */2         Jede Minute am Dienstag, Donnerstag, Samstag und
                                                             Sonntag einer jeden Woche, jeden Monats.
 15-45      *             *         *            *           Zu jeder Minute zwischen der 15. und 45. Minute einer
                                                             Stunde
 15-45      8-16          *         *            *           Zu jeder Minute zwischen der 15. Und 45. Minute ab
                                                             Uhr 08:00 bis 17:00 (letzter Zeitpunkt 16:45)
 *          *             1-7       5-9          *           Zu jeder Minute zwischen 1. Und 7. Der Monate Mai bis
                                                             September
 *          *             *         5-9          1-5         Zu jeder Minute, werktags (Mo-Fr) in den Monaten Mai
                                                             bis September
 1-59/2     *             *         *            *           Zu jeder ungeraden Minute jeder Stunde

 0          8-16/3        *         *            *           Zu jeder 3.ten Stunde ab 08:00 bis 16:00, also 08:00,
                                                             11:00, 14:00 eines jeden Tages
 0          10            5-31/7    *            1           Um 10:00 eines jeden 7. Tages ab dem 5. Tag im Monat
                                                             und jeden Montag
 0          10            *         1-3,8,9      *           Um 10:00 eines jeden Tages in den Monaten Jan-Mär,
                                                             Aug, Sep

Sagemcom Dr. Neuhaus GmbH                                              Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                          Seite 38/46
Version:      1.9.1                              Datenmodel für Steuerbox
Datum:        20.02.2020                                SMARTY iQ-IO
Autor:        DNT                              HGP 2.1 (HTTP Gateway Protocol)

XML-Elemente und Attribute

switchtable

rev                        integer = 1...n
                           Version des Objektes
id                         Objectid
                           Eindeutiger Bezeichner (ObjectID)
validFrom,                 String
[validTo]                  Gültigkeit der Steuertabelle. Datum von bis. Ist kein validTo angegeben, ist die
                           Tabelle ab validFrom dauerhaft gültig. Format: TT.MM.JJJJ
[description]              String

switchhandler

type                       string
                           Gibt den Namen des Relais oder der Schaltstufenkombination an, auf das sich
                           die Schalthandlungen beziehen
                           (relay_s1 | relay_s2 | relay_w1 | relay_w2 | power_4 | power_s | power_w)
priority                   String = 0…4
                           Gibt die Priorität der Schalthandlungen an.

Sagemcom Dr. Neuhaus GmbH                                                Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                            Seite 39/46
Version:   1.9.1                                 Datenmodel für Steuerbox
Datum:     20.02.2020                                   SMARTY iQ-IO
Autor:     DNT                                 HGP 2.1 (HTTP Gateway Protocol)

Action

type                    string = on | off | discard | xxx
                        Definiert die Schalthandlung. Bezieht sich die Schalthandlung auf ein einzelnes
                        Relais, so sind nur die Zustände „on“ oder „off“ zulässig. Bei Schalten einer
                        Schaltstufenkombination ist hier der Leistungswert P im Bereich 0..100 anzuge-
                        ben. Der Zustand „discard“ ist bei beiden Arten der Schalthandlung zulässig.
duration                string = xxxs | xxxm | xxxh | xxxd | inf
                        Mit dem Parameter duration kann eine gültige Zeit für die vorgenommene
                        Schalt-handlung angegeben werden. Die Kürzel hinter dem Zeitparameter kann
                        „s“ Sekunden, „m“ Minuten, „h“ Stunden oder „d“ Tage annehmen. Wenn der
                        Parameter mit „inf“ angegeben wird, wird der Schaltzustand bis zur nächsten
                        Änderung beibehalten. Eine Zeitangabe von „0“ ist unzulässig.
activationDelay         string = xxxs | xxxm | xxxh | xxxd
                        Mit dem Parameter activationDelay kann ein Zeitbereich angegeben werden in-
                        ner-halb dessen der Schaltvorgang aktiviert wird. Die genaue Aktivierungszeit
                        wird zu-fällig in diesem Bereich gewählt. Soll der Schaltvorgang sofort aktiviert
                        werden ist „“ oder „0s“ anzugeben.
Minutes                 string
                        Definiert den Schaltzeitpunkt zur vollen Minute. Zulässiger Wertebereich ist
                        0..59. Weitere Definitionen können durch die Zeichen „/“ (Intervall), „,“ (Aufzäh-
                        lung), „*“ (Jede), „-„ (Zeitspanne) angegeben werden.
Hours                   string
                        Definiert den Schaltzeitpunkt zur vollen Stunde. Zulässiger Wertebereich ist
                        0..23. Weitere Definitionen können durch die Zeichen „/“ (Intervall), „,“ (Aufzäh-
                        lung), „*“ (Jede), „-„ (Zeitspanne) angegeben werden.
Days                    string
                        Definiert den Schaltzeitpunkt zum Tag innerhalb des Monats. Zulässiger Wer-
                        tebereich ist 1..31. Weitere Definitionen können durch die Zeichen „/“ (Intervall),
                        „,“ (Aufzählung), „*“ (Jede), „-„ (Zeitspanne) angegeben werden.
Months                  string
                        Definiert den Schaltzeitpunkt des Monats innerhalb des Jahres. Zulässiger
                        Wertebereich ist 1..12. Weitere Definitionen können durch die Zeichen „/“ (Inter-
                        vall), „,“ (Aufzählung), „*“ (Jede), „-„ (Zeitspanne) angegeben werden.
Weekday                 string
                        Definiert den Schaltzeitpunkt bezogen auf den Wochentag. Zulässiger Wer-
                        tebereich ist 0..7, wobei 0 und 7 den Sonntag definiert, 1 = Montag, 2 = Diens-
                        tag usw. Weitere Definitionen können durch die Zeichen „/“ (Intervall), „,“ (Auf-
                        zählung), „*“ (Jede), „-„ (Zeitspanne) angegeben werden.

Sagemcom Dr. Neuhaus GmbH                                               Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                           Seite 40/46
Version:     1.9.1                           Datenmodel für Steuerbox
Datum:       20.02.2020                             SMARTY iQ-IO
Autor:       DNT                           HGP 2.1 (HTTP Gateway Protocol)

XML-Notation

Zeitschaltplan für die Relais S1 und S2:

         Beschreibung
         
               30
               *
               *
               *
               1-5
            
            0
            8
            *
            */2
            0,6
         
             0
             19
             *
             */2
             0,6
         
    •      Relais S1 wird werktags (Mo-Fr) zu jeder halben Stunde für die Dauer von 10min auf ON ge-
           schaltet
    •      Relais S2 wird jeden zweiten Monat (Feb, Apr, Jun,…) samstags und sonntags um Uhr 08:00
           mit einer Verzögerung von bis zu 120s eingeschaltet und um Uhr 19:00 ausgeschaltet

Sagemcom Dr. Neuhaus GmbH                                           Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                       Seite 41/46
Version:     1.9.1                          Datenmodel für Steuerbox
Datum:       20.02.2020                            SMARTY iQ-IO
Autor:       DNT                          HGP 2.1 (HTTP Gateway Protocol)

Zeitschaltplan für die Leistungsregelung der Schaltstufenkombination power_4:

         Leistungsregelung
         
               0
               8
               *
               *
               1
            
               15
               20
               *
               *
               5
            
    •      Schaltstufenkombination power_4 wird jeden Montag verzögert um bis zu 5 Minuten auf 100%
           geschaltet (W2=ON, S1/S2/W1=OFF) und jeden Freitag verzögert um bis zu einer Stunde auf
           20% gedrosselt (S1=ON, S2/W1/W2=OFF).

Sagemcom Dr. Neuhaus GmbH                                          Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                      Seite 42/46
Version:       1.9.1                              Datenmodel für Steuerbox
Datum:         20.02.2020                                SMARTY iQ-IO
Autor:         DNT                              HGP 2.1 (HTTP Gateway Protocol)

9          han – Knoten
9.1 hanProfile – Kommunikationsprofil
Beschreibung
Das HAN-Kommunikationsprofil enthält alle notwendigen Parameter, um eine Verbindung im HAN ent-
gegen zu nehmen (TLS - Server). Es existiert nur das Profil mit der id=“service“, welches fest verknüpft
ist mit dem Netzwerkprofil han-cls. Dieses han-Profil kann weder gelöscht, noch deaktiviert werden. Es
können auch keine weiteren han-Profile angelegt werden.

Envelope
Envelope-lsg-out / Envelope-lsg-in

URI
GET /lsg/hgp/han/service
POST /lsg/hgp/han/service

XML-Elemente und Attribute

han-profile

    rev                integer = 3
                       Version des Objektes
    description        string
                       Beschreibung
    enable             boolean = true
                       Das Profil ist stets aktiv.
    Ip-port            integer = 1024…65334
                       Der Parameter setzt den TCP-Port, auf dem der TLS-Server eingehende Verbindun-
                       gen entgegen nimmt. Es sind nur die frei verwendbaren Ports zulässig (> 1024).
                       Per default ist der Listener auf Port 5555 konfiguriert. Wird ein anderer Port gewählt,
                       so ist auch der Zielport des HAN-Profils des SMGWs dementsprechend zu konfigu-
                       rieren.
    keepalive

    enable             boolean = true | false
                       Der Parameter aktiviert/deaktiviert den Mechanismus zum automatischen Versen-
                       den von Alive-Nachrichten (default = enable).
    interval           integer = 60…172800
                       Intervall in Sekunden, die zwischen dem Generieren von 2 Alive-Nachrichten ver-
                       geht (default = 7200). Die erste Alive-Nachricht wird 2 min nach Aufbau der ersten
                       TLS-Verbindung zwischen SMGW und Schaltbox versendet, sofern interval>=300

Sagemcom Dr. Neuhaus GmbH                                                Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                            Seite 43/46
Version:   1.9.1                           Datenmodel für Steuerbox
Datum:     20.02.2020                             SMARTY iQ-IO
Autor:     DNT                           HGP 2.1 (HTTP Gateway Protocol)

                   konfiguriert ist. Andernfalls erfolgt der erste Versand der Alive-Nachricht 10s nach
                   Aufbau der ersten TLS-Verbindung.
  retry            integer = 1…10
                   Anzahl der Sendeversuche einer Alive-Nachricht. Bei Sendefehlern bzw. Ausbleiben
                   der Empfangsbestätigung werden retry-1 Wiederholungen durchgeführt (default = 1,
                   keine Wiederholungen). Bei einer Konfiguration von retry>1 erfolgt die Wiederholung
                   in folgenden Intervallen (s): 30,60,120,240,480,960,1920,3840,7680.

XML-Notation

        Service default HAN profile
        true
        5555
        
            true
            7200
            1
        
Sagemcom Dr. Neuhaus GmbH                                         Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                     Seite 44/46
Version:   1.9.1                             Datenmodel für Steuerbox
Datum:     20.02.2020                               SMARTY iQ-IO
Autor:     DNT                             HGP 2.1 (HTTP Gateway Protocol)

10 Abkürzungsverzeichnis
 BZ                     Betriebszertifikate
 CLS                    Controllable Local System (zusätzliche Einrichtungen/Geräte im HAN)
 CSR                    Certificate Signing Request
 EMT                    Externer Marktteilnehmer
 GWA                    Smart Meter Gateway Administrator
 HAN                    Home Area Network
 HGP                    HTTP Gateway Protocol
 LMN                    Local Metrological Network
 MAC                    Message Authentication Code
 PoC                    Point of Contact
 SMGW                   Smart Meter Gateway
 TLS                    Transport Layer Security
 TR                     Technische Richtlinie
 URI                    Uniform Ressource Identifier
 XML                    extensible markup language
 LSG                    Steuerbox (Lastschalt Gerät)

Sagemcom Dr. Neuhaus GmbH                                           Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                       Seite 45/46
Version:   1.9.1                          Datenmodel für Steuerbox
Datum:     20.02.2020                            SMARTY iQ-IO
Autor:     DNT                          HGP 2.1 (HTTP Gateway Protocol)

11 Mitgeltende Dokumente
 [1]            [TR03109-1] Technische Richtlinie BSI TR-03109-1 Anforderungen an die
                Interoperabilität der Kommunikationseinheit eines intelligenten Messsystem
 [2]            [TR03116-3] Technische Richtlinie BSI TR-03116-3 Kryptografische Vorgaben für
                Projekte der Bundesregierung: Intelligente Messsysteme
 [3]            [TR03109-1-Anlage-CMS] CMS-Datenformat für die Inhaltsdatenverschlüsselung
                und Signatur
 [4]            smgw-hgp-2-0.xsd
 [5]            [BSI-TR-03111-Elliptic Curve Cryptography] - Elliptic Curve Cryptography

Sagemcom Dr. Neuhaus GmbH                                        Vertraulich / Strictly confidential!
Datei: Dr.Neuhaus_Steuerbox_Datamodell_HGP_1v9.1.docx                                    Seite 46/46
Sie können auch lesen