MATLAB/Octave - Outdoor Weather Bricklet¶

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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

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);
    fprintf('Wind Direction (Station): %i\n', e.windDirection);
    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)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

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);
    fprintf("Wind Direction (Station): %d\n", e.windDirection);
    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

Basic Functions¶

public class BrickletOutdoorWeather(String uid, IPConnection ipcon)¶

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 (see examples above).

public int[] getStationIdentifiers()¶

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.

public int[] getSensorIdentifiers()¶

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.

public BrickletOutdoorWeather.StationData getStationData(int identifier)¶

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 in °C/10,
• Humidity in %RH,
• Wind Speed in m/10s,
• Gust Speed in m/10s,
• Rain Fall in mm/10,
• Wind Direction (N, NNE, NE, ENE, E, ESE, SE, SSE, S, SSW, SW, WSW, W, WNW, NW, NNW),
• Battery Low (true or false) and
• Last Change (time in seconds since the reception of this data).

The following constants are available for this function:

• 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

The returned object has the public member variables int temperature, int humidity, long windSpeed, long gustSpeed, long rain, int windDirection, boolean batteryLow and int lastChange.

public BrickletOutdoorWeather.SensorData getSensorData(int identifier)¶

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 in °C/10,
• Humidity in %RH and
• Last Change (time in seconds since the last reception of data).

The returned object has the public member variables int temperature, int humidity and int lastChange.

Advanced Functions¶

public int[] getAPIVersion()¶

Returns the version of the API definition (major, minor, revision) 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.

public boolean getResponseExpected(int functionId)¶

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 send and errors are silently ignored, because they cannot be detected.

See setResponseExpected() for the list of function ID constants available for this function.

public void setResponseExpected(int functionId, boolean responseExpected)¶

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 send and errors are silently ignored, because they cannot be detected.

The following function ID constants are available for this function:

• 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

public void setResponseExpectedAll(boolean responseExpected)¶

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

public BrickletOutdoorWeather.SPITFPErrorCount getSPITFPErrorCount()¶

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.

The returned object has the public member variables long errorCountAckChecksum, long errorCountMessageChecksum, long errorCountFrame and long errorCountOverflow.

public int setBootloaderMode(int mode)¶

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:

• 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
• 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

public int getBootloaderMode()¶

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

• 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

public void setWriteFirmwarePointer(long pointer)¶

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.

public int writeFirmware(int[] data)¶

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.

public void setStatusLEDConfig(int config)¶

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:

• 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

public int getStatusLEDConfig()¶

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

• 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

public int getChipTemperature()¶

Returns the temperature in °C 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.

public void 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!

public void writeUID(long uid)¶

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.

public long readUID()¶

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

public BrickletOutdoorWeather.Identity getIdentity()¶

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' or 'd'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

The returned object has the public member variables String uid, String connectedUid, char position, int[] hardwareVersion, int[] firmwareVersion and int deviceIdentifier.

Callback Configuration Functions¶

public void setStationCallbackConfiguration(boolean enableCallback)¶

Turns callback for station data on or off. Default is off.

public boolean getStationCallbackConfiguration()¶

Returns the configuration as set by setStationCallbackConfiguration().

public void setSensorCallbackConfiguration(boolean enableCallback)¶

Turns callback for sensor data on or off. Default is off.

public boolean getSensorCallbackConfiguration()¶

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.

public callback BrickletOutdoorWeather.StationDataCallback¶

Parameters:	identifier -- int temperature -- int humidity -- int windSpeed -- long gustSpeed -- long rain -- long windDirection -- int batteryLow -- 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:

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

public callback BrickletOutdoorWeather.SensorDataCallback¶

Parameters:	identifier -- int temperature -- int humidity -- int

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

For each station 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.

Constants¶

public static final int BrickletOutdoorWeather.DEVICE_IDENTIFIER¶

This constant is used to identify a Outdoor Weather Bricklet.

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

public static final String BrickletOutdoorWeather.DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a Outdoor Weather Bricklet.