MATLAB/Octave - UV Light Bricklet 2.0¶

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

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

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

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

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

    % Register UV index callback to function cb_uvi
    set(uvl, 'UVICallback', @(h, e) cb_uvi(e));

    % Set period for UVI callback to 1s (1000ms) without a threshold
    uvl.setUVICallbackConfiguration(1000, false, 'x', 0, 0);

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

% Callback function for UV index callback
function cb_uvi(e)
    fprintf('UV Index: %g\n', e.uvi/10.0);
end

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
22
23
24
25
26
27
28
29

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

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

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

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

    % Get current UV-A
    uva = uvl.getUVA();
    fprintf('UV-A: %g mW/m²\n', uva/10.0);

    % Get current UV-B
    uvb = uvl.getUVB();
    fprintf('UV-B: %g mW/m²\n', uvb/10.0);

    % Get current UV index
    uvi = uvl.getUVI();
    fprintf('UV Index: %g\n', uvi/10.0);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
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

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

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

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

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

    % Register UV index callback to function cb_uvi
    set(uvl, 'UVICallback', @(h, e) cb_uvi(e));

    % Configure threshold for UV index "greater than 3"
    % with a debounce period of 1s (1000ms)
    uvl.setUVICallbackConfiguration(1000, false, '>', 3*10, 0);

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

% Callback function for UV index callback
function cb_uvi(e)
    fprintf('UV Index: %g\n', e.uvi/10.0);
    fprintf('UV index > 3. Use sunscreen!\n');
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

function octave_example_callback()
    more off;

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

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

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

    % Register UV index callback to function cb_uvi
    uvl.addUVICallback(@cb_uvi);

    % Set period for UVI callback to 1s (1000ms) without a threshold
    uvl.setUVICallbackConfiguration(1000, false, "x", 0, 0);

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

% Callback function for UV index callback
function cb_uvi(e)
    fprintf("UV Index: %g\n", e.uvi/10.0);
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
21
22
23
24
25
26
27
28

function octave_example_simple()
    more off;

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

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

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

    % Get current UV-A
    uva = uvl.getUVA();
    fprintf("UV-A: %g mW/m²\n", uva/10.0);

    % Get current UV-B
    uvb = uvl.getUVB();
    fprintf("UV-B: %g mW/m²\n", uvb/10.0);

    % Get current UV index
    uvi = uvl.getUVI();
    fprintf("UV Index: %g\n", uvi/10.0);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
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

function octave_example_threshold()
    more off;

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

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

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

    % Register UV index callback to function cb_uvi
    uvl.addUVICallback(@cb_uvi);

    % Configure threshold for UV index "greater than 3"
    % with a debounce period of 1s (1000ms)
    uvl.setUVICallbackConfiguration(1000, false, ">", 3*10, 0);

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

% Callback function for UV index callback
function cb_uvi(e)
    fprintf("UV Index: %g\n", e.uvi/10.0);
    fprintf("UV index > 3. Use sunscreen!\n");
end

Basic Functions¶

class BrickletUVLightV2(String uid, IPConnection ipcon)¶

Parameters:	uid – Type: String ipcon – Type: IPConnection
Returns:	uvLightV2 – Type: BrickletUVLightV2

Creates an object with the unique device ID uid.

In MATLAB:

import com.tinkerforge.BrickletUVLightV2;

uvLightV2 = BrickletUVLightV2('YOUR_DEVICE_UID', ipcon);

In Octave:

uvLightV2 = java_new("com.tinkerforge.BrickletUVLightV2", "YOUR_DEVICE_UID", ipcon);

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

int BrickletUVLightV2.getUVA()¶

Returns:	uva – Type: int, Unit: 1/10 mW/m², Range: [-1 to 231 - 1]

Returns the UVA intensity of the sensor. The sensor has not weighted the intensity with the erythemal action spectrum to get the skin-affecting irradiation. Therefore, you cannot just divide the value by 250 to get the UVA index. To get the UV index use getUVI().

If the sensor is saturated, then -1 is returned, see setConfiguration().

If you want to get the intensity periodically, it is recommended to use the UVACallback callback and set the period with setUVACallbackConfiguration().

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

int BrickletUVLightV2.getUVB()¶

Returns:	uvb – Type: int, Unit: 1/10 mW/m², Range: [-1 to 231 - 1]

Returns the UVB intensity of the sensor. The sensor has not weighted the intensity with the erythemal action spectrum to get the skin-affecting irradiation. Therefore, you cannot just divide the value by 250 to get the UVB index. To get the UV index use getUVI().

