Universalzeitschaltuhren
Inhalt
In dieser Maske werden die Universalzeitschaltuhren verwaltet.

Um Befehle oder Befehlsfolgen zu bestimmten Zeiten zu starten bzw. nach Ablauf einer bestimmten Zeitspanne wieder zu stoppen, können Sie im HS/FS Universalzeitschaltuhren verwenden. Einer Universalzeitschaltuhr können bis zu 100 Funktionen zugeordnet werden, wobei jeder Funktion mehrere Befehle zugeordnet werden können.
Der Anwender ordnet den Funktionen im laufenden HS/FS die Ausführungszeitpunkte zu. Er bildet eine sog. Aktion aus Funktion und Ausführungszeitpunkt.

Weitere Informationen zur Anwendung finden Sie hier.

Ferner kann die Uhr im HS/FS über das Internet mit einem Zeitnormal -dem sogenannten Time-Server- oder über den EIB synchronisiert werden. Die Einstellungen werden unter Stammdaten\Projekt\Zeitabgleich vorgenommen.

Die Einstellung der Universalzeitschaltuhr ist nur bei laufenden HS/FS über eine der Bedienoberflächen möglich. Die Universalzeitschaltuhren werden remanent im HS/FS gespeichert.

Universalzeitschaltuhren können über die Globale Bibliothek importiert und exportiert werden.

1.Register

1.1.Daten

Bezeichnung

Unter diesem Begriff wird die Universalzeitschaltuhr im HS/FS-Experten geführt.
Über die Endpunkt-Schnittstelle können Universalzeitschaltuhren gesucht werden, bei denen ein Wort aus der Bezeichnung mit dem dort verwendeten Suchwort beginnt.

Steuerung: Ein-/Ausschalten über K.-Objekt

Über das folgende Kommunikationsobjekt kann die Uhr aktiviert oder deaktiviert werden. Gleichzeitig wird dieser Status in der Bedienoberfläche dem Anwender angezeigt. Hier kann der Anwender den Status umschalten. Ein Umschalten innerhalb der Bedienoberfläche ändert auch den Wert des Kommunikationsobjektes. Hat das Kommunikationsobjekt den Wert 1, so ist die Universalzeitschaltuhr aktiviert. Hat das Kommunikationsobjekt den Wert 0, so ist die Universalzeitschaltuhr deaktiviert.
Das Kommunikationsobjekt ist nicht zwingend notwendig für den Betrieb der Universalzeitschaltuhr. Wird kein Kommunikationsobjekt zugeordnet, so kann die Uhr nur über die Bedienoberfläche aktiviert/deaktiviert werden.

1.1.1.Funktionen

Diese Funktionen werden dem Anwender im Bedienmenü des HS/FS bei dieser Universalzeitschaltuhr angezeigt. In der folgenden Maske werden die Befehle zu jeder Funktion angelegt.
Aktions-Text
Dieser Text bezeichnet eine Zusammenstellung von Befehlen und wird bei laufendem HS/FS im Bedienmenü angezeigt. Die Befehle werden in der nachfolgenden Liste angelegt.
Hinweis
Nur verfügbar beim Anlegen/Bearbeiten einer Funktion.

1.2.Endpunkt

Auf Universalzeitschaltuhren kann über die Endpunkte-Schnittstelle des HS/FS zugegriffen werden.
Eine Beschreibung der Aufruf-Parameter gibt es hier.
Hinweis
Anstelle der in allen Aufruf-Beispielen in der folgenden Tabelle eingesetzten Universalzeitschaltuhr, kann natürlich jede beliebige Universalzeitschaltuhr verwendet werden.

Platzhalter sind in GROSSBUCHSTABEN angegeben.

1.2.1.Methoden

MethodeBeschreibung/Aufruf
metaAbruf von Meta-Daten der Universalzeitschaltuhr.
https://HS_IP/endpoints/call?key=TI@my_uzsu&method=meta&user=USER&pw=PWD
get_stateAbruf des aktuellen Zustands (aktiv oder inaktiv).
https://HS_IP/endpoints/call?key=TI@my_uzsu&method=get_state&user=USER&pw=PWD
set_activeAktiviert die Universalzeitschaltuhr.
https://HS_IP/endpoints/call?key=TI@my_uzsu&method=set_active&user=USER&pw=PWD
set_inactiveDeaktiviert die Universalzeitschaltuhr.
https://HS_IP/endpoints/call?key=TI@my_uzsu&method=set_inactive&user=USER&pw=PWD
get_eventsAbruf einer Liste mit allen definierten Ereignisse.
https://HS_IP/endpoints/call?key=TI@my_uzsu&method=get_events&user=USER&pw=PWD
add_eventFügt der Universalzeitschaltuhr ein Ereignis. Je nach Art des Ereignisses müssen unterschiedliche Parameter mitgegeben werden.

