JavaScript - Humidity Bricklet 2.0

Dies ist die Beschreibung der JavaScript API Bindings für das Humidity Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Humidity Bricklet 2.0 sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die JavaScript API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple (Node.js)

Download (ExampleSimple.js)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
var Tinkerforge = require('tinkerforge');

var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change XYZ to the UID of your Humidity Bricklet 2.0

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var h = new Tinkerforge.BrickletHumidityV2(UID, ipcon); // Create device object

ipcon.connect(HOST, PORT,
    function (error) {
        console.log('Error: ' + error);
    }
); // Connect to brickd
// Don't use device before ipcon is connected

ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
    function (connectReason) {
        // Get current humidity
        h.getHumidity(
            function (humidity) {
                console.log('Humidity: ' + humidity/100.0 + ' %RH');
            },
            function (error) {
                console.log('Error: ' + error);
            }
        );
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        ipcon.disconnect();
        process.exit(0);
    }
);

Callback (Node.js)

Download (ExampleCallback.js)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
var Tinkerforge = require('tinkerforge');

var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change XYZ to the UID of your Humidity Bricklet 2.0

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var h = new Tinkerforge.BrickletHumidityV2(UID, ipcon); // Create device object

ipcon.connect(HOST, PORT,
    function (error) {
        console.log('Error: ' + error);
    }
); // Connect to brickd
// Don't use device before ipcon is connected

ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
    function (connectReason) {
        // Set period for humidity callback to 1s (1000ms) without a threshold
        h.setHumidityCallbackConfiguration(1000, false, 'x', 0, 0);
    }
);

// Register humidity callback
h.on(Tinkerforge.BrickletHumidityV2.CALLBACK_HUMIDITY,
    // Callback function for humidity callback
    function (humidity) {
        console.log('Humidity: ' + humidity/100.0 + ' %RH');
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        ipcon.disconnect();
        process.exit(0);
    }
);

Threshold (Node.js)

Download (ExampleThreshold.js)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
var Tinkerforge = require('tinkerforge');

var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change XYZ to the UID of your Humidity Bricklet 2.0

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var h = new Tinkerforge.BrickletHumidityV2(UID, ipcon); // Create device object

ipcon.connect(HOST, PORT,
    function (error) {
        console.log('Error: ' + error);
    }
); // Connect to brickd
// Don't use device before ipcon is connected

ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
    function (connectReason) {
        // Configure threshold for humidity "outside of 30 to 60 %RH"
        // with a debounce period of 10s (10000ms)
        h.setHumidityCallbackConfiguration(10000, false, 'o', 30*100, 60*100);
    }
);

// Register humidity callback
h.on(Tinkerforge.BrickletHumidityV2.CALLBACK_HUMIDITY,
    // Callback function for humidity callback
    function (humidity) {
        console.log('Humidity: ' + humidity/100.0 + ' %RH');
        console.log('Recommended humidity for human comfort is 30 to 60 %RH.');
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        ipcon.disconnect();
        process.exit(0);
    }
);

Simple (HTML)

Download (ExampleSimple.html), Test (ExampleSimple.html)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
<!DOCTYPE html>
<html>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <head>
        <title>Tinkerforge | JavaScript Example</title>
    </head>
    <body>
        <div style="text-align:center;">
            <h1>Humidity Bricklet 2.0 Simple Example</h1>
            <p>
                <input value="localhost" id="host" type="text" size="20">:
                <input value="4280" id="port" type="text" size="5">,
                <input value="uid" id="uid" type="text" size="5">
                <input value="Start Example" id="start" type="button" onclick="startExample();">
            </p>
            <p>
                <textarea readonly id="text" cols="80" rows="24" style="resize:none;"
                          >Press "Start Example" to begin ...</textarea>
            </p>
        </div>
        <script src="./Tinkerforge.js" type='text/javascript'></script>
        <script type='text/javascript'>
            var ipcon;
            var textArea = document.getElementById("text");
            function startExample() {
                textArea.value = "";
                var HOST = document.getElementById("host").value;
                var PORT = parseInt(document.getElementById("port").value);
                var UID = document.getElementById("uid").value;
                if(ipcon !== undefined) {
                    ipcon.disconnect();
                }
                ipcon = new Tinkerforge.IPConnection(); // Create IP connection
                var h = new Tinkerforge.BrickletHumidityV2(UID, ipcon); // Create device object
                ipcon.connect(HOST, PORT,
                    function(error) {
                        textArea.value += 'Error: ' + error + '\n';
                    }
                ); // Connect to brickd
                // Don't use device before ipcon is connected

                ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
                    function (connectReason) {
                        // Get current humidity
                        h.getHumidity(
                            function (humidity) {
                                textArea.value += 'Humidity: ' + humidity/100.0 + ' %RH\n';
                            },
                            function (error) {
                                textArea.value += 'Error: ' + error + '\n';
                            }
                        );
                    }
                );
            }
        </script>
    </body>
