Perl - Temperature Bricklet

Dies ist die Beschreibung der Perl API Bindings für das Temperature Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Temperature 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
#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletTemperature;

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

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

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

# Get current temperature
my $temperature = $t->get_temperature();
print "Temperature: " . $temperature/100.0 . " °C\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::BrickletTemperature;

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

# Callback subroutine for temperature callback
sub cb_temperature
{
    my ($temperature) = @_;

    print "Temperature: " . $temperature/100.0 . " °C\n";
}

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

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

# Register temperature callback to subroutine cb_temperature
$t->register_callback($t->CALLBACK_TEMPERATURE, 'cb_temperature');

# Set period for temperature callback to 1s (1000ms)
# Note: The temperature callback is only called every second
#       if the temperature has changed since the last call!
$t->set_temperature_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::BrickletTemperature;

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

# Callback subroutine for temperature reached callback
sub cb_temperature_reached
{
    my ($temperature) = @_;

    print "Temperature: " . $temperature/100.0 . " °C\n";
    print "It is too hot, we need air conditioning!\n";
}

my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
my $t = Tinkerforge::BrickletTemperature->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)
$t->set_debounce_period(10000);

# Register temperature reached callback to subroutine cb_temperature_reached
$t->register_callback($t->CALLBACK_TEMPERATURE_REACHED, 'cb_temperature_reached');

# Configure threshold for temperature "greater than 30 °C"
$t->set_temperature_callback_threshold('>', 30*100, 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
  • Error->STREAM_OUT_OF_SYNC = 51
  • Error->INVALID_UID = 61
  • Error->NON_ASCII_CHAR_IN_SECRET = 71

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

BrickletTemperature->new($uid, $ipcon)
Parameter:
  • $uid – Typ: string
  • $ipcon – Typ: IPConnection
Rückgabe:
  • $temperature – Typ: BrickletTemperature

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

$temperature = BrickletTemperature->new("YOUR_DEVICE_UID", $ipcon);

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

BrickletTemperature->get_temperature()
Rückgabe:
  • $temperature – Typ: int, Einheit: 1/100 °C, Wertebereich: [-2500 bis 8500]

Gibt die Temperatur des Sensors zurück.

Wenn die Temperatur periodisch abgefragt werden soll, wird empfohlen den CALLBACK_TEMPERATURE Callback zu nutzen und die Periode mit set_temperature_callback_period() vorzugeben.

Fortgeschrittene Funktionen

BrickletTemperature->set_i2c_mode($mode)
Parameter:
  • $mode – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:
  • undef

Setzt den I2C Modus. Mögliche Modi sind:

  • 0: Fast (400kHz)
  • 1: Slow (100kHz)

Wenn Probleme mit offensichtlichen Ausreißern in den Temperature Bricklet Messungen auftreten, können diese eventuell aufgrund von elektromagnetischen Störungen sein. In diesem Fall kann es helfen die I2C Geschwindigkeit zu verringern.

Falls in einem System ein hoher Durchsatz an Nachrichten erwünscht ist, sollte die I2C Geschwindigkeit allerdings nicht verringert werden.

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

Für $mode:

  • BrickletTemperature->I2C_MODE_FAST = 0
  • BrickletTemperature->I2C_MODE_SLOW = 1

Neu in Version 2.0.1 (Plugin).

BrickletTemperature->get_i2c_mode()
Rückgabe:
  • $mode – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0

Gibt den I2C Modus zurück, wie von set_i2c_mode() gesetzt.

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

Für $mode:

  • BrickletTemperature->I2C_MODE_FAST = 0
  • BrickletTemperature->I2C_MODE_SLOW = 1

Neu in Version 2.0.1 (Plugin).

BrickletTemperature->get_identity()
Rückgabe-Array:
  • 0: $uid – Typ: string, Länge: bis zu 8
  • 1: $connected_uid – Typ: string, Länge: bis zu 8
  • 2: $position – Typ: char, Wertebereich: ['a' bis 'h', 'i', 'z']
  • 3: @hardware_version – Typ: [int, ...], Länge: 3
    • 0: $major – Typ: int, Wertebereich: [0 bis 255]
    • 1: $minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: $revision – Typ: int, Wertebereich: [0 bis 255]
  • 4: @firmware_version – Typ: [int, ...], Länge: 3
    • 0: $major – Typ: int, Wertebereich: [0 bis 255]
    • 1: $minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: $revision – Typ: int, Wertebereich: [0 bis 255]
  • 5: $device_identifier – Typ: int, Wertebereich: [0 bis 216 - 1]

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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

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

Konfigurationsfunktionen für Callbacks

BrickletTemperature->register_callback($callback_id, $function)
Parameter:
  • $callback_id – Typ: int
  • $function – Typ: string
Rückgabe:
  • 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.

BrickletTemperature->set_temperature_callback_period($period)
Parameter:
  • $period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • undef

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

Der CALLBACK_TEMPERATURE Callback wird nur ausgelöst, wenn sich die Temperatur seit der letzten Auslösung geändert hat.

BrickletTemperature->get_temperature_callback_period()
Rückgabe:
  • $period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

BrickletTemperature->set_temperature_callback_threshold($option, $min, $max)
Parameter:
  • $option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • $min – Typ: int, Einheit: 1/100 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • $max – Typ: int, Einheit: 1/100 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
Rückgabe:
  • undef

Setzt den Schwellwert für den CALLBACK_TEMPERATURE_REACHED Callback.

Die folgenden Optionen sind möglich:

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

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

Für $option:

  • BrickletTemperature->THRESHOLD_OPTION_OFF = 'x'
  • BrickletTemperature->THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletTemperature->THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletTemperature->THRESHOLD_OPTION_SMALLER = '<'
  • BrickletTemperature->THRESHOLD_OPTION_GREATER = '>'
BrickletTemperature->get_temperature_callback_threshold()
Rückgabe-Array:
  • 0: $option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • 1: $min – Typ: int, Einheit: 1/100 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • 2: $max – Typ: int, Einheit: 1/100 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

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

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

Für $option:

  • BrickletTemperature->THRESHOLD_OPTION_OFF = 'x'
  • BrickletTemperature->THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletTemperature->THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletTemperature->THRESHOLD_OPTION_SMALLER = '<'
  • BrickletTemperature->THRESHOLD_OPTION_GREATER = '>'
BrickletTemperature->set_debounce_period($debounce)
Parameter:
  • $debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Rückgabe:
  • undef

Setzt die Periode mit welcher die Schwellwert Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

BrickletTemperature->get_debounce_period()
Rückgabe:
  • $debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

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]";
}