Wochentage und Uhrzeit: (Dienstags und Donnerstags, 17:30 Uhr, Jeden Tag, Aktion-ID aus Abruf 'method=meta')
https://HS_IP/endpoints/call?key=TI@my_uzsu&method=add_event&date_type=1&weekdays=1,3&time_type=1&time=1730&filter=0&action=123&user=USER&pw=PWD
set_eventModifiziert ein bestehendes Ereignis. Je nach Art des Ereignisses müssen unterschiedliche Parameter mitgegeben werden.

Modifiziere das Beispiel aus 'add_event': Füge 'Mittwoch' hinzu. (event_id aus Abruf 'method=meta')
https://HS_IP/endpoints/call?key=TI@my_uzsu&method=set_event&event_id=789&weekdays=1,2,3&user=USER&pw=PWD
del_eventLöscht ein bestehendes Ereignis. (event_id aus Abruf 'method=meta')
https://HS_IP/endpoints/call?key=TI@my_uzsu&method=del_event&event_id=789&user=USER&pw=PWD
simulateLiefert die Zeitpunkte innerhalb des angegebenen Zeitraums (Angabe in Tagen, max. 28), an denen Ereignisse ausgelöst werden.
https://HS_IP/endpoints/call?key=TI@my_uzsu&method=simulate&days=5&user=USER&pw=PWD

1.2.2.Ereignis

Beschreibung der Struktur eines Ereignisses.
  • event_id - ID des Ereignisses.
  • date_type - Bestimmt die Art der Datums-Angabe
    • 1 => Wochentage
    • 2 => Zeitraum
    • 3 => Einzeldatum
  • Nur, wenn date_type = 1:
    • weekdays - Liste mit den aktivierten Wochentagen (0=Montag, 6=Sonntag).
  • Nur, wenn date_type = 2:
    • date1 - Erster Tag, an dem das Ereignis ausgelöst werden soll (Datumsangabe im Format "yymmdd").
    • date2 - Letzter Tag, an dem das Ereignis ausgelöst werden soll (Datumsangabe im Format "yymmdd").
  • Nur, wenn date_type = 3:
    • day - Tag (1-31), an dem das Ereignis ausgelöst werden soll. Wird das Feld nicht gesetzt, wird an jedem Tag ausgelöst an dem die Monat und Jahr übereinstimmen.
    • month - Monat (1-12), an dem das Ereignis ausgelöst werden soll. Wird das Feld nicht gesetzt, wird in jedem Montag ausgelöst an denen Tag und Jahr übereinstimmen.
    • year - Jahr (0-99 für 2000 bis 2099), in dem das Ereignis ausgelöst werden soll. Wird das Feld nicht gesetzt, wird in jedem Jahr ausgelöst, an dem Tag und Monat übereinstimmen.
  • time_type - Bestimmt die Art der Uhrzeit-Angabe
    • 1 => Uhrzeit
    • 2 => Sonnenaufgang
    • 3 => Sonnenuntergang
  • Nur, wenn time_type = 1:
    • time - Uhrzeit im Format "hhmm".
  • Nur, wenn time_type = 2 oder 3:
    • offset - Anzahl in Minuten, in der das Ereignis vor (negativer Wert) oder nach (positiver Wert) Sonnenaufgang bzw. Sonnenuntergang ausgelöst werden soll.
  • random - (Optional) Max. Anzahl in Minuten, die dem Auslösezeitpunkt hinzugefügt oder abgezogen werden.
  • filter - Bestimmt, ob eine Aktion ausgeführt wird
    • 0 => Immer
    • 1 => Normale Tage (kein Feiertag, kein Urlaubstag)
    • 2 => Feiertag
    • 3 => Urlaubstag
    • 4 => Nie
  • action - ID der Aktion, die ausgelöst werden soll. Alle in der Universalzeitschaltuhr definierten Aktionen werden beim Abruf der Meta-Daten übermittelt.

1.2.3.Felder

ID
Der hier eingegebene Wert bildet zusammen mit dem fest vorgegebenen Präfix "TI", mit dem die ID durch ein '@'-Zeichen verbunden ist, den eindeutigen Objekt-Schlüssel des Endpunkts.
Erlaubte Zeichen sind: A-Z, a-z, 0-9, Bindestrich ("-") und Unterstrich ("_")!
Beschreibung
Eine sprechende Beschreibung der Universalzeitschaltuhr.
Über die Endpunkt-Schnittstelle können Universalzeitschaltuhren gesucht werden, bei denen ein Wort aus der Beschreibung mit dem dort verwendeten Suchwort beginnt.
Tags
Eine Liste von Begriffen, getrennt durch Kommata (",").
Über die Endpunkt-Schnittstelle können Universalzeitschaltuhren gesucht werden, bei denen ein einzelner Tag vollständig mit dem dort verwendeten Suchwort übereinstimmt.
Erlaubte Zeichen sind: A-Z, a-z, 0-9, Bindestrich ("-") und Unterstrich ("_")!
Benutzergruppen
Achtung
Dieser Punkt ist nur verfügbar, wenn Benutzergruppen aktiviert wurden!
Benutzergruppen können berechtigt werden, über die Endpunkte-Schnittstelle auf diese Universalzeitschaltuhr zum Lesen (linke Spalte) und/oder zum Schreiben (rechte Spalte) zuzugreifen.