</html>

Callback (HTML)

Download (ExampleCallback.html), Test (ExampleCallback.html)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
<!DOCTYPE html>
<html>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <head>
        <title>Tinkerforge | JavaScript Example</title>
    </head>
    <body>
        <div style="text-align:center;">
            <h1>Humidity Bricklet 2.0 Callback Example</h1>
            <p>
                <input value="localhost" id="host" type="text" size="20">:
                <input value="4280" id="port" type="text" size="5">,
                <input value="uid" id="uid" type="text" size="5">
                <input value="Start Example" id="start" type="button" onclick="startExample();">
            </p>
            <p>
                <textarea readonly id="text" cols="80" rows="24" style="resize:none;"
                          >Press "Start Example" to begin ...</textarea>
            </p>
        </div>
        <script src="./Tinkerforge.js" type='text/javascript'></script>
        <script type='text/javascript'>
            var ipcon;
            var textArea = document.getElementById("text");
            function startExample() {
                textArea.value = "";
                var HOST = document.getElementById("host").value;
                var PORT = parseInt(document.getElementById("port").value);
                var UID = document.getElementById("uid").value;
                if(ipcon !== undefined) {
                    ipcon.disconnect();
                }
                ipcon = new Tinkerforge.IPConnection(); // Create IP connection
                var h = new Tinkerforge.BrickletHumidityV2(UID, ipcon); // Create device object
                ipcon.connect(HOST, PORT,
                    function(error) {
                        textArea.value += 'Error: ' + error + '\n';
                    }
                ); // Connect to brickd
                // Don't use device before ipcon is connected

                ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
                    function (connectReason) {
                        // Set period for humidity callback to 1s (1000ms) without a threshold
                        h.setHumidityCallbackConfiguration(1000, false, 'x', 0, 0);
                    }
                );

                // Register humidity callback
                h.on(Tinkerforge.BrickletHumidityV2.CALLBACK_HUMIDITY,
                    // Callback function for humidity callback
                    function (humidity) {
                        textArea.value += 'Humidity: ' + humidity/100.0 + ' %RH\n';
                        textArea.scrollTop = textArea.scrollHeight;
                    }
                );
            }
        </script>
    </body>
</html>

Threshold (HTML)

Download (ExampleThreshold.html), Test (ExampleThreshold.html)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
<!DOCTYPE html>
<html>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <head>
        <title>Tinkerforge | JavaScript Example</title>
    </head>
    <body>
        <div style="text-align:center;">
            <h1>Humidity Bricklet 2.0 Threshold Example</h1>
            <p>
                <input value="localhost" id="host" type="text" size="20">:
                <input value="4280" id="port" type="text" size="5">,
                <input value="uid" id="uid" type="text" size="5">
                <input value="Start Example" id="start" type="button" onclick="startExample();">
            </p>
            <p>
                <textarea readonly id="text" cols="80" rows="24" style="resize:none;"
                          >Press "Start Example" to begin ...</textarea>
            </p>
        </div>
        <script src="./Tinkerforge.js" type='text/javascript'></script>
        <script type='text/javascript'>
            var ipcon;
            var textArea = document.getElementById("text");
            function startExample() {
                textArea.value = "";
                var HOST = document.getElementById("host").value;
                var PORT = parseInt(document.getElementById("port").value);
                var UID = document.getElementById("uid").value;
                if(ipcon !== undefined) {
                    ipcon.disconnect();
                }
                ipcon = new Tinkerforge.IPConnection(); // Create IP connection
                var h = new Tinkerforge.BrickletHumidityV2(UID, ipcon); // Create device object
                ipcon.connect(HOST, PORT,
                    function(error) {
                        textArea.value += 'Error: ' + error + '\n';
                    }
                ); // Connect to brickd
                // Don't use device before ipcon is connected

                ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
                    function (connectReason) {
                        // Configure threshold for humidity "outside of 30 to 60 %RH"
                        // with a debounce period of 10s (10000ms)
                        h.setHumidityCallbackConfiguration(10000, false, 'o', 30*100, 60*100);
                    }
                );

                // Register humidity callback
                h.on(Tinkerforge.BrickletHumidityV2.CALLBACK_HUMIDITY,
                    // Callback function for humidity callback
                    function (humidity) {
                        textArea.value += 'Humidity: ' + humidity/100.0 + ' %RH\n';
                        textArea.value += 'Recommended humidity for human comfort is 30 to 60 %RH.\n';
                        textArea.scrollTop = textArea.scrollHeight;
                    }
                );
            }
        </script>
    </body>
