MATLAB/Octave - Outdoor Weather Bricklet¶

This is the description of the MATLAB/Octave API bindings for the Outdoor Weather Bricklet. General information and technical specifications for the Outdoor Weather Bricklet 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).

Callback (MATLAB)¶

Download (matlab_example_callback.m)

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

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

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

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

    % Enable station data callbacks
    ow.setStationCallbackConfiguration(true);

    % Enable sensor data callbacks
    ow.setSensorCallbackConfiguration(true);

    % Register station data callback to function cb_station_data
    set(ow, 'StationDataCallback', @(h, e) cb_station_data(e));

    % Register sensor data callback to function cb_sensor_data
    set(ow, 'SensorDataCallback', @(h, e) cb_sensor_data(e));

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

% Callback function for station data callback
function cb_station_data(e)
    fprintf('Identifier (Station): %i\n', e.identifier);
    fprintf('Temperature (Station): %g °C\n', e.temperature/10.0);
    fprintf('Humidity (Station): %i %%RH\n', e.humidity);
    fprintf('Wind Speed (Station): %g m/s\n', e.windSpeed/10.0);
    fprintf('Gust Speed (Station): %g m/s\n', e.gustSpeed/10.0);
    fprintf('Rain (Station): %g mm\n', e.rain/10.0);

    if e.windDirection == com.tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_N
        fprintf('Wind Direction (Station): N\n');
    elseif e.windDirection == com.tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_NNE
        fprintf('Wind Direction (Station): NNE\n');
    elseif e.windDirection == com.tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_NE
        fprintf('Wind Direction (Station): NE\n');
    elseif e.windDirection == com.tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_ENE
        fprintf('Wind Direction (Station): ENE\n');
    elseif e.windDirection == com.tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_E
        fprintf('Wind Direction (Station): E\n');
    elseif e.windDirection == com.tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_ESE
        fprintf('Wind Direction (Station): ESE\n');
    elseif e.windDirection == com.tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_SE
        fprintf('Wind Direction (Station): SE\n');
    elseif e.windDirection == com.tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_SSE
        fprintf('Wind Direction (Station): SSE\n');
    elseif e.windDirection == com.tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_S
        fprintf('Wind Direction (Station): S\n');
    elseif e.windDirection == com.tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_SSW
        fprintf('Wind Direction (Station): SSW\n');
    elseif e.windDirection == com.tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_SW
        fprintf('Wind Direction (Station): SW\n');
    elseif e.windDirection == com.tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_WSW
        fprintf('Wind Direction (Station): WSW\n');
    elseif e.windDirection == com.tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_W
        fprintf('Wind Direction (Station): W\n');
    elseif e.windDirection == com.tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_WNW
        fprintf('Wind Direction (Station): WNW\n');
    elseif e.windDirection == com.tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_NW
        fprintf('Wind Direction (Station): NW\n');
    elseif e.windDirection == com.tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_NNW
        fprintf('Wind Direction (Station): NNW\n');
    elseif e.windDirection == com.tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_ERROR
        fprintf('Wind Direction (Station): Error\n');
    end

    fprintf('Battery Low (Station): %i\n', e.batteryLow);
    fprintf('\n');
end

% Callback function for sensor data callback
function cb_sensor_data(e)
    fprintf('Identifier (Sensor): %i\n', e.identifier);
    fprintf('Temperature (Sensor): %g °C\n', e.temperature/10.0);
    fprintf('Humidity (Sensor): %i %%RH\n', e.humidity);
    fprintf('\n');
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 Outdoor Weather Bricklet

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

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

    % Enable station data callbacks
    ow.setStationCallbackConfiguration(true);

    % Enable sensor data callbacks
    ow.setSensorCallbackConfiguration(true);

    % Register station data callback to function cb_station_data
    ow.addStationDataCallback(@cb_station_data);

    % Register sensor data callback to function cb_sensor_data
    ow.addSensorDataCallback(@cb_sensor_data);

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

