HomeServerConnector. _UniversalTimer
Methods
new _UniversalTimer()
Universal-Zeitschaltuhr. Darf nicht direkt instanziert werden. Eine Instanz der Klasse wird von der Methode HomeServerConnector._Connection#getUniversalTimer erzeugt.
Example
var ti = conn.getUniversalTimer("TI@MyTimer", function(err, data) {});
Methods
addEvent(eventObj, callback)
Fügt der UZSU ein neues Ereignis hinzu.
Example
var evt = {"date_type": 1, "weekdays": [0,1,2,3,4], "time_type": 1, "time": "1200", "filter": 0, "action": 1};
ti.addEvent(evt, function(err) {});
Parameters
Name | Type | Optional | Description |
---|---|---|---|
eventObj |
Object |
|
Ereignis-Objekt |
callback |
function() |
|
deleteEvent(eventId, callback)
Löscht ein Ereignis aus der UZSU.
Example
var eventId = evt.getId();
ti.deleteEvent(eventId, function(err) {});
Parameters
Name | Type | Optional | Description |
---|---|---|---|
eventId |
Number |
|
Die ID eines Ereignisses. |
callback |
function() |
|
destroy()
Gibt das Objekt frei und hebt ein eventuell vorhandes Abonnement auf.
Example
ti.destroy();
getEvents(callback)
Liefert eine Liste mit allen Ereignissen der Zeitschaltuhr.
Example
ti.getEvents(function(err, events) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
callback |
function() |
|
getKey() → String
Liefert den Schlüssel des Objekts zurück.
Example
var object_key = ti.getKey();
- Returns
-
String
getMeta(callback)
Ruft die Meta-Daten ab.
Example
Abruf der Meta-Daten.
ti.getMeta(function(err, data) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
callback |
function() |
|
getSimulation(days, callback)
Liefert die Zeitpunkte innerhalb des angegebenen Zeitraums, an denen Ereignisse ausgelöst werden.
Example
Abruf der Ereignisse für die kommenden 7 Tage.
ti.getSimulation(7, function(err, events) {});
Parameters
Name | Type | Optional | Description |
---|---|---|---|
days |
Number |
|
Anzahl Tage (ab jetzt), die berechnet werden sollen. |
callback |
function() |
|
getState(callback)
Ruft den Status (aktiv/inaktiv) der UZSU ab.
Example
Abruf des Status.
ti.getState(function(err, active) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
callback |
function() |
|
setState(state, callback)
Setzt den Status (aktiv/inaktiv) der UZSU.
Example
Setzen des Status.
ti.setState(true, function(err) {});
Parameters
Name | Type | Optional | Description |
---|---|---|---|
state |
boolean |
|
true: UZSU wird aktiviert (oder bleibt eingeschaltet)
|
callback |
function() |
|
updateEvent(eventId, eventObj, callback)
Ändert/Setzt die Werte eines Ereignisses.
Example
var evt = {"date_type": 1, "weekdays": [0,1,2,3,4], "time_type": 1, "time": "1200", "filter": 0, "action": 1};
ti.updateEvent(47, evt, function(err) {});
Parameters
Name | Type | Optional | Description |
---|---|---|---|
eventId |
Number |
|
Die ID des Ereignisses, das neu gesetzt werden soll. |
eventObj |
Object |
|
Das Ereignis-Objekt, das verwendet werden soll. |
callback |
function() |
|
verify(eventObj) → boolean
Prüft ein Ereignis-Objekt. Liefert zurück, ob es in sich stimmig ist.
Example
ti.verify({}); // Returns false
ti.verfiy({"date_type": 1, "weekdays": [0,1,2,3,4], "time_type": 1, "time": "1200", "filter": 0, "action": 1}); // Returns true
Parameter
Name | Type | Optional | Description |
---|---|---|---|
eventObj |
Object |
|
Das zu prüfende Ereignis-Objekt |
- Returns
-
boolean
Abstract types
addEventCallback(err)
Example
var evt = {"date_type": 1, "weekdays": [0,1,2,3,4], "time_type": 1, "time": "1200", "filter": 0, "action": 1};
ti.addEvent(evt, function(err) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
err |
(Object or undefined) |
|
Fehler-Objekt |
deleteEventCallback(err)
Example
var eventId = evt.getId();
ti.deleteEvent(eventId, function(err) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
err |
(Object or undefined) |
|
Fehler-Objekt |
getEventsCallback(err, events)
Example
Liste aller Events abrufen
ti.getEvents(function(err, events) {});
Parameters
Name | Type | Optional | Description |
---|---|---|---|
err |
(Object or undefined) |
|
Fehler-Objekt |
events |
Array |
|
Liste mit allen Ereignissen der Zeitschaltuhr. |
getMetaCallback(err, data)
Example
Abruf der Meta-Daten.
ti.getMeta(function(err, data) {});
Parameters
Name | Type | Optional | Description |
---|---|---|---|
err |
(Object or undefined) |
|
Fehler-Objekt |
data |
Object |
|
Meta-Informationen
Struktur
Erklärung
|
getSimulationCallback(err, events)
Example
Abruf der Ereignisse für die kommenden 7 Tage.
ti.getSimulation(7, function(err, events) {});
Parameters
Name | Type | Optional | Description |
---|---|---|---|
err |
(Object or undefined) |
|
Fehler-Objekt |
events |
Array |
|
Liste mit den Ereignissen der Zeitschaltuhr innerhalb des vorgegebenen Zeitraums. Struktur
Erklärung
|
getStateCallback(err, active)
Example
Abruf des Status.
ti.getState(function(err, active) {});
Parameters
Name | Type | Optional | Description |
---|---|---|---|
err |
(Object or undefined) |
|
Fehler-Objekt |
active |
Boolean |
|
true: UZSU ist eingeschaltet - false: UZSU ist ausgeschaltet |
setStateCallback(err)
Example
Setzen des Status.
ti.setState(true, function(err) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
err |
(Object or undefined) |
|
Fehler-Objekt |
updateEventCallback(err)
Example
var evt = {"date_type": 1, "weekdays": [0,1,2,3,4], "time_type": 1, "time": "1200", "filter": 0, "action": 1};
ti.updateEvent(47, evt, function(err) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
err |
(Object or undefined) |
|
Fehler-Objekt |