MATLAB/Octave - Outdoor Weather Bricklet

Dies ist die Beschreibung der MATLAB/Octave API Bindings für das Outdoor Weather Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Outdoor Weather Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die MATLAB/Octave API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.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
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
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)

 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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
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

Prinzipiell kann jede Methode der MATLAB Bindings eine TimeoutException werfen. Diese Exception wird geworfen wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu groß wird.

Neben der TimeoutException kann auch noch eine NotConnectedException geworfen werden, wenn versucht wird mit einem Brick oder Bricklet zu kommunizieren, aber die IP Connection nicht verbunden ist.

Da die MATLAB Bindings auf Java basieren und Java nicht mehrere Rückgabewerte unterstützt und eine Referenzrückgabe für elementare Type nicht möglich ist, werden kleine Klassen verwendet, die nur aus Member-Variablen bestehen. Die Member-Variablen des zurückgegebenen Objektes werden in der jeweiligen Methodenbeschreibung erläutert.

Das Package für alle Brick/Bricklet Bindings und die IP Connection ist com.tinkerforge.*

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

class BrickletOutdoorWeather(String uid, IPConnection ipcon)

Erzeugt ein Objekt mit der eindeutigen Geräte 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);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

int[] BrickletOutdoorWeather.getStationIdentifiers()

Gibt die Identifier (Zahl zwischen 0 und 255) von allen 'Stationen <https://www.tinkerforge.com/de/shop/accessories/sensors/outdoor-weather-station-ws-6147.html>`__ die seit dem Start des Bricklets entdeckt wurden.

Jede Station gibt sich selbst einen zufälligen Identifier beim ersten Start.

Seit Firmware-Version 2.0.2 wird eine Station von der Liste wieder entfernt wenn für 12 Stunden am Stück keine Daten empfangen werden.

int[] BrickletOutdoorWeather.getSensorIdentifiers()

Gibt die Identifier (Zahl zwischen 0 und 255) von allen 'Sensoren <https://www.tinkerforge.com/en/shop/accessories/sensors/temperature-humidity-sensor-th-6148.html>`__ die seit dem Start des Bricklets entdeckt wurden.

Jede Sensor gibt sich selbst einen zufälligen Identifier beim ersten Start.

Seit Firmware-Version 2.0.2 wird ein Sensor von der Liste wieder entfernt wenn für 12 Stunden am Stück keine Daten empfangen werden.

BrickletOutdoorWeather.StationData BrickletOutdoorWeather.getStationData(int identifier)

Gibt die zuletzt empfangenen Daten für die Station mit dem entsprechenden Identifier zurück.

Die Rückgabewerte sind:

  • Temperatur in °C/10,
  • Luftfeuchte in %RH,
  • Windgeschwindigkeit in m/10s,
  • Windböengeschwindigkeit in m/10s,
  • Niederschlag in mm/10,
  • Windrichtung (N, NNE, NE, ENE, E, ESE, SE, SSE, S, SSW, SW, WSW, W, WNW, NW, NNW),
  • Batteriewarnung (true oder false) und
  • Letzte Änderung (Zeit in Sekunden seitdem diese Daten empfangen wurden).

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • 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

Das zurückgegebene Objekt enthält die Public-Member-Variablen int temperature, int humidity, long windSpeed, long gustSpeed, long rain, int windDirection, boolean batteryLow und int lastChange.

BrickletOutdoorWeather.SensorData BrickletOutdoorWeather.getSensorData(int identifier)

Gibt die zuletzt empfangenen Daten für den Sensor mit dem entsprechenden Identifier zurück.

Die Rückgabewerte sind:

  • Temperatur in °C/10,
  • Luftfeuchte in %RH und
  • Letzte Änderung (Zeit in Sekunden seitdem diese Daten empfangen wurden).

Das zurückgegebene Objekt enthält die Public-Member-Variablen int temperature, int humidity und int lastChange.

Fortgeschrittene Funktionen

int[] BrickletOutdoorWeather.getAPIVersion()

Gibt die Version der API Definition (Major, Minor, Revision) zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

boolean BrickletOutdoorWeather.getResponseExpected(int functionId)

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels setResponseExpected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • 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(int functionId, boolean responseExpected)

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

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

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

BrickletOutdoorWeather.SPITFPErrorCount BrickletOutdoorWeather.getSPITFPErrorCount()

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

Das zurückgegebene Objekt enthält die Public-Member-Variablen long errorCountAckChecksum, long errorCountMessageChecksum, long errorCountFrame und long errorCountOverflow.

int BrickletOutdoorWeather.setBootloaderMode(int mode)

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootlodaer- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • 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
int BrickletOutdoorWeather.getBootloaderMode()

