Perl - Outdoor Weather Bricklet

Dies ist die Beschreibung der Perl 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 Perl API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Callback

Download (example_callback.pl)

  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
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletOutdoorWeather;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your Outdoor Weather Bricklet

# Callback subroutine for station data callback
sub cb_station_data
{
    my ($identifier, $temperature, $humidity, $wind_speed, $gust_speed, $rain,
        $wind_direction, $battery_low) = @_;

    print "Identifier (Station): $identifier\n";
    print "Temperature (Station): " . $temperature/10.0 . " °C\n";
    print "Humidity (Station): $humidity %RH\n";
    print "Wind Speed (Station): " . $wind_speed/10.0 . " m/s\n";
    print "Gust Speed (Station): " . $gust_speed/10.0 . " m/s\n";
    print "Rain (Station): " . $rain/10.0 . " mm\n";

    if ($wind_direction == Tinkerforge::BrickletOutdoorWeather->WIND_DIRECTION_N)
    {
        print "Wind Direction (Station): N\n";
    }
    elsif ($wind_direction == Tinkerforge::BrickletOutdoorWeather->WIND_DIRECTION_NNE)
    {
        print "Wind Direction (Station): NNE\n";
    }
    elsif ($wind_direction == Tinkerforge::BrickletOutdoorWeather->WIND_DIRECTION_NE)
    {
        print "Wind Direction (Station): NE\n";
    }
    elsif ($wind_direction == Tinkerforge::BrickletOutdoorWeather->WIND_DIRECTION_ENE)
    {
        print "Wind Direction (Station): ENE\n";
    }
    elsif ($wind_direction == Tinkerforge::BrickletOutdoorWeather->WIND_DIRECTION_E)
    {
        print "Wind Direction (Station): E\n";
    }
    elsif ($wind_direction == Tinkerforge::BrickletOutdoorWeather->WIND_DIRECTION_ESE)
    {
        print "Wind Direction (Station): ESE\n";
    }
    elsif ($wind_direction == Tinkerforge::BrickletOutdoorWeather->WIND_DIRECTION_SE)
    {
        print "Wind Direction (Station): SE\n";
    }
    elsif ($wind_direction == Tinkerforge::BrickletOutdoorWeather->WIND_DIRECTION_SSE)
    {
        print "Wind Direction (Station): SSE\n";
    }
    elsif ($wind_direction == Tinkerforge::BrickletOutdoorWeather->WIND_DIRECTION_S)
    {
        print "Wind Direction (Station): S\n";
    }
    elsif ($wind_direction == Tinkerforge::BrickletOutdoorWeather->WIND_DIRECTION_SSW)
    {
        print "Wind Direction (Station): SSW\n";
    }
    elsif ($wind_direction == Tinkerforge::BrickletOutdoorWeather->WIND_DIRECTION_SW)
    {
        print "Wind Direction (Station): SW\n";
    }
    elsif ($wind_direction == Tinkerforge::BrickletOutdoorWeather->WIND_DIRECTION_WSW)
    {
        print "Wind Direction (Station): WSW\n";
    }
    elsif ($wind_direction == Tinkerforge::BrickletOutdoorWeather->WIND_DIRECTION_W)
    {
        print "Wind Direction (Station): W\n";
    }
    elsif ($wind_direction == Tinkerforge::BrickletOutdoorWeather->WIND_DIRECTION_WNW)
    {
        print "Wind Direction (Station): WNW\n";
    }
    elsif ($wind_direction == Tinkerforge::BrickletOutdoorWeather->WIND_DIRECTION_NW)
    {
        print "Wind Direction (Station): NW\n";
    }
    elsif ($wind_direction == Tinkerforge::BrickletOutdoorWeather->WIND_DIRECTION_NNW)
    {
        print "Wind Direction (Station): NNW\n";
    }
    elsif ($wind_direction == Tinkerforge::BrickletOutdoorWeather->WIND_DIRECTION_ERROR)
    {
        print "Wind Direction (Station): Error\n";
    }

    print "Battery Low (Station): $battery_low\n";
    print "\n";
}

# Callback subroutine for sensor data callback
sub cb_sensor_data
{
    my ($identifier, $temperature, $humidity) = @_;

    print "Identifier (Sensor): $identifier\n";
    print "Temperature (Sensor): " . $temperature/10.0 . " °C\n";
    print "Humidity (Sensor): $humidity %RH\n";
    print "\n";
}

