new _Scene()

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

Example

var sc = conn.getScene("SC@MyScene", function(err, data) {});

Methods

call(callback)

Ruft die Szene ab.

Example

sc.call(function(err) {}); 

Parameter

Name Type Optional Description

callback

function()

 

HomeServerConnector._Scene~callCallback

destroy()

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

Example

sc.destroy(); 

getActors(callback)

Abrufen einer Liste mit Daten zu jedem in der Szene verwendeten KO. Jeder Eintrag in der Liste enthält die Daten zu einem KO.

Example

sc.getActors(function(err, actors) {});

Parameter

Name Type Optional Description

callback

function()

 

HomeServerConnector._Scene~getActorsCallback

getKey() → String

Liefert den Schlüssel des Objekts zurück.

Example

var object_key = sc.getKey(); 
Returns

String 

getMeta(callback)

Ruft die Meta-Daten ab.

Example

Abruf der Meta-Daten.

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

Parameter

Name Type Optional Description

callback

function()

 

HomeServerConnector._Scene~getMetaCallback

learn(callback)

Lernt die Szene neu ein.

Example

sc.learn(function(err) {}); 

Parameter

Name Type Optional Description

callback

function()

 

HomeServerConnector._Scene~learnCallback

listNext(callback)

Setzen aller KO in der Szene auf den nächst-größeren der im Experte im Feld 'Liste' (beim KO) angegebenen Werte.

Example

sc.listNext(function(err) {}); 

Parameter

Name Type Optional Description

callback

function()

 

HomeServerConnector._Scene~listNextCallback

listPrevious(callback)

Setzen aller KO in der Szene auf den nächst-kleineren der im Experte im Feld 'Liste' (beim KO) angegebenen Werte.

Example

sc.listPrevious(function(err) {}); 

Parameter

Name Type Optional Description

callback

function()

 

HomeServerConnector._Scene~listPreviousCallback

offsetMinus(callback)

Der Wert aller KO in der Szene wird um den im Experte im Feld 'Schrittgröße' (beim KO) angegebenen Wert vermindert.

Example

sc.offsetMinus(function(err) {}); 

Parameter

Name Type Optional Description

callback

function()

 

HomeServerConnector._Scene~offsetMinusCallback

offsetPlus(callback)

Der Wert aller KO in der Szene wird um den im Experte im Feld 'Schrittgröße' (beim KO) angegebenen Wert erhöht.

Example

sc.offsetPlus(function(err) {}); 

Parameter

Name Type Optional Description

callback

function()

 

HomeServerConnector._Scene~offsetPlusCallback

Abstract types

inner

callCallback(err)

Example

sc.call(function(err) {}); 

Parameter

Name Type Optional Description

err

(Object or undefined)

 

Fehler-Objekt

inner

getActorsCallback(err, data)

Example

sc.getActors(function(err, actors) {}); 

Parameters

Name Type Optional Description

err

(Object or undefined)

 

Fehler-Objekt

data

Array

 

Daten der Szene

Struktur

[
   {
      "key":   String,
      "value": Number,
      "learn": Boolean
   }
]

Erklärung

Liste von Objekten:

  • key - Schlüssel des verwendeten K.-Objekts.
  • value - In der Szene gespeicherter Wert.
  • learn - true: Der Wert kann durch Lernen verändert werden.
inner

getMetaCallback(err, data)

Example

Abruf der Meta-Daten.

sc.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,
  "actors":      Array of String
}

Erklärung

  • keys - Liste mit Schlüsseln (z.B.: ["SC:4", "SC@MyScene"]). Enthält mindestens einen Eintrag.
  • caption - Bezeichnung des Objekts.
  • description - Beschreibung des Objekts.
  • tags - Liste von Tags (z.B.: ["Holiday", "Light"]).
  • actors - Liste der Schlüssel der enthaltenen K.-Objekte.
inner

learnCallback(err)

Example

sc.learn(function(err) {}); 

Parameter

Name Type Optional Description

err

(Object or undefined)

 

Fehler-Objekt

inner

listNextCallback(err)

Example

Setzen aller KO in der Szene auf den nächst-größeren der im Experte im Feld 'Liste' (beim KO) angegebenen Werte.

sc.listNext(function(err) {}); 

Parameter

Name Type Optional Description

err

(Object or undefined)

 

Fehler-Objekt

inner

listPreviousCallback(err)

Example

Setzen aller KO in der Szene auf den nächst-kleineren der im Experte im Feld 'Liste' (beim KO) angegebenen Werte.

sc.listPrevious(function(err) {}); 

Parameter

Name Type Optional Description

err

(Object or undefined)

 

Fehler-Objekt

inner

offsetMinusCallback(err)

Example

Der Wert aller KO in der Szene wird um den im Experte im Feld 'Schrittgröße' (beim KO) angegebenen Wert vermindert.

sc.offsetMinus(function(err) {}); 

Parameter

Name Type Optional Description

err

(Object or undefined)

 

Fehler-Objekt

inner

offsetPlusCallback(err)

Example

Der Wert aller KO in der Szene wird um den im Experte im Feld 'Schrittgröße' (beim KO) angegebenen Wert erhöht.

sc.offsetPlus(function(err) {}); 

Parameter

Name Type Optional Description

err

(Object or undefined)

 

Fehler-Objekt