Gibt den aktuellen Bootloader-Modus zurück, siehe setBootloaderMode().

Die folgenden Konstanten sind für diese Funktion verfügbar:

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

Setzt den Firmware-Pointer für writeFirmware(). Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

int BrickletOutdoorWeather.writeFirmware(int[] data)

Schreibt 64 Bytes Firmware an die Position die vorher von setWriteFirmwarePointer() gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

void BrickletOutdoorWeather.setStatusLEDConfig(int config)

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

Die folgenden Konstanten sind für diese Funktion verfügbar:

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

Gibt die Konfiguration zurück, wie von setStatusLEDConfig() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

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

Gibt die Temperatur in °C, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

void BrickletOutdoorWeather.reset()

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

void BrickletOutdoorWeather.writeUID(long uid)

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

long BrickletOutdoorWeather.readUID()

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

BrickletOutdoorWeather.Identity BrickletOutdoorWeather.getIdentity()

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Das zurückgegebene Objekt enthält die Public-Member-Variablen String uid, String connectedUid, char position, int[] hardwareVersion, int[] firmwareVersion und int deviceIdentifier.

Konfigurationsfunktionen für Callbacks

void BrickletOutdoorWeather.setStationCallbackConfiguration(boolean enableCallback)

Aktiviert/Deaktiviert den Callback für Stationsdaten. Standardmäßig ist der Callback deaktiviert.

boolean BrickletOutdoorWeather.getStationCallbackConfiguration()

Gibt die Konfiguration zurück wie von setStationCallbackConfiguration() gesetzt.

void BrickletOutdoorWeather.setSensorCallbackConfiguration(boolean enableCallback)

Aktiviert/Deaktiviert den Callback für Sensordaten. Standardmäßig ist der Callback deaktiviert.

boolean BrickletOutdoorWeather.getSensorCallbackConfiguration()

Gibt die Konfiguration zurück wie von setSensorCallbackConfiguration() gesetzt.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung wird mit MATLABs "set" Funktion durchgeführt. Die Parameter sind ein Gerätobjekt, der Callback-Name und die Callback-Funktion. Hier ein Beispiel in MATLAB:

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

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

Die Octave Java Unterstützung unterscheidet sich hier von MATLAB, die "set" Funktion kann hier nicht verwendet werden. Die Registrierung wird in Octave mit "add*Callback" Funktionen des Gerätobjekts durchgeführt. Hier ein Beispiel in Octave:

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

device.addExampleCallback(@my_callback);

Es ist möglich mehrere Callback-Funktion hinzuzufügen und auch mit einem korrespondierenden "remove*Callback" wieder zu entfernen.

Die Parameter des Callbacks werden der Callback-Funktion als Felder der Struktur e übergeben. Diese ist von der java.util.EventObject Klasse abgeleitete. Die verfügbaren Callback-Namen mit den entsprechenden Strukturfeldern werden unterhalb beschrieben.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

callback BrickletOutdoorWeather.StationDataCallback
Parameter:
  • identifier -- int
  • temperature -- int
  • humidity -- int
  • windSpeed -- long
  • gustSpeed -- long
  • rain -- long
  • windDirection -- int
  • batteryLow -- boolean

Meldet die Stationsdaten bei jedem eingehenden Datenpaket. Siehe getStationData() für Details über die Daten.

Für jede Station wird dieser Callback ca. alle 45 Sekunden ausgelöst werden.

Der Callback kann mittels setStationCallbackConfiguration() aktiviert/deaktiviert werden (standardmäßig ist der Callback deaktiviert).

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • 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 kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.

In Octave kann diesem Callback mit addStationDataCallback() eine Callback-Function hinzugefügt werde. Eine hinzugefügter Callback-Function kann mit removeStationDataCallback() wieder entfernt werden.

callback BrickletOutdoorWeather.SensorDataCallback
Parameter:
  • identifier -- int
  • temperature -- int
  • humidity -- int

Meldet die Sensordaten bei jedem eingehenden Datenpaket. Siehe getSensorData() für Details über die Daten.

Für jeden Sensor wird dieser Callback ca. alle 45 Sekunden ausgelöst werden.

Der Callback kann mittels setSensorCallbackConfiguration() aktiviert/deaktiviert werden (standardmäßig ist der Callback deaktiviert).

In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.

In Octave kann diesem Callback mit addSensorDataCallback() eine Callback-Function hinzugefügt werde. Eine hinzugefügter Callback-Function kann mit removeSensorDataCallback() wieder entfernt werden.

Konstanten

static final int BrickletOutdoorWeather.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Outdoor Weather Bricklet zu identifizieren.

Die getIdentity() Funktion und der IPConnection.EnumerateCallback Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

static final String BrickletOutdoorWeather.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Outdoor Weather Bricklet dar.