</html>

API

Allgemein kann jede Methode der JavaScript Bindings zwei optionale Parameter haben, returnCallback und errorCallback. Dies sind benutzerdefinierte Callback-Funktionen. Die returnCallback-Funktion wird mit dem Ergebnissen der Methode als Argumente aufgerufen, falls die Methode ihre Ergebnisse asynchron zurückgibt. Die errorCallback-Funktion wird im Fehlerfall mit einem Fehlercode aufgerufen. Der Fehlercode kann einer der folgenden Werte sein:

  • IPConnection.ERROR_ALREADY_CONNECTED = 11
  • IPConnection.ERROR_NOT_CONNECTED = 12
  • IPConnection.ERROR_CONNECT_FAILED = 13
  • IPConnection.ERROR_INVALID_FUNCTION_ID = 21
  • IPConnection.ERROR_TIMEOUT = 31
  • IPConnection.ERROR_INVALID_PARAMETER = 41
  • IPConnection.ERROR_FUNCTION_NOT_SUPPORTED = 42
  • IPConnection.ERROR_UNKNOWN_ERROR = 43
  • IPConnection.ERROR_STREAM_OUT_OF_SYNC = 51
  • IPConnection.ERROR_NON_ASCII_CHAR_IN_SECRET = 71

Der Namespace der JavaScript Bindings ist Tinkerforge.*.

Grundfunktionen

new BrickletHumidityV2(uid, ipcon)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: IPConnection
Rückgabe:
  • humidityV2 – Typ: BrickletHumidityV2

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

var humidityV2 = new BrickletHumidityV2("YOUR_DEVICE_UID", ipcon)

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

BrickletHumidityV2.getHumidity([returnCallback][, errorCallback])
Callback-Parameter:
  • humidity – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • undefined

Gibt die gemessene Luftfeuchtigkeit des Sensors zurück. Der Wertebereich ist von 0 bis 10000 und wird in %RH/100 angegeben (relative Luftfeuchtigkeit), z.B. bedeutet ein Wert von 4223 eine gemessene Luftfeuchtigkeit von 42,23 %RH.

Wenn der Wert periodisch benötigt wird, kann auch der CALLBACK_HUMIDITY Callback verwendet werden. Der Callback wird mit der Funktion setHumidityCallbackConfiguration() konfiguriert.

BrickletHumidityV2.getTemperature([returnCallback][, errorCallback])
Callback-Parameter:
  • temperature – Typ: int, Wertebereich: [-215 bis 215 - 1]
Rückgabe:
  • undefined

Gibt die gemessene Temperatur des Sensors zurück. Der Wertebereich ist von -4000 bis 16500 und wird in °C/100 angegeben, z.B. bedeutet ein Wert von 3200 eine gemessene Temperatur von 32,00 °C.

Wenn der Wert periodisch benötigt wird, kann auch der CALLBACK_TEMPERATURE Callback verwendet werden. Der Callback wird mit der Funktion setTemperatureCallbackConfiguration() konfiguriert.

BrickletHumidityV2.setHeaterConfiguration(heaterConfig[, returnCallback][, errorCallback])
Parameter:
  • heaterConfig – Typ: int, Wertebereich: Siehe Konstanten
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Aktiviert/deaktiviert das Heizelement. Das Heizelement kann genutzt werden um den Sensor bei extremer Feuchtigkeit zu trocknen.

Standardmäßig ist das Heizelement deaktiviert.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für heater_config:

  • BrickletHumidityV2.HEATER_CONFIG_DISABLED = 0
  • BrickletHumidityV2.HEATER_CONFIG_ENABLED = 1
BrickletHumidityV2.getHeaterConfiguration([returnCallback][, errorCallback])
Callback-Parameter:
  • heaterConfig – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • undefined

