HomeServerConnector. _CommunicationObject
Methods
new _CommunicationObject()
Kommunikations-Objekt (KO). Darf nicht direkt instanziert werden. Eine Instanz der Klasse wird von der Methode HomeServerConnector._Connection#getCommunicationObject erzeugt.
Example
var co = conn.getCommunicationObject("CO@1_1_1", function(err, value, isInit) {});
Methods
addValue(value, callback)
Addiert den Wert.
Examples
Addieren von '5' auf den aktuellen Wert des KO.
co.addValue(5, function(err) {});
Subtrahieren von '5' ( = Addieren von '-5') vom aktuellen Wert des KO.
co.addValue(-5, function(err) {});
Parameters
Name | Type | Optional | Description |
---|---|---|---|
value |
Number |
|
der zu addierende Wert |
callback |
function() |
|
destroy()
Gibt das Objekt frei und hebt ein eventuell vorhandes Abonnement auf.
Example
co.destroy();
getKey() → String
Liefert den Schlüssel des Objekts zurück.
Example
var object_key = co.getKey();
- Returns
-
String
getMeta(callback)
Ruft die Meta-Daten ab.
Example
Abruf der Meta-Daten.
co.getMeta(function(err, data) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
callback |
function() |
|
getValue(callback)
Ruft den aktuellen Wert ab.
Example
Abfragen des aktuellen Werts des KO.
co.getValue(function(err, value) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
callback |
function() |
|
listNext(callback)
Springt den nächsten Wert in der Liste an.
Example
Setzen des KO auf den nächst-größeren der im Experte im Feld 'Liste' angegebenen Werte.
co.listNext(function(err) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
callback |
function() |
|
listPrevious(callback)
Springt den vorherigen Wert in der Liste an.
Example
Setzen des KO auf den nächst-kleineren der im Experte im Feld 'Liste' angegebenen Werte.
co.listPrevious(function(err) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
callback |
function() |
|
HomeServerConnector._CommunicationObject~listPreviousCallback |
offsetMinus(callback)
Vermindert den Wert um die Schrittweite.
Example
Der Wert des KO wird um den im Experte im Feld 'Schrittgröße' angegebenen Wert vermindert.
co.offsetMinus(function(err) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
callback |
function() |
|
HomeServerConnector._CommunicationObject~offsetMinusCallback |
offsetPlus(callback)
Erhöht den Wert um die Schrittweite.
Example
Der Wert des KO wird um den im Experte im Feld 'Schrittgröße' angegebenen Wert erhöht.
co.offsetPlus(function(err) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
callback |
function() |
|
setValue(value, callback)
Setzt den Wert.
Examples
Setzen eines numerischen Werts.
co.setValue(1.0, function(err) {});
Setzen eines Strings.
co.setValue("Text Text Text", function(err) {});
Parameters
Name | Type | Optional | Description |
---|---|---|---|
value |
(String or Number) |
|
Wert, auf den das K.-Objekt gesetzt werden soll. |
callback |
function() |
|
toggle(value, callback)
Schaltet zwischen '0' und dem Wert um.
Example
Toggeln zwischen (fix) '0' und '1'.
co.toggle(1, function(err) {});
Parameters
Name | Type | Optional | Description |
---|---|---|---|
value |
Number |
|
Wert. Umschaltung erfolgt zwischen diesem Wert und '0'. |
callback |
function() |
|
Abstract types
addValueCallback(err)
Examples
Addieren von '5' auf den aktuellen Wert des KO
co.addValue(5, function(err) {});
Subtrahieren von '5' ( = Addieren von '-5') vom aktuellen Wert des KO.
co.addValue(-5, function(err) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
err |
(Object or undefined) |
|
Fehler-Objekt |
getMetaCallback(err, data)
Example
Abruf der Meta-Daten.
co.getMeta(function(err, data) {});
Parameters
Name | Type | Optional | Description |
---|---|---|---|
err |
(Object or undefined) |
|
Fehler-Objekt |
data |
Object |
|
Meta-Informationen
Struktur
Erklärung
|
getValueCallback(err, value)
Example
Abfragen des aktuellen Werts des KO.
co.getValue(function(err, value) {});
Parameters
Name | Type | Optional | Description |
---|---|---|---|
err |
(Object or undefined) |
|
Fehler-Objekt |
value |
(String or Number) |
|
zurückgelieferter Wert des KO |
listNextCallback(err)
Example
Setzen des KO auf den nächst-größeren der im Experte im Feld 'Liste' angegebenen Werte.
co.listNext(function(err) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
err |
(Object or undefined) |
|
Fehler-Objekt |
listPreviousCallback(err)
Example
Setzen des KO auf den nächst-kleineren der im Experte im Feld 'Liste' angegebenen Werte.
co.listPrevious(function(err) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
err |
(Object or undefined) |
|
Fehler-Objekt |
offsetMinusCallback(err)
Example
Der Wert des KO wird um den im Experte im Feld 'Schrittgröße' angegebenen Wert vermindert.
co.offsetMinus(function(err) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
err |
(Object or undefined) |
|
Fehler-Objekt |
offsetPlusCallback(err)
Example
Der Wert des KO wird um den im Experte im Feld 'Schrittgröße' angegebenen Wert erhöht.
co.offsetPlus(function(err) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
err |
(Object or undefined) |
|
Fehler-Objekt |
setValueCallback(err)
Examples
Setzen eines numerischen Werts
co.setValue(1.0, function(err) {});
Setzen eines Strings.
co.setValue("Text Text Text", function(err) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
err |
(Object or undefined) |
|
Fehler-Objekt |
toggleCallback(err)
Example
Toggeln zwischen (fix) '0' und '1'
co.toggle(1, function(err) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
err |
(Object or undefined) |
|
Fehler-Objekt |