Software / API Bindings / Perl / API Referenz und Beispiele / Bricklets / Linear Poti Bricklet

Perl - Linear Poti Bricklet¶

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

#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletLinearPoti;

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

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

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

# Get current position
my $position = $lp->get_position();
print "Position: $position %\n"; # Range: 0 to 100

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

Callback¶

Download (example_callback.pl)

#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletLinearPoti;

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

# Callback subroutine for position callback
sub cb_position
{
    my ($position) = @_;

    print "Position: $position %\n"; # Range: 0 to 100
}

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

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

# Register position callback to subroutine cb_position
$lp->register_callback($lp->CALLBACK_POSITION, 'cb_position');

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

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
Error->WRONG_DEVICE_TYPE = 81
Error->DEVICE_REPLACED = 82
Error->WRONG_RESPONSE_LENGTH = 83

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen¶

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

Parameter:	$uid – Typ: string $ipcon – Typ: IPConnection
Rückgabe:	$linear_poti – Typ: BrickletLinearPoti

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

$linear_poti = BrickletLinearPoti->new("YOUR_DEVICE_UID", $ipcon);

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

BrickletLinearPoti->get_position()¶

Rückgabe:	$position – Typ: int, Einheit: 1 %, Wertebereich: [0 bis 100]

Gibt die Position des Linearpotentiometers zurück. Der Wertebereich ist von 0% (Schieberegler unten) und 100% (Schieberegler oben).

Wenn die Position periodisch abgefragt werden soll, wird empfohlen den CALLBACK_POSITION Callback zu nutzen und die Periode mit set_position_callback_period() vorzugeben.

Fortgeschrittene Funktionen¶

BrickletLinearPoti->get_analog_value()¶

Rückgabe:	$value – Typ: int, Wertebereich: [0 bis 2¹² - 1]

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück.

Bemerkung

Der von get_position() zurückgegebene Wert ist über mehrere Messwerte gemittelt um das Rauschen zu vermindern, während get_analog_value() unverarbeitete Analogwerte zurück gibt. Der einzige Grund get_analog_value() zu nutzen, ist die volle Auflösung des Analog-Digital-Wandlers zu erhalten.

Wenn der Analogwert periodisch abgefragt werden soll, wird empfohlen den CALLBACK_ANALOG_VALUE Callback zu nutzen und die Periode mit set_analog_value_callback_period() vorzugeben.

BrickletLinearPoti->get_identity()¶

Rückgabe-Array:

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 2¹⁶ - 1]

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 2¹⁶ - 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¶

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

BrickletLinearPoti->set_position_callback_period($period)¶

Parameter:	$period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	undef

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

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

BrickletLinearPoti->get_position_callback_period()¶

Rückgabe:	$period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

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

BrickletLinearPoti->set_analog_value_callback_period($period)¶

Parameter:	$period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	undef

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

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

BrickletLinearPoti->get_analog_value_callback_period()¶

Rückgabe:	$period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

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

BrickletLinearPoti->set_position_callback_threshold($option, $min, $max)¶

Parameter:	$option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' $min – Typ: int, Einheit: 1 %, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 $max – Typ: int, Einheit: 1 %, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0
Rückgabe:	undef

Setzt den Schwellwert für den CALLBACK_POSITION_REACHED Callback.

Die folgenden Optionen sind möglich:

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

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

Für $option:

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

BrickletLinearPoti->get_position_callback_threshold()¶

Rückgabe-Array:	0: $option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' 1: $min – Typ: int, Einheit: 1 %, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 2: $max – Typ: int, Einheit: 1 %, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0

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

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

Für $option:

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

BrickletLinearPoti->set_analog_value_callback_threshold($option, $min, $max)¶

Parameter:	$option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' $min – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 $max – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0
Rückgabe:	undef

Setzt den Schwellwert für den CALLBACK_ANALOG_VALUE_REACHED Callback.

Die folgenden Optionen sind möglich:

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

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

Für $option:

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

BrickletLinearPoti->get_analog_value_callback_threshold()¶

Rückgabe-Array:	0: $option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' 1: $min – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 2: $max – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0

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

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

Für $option:

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

BrickletLinearPoti->set_debounce_period($debounce)¶

Parameter:	$debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 100
Rückgabe:	undef

Setzt die Periode mit welcher die Schwellwert Callbacks

CALLBACK_POSITION_REACHED,
CALLBACK_ANALOG_VALUE_REACHED

ausgelöst werden, wenn die Schwellwerte

set_position_callback_threshold(),
set_analog_value_callback_threshold()

weiterhin erreicht bleiben.

BrickletLinearPoti->get_debounce_period()¶

Rückgabe:	$debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 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]";
}

$linear_poti->register_callback(BrickletLinearPoti->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.

BrickletLinearPoti->CALLBACK_POSITION¶

Callback-Parameter:	$position – Typ: int, Einheit: 1 %, Wertebereich: [0 bis 100]

Dieser Callback wird mit der Periode, wie gesetzt mit set_position_callback_period(), ausgelöst. Der Parameter ist die Position des Linearpotentiometers.

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

BrickletLinearPoti->CALLBACK_ANALOG_VALUE¶

Callback-Parameter:	$value – Typ: int, Wertebereich: [0 bis 2¹² - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit set_analog_value_callback_period(), ausgelöst. Der Parameter ist der Analogwert des Linearpotentiometers.

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

BrickletLinearPoti->CALLBACK_POSITION_REACHED¶

Callback-Parameter:	$position – Typ: int, Einheit: 1 %, Wertebereich: [0 bis 100]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von set_position_callback_threshold() gesetzt, erreicht wird. Der Parameter ist die Position des Linearpotentiometers.

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

BrickletLinearPoti->CALLBACK_ANALOG_VALUE_REACHED¶

Callback-Parameter:	$value – Typ: int, Wertebereich: [0 bis 2¹² - 1]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von set_analog_value_callback_threshold() gesetzt, erreicht wird. Der Parameter ist der Analogwert des Linearpotentiometers.

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.

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

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

BrickletLinearPoti->FUNCTION_SET_POSITION_CALLBACK_PERIOD = 3
BrickletLinearPoti->FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
BrickletLinearPoti->FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 7
BrickletLinearPoti->FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
BrickletLinearPoti->FUNCTION_SET_DEBOUNCE_PERIOD = 11

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

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

Für $function_id:

BrickletLinearPoti->FUNCTION_SET_POSITION_CALLBACK_PERIOD = 3
BrickletLinearPoti->FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
BrickletLinearPoti->FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 7
BrickletLinearPoti->FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
BrickletLinearPoti->FUNCTION_SET_DEBOUNCE_PERIOD = 11

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

BrickletLinearPoti->DEVICE_IDENTIFIER¶

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

BrickletLinearPoti->DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Linear Poti Bricklet dar.