JavaScript - Humidity Bricklet 2.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>

Basic Functions¶

new BrickletHumidityV2(uid, ipcon)¶

Parameters:	uid – Type: string ipcon – Type: IPConnection
Returns:	humidityV2 – Type: BrickletHumidityV2

Creates an object with the unique device ID uid:

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

This object can then be used after the IP Connection is connected.

BrickletHumidityV2.getHumidity([returnCallback][, errorCallback])¶

Callback Parameters:	humidity – Type: int, Unit: 1/100 %, Range: [0 to 10000]
Returns:	undefined

Returns the humidity measured by the sensor.

If you want to get the value periodically, it is recommended to use the CALLBACK_HUMIDITY callback. You can set the callback configuration with setHumidityCallbackConfiguration().

BrickletHumidityV2.getTemperature([returnCallback][, errorCallback])¶

Callback Parameters:	temperature – Type: int, Unit: 1/100 °C, Range: [-4000 to 16500]
Returns:	undefined

Returns the temperature measured by the sensor.

If you want to get the value periodically, it is recommended to use the CALLBACK_TEMPERATURE callback. You can set the callback configuration with setTemperatureCallbackConfiguration().

BrickletHumidityV2.setHeaterConfiguration(heaterConfig[, returnCallback][, errorCallback])¶

Parameters:	heaterConfig – Type: int, Range: See constants, Default: False
Callback Parameters:	undefined
Returns:	undefined

Enables/disables the heater. The heater can be used to dry the sensor in extremely wet conditions.

The following constants are available for this function:

For heater_config:

• BrickletHumidityV2.HEATER_CONFIG_DISABLED = 0
• BrickletHumidityV2.HEATER_CONFIG_ENABLED = 1

BrickletHumidityV2.getHeaterConfiguration([returnCallback][, errorCallback])¶

Callback Parameters:	heaterConfig – Type: int, Range: See constants, Default: False
Returns:	undefined

Returns the heater configuration as set by setHeaterConfiguration().

The following constants are available for this function:

For heater_config:

• BrickletHumidityV2.HEATER_CONFIG_DISABLED = 0
• BrickletHumidityV2.HEATER_CONFIG_ENABLED = 1

BrickletHumidityV2.setMovingAverageConfiguration(movingAverageLengthHumidity, movingAverageLengthTemperature[, returnCallback][, errorCallback])¶

Parameters:	movingAverageLengthHumidity – Type: int, Range: [1 to 1000], Default: 5 movingAverageLengthTemperature – Type: int, Range: [1 to 1000], Default: 5
Callback Parameters:	undefined
Returns:	undefined

Sets the length of a moving averaging for the humidity and temperature.

Setting the length to 1 will turn the averaging off. With less averaging, there is more noise on the data.

New data is gathered every 50ms*. With a moving average of length 1000 the resulting averaging window has a length of 50s. If you want to do long term measurements the longest moving average will give the cleanest results.

* In firmware version 2.0.3 we added the setSamplesPerSecond() function. It configures the measurement frequency. Since high frequencies can result in self-heating of th IC, changed the default value from 20 samples per second to 1. With 1 sample per second a moving average length of 1000 would result in an averaging window of 1000 seconds!

BrickletHumidityV2.getMovingAverageConfiguration([returnCallback][, errorCallback])¶

Callback Parameters:	movingAverageLengthHumidity – Type: int, Range: [1 to 1000], Default: 5 movingAverageLengthTemperature – Type: int, Range: [1 to 1000], Default: 5
Returns:	undefined

Returns the moving average configuration as set by setMovingAverageConfiguration().

BrickletHumidityV2.setSamplesPerSecond(sps[, returnCallback][, errorCallback])¶

Parameters:	sps – Type: int, Range: See constants, Default: 3
Callback Parameters:	undefined
Returns:	undefined

Sets the samples per second that are gathered by the humidity/temperature sensor HDC1080.

We added this function since we found out that a high measurement frequency can lead to self-heating of the sensor. Which can distort the temperature measurement.