% Callback function for station data callback
function cb_station_data(e)
    fprintf("Identifier (Station): %d\n", e.identifier);
    fprintf("Temperature (Station): %g °C\n", e.temperature/10.0);
    fprintf("Humidity (Station): %d %%RH\n", e.humidity);
    fprintf("Wind Speed (Station): %g m/s\n", java2int(e.windSpeed)/10.0);
    fprintf("Gust Speed (Station): %g m/s\n", java2int(e.gustSpeed)/10.0);
    fprintf("Rain (Station): %g mm\n", java2int(e.rain)/10.0);

    if e.windDirection == 0
        fprintf("Wind Direction (Station): N\n");
    elseif e.windDirection == 1
        fprintf("Wind Direction (Station): NNE\n");
    elseif e.windDirection == 2
        fprintf("Wind Direction (Station): NE\n");
    elseif e.windDirection == 3
        fprintf("Wind Direction (Station): ENE\n");
    elseif e.windDirection == 4
        fprintf("Wind Direction (Station): E\n");
    elseif e.windDirection == 5
        fprintf("Wind Direction (Station): ESE\n");
    elseif e.windDirection == 6
        fprintf("Wind Direction (Station): SE\n");
    elseif e.windDirection == 7
        fprintf("Wind Direction (Station): SSE\n");
    elseif e.windDirection == 8
        fprintf("Wind Direction (Station): S\n");
    elseif e.windDirection == 9
        fprintf("Wind Direction (Station): SSW\n");
    elseif e.windDirection == 10
        fprintf("Wind Direction (Station): SW\n");
    elseif e.windDirection == 11
        fprintf("Wind Direction (Station): WSW\n");
    elseif e.windDirection == 12
        fprintf("Wind Direction (Station): W\n");
    elseif e.windDirection == 13
        fprintf("Wind Direction (Station): WNW\n");
    elseif e.windDirection == 14
        fprintf("Wind Direction (Station): NW\n");
    elseif e.windDirection == 15
        fprintf("Wind Direction (Station): NNW\n");
    elseif e.windDirection == 255
        fprintf("Wind Direction (Station): Error\n");
    end

    fprintf("Battery Low (Station): %d\n", e.batteryLow);
    fprintf("\n");
end

% Callback function for sensor data callback
function cb_sensor_data(e)
    fprintf("Identifier (Sensor): %d\n", e.identifier);
    fprintf("Temperature (Sensor): %g °C\n", e.temperature/10.0);
    fprintf("Humidity (Sensor): %d %%RH\n", e.humidity);
    fprintf("\n");
end

function int = java2int(value)
    if compare_versions(version(), "3.8", "<=")
        int = value.intValue();
    else
        int = value;
    end
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 BrickletOutdoorWeather(String uid, IPConnection ipcon)¶

Parameters:	uid – Type: String ipcon – Type: IPConnection
Returns:	outdoorWeather – Type: BrickletOutdoorWeather

Creates an object with the unique device ID uid.

In MATLAB:

import com.tinkerforge.BrickletOutdoorWeather;

outdoorWeather = BrickletOutdoorWeather('YOUR_DEVICE_UID', ipcon);

In Octave:

outdoorWeather = java_new("com.tinkerforge.BrickletOutdoorWeather", "YOUR_DEVICE_UID", ipcon);

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

int[] BrickletOutdoorWeather.getStationIdentifiers()¶

Returns:	identifiers – Type: int[], Length: variable, Range: [0 to 255]

Returns the identifiers (number between 0 and 255) of all stations that have been seen since the startup of the Bricklet.

Each station gives itself a random identifier on first startup.

Since firmware version 2.0.2 a station is removed from the list if no data was received for 12 hours.

int[] BrickletOutdoorWeather.getSensorIdentifiers()¶

Returns:	identifiers – Type: int[], Length: variable, Range: [0 to 255]

Returns the identifiers (number between 0 and 255) of all sensors that have been seen since the startup of the Bricklet.

Each sensor gives itself a random identifier on first startup.

Since firmware version 2.0.2 a sensor is removed from the list if no data was received for 12 hours.

BrickletOutdoorWeather.StationData BrickletOutdoorWeather.getStationData(int identifier)¶

Parameters:

identifier – Type: int, Range: [0 to 255]

Return Object:

temperature – Type: int, Unit: 1/10 °C, Range: [-400 to 650]
humidity – Type: int, Unit: 1 %, Range: [10 to 99]
windSpeed – Type: long, Unit: 1/10 m/s, Range: [0 to 2³² - 1]
gustSpeed – Type: long, Unit: 1/10 m/s, Range: [0 to 2³² - 1]
rain – Type: long, Unit: 1/10 mm, Range: [0 to 2³² - 1]
windDirection – Type: int, Range: See constants
batteryLow – Type: boolean
lastChange – Type: int, Unit: 1 s, Range: [0 to 2¹⁶ - 1]

