Perl - Hall Effect Bricklet¶

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::BrickletHallEffect;

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

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

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

# Get current edge count without reset
my $count = $he->get_edge_count(0);
print "Count: $count\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::BrickletHallEffect;

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

# Callback subroutine for edge count callback
sub cb_edge_count
{
    my ($count, $value) = @_;

    print "Count: $count\n";
}

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

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

# Register edge count callback to subroutine cb_edge_count
$he->register_callback($he->CALLBACK_EDGE_COUNT, 'cb_edge_count');

# Set period for edge count callback to 0.05s (50ms)
# Note: The edge count callback is only called every 0.05 seconds
#       if the edge count has changed since the last call!
$he->set_edge_count_callback_period(50);

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

Grundfunktionen¶

BrickletHallEffect->new($uid, $ipcon)¶

Parameter:	$uid – Typ: string $ipcon – Typ: IPConnection
Rückgabe:	$hall_effect – Typ: BrickletHallEffect

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

$hall_effect = BrickletHallEffect->new("YOUR_DEVICE_UID", $ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

BrickletHallEffect->get_value()¶

Rückgabe:	$value – Typ: bool

Gibt true zurück wenn ein Magnetfeld mit 3,5 Millitesla oder größer detektiert wird.

BrickletHallEffect->get_edge_count($reset_counter)¶

Parameter:	$reset_counter – Typ: bool
Rückgabe:	$count – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt den aktuellen Wert des Flankenzählers zurück. Die zu zählenden Flanken (steigend, fallend, beide) können mit set_edge_count_config() konfiguriert werden.

Wenn reset counter auf true gesetzt wird, wird der Zählerstand direkt nach dem auslesen auf 0 zurückgesetzt.

Fortgeschrittene Funktionen¶

BrickletHallEffect->set_edge_count_config($edge_type, $debounce)¶

Parameter:	$edge_type – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0 $debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 255], Standardwert: 100
Rückgabe:	undef

Der edge type Parameter konfiguriert den zu zählenden Flankentyp. Es können steigende, fallende oder beide Flanken gezählt werden. Mögliche Flankentypen sind:

• 0 = steigend
• 1 = fallend
• 2 = beide

Wird ein Magnet in die Nähe des Bricklets gebracht (>3,5 Millitesla) erzeugt dies ein low-Signal (fallende Flanke), wenn ein Magnet vom Bricklet entfernt (<2,5 Millitesla) wird entsteht ein high-Signal (steigende Flanke).

Durch das Konfigurieren wird der Wert des Flankenzählers auf 0 zurückgesetzt.

Falls unklar ist was dies alles bedeutet, kann diese Funktion einfach ignoriert werden. Die Standardwerte sind in fast allen Situationen OK.

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

Für $edge_type:

• BrickletHallEffect->EDGE_TYPE_RISING = 0
• BrickletHallEffect->EDGE_TYPE_FALLING = 1
• BrickletHallEffect->EDGE_TYPE_BOTH = 2

BrickletHallEffect->get_edge_count_config()¶

Rückgabe-Array:	0: $edge_type – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0 1: $debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 255], Standardwert: 100

Gibt den Flankentyp sowie die Entprellzeit zurück, wie von set_edge_count_config() gesetzt.

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

Für $edge_type:

• BrickletHallEffect->EDGE_TYPE_RISING = 0
• BrickletHallEffect->EDGE_TYPE_FALLING = 1
• BrickletHallEffect->EDGE_TYPE_BOTH = 2

BrickletHallEffect->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', '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 ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein 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¶

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

BrickletHallEffect->set_edge_interrupt($edges)¶

Parameter:	$edges – Typ: int, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:	undef

Setzt die Anzahl der zu zählenden Flanken bis ein Interrupt aufgerufen wird.

Wenn edges auf n gesetzt ist, wird der Interrupt nach jeder n-ten detektierten Flanke aufgerufen.

Wenn edges auf 0 gesetzt ist, wird der Interrupt deaktiviert.

BrickletHallEffect->get_edge_interrupt()¶

Rückgabe:	$edges – Typ: int, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt edges zurück, wie von set_edge_interrupt() gesetzt.

BrickletHallEffect->set_edge_count_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_EDGE_COUNT Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

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

$hall_effect->register_callback(BrickletHallEffect->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.

BrickletHallEffect->CALLBACK_EDGE_COUNT¶

Callback-Parameter:	$count – Typ: int, Wertebereich: [0 bis 232 - 1] $value – Typ: bool

Dieser Callback wird mit der Periode, wie gesetzt mit set_edge_count_callback_period(), ausgelöst. Die Parameter sind der aktuelle Zählerstand und der aktuelle Wert (siehe get_value() and get_edge_count()).

Der CALLBACK_EDGE_COUNT Callback wird nur ausgelöst, wenn sich mindestens einer der beiden Werte seit der letzten Auslösung geändert hat.

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.

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

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

• BrickletHallEffect->FUNCTION_SET_EDGE_COUNT_CONFIG = 3
• BrickletHallEffect->FUNCTION_SET_EDGE_INTERRUPT = 5
• BrickletHallEffect->FUNCTION_SET_EDGE_COUNT_CALLBACK_PERIOD = 7

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

• BrickletHallEffect->FUNCTION_SET_EDGE_COUNT_CONFIG = 3
• BrickletHallEffect->FUNCTION_SET_EDGE_INTERRUPT = 5
• BrickletHallEffect->FUNCTION_SET_EDGE_COUNT_CALLBACK_PERIOD = 7

BrickletHallEffect->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¶

BrickletHallEffect->DEVICE_IDENTIFIER¶

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

BrickletHallEffect->DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Hall Effect Bricklet dar.