Perl - Barometer Bricklet

Dies ist die Beschreibung der Perl API Bindings für das Barometer Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Barometer 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).

Simple

Download (example_simple.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
#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletBarometer;

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

my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
my $b = Tinkerforge::BrickletBarometer->new(&UID, $ipcon); # Create device object

$ipcon->connect(&HOST, &PORT); # Connect to brickd
# Don't use device before ipcon is connected

# Get current air pressure
my $air_pressure = $b->get_air_pressure();
print "Air Pressure: " . $air_pressure/1000.0 . " mbar\n";

# Get current altitude
my $altitude = $b->get_altitude();
print "Altitude: " . $altitude/100.0 . " m\n";

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

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
#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletBarometer;

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

# Callback subroutine for air pressure callback
sub cb_air_pressure
{
    my ($air_pressure) = @_;

    print "Air Pressure: " . $air_pressure/1000.0 . " mbar\n";
}

my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
my $b = Tinkerforge::BrickletBarometer->new(&UID, $ipcon); # Create device object

$ipcon->connect(&HOST, &PORT); # Connect to brickd
# Don't use device before ipcon is connected

# Register air pressure callback to subroutine cb_air_pressure
$b->register_callback($b->CALLBACK_AIR_PRESSURE, 'cb_air_pressure');

# Set period for air pressure callback to 1s (1000ms)
# Note: The air pressure callback is only called every second
#       if the air pressure has changed since the last call!
$b->set_air_pressure_callback_period(1000);

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

Threshold

Download (example_threshold.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
#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletBarometer;

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

# Callback subroutine for air pressure reached callback
sub cb_air_pressure_reached
{
    my ($air_pressure) = @_;

    print "Air Pressure: " . $air_pressure/1000.0 . " mbar\n";
    print "Enjoy the potentially good weather!\n";
}

my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
my $b = Tinkerforge::BrickletBarometer->new(&UID, $ipcon); # Create device object

$ipcon->connect(&HOST, &PORT); # Connect to brickd
# Don't use device before ipcon is connected

# Get threshold callbacks with a debounce time of 10 seconds (10000ms)
$b->set_debounce_period(10000);

# Register air pressure reached callback to subroutine cb_air_pressure_reached
$b->register_callback($b->CALLBACK_AIR_PRESSURE_REACHED, 'cb_air_pressure_reached');

# Configure threshold for air pressure "greater than 1025 mbar"
$b->set_air_pressure_callback_threshold('>', 1025*1000, 0);

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

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

BrickletBarometer

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

$barometer = BrickletBarometer->new("YOUR_DEVICE_UID", $ipcon);

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

BrickletBarometer->get_air_pressure()
Rückgabetyp:int

Gibt den Luftdruck des Luftdrucksensors zurück. Der Wertbereich geht von 10000 bis 1200000 und ist in mbar/1000 angegeben, d.h. bei einem Wert von 1001092 wurde ein Luftdruck von 1001,092 mbar gemessen.

Wenn der Luftdruck periodisch abgefragt werden soll, wird empfohlen den CALLBACK_AIR_PRESSURE Callback zu nutzen und die Periode mit set_air_pressure_callback_period() vorzugeben.

BrickletBarometer->get_altitude()
Rückgabetyp:int

Gibt die relative Höhe des Luftdrucksensors zurück. Der Wert ist in cm angegeben und wird auf Basis der Differenz zwischen dem aktuellen Luftdruck und dem Referenzluftdruck berechnet, welcher mit set_reference_air_pressure() gesetzt werden kann.

Wenn die Höhe periodisch abgefragt werden soll, wird empfohlen den CALLBACK_ALTITUDE Callback zu nutzen und die Periode mit set_altitude_callback_period() vorzugeben.

BrickletBarometer->set_reference_air_pressure($air_pressure)
Parameter:$air_pressure -- int
Rückgabetyp:undef

Setzt den Referenzluftdruck in mbar/1000 für die Höhenberechnung. Gültige Werte liegen zwischen 10000 und 1200000. Wenn der aktuelle Luftdruckwert als Referenz übergeben wird dann gibt die Höhenberechnung 0cm aus. Als Abkürzung kann auch 0 übergeben werden, dadurch wird der Referenzluftdruck intern auf den aktuellen Luftdruckwert gesetzt.

Wohl bekannte Referenzluftdruckwerte, die in der Luftfahrt verwendet werden, sind QNH und QFE aus dem Q-Schlüssel.

Der Standardwert ist 1013,25mbar.

BrickletBarometer->get_reference_air_pressure()
Rückgabetyp:int

Gibt den Referenzluftdruckwert zurück, wie von set_reference_air_pressure() gesetzt.

Fortgeschrittene Funktionen

BrickletBarometer->get_chip_temperature()
Rückgabetyp:int

Gibt die Temperatur des Luftdrucksensors zurück. Der Wertbereich ist von -4000 bis 8500 und ist in °C/100 angegeben, d.h. bei einem Wert von 2007 wurde eine Temperatur von 20,07 °C gemessen.

Diese Temperatur wird intern zur Temperaturkompensation der Luftdruckmessung verwendet. Sie ist nicht so genau wie die Temperatur die vom Temperature Bricklet oder dem Temperature IR Bricklet gemessen wird.

BrickletBarometer->set_averaging($moving_average_pressure, $average_pressure, $average_temperature)
Parameter:
  • $moving_average_pressure -- int
  • $average_pressure -- int
  • $average_temperature -- int
Rückgabetyp:

undef

Setzt die unterschiedlichen Averaging-Parameter (Mittelwertbildung). Es ist möglich die Länge des Mittelwerts für Temperatur und Luftdruck anzugeben. Zusätzlich gibt kann die Länge für einen gleitenden Mittelwert für den Luftdruck angegeben werden. Der gleitende Mittelwert wird mit den Werten des normalen Mittelwerts berechnet. Es gibt keinen gleitenden Mittelwert für die Temperatur.

Die maximale Länge des Luftdruckmittelwerts ist 10, des Temperaturmittelwerts 255 und des gleitenden Mittelwertes 25.

Wenn alle drei Parameter auf 0 gesetzt werden, ist das Averaging komplett aus. In diesem Fall gibt es viel Rauschen auf den Daten, allerdings sind die Daten dann ohne Verzögerung. Wir empfehlen das Averaging auszustellen wenn die Daten des Barometer Bricklets zusammen mit anderen Sensordaten fusioniert werden sollen.

Der Standardwert ist 10 für die normalen Mittelwerte und 25 für den gleitenden Mittelwert

Neu in Version 2.0.1 (Plugin).

BrickletBarometer->get_averaging()
Rückgabetyp:[int, int, int]

Gibt die Averaging-Konfiguration zurück, wie von set_averaging() gesetzt.

Neu in Version 2.0.1 (Plugin).

Das zurückgegebene Array enthält die Elemente moving_average_pressure, average_pressure und average_temperature.

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

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

BrickletBarometer->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:

  • BrickletBarometer->FUNCTION_SET_AIR_PRESSURE_CALLBACK_PERIOD = 3
  • BrickletBarometer->FUNCTION_SET_ALTITUDE_CALLBACK_PERIOD = 5
  • BrickletBarometer->FUNCTION_SET_AIR_PRESSURE_CALLBACK_THRESHOLD = 7
  • BrickletBarometer->FUNCTION_SET_ALTITUDE_CALLBACK_THRESHOLD = 9
  • BrickletBarometer->FUNCTION_SET_DEBOUNCE_PERIOD = 11
  • BrickletBarometer->FUNCTION_SET_REFERENCE_AIR_PRESSURE = 13
  • BrickletBarometer->FUNCTION_SET_AVERAGING = 20
BrickletBarometer->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.

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

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

BrickletBarometer->set_air_pressure_callback_period($period)
Parameter:$period -- int
Rückgabetyp:undef

Setzt die Periode in ms mit welcher der CALLBACK_AIR_PRESSURE Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der CALLBACK_AIR_PRESSURE Callback wird nur ausgelöst wenn sich der Luftdruck seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

BrickletBarometer->get_air_pressure_callback_period()
Rückgabetyp:int

Gibt die Periode zurück, wie von set_air_pressure_callback_period() gesetzt.

BrickletBarometer->set_altitude_callback_period($period)
Parameter:$period -- int
Rückgabetyp:undef

Setzt die Periode in ms mit welcher der CALLBACK_ALTITUDE Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der CALLBACK_ALTITUDE Callback wird nur ausgelöst wenn sich Höhe seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

BrickletBarometer->get_altitude_callback_period()
Rückgabetyp:int

Gibt die Periode zurück, wie von set_altitude_callback_period() gesetzt.

BrickletBarometer->set_air_pressure_callback_threshold($option, $min, $max)
Parameter:
  • $option -- char
  • $min -- int
  • $max -- int
Rückgabetyp:

undef

Setzt den Schwellwert für den CALLBACK_AIR_PRESSURE_REACHED Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst wenn der Luftdruck außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst wenn der Luftdruck innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst wenn der Luftdruck kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst wenn der Luftdruck größer als der min Wert ist (max wird ignoriert)

Der Standardwert ist ('x', 0, 0).

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

  • BrickletBarometer->THRESHOLD_OPTION_OFF = 'x'
  • BrickletBarometer->THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletBarometer->THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletBarometer->THRESHOLD_OPTION_SMALLER = '<'
  • BrickletBarometer->THRESHOLD_OPTION_GREATER = '>'
BrickletBarometer->get_air_pressure_callback_threshold()
Rückgabetyp:[char, int, int]

Gibt den Schwellwert zurück, wie von set_air_pressure_callback_threshold() gesetzt.

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

  • BrickletBarometer->THRESHOLD_OPTION_OFF = 'x'
  • BrickletBarometer->THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletBarometer->THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletBarometer->THRESHOLD_OPTION_SMALLER = '<'
  • BrickletBarometer->THRESHOLD_OPTION_GREATER = '>'

Das zurückgegebene Array enthält die Elemente option, min und max.

BrickletBarometer->set_altitude_callback_threshold($option, $min, $max)
Parameter:
  • $option -- char
  • $min -- int
  • $max -- int
Rückgabetyp:

undef

Setzt den Schwellwert für den CALLBACK_ALTITUDE_REACHED Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst wenn die Höhe außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst wenn die Höhe innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst wenn die Höhe kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst wenn die Höhe größer als der min Wert ist (max wird ignoriert)

Der Standardwert ist ('x', 0, 0).

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

  • BrickletBarometer->THRESHOLD_OPTION_OFF = 'x'
  • BrickletBarometer->THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletBarometer->THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletBarometer->THRESHOLD_OPTION_SMALLER = '<'
  • BrickletBarometer->THRESHOLD_OPTION_GREATER = '>'
BrickletBarometer->get_altitude_callback_threshold()
Rückgabetyp:[char, int, int]

Gibt den Schwellwert zurück, wie von set_altitude_callback_threshold() gesetzt.

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

  • BrickletBarometer->THRESHOLD_OPTION_OFF = 'x'
  • BrickletBarometer->THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletBarometer->THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletBarometer->THRESHOLD_OPTION_SMALLER = '<'
  • BrickletBarometer->THRESHOLD_OPTION_GREATER = '>'

Das zurückgegebene Array enthält die Elemente option, min und max.

BrickletBarometer->set_debounce_period($debounce)
Parameter:$debounce -- int
Rückgabetyp:undef

Setzt die Periode in ms mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

Der Standardwert ist 100.

BrickletBarometer->get_debounce_period()
Rückgabetyp:int

Gibt die Entprellperiode zurück, wie von set_debounce_period() 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]";
}