If the sensor is saturated, then -1 is returned, see setConfiguration().

If you want to get the intensity periodically, it is recommended to use the UVBCallback callback and set the period with setUVBCallbackConfiguration().

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

int BrickletUVLightV2.getUVI()¶

Returns:	uvi – Type: int, Unit: 1/10 , Range: [-1 to 231 - 1]

Returns the UV index of the sensor, the index is given in 1/10.

If the sensor is saturated, then -1 is returned, see setConfiguration().

If you want to get the intensity periodically, it is recommended to use the UVICallback callback and set the period with setUVICallbackConfiguration().

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

Advanced Functions¶

void BrickletUVLightV2.setConfiguration(int integrationTime)¶

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

Sets the configuration of the sensor. The integration time can be configured between 50 and 800 ms. With a shorter integration time the sensor reading updates more often but contains more noise. With a longer integration the sensor reading contains less noise but updates less often.

With a longer integration time (especially 800 ms) and a higher UV intensity the sensor can be saturated. If this happens the UVA/UVB/UVI readings are all -1. In this case you need to choose a shorter integration time.

The following constants are available for this function:

For integrationTime:

• BrickletUVLightV2.INTEGRATION_TIME_50MS = 0
• BrickletUVLightV2.INTEGRATION_TIME_100MS = 1
• BrickletUVLightV2.INTEGRATION_TIME_200MS = 2
• BrickletUVLightV2.INTEGRATION_TIME_400MS = 3
• BrickletUVLightV2.INTEGRATION_TIME_800MS = 4

int BrickletUVLightV2.getConfiguration()¶

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

Returns the configuration as set by setConfiguration().

The following constants are available for this function:

For integrationTime:

• BrickletUVLightV2.INTEGRATION_TIME_50MS = 0
• BrickletUVLightV2.INTEGRATION_TIME_100MS = 1
• BrickletUVLightV2.INTEGRATION_TIME_200MS = 2
• BrickletUVLightV2.INTEGRATION_TIME_400MS = 3
• BrickletUVLightV2.INTEGRATION_TIME_800MS = 4

BrickletUVLightV2.SPITFPErrorCount BrickletUVLightV2.getSPITFPErrorCount()¶

Return Object:	errorCountAckChecksum – Type: long, Range: [0 to 232 - 1] errorCountMessageChecksum – Type: long, Range: [0 to 232 - 1] errorCountFrame – Type: long, Range: [0 to 232 - 1] errorCountOverflow – Type: long, Range: [0 to 232 - 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 BrickletUVLightV2.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:

• BrickletUVLightV2.STATUS_LED_CONFIG_OFF = 0
• BrickletUVLightV2.STATUS_LED_CONFIG_ON = 1
• BrickletUVLightV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletUVLightV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletUVLightV2.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:

• BrickletUVLightV2.STATUS_LED_CONFIG_OFF = 0
• BrickletUVLightV2.STATUS_LED_CONFIG_ON = 1
• BrickletUVLightV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletUVLightV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletUVLightV2.getChipTemperature()¶

Returns:	temperature – Type: int, Unit: 1 °C, Range: [-215 to 215 - 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 BrickletUVLightV2.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!

BrickletUVLightV2.Identity BrickletUVLightV2.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 BrickletUVLightV2.setUVACallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max)¶

Parameters:	period – Type: long, 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/10 mW/m², Range: [-231 to 231 - 1], Default: 0 max – Type: int, Unit: 1/10 mW/m², Range: [-231 to 231 - 1], Default: 0

The period is the period with which the UVACallback 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 UVACallback 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:

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

BrickletUVLightV2.UVACallbackConfiguration BrickletUVLightV2.getUVACallbackConfiguration()¶

Return Object:	period – Type: long, 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/10 mW/m², Range: [-231 to 231 - 1], Default: 0 max – Type: int, Unit: 1/10 mW/m², Range: [-231 to 231 - 1], Default: 0

Returns the callback configuration as set by setUVACallbackConfiguration().

The following constants are available for this function:

For option:

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

void BrickletUVLightV2.setUVBCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max)¶

Parameters:	period – Type: long, 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/10 mW/m², Range: [-231 to 231 - 1], Default: 0 max – Type: int, Unit: 1/10 mW/m², Range: [-231 to 231 - 1], Default: 0

The period is the period with which the UVBCallback 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 UVBCallback 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:

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

BrickletUVLightV2.UVBCallbackConfiguration BrickletUVLightV2.getUVBCallbackConfiguration()¶