Gibt die Heizelement-Konfiguration zurück, wie von setHeaterConfiguration() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für heater_config:

  • BrickletHumidityV2.HEATER_CONFIG_DISABLED = 0
  • BrickletHumidityV2.HEATER_CONFIG_ENABLED = 1
BrickletHumidityV2.setMovingAverageConfiguration(movingAverageLengthHumidity, movingAverageLengthTemperature[, returnCallback][, errorCallback])
Parameter:
  • movingAverageLengthHumidity – Typ: int, Wertebereich: [0 bis 216 - 1]
  • movingAverageLengthTemperature – Typ: int, Wertebereich: [0 bis 216 - 1]
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Setzt die Länge eines gleitenden Mittelwerts für die Luftfeuchtigkeit und Temperatur.

Wenn die Länge auf 1 gesetzt wird, ist die Mittelwertbildung deaktiviert. Je kürzer die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

Der Wertebereich liegt bei 1-1000.

Einer neue Wert wird alle 50ms* gemessen. Mit einer Mittelwerts-Länge von 1000 hat das resultierende gleitende Fenster eine Zeitspanne von 50s. Bei Langzeitmessungen gibt ein langer Mittelwert die saubersten Resultate.

Der Standardwert ist 5.

* In Firmware Version 2.0.3 haben wir die Funktion setSamplesPerSecond() hinzugefügt. Diese konfiguriert die Messfrequenz. Da eine hohe Messfrequenz zu Selbsterhitzung führen kann haben wir die Standardeinstellung von 20 SPS auf 1 SPS geändert. Mit einer Messung pro Sekunde entspricht eine Mittelwert-Länge von 1000 einem Zeitfenster von 1000 Sekunden!

BrickletHumidityV2.getMovingAverageConfiguration([returnCallback][, errorCallback])
Callback-Parameter:
  • movingAverageLengthHumidity – Typ: int, Wertebereich: [0 bis 216 - 1]
  • movingAverageLengthTemperature – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • undefined

Gibt die Moving Average-Konfiguration zurück, wie von setMovingAverageConfiguration() gesetzt.

BrickletHumidityV2.setSamplesPerSecond(sps[, returnCallback][, errorCallback])
Parameter:
  • sps – Typ: int, Wertebereich: Siehe Konstanten
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Setzt die Messungen pro Sekunde mit denen neue Luftfeuchte/Temperatur-Werte vom HDC1080 Sensor gelesen werden.

Wir haben diese Funktion hinzugefügt, da eine hohe Messfrequenz zu einer Selbsterhitzung des Sensors führen kann. Diese kann die Temperaturmessung verfälschen.

Wenn wenig Messwerte benötigt werden kann die Frequenz auf bis zu 0,1 Messungen pro Sekunde verringert werden um einen Fehler durch Selbsterhitzung möglichst weit zu minimieren.

Vor Version 2.0.3 wurden 30 Messungen pro Sekunde gemacht. Der neue Standardwert seit 2.0.3 ist 1 Messung pro Sekunde.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für sps:

  • BrickletHumidityV2.SPS_20 = 0
  • BrickletHumidityV2.SPS_10 = 1
  • BrickletHumidityV2.SPS_5 = 2
  • BrickletHumidityV2.SPS_1 = 3
  • BrickletHumidityV2.SPS_02 = 4
  • BrickletHumidityV2.SPS_01 = 5

Neu in Version 2.0.3 (Plugin).

BrickletHumidityV2.getSamplesPerSecond([returnCallback][, errorCallback])
Callback-Parameter:
  • sps – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • undefined

Gibt die Messwerte pro Sekunde zurück, wie von setSamplesPerSecond() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für sps:

  • BrickletHumidityV2.SPS_20 = 0
  • BrickletHumidityV2.SPS_10 = 1
  • BrickletHumidityV2.SPS_5 = 2
  • BrickletHumidityV2.SPS_1 = 3
  • BrickletHumidityV2.SPS_02 = 4
  • BrickletHumidityV2.SPS_01 = 5

Neu in Version 2.0.3 (Plugin).

Fortgeschrittene Funktionen

BrickletHumidityV2.getAPIVersion()
Rückgabe:
  • apiVersion – Typ: [int, ...], Länge: 3, Wertebereich: [0 bis 255]

Gibt die Version der API Definition (Major, Minor, Revision) zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

