new _Sequence()

Sequenz.
Darf nicht direkt instanziert werden. Eine Instanz der Klasse wird von der Methode HomeServerConnector._Connection#getSequence erzeugt.

Example

var sq = conn.getSequence("SQ@MySequence", function(err, data) {});

Methods

destroy()

Gibt das Objekt frei und hebt ein eventuell vorhandes Abonnement auf.

Example

sq.destroy(); 

getKey() → String

Liefert den Schlüssel des Objekts zurück.

Example

var object_key = sq.getKey(); 
Returns

String 

getMeta(callback)

Ruft die Meta-Daten ab.

Example

Abruf der Meta-Daten.

sq.getMeta(function(err, data) {}); 

Parameter

Name Type Optional Description

callback

function()

 

HomeServerConnector._Sequence~getMetaCallback

getState(callback)

Liefert den Status der Sequenz: Sequenz läuft / läuft nicht

Example

Abruf des Status.

sq.getState(function(err, state) {});

Parameter

Name Type Optional Description

callback

function()

 

HomeServerConnector._Sequence~getStateCallback

start(callback)

Startet eine Sequenz.

Example

Sequenz starten.

sq.start(function(err) {}); 

Parameter

Name Type Optional Description

callback

function()

 

HomeServerConnector._Sequence~startCallback

stop(callback)

Stoppt eine laufende Sequenz.

Example

Sequenz anhalten.

sq.stop(function(err) {}); 

Parameter

Name Type Optional Description

callback

function()

 

HomeServerConnector._Sequence~stopCallback

Abstract types

inner

getMetaCallback(err, data)

Example

Abruf der Meta-Daten.

sq.getMeta(function(err, data) {}); 

Parameters

Name Type Optional Description

err

(Object or undefined)

 

Fehler-Objekt

data

Object

 

Meta-Informationen

Struktur

{ 
  "keys":        Array of String,
  "caption":     String,
  "description": String,
  "tags":        Array of String,
  "restart":     Boolean
}

Erklärung

  • keys - Liste mit Schlüsseln (z.B.: ["SQ:5", "SQ@MySequence"]). Enthält mindestens einen Eintrag.
  • caption - Bezeichnung des Objekts.
  • description - Beschreibung des Objekts.
  • tags - Liste von Tags (z.B.: ["Light", "Alarms"]).
  • restart - true: Die Sequenz kann während des Ablaufs neu gestartet werden.
inner

getStateCallback(err, state)

Example

Abruf des Status.

sq.getState(function(err, state) {});

Parameters

Name Type Optional Description

err

(Object or undefined)

 

Fehler-Objekt

state

Boolean

 

true: Sequenz läuft - false: Sequenz läuft nicht.

inner

startCallback(err)

Example

Sequenz starten.

sq.start(function(err) {}); 

Parameter

Name Type Optional Description

err

(Object or undefined)

 

Fehler-Objekt

inner

stopCallback(err)

Example

Sequenz anhalten.

sq.stop(function(err) {}); 

Parameter

Name Type Optional Description

err

(Object or undefined)

 

Fehler-Objekt