Return Object:	period – Type: long, 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/10 mW/m², Range: [-231 to 231 - 1], Default: 0 max – Type: int, Unit: 1/10 mW/m², Range: [-231 to 231 - 1], Default: 0

Returns the callback configuration as set by setUVBCallbackConfiguration().

The following constants are available for this function:

For option:

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

void BrickletUVLightV2.setUVICallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max)¶

Parameters:	period – Type: long, 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/10 , Range: [-231 to 231 - 1], Default: 0 max – Type: int, Unit: 1/10 , Range: [-231 to 231 - 1], Default: 0

The period is the period with which the UVICallback 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 UVICallback 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:

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

BrickletUVLightV2.UVICallbackConfiguration BrickletUVLightV2.getUVICallbackConfiguration()¶

Return Object:	period – Type: long, 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/10 , Range: [-231 to 231 - 1], Default: 0 max – Type: int, Unit: 1/10 , Range: [-231 to 231 - 1], Default: 0

Returns the callback configuration as set by setUVICallbackConfiguration().

The following constants are available for this function:

For option:

• BrickletUVLightV2.THRESHOLD_OPTION_OFF = 'x'
• BrickletUVLightV2.THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletUVLightV2.THRESHOLD_OPTION_INSIDE = 'i'
• BrickletUVLightV2.THRESHOLD_OPTION_SMALLER = '<'
• BrickletUVLightV2.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.

callback BrickletUVLightV2.UVACallback¶

Event Object:	uva – Type: int, Unit: 1/10 mW/m², Range: [-1 to 231 - 1]

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

The parameter is the same as getUVA().

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

callback BrickletUVLightV2.UVBCallback¶

Event Object:	uvb – Type: int, Unit: 1/10 mW/m², Range: [-1 to 231 - 1]

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

The parameter is the same as getUVB().

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

callback BrickletUVLightV2.UVICallback¶

Event Object:	uvi – Type: int, Unit: 1/10 , Range: [-1 to 231 - 1]

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

The parameter is the same as getUVI().

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 addUVICallback() function. An added callback function can be removed with the removeUVICallback() 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[] BrickletUVLightV2.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 BrickletUVLightV2.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:

• BrickletUVLightV2.FUNCTION_SET_UVA_CALLBACK_CONFIGURATION = 2
• BrickletUVLightV2.FUNCTION_SET_UVB_CALLBACK_CONFIGURATION = 6
• BrickletUVLightV2.FUNCTION_SET_UVI_CALLBACK_CONFIGURATION = 10
• BrickletUVLightV2.FUNCTION_SET_CONFIGURATION = 13
• BrickletUVLightV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletUVLightV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletUVLightV2.FUNCTION_RESET = 243
• BrickletUVLightV2.FUNCTION_WRITE_UID = 248

void BrickletUVLightV2.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:

• BrickletUVLightV2.FUNCTION_SET_UVA_CALLBACK_CONFIGURATION = 2
• BrickletUVLightV2.FUNCTION_SET_UVB_CALLBACK_CONFIGURATION = 6
• BrickletUVLightV2.FUNCTION_SET_UVI_CALLBACK_CONFIGURATION = 10
• BrickletUVLightV2.FUNCTION_SET_CONFIGURATION = 13
• BrickletUVLightV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletUVLightV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletUVLightV2.FUNCTION_RESET = 243
• BrickletUVLightV2.FUNCTION_WRITE_UID = 248

void BrickletUVLightV2.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 BrickletUVLightV2.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:

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

For status:

• BrickletUVLightV2.BOOTLOADER_STATUS_OK = 0
• BrickletUVLightV2.BOOTLOADER_STATUS_INVALID_MODE = 1
• BrickletUVLightV2.BOOTLOADER_STATUS_NO_CHANGE = 2
• BrickletUVLightV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• BrickletUVLightV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• BrickletUVLightV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5

int BrickletUVLightV2.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:

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

void BrickletUVLightV2.setWriteFirmwarePointer(long pointer)¶

Parameters:	pointer – Type: long, Unit: 1 B, Range: [0 to 232 - 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 BrickletUVLightV2.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 BrickletUVLightV2.writeUID(long uid)¶

Parameters:	uid – Type: long, Range: [0 to 232 - 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 BrickletUVLightV2.readUID()¶

Returns:	uid – Type: long, Range: [0 to 232 - 1]

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

Constants¶

int BrickletUVLightV2.DEVICE_IDENTIFIER¶

This constant is used to identify a UV Light 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 BrickletUVLightV2.DEVICE_DISPLAY_NAME¶

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