BrickletHumidityV2.getResponseExpected(functionId[, errorCallback])
Parameter:
  • functionId – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: boolean

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels setResponseExpected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für function_id:

  • BrickletHumidityV2.FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION = 2
  • BrickletHumidityV2.FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 6
  • BrickletHumidityV2.FUNCTION_SET_HEATER_CONFIGURATION = 9
  • BrickletHumidityV2.FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 11
  • BrickletHumidityV2.FUNCTION_SET_SAMPLES_PER_SECOND = 13
  • BrickletHumidityV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletHumidityV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletHumidityV2.FUNCTION_RESET = 243
  • BrickletHumidityV2.FUNCTION_WRITE_UID = 248
BrickletHumidityV2.setResponseExpected(functionId, responseExpected[, errorCallback])
Parameter:
  • functionId – Typ: int, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: boolean
Rückgabe:
  • undefined

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für function_id:

  • BrickletHumidityV2.FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION = 2
  • BrickletHumidityV2.FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 6
  • BrickletHumidityV2.FUNCTION_SET_HEATER_CONFIGURATION = 9
  • BrickletHumidityV2.FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 11
  • BrickletHumidityV2.FUNCTION_SET_SAMPLES_PER_SECOND = 13
  • BrickletHumidityV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletHumidityV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletHumidityV2.FUNCTION_RESET = 243
  • BrickletHumidityV2.FUNCTION_WRITE_UID = 248
BrickletHumidityV2.setResponseExpectedAll(responseExpected)
Parameter:
  • responseExpected – Typ: boolean
Rückgabe:
  • undefined

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

BrickletHumidityV2.getSPITFPErrorCount([returnCallback][, errorCallback])
Callback-Parameter:
  • errorCountAckChecksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • errorCountMessageChecksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • errorCountFrame – Typ: int, Wertebereich: [0 bis 232 - 1]
  • errorCountOverflow – Typ: int, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • undefined

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

BrickletHumidityV2.setBootloaderMode(mode[, returnCallback][, errorCallback])
Parameter:
  • mode – Typ: int, Wertebereich: Siehe Konstanten
Callback-Parameter:
  • status – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • undefined

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootlodaer- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für mode:

  • BrickletHumidityV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletHumidityV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletHumidityV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletHumidityV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletHumidityV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

  • BrickletHumidityV2.BOOTLOADER_STATUS_OK = 0
  • BrickletHumidityV2.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletHumidityV2.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletHumidityV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletHumidityV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletHumidityV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5
BrickletHumidityV2.getBootloaderMode([returnCallback][, errorCallback])
Callback-Parameter:
  • mode – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • undefined

Gibt den aktuellen Bootloader-Modus zurück, siehe setBootloaderMode().

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für mode:

  • BrickletHumidityV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletHumidityV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletHumidityV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletHumidityV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletHumidityV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
BrickletHumidityV2.setWriteFirmwarePointer(pointer[, returnCallback][, errorCallback])
Parameter:
  • pointer – Typ: int, Wertebereich: [0 bis 232 - 1]
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Setzt den Firmware-Pointer für writeFirmware(). Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

BrickletHumidityV2.writeFirmware(data[, returnCallback][, errorCallback])
Parameter:
  • data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Callback-Parameter:
  • status – Typ: int, Wertebereich: [0 bis 255]
Rückgabe:
  • undefined

Schreibt 64 Bytes Firmware an die Position die vorher von setWriteFirmwarePointer() gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

BrickletHumidityV2.setStatusLEDConfig(config[, returnCallback][, errorCallback])
Parameter:
  • config – Typ: int, Wertebereich: Siehe Konstanten
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für config:

  • BrickletHumidityV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletHumidityV2.STATUS_LED_CONFIG_ON = 1
  • BrickletHumidityV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletHumidityV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletHumidityV2.getStatusLEDConfig([returnCallback][, errorCallback])
Callback-Parameter:
  • config – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • undefined

Gibt die Konfiguration zurück, wie von setStatusLEDConfig() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für config:

  • BrickletHumidityV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletHumidityV2.STATUS_LED_CONFIG_ON = 1
  • BrickletHumidityV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletHumidityV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletHumidityV2.getChipTemperature([returnCallback][, errorCallback])
Callback-Parameter:
  • temperature – Typ: int, Wertebereich: [-215 bis 215 - 1]
Rückgabe:
  • undefined

Gibt die Temperatur in °C, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

BrickletHumidityV2.reset([returnCallback][, errorCallback])
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

