Perl - Dust Detector Bricklet

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

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

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

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

# Get current dust density
my $dust_density = $dd->get_dust_density();
print "Dust Density: $dust_density µg/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::BrickletDustDetector;

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

# Callback subroutine for dust density callback
sub cb_dust_density
{
    my ($dust_density) = @_;

    print "Dust Density: $dust_density µg/m³\n";
}

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

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

# Register dust density callback to subroutine cb_dust_density
$dd->register_callback($dd->CALLBACK_DUST_DENSITY, 'cb_dust_density');

# Set period for dust density callback to 1s (1000ms)
# Note: The dust density callback is only called every second
#       if the dust density has changed since the last call!
$dd->set_dust_density_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
#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletDustDetector;

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

# Callback subroutine for dust density reached callback
sub cb_dust_density_reached
{
    my ($dust_density) = @_;

    print "Dust Density: $dust_density µg/m³\n";
}

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

# Register dust density reached callback to subroutine cb_dust_density_reached
$dd->register_callback($dd->CALLBACK_DUST_DENSITY_REACHED, 'cb_dust_density_reached');

# Configure threshold for dust density "greater than 10 µg/m³"
$dd->set_dust_density_callback_threshold('>', 10, 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

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

BrickletDustDetector

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

$dust_detector = BrickletDustDetector->new("YOUR_DEVICE_UID", $ipcon);

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

BrickletDustDetector->get_dust_density()
Rückgabetyp:int

Gibt die Staubdichte in µg/m³ zurück.

Wenn die Staubdichte periodisch abgefragt werden soll, wird empfohlen den CALLBACK_DUST_DENSITY Callback zu nutzen und die Periode mit set_dust_density_callback_period() vorzugeben.

Fortgeschrittene Funktionen

BrickletDustDetector->set_moving_average($average)
Parameter:$average -- int
Rückgabetyp:undef

Setzt die Länge eines gleitenden Mittelwerts für die Staubdichte.

Wenn die Länge auf 0 gesetzt wird, ist das Averaging komplett aus. Desto kleiner die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

Der Wertebereich liegt bei 0-100.

Der Standardwert ist 100.

BrickletDustDetector->get_moving_average()
Rückgabetyp:int

Gibt die Länge des gleitenden Mittelwerts zurück, wie von set_moving_average() gesetzt.

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

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

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

  • BrickletDustDetector->FUNCTION_SET_DUST_DENSITY_CALLBACK_PERIOD = 2
  • BrickletDustDetector->FUNCTION_SET_DUST_DENSITY_CALLBACK_THRESHOLD = 4
  • BrickletDustDetector->FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletDustDetector->FUNCTION_SET_MOVING_AVERAGE = 10
BrickletDustDetector->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 Konstanten sind für diese Funktion verfügbar:

  • BrickletDustDetector->FUNCTION_SET_DUST_DENSITY_CALLBACK_PERIOD = 2
  • BrickletDustDetector->FUNCTION_SET_DUST_DENSITY_CALLBACK_THRESHOLD = 4
  • BrickletDustDetector->FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletDustDetector->FUNCTION_SET_MOVING_AVERAGE = 10
BrickletDustDetector->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.

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

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

BrickletDustDetector->set_dust_density_callback_period($period)
Parameter:$period -- int
Rückgabetyp:undef

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

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

Der Standardwert ist 0.

BrickletDustDetector->get_dust_density_callback_period()
Rückgabetyp:int

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

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

undef

Setzt den Schwellwert für den CALLBACK_DUST_DENSITY_REACHED Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Staubdichte außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn der Staubdichte innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn der Staubdichte kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn der Staubdichte 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:

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

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

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

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

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

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

Setzt die Periode in ms mit welcher die Schwellwert Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

Der Standardwert ist 100.

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

$dust_detector->register_callback(BrickletDustDetector->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.

BrickletDustDetector->CALLBACK_DUST_DENSITY
Parameter:$dust_density -- int

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

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

BrickletDustDetector->CALLBACK_DUST_DENSITY_REACHED
Parameter:$dust_density -- int

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

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

Konstanten

BrickletDustDetector->DEVICE_IDENTIFIER

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

BrickletDustDetector->DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Dust Detector Bricklet dar.