If you don't need a lot of measurements, you can use the lowest available measurement frequency of 0.1 samples per second for the least amount of self-heating.

Before version 2.0.3 the default was 20 samples per second. The new default is 1 sample per second.

The following constants are available for this function:

For 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

New in version 2.0.3 (Plugin).

BrickletHumidityV2.getSamplesPerSecond([returnCallback][, errorCallback])¶

Callback Parameters:	sps – Type: int, Range: See constants, Default: 3
Returns:	undefined

Returnes the samples per second, as set by setSamplesPerSecond().

The following constants are available for this function:

For 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

New in version 2.0.3 (Plugin).

Advanced Functions¶

BrickletHumidityV2.getSPITFPErrorCount([returnCallback][, errorCallback])¶

Callback Parameters:	errorCountAckChecksum – Type: int, Range: [0 to 232 - 1] errorCountMessageChecksum – Type: int, Range: [0 to 232 - 1] errorCountFrame – Type: int, Range: [0 to 232 - 1] errorCountOverflow – Type: int, Range: [0 to 232 - 1]
Returns:	undefined

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

• ACK checksum errors,
• message checksum errors,
• framing errors and
• overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

BrickletHumidityV2.setStatusLEDConfig(config[, returnCallback][, errorCallback])¶

Parameters:	config – Type: int, Range: See constants, Default: 3
Callback Parameters:	undefined
Returns:	undefined

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following constants are available for this function:

For 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 Parameters:	config – Type: int, Range: See constants, Default: 3
Returns:	undefined

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

For 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 Parameters:	temperature – Type: int, Unit: 1 °C, Range: [-215 to 215 - 1]
Returns:	undefined

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

BrickletHumidityV2.reset([returnCallback][, errorCallback])¶

Callback Parameters:	undefined
Returns:	undefined

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

BrickletHumidityV2.getIdentity([returnCallback][, errorCallback])¶

Callback Parameters:

uid – Type: string, Length: up to 8 connectedUid – Type: string, Length: up to 8 position – Type: char, Range: ['a' to 'h', 'z'] hardwareVersion – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] firmwareVersion – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] deviceIdentifier – Type: int, Range: [0 to 216 - 1]

Returns:

undefined

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions¶

BrickletHumidityV2.on(callback_id, function[, errorCallback])¶

Parameters:	callback_id – Type: int function – Type: function
Returns:	undefined

Registers the given function with the given callback_id.

The available callback IDs with corresponding function signatures are listed below.

BrickletHumidityV2.setHumidityCallbackConfiguration(period, valueHasToChange, option, min, max[, returnCallback][, errorCallback])¶

Parameters:	period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 valueHasToChange – Type: boolean, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1/100 %, Range: [0 to 216 - 1], Default: 0 max – Type: int, Unit: 1/100 %, Range: [0 to 216 - 1], Default: 0
Callback Parameters:	undefined
Returns:	undefined

The period is the period with which the CALLBACK_HUMIDITY callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the CALLBACK_HUMIDITY callback.

The following options are possible:

Option	Description
'x'	Threshold is turned off
'o'	Threshold is triggered when the value is outside the min and max values
'i'	Threshold is triggered when the value is inside or equal to the min and max values
'<'	Threshold is triggered when the value is smaller than the min value (max is ignored)
'>'	Threshold is triggered when the value is greater than the min value (max is ignored)

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The following constants are available for this function:

For 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 Parameters:	period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 valueHasToChange – Type: boolean, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1/100 %, Range: [0 to 216 - 1], Default: 0 max – Type: int, Unit: 1/100 %, Range: [0 to 216 - 1], Default: 0
Returns:	undefined

Returns the callback configuration as set by setHumidityCallbackConfiguration().

The following constants are available for this function:

For 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])¶

Parameters:	period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 valueHasToChange – Type: boolean, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1/100 °C, Range: [-215 to 215 - 1], Default: 0 max – Type: int, Unit: 1/100 °C, Range: [-215 to 215 - 1], Default: 0
Callback Parameters:	undefined
Returns:	undefined

