JavaScript - Moisture Bricklet¶

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 Moisture Bricklet

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var m = new Tinkerforge.BrickletMoisture(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 moisture value
        m.getMoistureValue(
            function (moisture) {
                console.log('Moisture Value: ' + moisture);
            },
            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
39
40

var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var m = new Tinkerforge.BrickletMoisture(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 moisture value callback to 1s (1000ms)
        // Note: The moisture value callback is only called every second
        //       if the moisture value has changed since the last call!
        m.setMoistureCallbackPeriod(1000);
    }
);

// Register moisture value callback
m.on(Tinkerforge.BrickletMoisture.CALLBACK_MOISTURE,
    // Callback function for moisture value callback
    function (moisture) {
        console.log('Moisture Value: ' + moisture);
    }
);

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
41

var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var m = new Tinkerforge.BrickletMoisture(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 threshold callbacks with a debounce time of 1 second (1000ms)
        m.setDebouncePeriod(1000);

        // Configure threshold for moisture value "greater than 200"
        m.setMoistureCallbackThreshold('>', 200, 0);
    }
);

// Register moisture value reached callback
m.on(Tinkerforge.BrickletMoisture.CALLBACK_MOISTURE_REACHED,
    // Callback function for moisture value reached callback
    function (moisture) {
        console.log('Moisture Value: ' + moisture);
    }
);

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>Moisture Bricklet 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 m = new Tinkerforge.BrickletMoisture(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 moisture value
                        m.getMoistureValue(
                            function (moisture) {
                                textArea.value += 'Moisture Value: ' + moisture + '\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
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>Moisture Bricklet 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 m = new Tinkerforge.BrickletMoisture(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 moisture value callback to 1s (1000ms)
                        // Note: The moisture value callback is only called every second
                        //       if the moisture value has changed since the last call!
                        m.setMoistureCallbackPeriod(1000);
                    }
                );

                // Register moisture value callback
                m.on(Tinkerforge.BrickletMoisture.CALLBACK_MOISTURE,
                    // Callback function for moisture value callback
                    function (moisture) {
                        textArea.value += 'Moisture Value: ' + moisture + '\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
63

<!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>Moisture Bricklet 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 m = new Tinkerforge.BrickletMoisture(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 threshold callbacks with a debounce time of 1 second (1000ms)
                        m.setDebouncePeriod(1000);

                        // Configure threshold for moisture value "greater than 200"
                        m.setMoistureCallbackThreshold('>', 200, 0);
                    }
                );

                // Register moisture value reached callback
                m.on(Tinkerforge.BrickletMoisture.CALLBACK_MOISTURE_REACHED,
                    // Callback function for moisture value reached callback
                    function (moisture) {
                        textArea.value += 'Moisture Value: ' + moisture + '\n';
                        textArea.scrollTop = textArea.scrollHeight;
                    }
                );
            }
        </script>
    </body>
</html>

Basic Functions¶

new BrickletMoisture(uid, ipcon)¶

Parameters:	uid – Type: string ipcon – Type: IPConnection
Returns:	moisture – Type: BrickletMoisture

Creates an object with the unique device ID uid:

var moisture = new BrickletMoisture("YOUR_DEVICE_UID", ipcon);

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

BrickletMoisture.getMoistureValue([returnCallback][, errorCallback])¶

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

Returns the current moisture value. A small value corresponds to little moisture, a big value corresponds to much moisture.

If you want to get the moisture value periodically, it is recommended to use the CALLBACK_MOISTURE callback and set the period with setMoistureCallbackPeriod().

Advanced Functions¶

BrickletMoisture.setMovingAverage(average[, returnCallback][, errorCallback])¶

Parameters:	average – Type: int, Range: [0 to 100], Default: 100
Callback Parameters:	undefined
Returns:	undefined

Sets the length of a moving averaging for the moisture value.

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

BrickletMoisture.getMovingAverage([returnCallback][, errorCallback])¶

Callback Parameters:	average – Type: int, Range: [0 to 100], Default: 100
Returns:	undefined

Returns the length moving average as set by setMovingAverage().

BrickletMoisture.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¶

BrickletMoisture.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.

BrickletMoisture.setMoistureCallbackPeriod(period[, returnCallback][, errorCallback])¶

Parameters:	period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Callback Parameters:	undefined
Returns:	undefined

Sets the period with which the CALLBACK_MOISTURE callback is triggered periodically. A value of 0 turns the callback off.

The CALLBACK_MOISTURE callback is only triggered if the moisture value has changed since the last triggering.

BrickletMoisture.getMoistureCallbackPeriod([returnCallback][, errorCallback])¶

Callback Parameters:	period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Returns:	undefined

Returns the period as set by setMoistureCallbackPeriod().

BrickletMoisture.setMoistureCallbackThreshold(option, min, max[, returnCallback][, errorCallback])¶

Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: int, Range: [0 to 216 - 1], Default: 0 max – Type: int, Range: [0 to 216 - 1], Default: 0
Callback Parameters:	undefined
Returns:	undefined

Sets the thresholds for the CALLBACK_MOISTURE_REACHED callback.

The following options are possible:

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

The following constants are available for this function:

For option:

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

BrickletMoisture.getMoistureCallbackThreshold([returnCallback][, errorCallback])¶

Callback Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: int, Range: [0 to 216 - 1], Default: 0 max – Type: int, Range: [0 to 216 - 1], Default: 0
Returns:	undefined

Returns the threshold as set by setMoistureCallbackThreshold().

The following constants are available for this function:

For option:

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

BrickletMoisture.setDebouncePeriod(debounce[, returnCallback][, errorCallback])¶

Parameters:	debounce – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100
Callback Parameters:	undefined
Returns:	undefined

Sets the period with which the threshold callback

• CALLBACK_MOISTURE_REACHED

is triggered, if the threshold

• setMoistureCallbackThreshold()

keeps being reached.

BrickletMoisture.getDebouncePeriod([returnCallback][, errorCallback])¶

Callback Parameters:	debounce – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100
Returns:	undefined

Returns the debounce period as set by setDebouncePeriod().

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:

moisture.on(BrickletMoisture.CALLBACK_EXAMPLE,
    function (param) {
        console.log(param);
    }
);

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

BrickletMoisture.CALLBACK_MOISTURE¶

Callback Parameters:	moisture – Type: int, Range: [0 to 212 - 1]

This callback is triggered periodically with the period that is set by setMoistureCallbackPeriod(). The parameter is the moisture value of the sensor.

The CALLBACK_MOISTURE callback is only triggered if the moisture value has changed since the last triggering.

BrickletMoisture.CALLBACK_MOISTURE_REACHED¶

Callback Parameters:	moisture – Type: int, Range: [0 to 212 - 1]

This callback is triggered when the threshold as set by setMoistureCallbackThreshold() is reached. The parameter is the moisture value of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by setDebouncePeriod().

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.

BrickletMoisture.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.

BrickletMoisture.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:

• BrickletMoisture.FUNCTION_SET_MOISTURE_CALLBACK_PERIOD = 2
• BrickletMoisture.FUNCTION_SET_MOISTURE_CALLBACK_THRESHOLD = 4
• BrickletMoisture.FUNCTION_SET_DEBOUNCE_PERIOD = 6
• BrickletMoisture.FUNCTION_SET_MOVING_AVERAGE = 10

BrickletMoisture.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:

• BrickletMoisture.FUNCTION_SET_MOISTURE_CALLBACK_PERIOD = 2
• BrickletMoisture.FUNCTION_SET_MOISTURE_CALLBACK_THRESHOLD = 4
• BrickletMoisture.FUNCTION_SET_DEBOUNCE_PERIOD = 6
• BrickletMoisture.FUNCTION_SET_MOVING_AVERAGE = 10

BrickletMoisture.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.

Constants¶

BrickletMoisture.DEVICE_IDENTIFIER¶

This constant is used to identify a Moisture Bricklet.

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.

BrickletMoisture.DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a Moisture Bricklet.