new _Scene()

Scene.
May not be directly instanced. An instance of the class is created by the method HomeServerConnector._Connection#getScene.

Example

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

Methods

call(callback)

Retrieves the scene.

Example

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

Parameter

Name Type Optional Description

callback

function()

 

HomeServerConnector._Scene~callCallback

destroy()

Enables the object and cancels any existing subscription.

Example

sc.destroy(); 

getActors(callback)

Retrieval of a list with data on each communication object used in the scene. Each entry in the list contains the data for a CO.

Example

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

Parameter

Name Type Optional Description

callback

function()

 

HomeServerConnector._Scene~getActorsCallback

getKey() → String

Returns the key of the object.

Example

var object_key = sc.getKey(); 
Returns

String 

getMeta(callback)

Retrieves the metadata.

Example

Retrieval of metadata.

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

Parameter

Name Type Optional Description

callback

function()

 

HomeServerConnector._Scene~getMetaCallback

learn(callback)

Teach-in of the scene.

Example

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

Parameter

Name Type Optional Description

callback

function()

 

HomeServerConnector._Scene~learnCallback

listNext(callback)

Setting all communication objects in the scene to the next highest values specified in Expert in the field 'List' (for communication object).

Example

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

Parameter

Name Type Optional Description

callback

function()

 

HomeServerConnector._Scene~listNextCallback

listPrevious(callback)

Setting all communication objects in the scene to the next lowest values specified in Expert in the field 'List' (for communication object).

Example

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

Parameter

Name Type Optional Description

callback

function()

 

HomeServerConnector._Scene~listPreviousCallback

offsetMinus(callback)

The value of all the communication objects in the scene is reduced by the value specified in Expert in the field 'Step size' (for communication object).

Example

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

Parameter

Name Type Optional Description

callback

function()

 

HomeServerConnector._Scene~offsetMinusCallback

offsetPlus(callback)

The value of all the communication objects in the scene is increased by the value specified in Expert in the field 'Step size' (for communication object).

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)

 

Error object

inner

getActorsCallback(err, data)

Example

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

Parameters

Name Type Optional Description

err

(Object or undefined)

 

Error object

data

Array

 

Data of the scene

Structure

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

Explanation

List of objects:

  • key - Key of the communication object used.
  • value - Value saved in the scene.
  • learn - true: The value can be changed by learning.
inner

getMetaCallback(err, data)

Example

Retrieval of metadata.

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

Parameters

Name Type Optional Description

err

(Object or undefined)

 

Error object

data

Object

 

Meta information

Structure

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

Explanation

  • keys - List with keys (e.g.: ["SC:4", "SC@MyScene"]). Contains at least one number.
  • caption - Designation of the object.
  • description - Description of the object.
  • tags - List of tags (e.g.: ["Holiday", "Light"]).
  • actors - List of keys of the communication objects contained.
inner

learnCallback(err)

Example

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

Parameter

Name Type Optional Description

err

(Object or undefined)

 

Error object

inner

listNextCallback(err)

Example

Setting all communication objects in the scene to the next highest values specified in Expert in the field 'List' (for communication object).

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

Parameter

Name Type Optional Description

err

(Object or undefined)

 

Error object

inner

listPreviousCallback(err)

Example

Setting all communication objects in the scene to the next lowest values specified in Expert in the field 'List' (for communication object).

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

Parameter

Name Type Optional Description

err

(Object or undefined)

 

Error object

inner

offsetMinusCallback(err)

Example

The value of all the communication objects in the scene is reduced by the value specified in Expert in the field 'Step size' (for communication object).

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

Parameter

Name Type Optional Description

err

(Object or undefined)

 

Error object

inner

offsetPlusCallback(err)

Example

The value of all the communication objects in the scene is increased by the value specified in Expert in the field 'Step size' (for communication object).

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

Parameter

Name Type Optional Description

err

(Object or undefined)

 

Error object