$barometer->register_callback(BrickletBarometer->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.

BrickletBarometer->CALLBACK_AIR_PRESSURE
Parameter:$air_pressure -- int

Dieser Callback wird mit der Periode, wie gesetzt mit set_air_pressure_callback_period(), ausgelöst. Der Parameter ist der Luftdruck des Luftdrucksensors.

Der CALLBACK_AIR_PRESSURE Callback wird nur ausgelöst wenn sich der Luftdruck seit der letzten Auslösung geändert hat.

BrickletBarometer->CALLBACK_ALTITUDE
Parameter:$altitude -- int

Dieser Callback wird mit der Periode, wie gesetzt mit set_altitude_callback_period(), ausgelöst. Der Parameter ist die Höhe des Luftdrucksensors.

Der CALLBACK_ALTITUDE Callback wird nur ausgelöst wenn sich die Höhe seit der letzten Auslösung geändert hat.

BrickletBarometer->CALLBACK_AIR_PRESSURE_REACHED
Parameter:$air_pressure -- int

Dieser Callback wird ausgelöst wenn der Schwellwert, wie von set_air_pressure_callback_threshold() gesetzt, erreicht wird. Der Parameter ist der Luftdruck des Luftdrucksensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit set_debounce_period() gesetzt, ausgelöst.

BrickletBarometer->CALLBACK_ALTITUDE_REACHED
Parameter:$altitude -- int

Dieser Callback wird ausgelöst wenn der Schwellwert, wie von set_altitude_callback_threshold() gesetzt, erreicht wird. Der Parameter ist die Höhe des Luftdrucksensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit set_debounce_period() gesetzt, ausgelöst.

Konstanten

BrickletBarometer->DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Barometer Bricklet zu identifizieren.

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

BrickletBarometer->DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Barometer Bricklet dar.