Software / API Bindings / MATLAB/Octave / API Reference and Examples / Bricklets / Humidity Bricklet 2.0

MATLAB/Octave - Humidity Bricklet 2.0¶

This is the description of the MATLAB/Octave API bindings for the Humidity Bricklet 2.0. General information and technical specifications for the Humidity Bricklet 2.0 are summarized in its hardware description.

An installation guide for the MATLAB/Octave API bindings is part of their general description.

Examples¶

The example code below is Public Domain (CC0 1.0).

Simple (MATLAB)¶

Download (matlab_example_simple.m)

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

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

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

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

    % Get current humidity
    humidity = h.getHumidity();
    fprintf('Humidity: %g %%RH\n', humidity/100.0);

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

Callback (MATLAB)¶

Download (matlab_example_callback.m)

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

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

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

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

    % Register humidity callback to function cb_humidity
    set(h, 'HumidityCallback', @(h, e) cb_humidity(e));

    % Set period for humidity callback to 1s (1000ms) without a threshold
    h.setHumidityCallbackConfiguration(1000, false, 'x', 0, 0);

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

% Callback function for humidity callback
function cb_humidity(e)
    fprintf('Humidity: %g %%RH\n', e.humidity/100.0);
end

Threshold (MATLAB)¶

Download (matlab_example_threshold.m)

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

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

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

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

    % Register humidity callback to function cb_humidity
    set(h, 'HumidityCallback', @(h, e) cb_humidity(e));

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

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

% Callback function for humidity callback
function cb_humidity(e)
    fprintf('Humidity: %g %%RH\n', e.humidity/100.0);
    fprintf('Recommended humidity for human comfort is 30 to 60 %%RH.\n');
end

Simple (Octave)¶

Download (octave_example_simple.m)

function octave_example_simple()
    more off;

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

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

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

    % Get current humidity
    humidity = h.getHumidity();
    fprintf("Humidity: %g %%RH\n", humidity/100.0);

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

Callback (Octave)¶

Download (octave_example_callback.m)

function octave_example_callback()
    more off;

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

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

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

    % Register humidity callback to function cb_humidity
    h.addHumidityCallback(@cb_humidity);

    % Set period for humidity callback to 1s (1000ms) without a threshold
    h.setHumidityCallbackConfiguration(1000, false, "x", 0, 0);

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

% Callback function for humidity callback
function cb_humidity(e)
    fprintf("Humidity: %g %%RH\n", e.humidity/100.0);
end

Threshold (Octave)¶

Download (octave_example_threshold.m)

function octave_example_threshold()
    more off;

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

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

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

    % Register humidity callback to function cb_humidity
    h.addHumidityCallback(@cb_humidity);

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

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

% Callback function for humidity callback
function cb_humidity(e)
    fprintf("Humidity: %g %%RH\n", e.humidity/100.0);
    fprintf("Recommended humidity for human comfort is 30 to 60 %%RH.\n");
end

API¶

Generally, every method of the MATLAB bindings that returns a value can throw a TimeoutException. This exception gets thrown if the device did not respond. If a cable based connection is used, it is unlikely that this exception gets thrown (assuming nobody unplugs the device). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

Beside the TimeoutException there is also a NotConnectedException that is thrown if a method needs to communicate with the device while the IP Connection is not connected.

Since the MATLAB bindings are based on Java and Java does not support multiple return values and return by reference is not possible for primitive types, we use small classes that only consist of member variables. The member variables of the returned objects are described in the corresponding method descriptions.

The package for all Brick/Bricklet bindings and the IP Connection is com.tinkerforge.*

All methods listed below are thread-safe.

Basic Functions¶

class BrickletHumidityV2(String uid, IPConnection ipcon)¶

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

Creates an object with the unique device ID uid.

In MATLAB:

import com.tinkerforge.BrickletHumidityV2;

humidityV2 = BrickletHumidityV2('YOUR_DEVICE_UID', ipcon);

In Octave:

humidityV2 = java_new("com.tinkerforge.BrickletHumidityV2", "YOUR_DEVICE_UID", ipcon);

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

int BrickletHumidityV2.getHumidity()¶

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

Returns the humidity measured by the sensor.

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

int BrickletHumidityV2.getTemperature()¶

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

Returns the temperature measured by the sensor.

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

void BrickletHumidityV2.setHeaterConfiguration(int heaterConfig)¶

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

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

BrickletHumidityV2.HEATER_CONFIG_DISABLED = 0
BrickletHumidityV2.HEATER_CONFIG_ENABLED = 1

int BrickletHumidityV2.getHeaterConfiguration()¶

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

Returns the heater configuration as set by setHeaterConfiguration().

The following constants are available for this function:

For heaterConfig:

BrickletHumidityV2.HEATER_CONFIG_DISABLED = 0
BrickletHumidityV2.HEATER_CONFIG_ENABLED = 1

void BrickletHumidityV2.setMovingAverageConfiguration(int movingAverageLengthHumidity, int movingAverageLengthTemperature)¶

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

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.MovingAverageConfiguration BrickletHumidityV2.getMovingAverageConfiguration()¶

Return Object:	movingAverageLengthHumidity – Type: int, Range: [1 to 1000], Default: 5 movingAverageLengthTemperature – Type: int, Range: [1 to 1000], Default: 5

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

void BrickletHumidityV2.setSamplesPerSecond(int sps)¶

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

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

int BrickletHumidityV2.getSamplesPerSecond()¶

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

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.SPITFPErrorCount BrickletHumidityV2.getSPITFPErrorCount()¶

Return Object:	errorCountAckChecksum – Type: long, Range: [0 to 2³² - 1] errorCountMessageChecksum – Type: long, Range: [0 to 2³² - 1] errorCountFrame – Type: long, Range: [0 to 2³² - 1] errorCountOverflow – Type: long, Range: [0 to 2³² - 1]

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.

void BrickletHumidityV2.setStatusLEDConfig(int config)¶

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

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

int BrickletHumidityV2.getStatusLEDConfig()¶

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

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

int BrickletHumidityV2.getChipTemperature()¶

Returns:	temperature – Type: int, Unit: 1 °C, Range: [-2¹⁵ to 2¹⁵ - 1]

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.

void BrickletHumidityV2.reset()¶

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.Identity BrickletHumidityV2.getIdentity()¶

Return Object:

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 2¹⁶ - 1]

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 2¹⁶ - 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 BrickletHumidityV2.setHumidityCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max)¶

Parameters:	period – Type: long, Unit: 1 ms, Range: [0 to 2³² - 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 2¹⁶ - 1], Default: 0 max – Type: int, Unit: 1/100 %, Range: [0 to 2¹⁶ - 1], Default: 0

The period is the period with which the HumidityCallback 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 HumidityCallback 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.HumidityCallbackConfiguration BrickletHumidityV2.getHumidityCallbackConfiguration()¶

Return Object:	period – Type: long, Unit: 1 ms, Range: [0 to 2³² - 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 2¹⁶ - 1], Default: 0 max – Type: int, Unit: 1/100 %, Range: [0 to 2¹⁶ - 1], Default: 0

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 = '>'

void BrickletHumidityV2.setTemperatureCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max)¶

Parameters:	period – Type: long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1/100 °C, Range: [-2¹⁵ to 2¹⁵ - 1], Default: 0 max – Type: int, Unit: 1/100 °C, Range: [-2¹⁵ to 2¹⁵ - 1], Default: 0

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

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 TemperatureCallback 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.TemperatureCallbackConfiguration BrickletHumidityV2.getTemperatureCallbackConfiguration()¶

Return Object:	period – Type: long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1/100 °C, Range: [-2¹⁵ to 2¹⁵ - 1], Default: 0 max – Type: int, Unit: 1/100 °C, Range: [-2¹⁵ to 2¹⁵ - 1], Default: 0

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

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

callback BrickletHumidityV2.HumidityCallback¶

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

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 addHumidityCallback() function. An added callback function can be removed with the removeHumidityCallback() function.

callback BrickletHumidityV2.TemperatureCallback¶

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

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 addTemperatureCallback() function. An added callback function can be removed with the removeTemperatureCallback() 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[] BrickletHumidityV2.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 BrickletHumidityV2.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:

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

void BrickletHumidityV2.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.

The following constants are available for this function:

For functionId:

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

void BrickletHumidityV2.setResponseExpectedAll(boolean responseExpected)¶

Parameters:	responseExpected – Type: boolean

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.

int BrickletHumidityV2.setBootloaderMode(int mode)¶

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

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

int BrickletHumidityV2.getBootloaderMode()¶

Returns:	mode – Type: int, Range: See constants

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

void BrickletHumidityV2.setWriteFirmwarePointer(long pointer)¶

Parameters:	pointer – Type: long, Unit: 1 B, Range: [0 to 2³² - 1]

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.

int BrickletHumidityV2.writeFirmware(int[] data)¶

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

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.

void BrickletHumidityV2.writeUID(long uid)¶

Parameters:	uid – Type: long, Range: [0 to 2³² - 1]

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.

long BrickletHumidityV2.readUID()¶

Returns:	uid – Type: long, Range: [0 to 2³² - 1]

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

Constants¶

int BrickletHumidityV2.DEVICE_IDENTIFIER¶

This constant is used to identify a Humidity Bricklet 2.0.

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 BrickletHumidityV2.DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Humidity Bricklet 2.0.