Returns the last received data for a station with the given identifier. Call getStationIdentifiers() for a list of all available identifiers.

The return values are:

Temperature,
Humidity,
Wind Speed,
Gust Speed,
Rain Fall (accumulated since station power-up),
Wind Direction,
Battery Low (true if battery is low) and
Last Change (seconds since the reception of this data).

The following constants are available for this function:

For windDirection:

BrickletOutdoorWeather.WIND_DIRECTION_N = 0
BrickletOutdoorWeather.WIND_DIRECTION_NNE = 1
BrickletOutdoorWeather.WIND_DIRECTION_NE = 2
BrickletOutdoorWeather.WIND_DIRECTION_ENE = 3
BrickletOutdoorWeather.WIND_DIRECTION_E = 4
BrickletOutdoorWeather.WIND_DIRECTION_ESE = 5
BrickletOutdoorWeather.WIND_DIRECTION_SE = 6
BrickletOutdoorWeather.WIND_DIRECTION_SSE = 7
BrickletOutdoorWeather.WIND_DIRECTION_S = 8
BrickletOutdoorWeather.WIND_DIRECTION_SSW = 9
BrickletOutdoorWeather.WIND_DIRECTION_SW = 10
BrickletOutdoorWeather.WIND_DIRECTION_WSW = 11
BrickletOutdoorWeather.WIND_DIRECTION_W = 12
BrickletOutdoorWeather.WIND_DIRECTION_WNW = 13
BrickletOutdoorWeather.WIND_DIRECTION_NW = 14
BrickletOutdoorWeather.WIND_DIRECTION_NNW = 15
BrickletOutdoorWeather.WIND_DIRECTION_ERROR = 255

BrickletOutdoorWeather.SensorData BrickletOutdoorWeather.getSensorData(int identifier)¶

Parameters:	identifier – Type: int, Range: [0 to 255]
Return Object:	temperature – Type: int, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1] humidity – Type: int, Unit: 1 %, Range: [0 to 255] lastChange – Type: int, Unit: 1 s, Range: [0 to 2¹⁶ - 1]

Returns the last measured data for a sensor with the given identifier. Call getSensorIdentifiers() for a list of all available identifiers.

The return values are:

Temperature,
Humidity and
Last Change (seconds since the last reception of data).

Advanced Functions¶

BrickletOutdoorWeather.SPITFPErrorCount BrickletOutdoorWeather.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 BrickletOutdoorWeather.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:

BrickletOutdoorWeather.STATUS_LED_CONFIG_OFF = 0
BrickletOutdoorWeather.STATUS_LED_CONFIG_ON = 1
BrickletOutdoorWeather.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletOutdoorWeather.STATUS_LED_CONFIG_SHOW_STATUS = 3

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

BrickletOutdoorWeather.STATUS_LED_CONFIG_OFF = 0
BrickletOutdoorWeather.STATUS_LED_CONFIG_ON = 1
BrickletOutdoorWeather.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletOutdoorWeather.STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletOutdoorWeather.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 BrickletOutdoorWeather.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!

BrickletOutdoorWeather.Identity BrickletOutdoorWeather.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 BrickletOutdoorWeather.setStationCallbackConfiguration(boolean enableCallback)¶

Parameters:	enableCallback – Type: boolean, Default: false

Turns callback for station data on or off.

boolean BrickletOutdoorWeather.getStationCallbackConfiguration()¶

Returns:	enableCallback – Type: boolean, Default: false

Returns the configuration as set by setStationCallbackConfiguration().

void BrickletOutdoorWeather.setSensorCallbackConfiguration(boolean enableCallback)¶

Parameters:	enableCallback – Type: boolean, Default: false

Turns callback for sensor data on or off.

boolean BrickletOutdoorWeather.getSensorCallbackConfiguration()¶

Returns:	enableCallback – Type: boolean, Default: false

Returns the configuration as set by setSensorCallbackConfiguration().

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 BrickletOutdoorWeather.StationDataCallback¶

Event Object:

