MATLAB/Octave - Moisture Bricklet¶

Simple (MATLAB)¶

Download (matlab_example_simple.m)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21

function matlab_example_simple()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletMoisture;

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

    ipcon = IPConnection(); % Create IP connection
    m = handle(BrickletMoisture(UID, ipcon), 'CallbackProperties'); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Get current moisture value
    moisture = m.getMoistureValue();
    fprintf('Moisture Value: %i\n', moisture);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

Callback (MATLAB)¶

Download (matlab_example_callback.m)

 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

function matlab_example_callback()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletMoisture;

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

    ipcon = IPConnection(); % Create IP connection
    m = handle(BrickletMoisture(UID, ipcon), 'CallbackProperties'); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Register moisture value callback to function cb_moisture
    set(m, 'MoistureCallback', @(h, e) cb_moisture(e));

    % 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);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

% Callback function for moisture value callback
function cb_moisture(e)
    fprintf('Moisture Value: %i\n', e.moisture);
end

Threshold (MATLAB)¶

Download (matlab_example_threshold.m)

 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

function matlab_example_threshold()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletMoisture;

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

    ipcon = IPConnection(); % Create IP connection
    m = handle(BrickletMoisture(UID, ipcon), 'CallbackProperties'); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Get threshold callbacks with a debounce time of 1 second (1000ms)
    m.setDebouncePeriod(1000);

    % Register moisture value reached callback to function cb_moisture_reached
    set(m, 'MoistureReachedCallback', @(h, e) cb_moisture_reached(e));

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

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

% Callback function for moisture value reached callback
function cb_moisture_reached(e)
    fprintf('Moisture Value: %i\n', e.moisture);
end

Simple (Octave)¶

Download (octave_example_simple.m)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

function octave_example_simple()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Moisture Bricklet

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    m = javaObject("com.tinkerforge.BrickletMoisture", UID, ipcon); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Get current moisture value
    moisture = m.getMoistureValue();
    fprintf("Moisture Value: %d\n", moisture);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

Callback (Octave)¶

Download (octave_example_callback.m)

 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

function octave_example_callback()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Moisture Bricklet

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    m = javaObject("com.tinkerforge.BrickletMoisture", UID, ipcon); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Register moisture value callback to function cb_moisture
    m.addMoistureCallback(@cb_moisture);

    % 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);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

% Callback function for moisture value callback
function cb_moisture(e)
    fprintf("Moisture Value: %d\n", e.moisture);
end

Threshold (Octave)¶

Download (octave_example_threshold.m)

 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

function octave_example_threshold()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Moisture Bricklet

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    m = javaObject("com.tinkerforge.BrickletMoisture", UID, ipcon); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Get threshold callbacks with a debounce time of 1 second (1000ms)
    m.setDebouncePeriod(1000);

    % Register moisture value reached callback to function cb_moisture_reached
    m.addMoistureReachedCallback(@cb_moisture_reached);

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

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

% Callback function for moisture value reached callback
function cb_moisture_reached(e)
    fprintf("Moisture Value: %d\n", e.moisture);
end

Basic Functions¶

class BrickletMoisture(String uid, IPConnection ipcon)¶

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

Creates an object with the unique device ID uid.

In MATLAB:

import com.tinkerforge.BrickletMoisture;

moisture = BrickletMoisture('YOUR_DEVICE_UID', ipcon);

In Octave:

moisture = java_new("com.tinkerforge.BrickletMoisture", "YOUR_DEVICE_UID", ipcon);

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

int BrickletMoisture.getMoistureValue()¶

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

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 MoistureCallback callback and set the period with setMoistureCallbackPeriod().

Advanced Functions¶

void BrickletMoisture.setMovingAverage(short average)¶

Parameters:	average – Type: short, Range: [0 to 100], Default: 100

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.

short BrickletMoisture.getMovingAverage()¶

Returns:	average – Type: short, Range: [0 to 100], Default: 100

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

BrickletMoisture.Identity BrickletMoisture.getIdentity()¶

Return Object:

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

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¶

void BrickletMoisture.setMoistureCallbackPeriod(long period)¶

Parameters:	period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

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

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

long BrickletMoisture.getMoistureCallbackPeriod()¶

Returns:	period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by setMoistureCallbackPeriod().

void BrickletMoisture.setMoistureCallbackThreshold(char option, int min, int max)¶

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

Sets the thresholds for the MoistureReachedCallback 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.MoistureCallbackThreshold BrickletMoisture.getMoistureCallbackThreshold()¶

Return Object:	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 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 = '>'

void BrickletMoisture.setDebouncePeriod(long debounce)¶

Parameters:	debounce – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Sets the period with which the threshold callback

• MoistureReachedCallback

is triggered, if the threshold

• setMoistureCallbackThreshold()

keeps being reached.

long BrickletMoisture.getDebouncePeriod()¶

Returns:	debounce – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

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 "set" function of MATLAB. The parameters consist of the IP Connection object, the callback name and the callback function. For example, it looks like this in MATLAB:

function my_callback(e)
    fprintf('Parameter: %s\n', e.param);
end

set(device, 'ExampleCallback', @(h, e) my_callback(e));

Due to a difference in the Octave Java support the "set" function cannot be used in Octave. The registration is done with "add*Callback" functions of the device object. It looks like this in Octave:

function my_callback(e)
    fprintf("Parameter: %s\n", e.param);
end

device.addExampleCallback(@my_callback);

It is possible to add several callbacks and to remove them with the corresponding "remove*Callback" function.

The parameters of the callback are passed to the callback function as fields of the structure e, which is derived from the java.util.EventObject class. The available callback names with corresponding structure fields are described below.

callback BrickletMoisture.MoistureCallback¶

Event Object:	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 MoistureCallback callback is only triggered if the moisture value has changed since the last triggering.

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addMoistureCallback() function. An added callback function can be removed with the removeMoistureCallback() function.

callback BrickletMoisture.MoistureReachedCallback¶

Event Object:	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().

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addMoistureReachedCallback() function. An added callback function can be removed with the removeMoistureReachedCallback() function.

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.

short[] BrickletMoisture.getAPIVersion()¶

Return Object:	apiVersion – Type: short[], Length: 3 1: major – Type: short, Range: [0 to 255] 2: minor – Type: short, Range: [0 to 255] 3: revision – Type: short, 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.

boolean BrickletMoisture.getResponseExpected(byte functionId)¶

Parameters:	functionId – Type: byte, 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 functionId:

• 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

void BrickletMoisture.setResponseExpected(byte functionId, boolean responseExpected)¶

Parameters:	functionId – Type: byte, Range: See constants responseExpected – Type: boolean

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 functionId:

• 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

void BrickletMoisture.setResponseExpectedAll(boolean responseExpected)¶

Parameters:	responseExpected – Type: boolean

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

Constants¶

int BrickletMoisture.DEVICE_IDENTIFIER¶

This constant is used to identify a Moisture Bricklet.

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

String BrickletMoisture.DEVICE_DISPLAY_NAME¶

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