The period is the period with which the CALLBACK_TEMPERATURE callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the CALLBACK_TEMPERATURE callback.

The following options are possible:

Option	Description
'x'	Threshold is turned off
'o'	Threshold is triggered when the value is outside the min and max values
'i'	Threshold is triggered when the value is inside or equal to the min and max values
'<'	Threshold is triggered when the value is smaller than the min value (max is ignored)
'>'	Threshold is triggered when the value is greater than the min value (max is ignored)

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The following constants are available for this function:

For 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 Parameters:	period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 valueHasToChange – Type: boolean, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1/100 °C, Range: [-215 to 215 - 1], Default: 0 max – Type: int, Unit: 1/100 °C, Range: [-215 to 215 - 1], Default: 0
Returns:	undefined

Returns the callback configuration as set by setTemperatureCallbackConfiguration().

The following constants are available for this function:

For 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 can be registered to receive time critical or recurring data from the device. The registration is done with the on() function of the device object. The first parameter is the callback ID and the second parameter the callback function:

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

The available constants with inherent number and type of parameters are described below.

BrickletHumidityV2.CALLBACK_HUMIDITY¶

Callback Parameters:	humidity – Type: int, Unit: 1/100 %, Range: [0 to 10000]

This callback is triggered periodically according to the configuration set by setHumidityCallbackConfiguration().

The parameter is the same as getHumidity().

BrickletHumidityV2.CALLBACK_TEMPERATURE¶

Callback Parameters:	temperature – Type: int, Unit: 1/100 °C, Range: [-4000 to 16500]

This callback is triggered periodically according to the configuration set by setTemperatureCallbackConfiguration().

The parameter is the same as getTemperature().

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

BrickletHumidityV2.getAPIVersion()¶

Returns:	apiVersion – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255]

Returns the version of the API definition implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

BrickletHumidityV2.getResponseExpected(functionId[, errorCallback])¶

Parameters:	functionId – Type: int, Range: See constants
Returns:	responseExpected – Type: boolean

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by setResponseExpected(). For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For 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])¶

Parameters:	functionId – Type: int, Range: See constants responseExpected – Type: boolean
Returns:	undefined

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For 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)¶

Parameters:	responseExpected – Type: boolean
Returns:	undefined

Changes the response expected flag for all setter and callback configuration functions of this device at once.

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

BrickletHumidityV2.setBootloaderMode(mode[, returnCallback][, errorCallback])¶

Parameters:	mode – Type: int, Range: See constants
Callback Parameters:	status – Type: int, Range: See constants
Returns:	undefined

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following constants are available for this function:

For 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

For 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 Parameters:	mode – Type: int, Range: See constants
Returns:	undefined

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

For 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])¶

Parameters:	pointer – Type: int, Unit: 1 B, Range: [0 to 232 - 1]
Callback Parameters:	undefined
Returns:	undefined

Sets the firmware pointer for writeFirmware(). The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

BrickletHumidityV2.writeFirmware(data[, returnCallback][, errorCallback])¶

Parameters:	data – Type: [int, ...], Length: 64, Range: [0 to 255]
Callback Parameters:	status – Type: int, Range: [0 to 255]
Returns:	undefined

Writes 64 Bytes of firmware at the position as written by setWriteFirmwarePointer() before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

BrickletHumidityV2.writeUID(uid[, returnCallback][, errorCallback])¶

Parameters:	uid – Type: int, Range: [0 to 232 - 1]
Callback Parameters:	undefined
Returns:	undefined

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

BrickletHumidityV2.readUID([returnCallback][, errorCallback])¶

Callback Parameters:	uid – Type: int, Range: [0 to 232 - 1]
Returns:	undefined

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

Constants¶

BrickletHumidityV2.DEVICE_IDENTIFIER¶

This constant is used to identify a Humidity Bricklet 2.0.

The getIdentity() function and the IPConnection.CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

BrickletHumidityV2.DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a Humidity Bricklet 2.0.