$temperature->register_callback(BrickletTemperature->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.

BrickletTemperature->CALLBACK_TEMPERATURE
Callback-Parameter:
  • $temperature – Typ: int, Einheit: 1/100 °C, Wertebereich: [-2500 bis 8500]

Dieser Callback wird mit der Periode, wie gesetzt mit set_temperature_callback_period(), ausgelöst. Der Parameter ist die Temperatur des Sensors.

Der CALLBACK_TEMPERATURE Callback wird nur ausgelöst, wenn sich die Temperatur seit der letzten Auslösung geändert hat.

BrickletTemperature->CALLBACK_TEMPERATURE_REACHED
Callback-Parameter:
  • $temperature – Typ: int, Einheit: 1/100 °C, Wertebereich: [-2500 bis 8500]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von set_temperature_callback_threshold() gesetzt, erreicht wird. Der Parameter ist die Temperatur des Sensors.

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

Virtuelle Funktionen

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

BrickletTemperature->get_api_version()
Rückgabe-Array:
  • 0: @api_version – Typ: [int, ...], Länge: 3
    • 0: $major – Typ: int, Wertebereich: [0 bis 255]
    • 1: $minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: $revision – Typ: int, Wertebereich: [0 bis 255]

Gibt die Version der API Definition 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.

BrickletTemperature->get_response_expected($function_id)
Parameter:
  • $function_id – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • $response_expected – Typ: 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.

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

Für $function_id:

  • BrickletTemperature->FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 2
  • BrickletTemperature->FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 4
  • BrickletTemperature->FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletTemperature->FUNCTION_SET_I2C_MODE = 10
BrickletTemperature->set_response_expected($function_id, $response_expected)
Parameter:
  • $function_id – Typ: int, Wertebereich: Siehe Konstanten
  • $response_expected – Typ: bool
Rückgabe:
  • 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 Konstanten sind für diese Funktion verfügbar:

Für $function_id:

  • BrickletTemperature->FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 2
  • BrickletTemperature->FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 4
  • BrickletTemperature->FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletTemperature->FUNCTION_SET_I2C_MODE = 10
BrickletTemperature->set_response_expected_all($response_expected)
Parameter:
  • $response_expected – Typ: bool
Rückgabe:
  • undef

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

Konstanten

BrickletTemperature->DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Temperature 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.

BrickletTemperature->DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Temperature Bricklet dar.