BrickletHumidityV2.writeUID(uid[, returnCallback][, errorCallback])
Parameter:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

BrickletHumidityV2.readUID([returnCallback][, errorCallback])
Callback-Parameter:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • undefined

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

BrickletHumidityV2.getIdentity([returnCallback][, errorCallback])
Callback-Parameter:
  • uid – Typ: string, Länge: bis zu 8
  • connectedUid – Typ: string, Länge: bis zu 8
  • position – Typ: char
  • hardwareVersion – Typ: [int, ...], Länge: 3, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: [int, ...], Länge: 3, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • undefined

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks

BrickletHumidityV2.on(callback_id, function)
Parameter:
  • callback_id – Typ: int
  • function – Typ: function
Rückgabe:
  • undefined

Registriert die function für die gegebene callback_id.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

BrickletHumidityV2.setHumidityCallbackConfiguration(period, valueHasToChange, option, min, max[, returnCallback][, errorCallback])
Parameter:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: boolean, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Wertebereich: [0 bis 216 - 1]
  • max – Typ: int, Wertebereich: [0 bis 216 - 1]
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Die Periode ist die Periode mit der der CALLBACK_HUMIDITY Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den CALLBACK_HUMIDITY Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

Der Standardwert ist (0, false, 'x', 0, 0).

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für option:

  • BrickletHumidityV2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletHumidityV2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletHumidityV2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletHumidityV2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletHumidityV2.THRESHOLD_OPTION_GREATER = '>'
BrickletHumidityV2.getHumidityCallbackConfiguration([returnCallback][, errorCallback])
Callback-Parameter:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: boolean, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Wertebereich: [0 bis 216 - 1]
  • max – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • undefined

Gibt die Callback-Konfiguration zurück, wie mittels setHumidityCallbackConfiguration() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für option:

  • BrickletHumidityV2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletHumidityV2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletHumidityV2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletHumidityV2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletHumidityV2.THRESHOLD_OPTION_GREATER = '>'
BrickletHumidityV2.setTemperatureCallbackConfiguration(period, valueHasToChange, option, min, max[, returnCallback][, errorCallback])
Parameter:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: boolean, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Wertebereich: [-215 bis 215 - 1]
  • max – Typ: int, Wertebereich: [-215 bis 215 - 1]
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Die Periode ist die Periode mit der der CALLBACK_TEMPERATURE Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den CALLBACK_TEMPERATURE Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

Der Standardwert ist (0, false, 'x', 0, 0).

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für option:

  • BrickletHumidityV2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletHumidityV2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletHumidityV2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletHumidityV2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletHumidityV2.THRESHOLD_OPTION_GREATER = '>'
BrickletHumidityV2.getTemperatureCallbackConfiguration([returnCallback][, errorCallback])
Callback-Parameter:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: boolean, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Wertebereich: [-215 bis 215 - 1]
  • max – Typ: int, Wertebereich: [-215 bis 215 - 1]
Rückgabe:
  • undefined

Gibt die Callback-Konfiguration zurück, wie mittels setTemperatureCallbackConfiguration() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für option:

  • BrickletHumidityV2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletHumidityV2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletHumidityV2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletHumidityV2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletHumidityV2.THRESHOLD_OPTION_GREATER = '>'

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion on() des Geräte Objektes durchgeführt werden. Der erste Parameter ist die Callback ID und der zweite Parameter die Callback-Funktion:

humidityV2.on(BrickletHumidityV2.CALLBACK_EXAMPLE,
    function (param) {
        console.log(param);
    }
);

Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen werden weiter unten beschrieben.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

BrickletHumidityV2.CALLBACK_HUMIDITY
Callback-Parameter:
  • humidity – Typ: int, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird periodisch ausgelöst abhängig von der mittels setHumidityCallbackConfiguration() gesetzten Konfiguration

Der Parameter ist der gleiche wie getHumidity().

BrickletHumidityV2.CALLBACK_TEMPERATURE
Callback-Parameter:
  • temperature – Typ: int, Wertebereich: [-215 bis 215 - 1]

Dieser Callback wird periodisch ausgelöst abhängig von der mittels setTemperatureCallbackConfiguration() gesetzten Konfiguration

Der Parameter ist der gleiche wie getTemperature().

Konstanten

BrickletHumidityV2.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Humidity Bricklet 2.0 zu identifizieren.

Die getIdentity() Funktion und der IPConnection.CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickletHumidityV2.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Humidity Bricklet 2.0 dar.