Event Object:	identifier – Type: int, Range: [0 to 255] temperature – Type: int, Unit: 1/10 °C, Range: [-400 to 650] humidity – Type: int, Unit: 1 %, Range: [10 to 99] windSpeed – Type: long, Unit: 1/10 m/s, Range: [0 to 2³² - 1] gustSpeed – Type: long, Unit: 1/10 m/s, Range: [0 to 2³² - 1] rain – Type: long, Unit: 1/10 mm, Range: [0 to 2³² - 1] windDirection – Type: int, Range: See constants batteryLow – Type: boolean

identifier – Type: int, Range: [0 to 255]
temperature – Type: int, Unit: 1/10 °C, Range: [-400 to 650]
humidity – Type: int, Unit: 1 %, Range: [10 to 99]
windSpeed – Type: long, Unit: 1/10 m/s, Range: [0 to 2³² - 1]
gustSpeed – Type: long, Unit: 1/10 m/s, Range: [0 to 2³² - 1]
rain – Type: long, Unit: 1/10 mm, Range: [0 to 2³² - 1]
windDirection – Type: int, Range: See constants
batteryLow – Type: boolean

Reports the station data every time a new data packet is received. See getStationData() for information about the data.

For each station the callback will be triggered about every 45 seconds.

Turn the callback on/off with setStationCallbackConfiguration() (by default it is turned off).

The following constants are available for this function:

For windDirection:

BrickletOutdoorWeather.WIND_DIRECTION_N = 0
BrickletOutdoorWeather.WIND_DIRECTION_NNE = 1
BrickletOutdoorWeather.WIND_DIRECTION_NE = 2
BrickletOutdoorWeather.WIND_DIRECTION_ENE = 3
BrickletOutdoorWeather.WIND_DIRECTION_E = 4
BrickletOutdoorWeather.WIND_DIRECTION_ESE = 5
BrickletOutdoorWeather.WIND_DIRECTION_SE = 6
BrickletOutdoorWeather.WIND_DIRECTION_SSE = 7
BrickletOutdoorWeather.WIND_DIRECTION_S = 8
BrickletOutdoorWeather.WIND_DIRECTION_SSW = 9
BrickletOutdoorWeather.WIND_DIRECTION_SW = 10
BrickletOutdoorWeather.WIND_DIRECTION_WSW = 11
BrickletOutdoorWeather.WIND_DIRECTION_W = 12
BrickletOutdoorWeather.WIND_DIRECTION_WNW = 13
BrickletOutdoorWeather.WIND_DIRECTION_NW = 14
BrickletOutdoorWeather.WIND_DIRECTION_NNW = 15
BrickletOutdoorWeather.WIND_DIRECTION_ERROR = 255

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

callback BrickletOutdoorWeather.SensorDataCallback¶

Event Object:	identifier – Type: int, Range: [0 to 255] temperature – Type: int, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1] humidity – Type: int, Unit: 1 %, Range: [0 to 255]

Reports the sensor data every time a new data packet is received. See getSensorData() for information about the data.

For each sensor the callback will be called about every 45 seconds.

Turn the callback on/off with setSensorCallbackConfiguration() (by default it is turned off).

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 addSensorDataCallback() function. An added callback function can be removed with the removeSensorDataCallback() 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[] BrickletOutdoorWeather.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 BrickletOutdoorWeather.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:

BrickletOutdoorWeather.FUNCTION_SET_STATION_CALLBACK_CONFIGURATION = 5
BrickletOutdoorWeather.FUNCTION_SET_SENSOR_CALLBACK_CONFIGURATION = 7
BrickletOutdoorWeather.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletOutdoorWeather.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletOutdoorWeather.FUNCTION_RESET = 243
BrickletOutdoorWeather.FUNCTION_WRITE_UID = 248

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

BrickletOutdoorWeather.FUNCTION_SET_STATION_CALLBACK_CONFIGURATION = 5
BrickletOutdoorWeather.FUNCTION_SET_SENSOR_CALLBACK_CONFIGURATION = 7
BrickletOutdoorWeather.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletOutdoorWeather.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletOutdoorWeather.FUNCTION_RESET = 243
BrickletOutdoorWeather.FUNCTION_WRITE_UID = 248

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

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

For status:

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

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

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

void BrickletOutdoorWeather.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 BrickletOutdoorWeather.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 BrickletOutdoorWeather.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 BrickletOutdoorWeather.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 BrickletOutdoorWeather.DEVICE_IDENTIFIER¶

This constant is used to identify a Outdoor Weather 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 BrickletOutdoorWeather.DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Outdoor Weather Bricklet.