my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
my $ow = Tinkerforge::BrickletOutdoorWeather->new(&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->set_station_callback_configuration(1);

# Enable sensor data callbacks
$ow->set_sensor_callback_configuration(1);

# Register station data callback to subroutine cb_station_data
$ow->register_callback($ow->CALLBACK_STATION_DATA, 'cb_station_data');

# Register sensor data callback to subroutine cb_sensor_data
$ow->register_callback($ow->CALLBACK_SENSOR_DATA, 'cb_sensor_data');

print "Press key to exit\n";
<STDIN>;
$ipcon->disconnect();

API

Allgemein kann jede Subroutine der Perl Bindings Fehler als Tinkerforge::Error Objekt mittels croak() melden. Das Objekt hat eine get_code() und eine get_message() Subroutine. Es sind verschiedene Fehlercodes definiert:

  • Error->ALREADY_CONNECTED = 11
  • Error->NOT_CONNECTED = 12
  • Error->CONNECT_FAILED = 13
  • Error->INVALID_FUNCTION_ID = 21
  • Error->TIMEOUT = 31
  • Error->INVALID_PARAMETER = 41
  • Error->FUNCTION_NOT_SUPPORTED = 42
  • Error->UNKNOWN_ERROR = 43

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

BrickletOutdoorWeather->new($uid, $ipcon)
Parameter:
  • $uid -- string
  • $ipcon -- IPConnection
Rückgabetyp:

BrickletOutdoorWeather

Erzeugt ein Objekt mit der eindeutigen Geräte ID $uid:

$outdoor_weather = BrickletOutdoorWeather->new("YOUR_DEVICE_UID", $ipcon);

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

BrickletOutdoorWeather->get_station_identifiers()
Rückgabetyp:[int, int, ...]

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.

BrickletOutdoorWeather->get_sensor_identifiers()
Rückgabetyp:[int, int, ...]

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->get_station_data($identifier)
Parameter:$identifier -- int
Rückgabetyp:[int, int, int, int, int, int, bool, int]

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 Array enthält die Elemente temperature, humidity, wind_speed, gust_speed, rain, wind_direction, battery_low und last_change.

BrickletOutdoorWeather->get_sensor_data($identifier)
Parameter:$identifier -- int
Rückgabetyp:[int, int, int]

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 Array enthält die Elemente temperature, humidity und last_change.

Fortgeschrittene Funktionen

BrickletOutdoorWeather->get_api_version()
Rückgabetyp:[int, int, int]

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.

BrickletOutdoorWeather->get_response_expected($function_id)
Parameter:$function_id -- int
Rückgabetyp:bool

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

Siehe set_response_expected() für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

BrickletOutdoorWeather->set_response_expected($function_id, $response_expected)
Parameter:
  • $function_id -- int
  • $response_expected -- bool
Rückgabetyp:

undef

Ä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 Funktions ID 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
BrickletOutdoorWeather->set_response_expected_all($response_expected)
Parameter:$response_expected -- bool
Rückgabetyp:undef

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

BrickletOutdoorWeather->get_spitfp_error_count()
Rückgabetyp:[int, int, int, int]

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 Array enthält die Elemente error_count_ack_checksum, error_count_message_checksum, error_count_frame und error_count_overflow.

BrickletOutdoorWeather->set_bootloader_mode($mode)
Parameter:$mode -- int
Rückgabetyp:int

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
BrickletOutdoorWeather->get_bootloader_mode()
Rückgabetyp:int

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

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->set_write_firmware_pointer($pointer)
Parameter:$pointer -- int
Rückgabetyp:undef

Setzt den Firmware-Pointer für write_firmware(). 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.

BrickletOutdoorWeather->write_firmware(@data)
Parameter:@data -- [int, int, ..61x.., int]
Rückgabetyp:int

Schreibt 64 Bytes Firmware an die Position die vorher von set_write_firmware_pointer() 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.

BrickletOutdoorWeather->set_status_led_config($config)
Parameter:$config -- int
Rückgabetyp:undef

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
BrickletOutdoorWeather->get_status_led_config()
Rückgabetyp:int

Gibt die Konfiguration zurück, wie von set_status_led_config() 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
BrickletOutdoorWeather->get_chip_temperature()
Rückgabetyp:int

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.

BrickletOutdoorWeather->reset()
Rückgabetyp:undef

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.

BrickletOutdoorWeather->write_uid($uid)
Parameter:$uid -- int
Rückgabetyp:undef

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.

BrickletOutdoorWeather->read_uid()
Rückgabetyp:int

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

BrickletOutdoorWeather->get_identity()
Rückgabetyp:[string, string, char, [int, int, int], [int, int, int], int]

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 Array enthält die Elemente uid, connected_uid, position, hardware_version, firmware_version und device_identifier.

Konfigurationsfunktionen für Callbacks

BrickletOutdoorWeather->register_callback($id, $callback)
Parameter:
  • $id -- int
  • $callback -- string
Rückgabetyp:

undef

Registriert den $function Namen für die gegebene $callback_id.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

BrickletOutdoorWeather->set_station_callback_configuration($enable_callback)
Parameter:$enable_callback -- bool
Rückgabetyp:undef

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

BrickletOutdoorWeather->get_station_callback_configuration()
Rückgabetyp:bool

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

BrickletOutdoorWeather->set_sensor_callback_configuration($enable_callback)
Parameter:$enable_callback -- bool
Rückgabetyp:undef

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

BrickletOutdoorWeather->get_sensor_callback_configuration()
Rückgabetyp:bool

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

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion register_callback() des Geräte Objektes durchgeführt werden. Der erste Parameter ist die Callback ID und der zweite Parameter ist der Name der Callback-Funktion:

sub my_callback
{
    print "@_[0]";
}

$outdoor_weather->register_callback(BrickletOutdoorWeather->CALLBACK_EXAMPLE, 'my_callback')

Die Callback Funktion wird dann von einem internen Thread der IP Connection aufgerufen werden. Im Gegensatz zu vielen anderen Programmiersprachen werden Variablen nicht automatisch zwischen Threads geteilt. Wenn eine Variable gleichzeitig in einer Callback Funktion und dem Rest des Programms genutzt werden soll, dann muss diese als :shared markiert werden. Siehe dazu auch die Dokumentation des threads::shared Perl Moduls für weitere Details.

Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen werden weiter unten 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.

BrickletOutdoorWeather->CALLBACK_STATION_DATA
Parameter:
  • $identifier -- int
  • $temperature -- int
  • $humidity -- int
  • $wind_speed -- int
  • $gust_speed -- int
  • $rain -- int
  • $wind_direction -- int
  • $battery_low -- bool

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

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

Der Callback kann mittels set_station_callback_configuration() 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
BrickletOutdoorWeather->CALLBACK_SENSOR_DATA
Parameter:
  • $identifier -- int
  • $temperature -- int
  • $humidity -- int

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

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

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

Konstanten

BrickletOutdoorWeather->DEVICE_IDENTIFIER

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

Die get_identity() Funktion und der IPConnection->CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickletOutdoorWeather->DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Outdoor Weather Bricklet dar.