Dies ist die Beschreibung der Perl API Bindings für das Solid State Relay Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Solid State Relay Bricklet sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die Perl API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
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 | #!/usr/bin/perl
use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletSolidStateRelay;
use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your Solid State Relay Bricklet
my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
my $ssr = Tinkerforge::BrickletSolidStateRelay->new(&UID, $ipcon); # Create device object
$ipcon->connect(&HOST, &PORT); # Connect to brickd
# Don't use device before ipcon is connected
# Turn relay on/off 10 times with 1 second delay
for (my $i = 0; $i < 5; $i++)
{
sleep(1);
$ssr->set_state(1);
sleep(1);
$ssr->set_state(0);
}
print "Press key to exit\n";
<STDIN>;
$ipcon->disconnect();
|
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:
Alle folgend aufgelisteten Funktionen sind Thread-sicher.
Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID $uid:
$solid_state_relay = BrickletSolidStateRelay->new("YOUR_DEVICE_UID", $ipcon);
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).
Parameter: |
|
---|---|
Rückgabe: |
|
Setzt den Zustand des Relais, true bedeutet ein und false aus.
Ein laufender Monoflop Timer wird abgebrochen, wenn diese Funktion aufgerufen wird.
Rückgabe: |
|
---|
Gibt den Zustand der Relais zurück, true bedeutet ein und false aus.
Parameter: |
|
---|---|
Rückgabe: |
|
Der erste Parameter ist der gewünschte Zustand des Relais (true bedeutet ein und false aus). Der zweite Parameter stellt die Zeit dar, welche das Relais den Zustand halten soll.
Wenn diese Funktion mit den Parametern (true, 1500) aufgerufen wird: Das Relais wird angeschaltet und nach 1,5s wieder ausgeschaltet.
Ein Monoflop kann als Ausfallsicherung verwendet werden. Beispiel: Angenommen ein RS485 Bus und ein Dual Relay Bricklet ist an ein Slave Stapel verbunden. Jetzt kann diese Funktion sekündlich, mit einem Zeitparameter von 2 Sekunden, aufgerufen werden. Das Relais wird die gesamte Zeit ein sein. Wenn jetzt die RS485 Verbindung getrennt wird, wird das Relais nach spätestens zwei Sekunden ausschalten.
Rückgabe-Array: |
|
---|
Gibt den aktuellen Zustand und die Zeit, wie von set_monoflop() gesetzt, sowie die noch verbleibende Zeit bis zum Zustandswechsel, zurück.
Wenn der Timer aktuell nicht läuft, ist die noch verbleibende Zeit 0.
Rückgabe-Array: |
|
---|
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.
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]";
}
$solid_state_relay->register_callback(BrickletSolidStateRelay->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.
Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn ein Monoflop Timer abläuft (0 erreicht). Der Parameter ist der aktuellen Zustand des Relais (der Zustand nach dem Monoflop).
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.
Rückgabe-Array: |
|
---|
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.
Parameter: |
|
---|---|
Rückgabe: |
|
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:
Parameter: |
|
---|---|
Rückgabe: |
|
Ä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:
Parameter: |
|
---|---|
Rückgabe: |
|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
Diese Konstante wird verwendet um ein Solid State Relay 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.
Diese Konstante stellt den Anzeigenamen eines Solid State Relay Bricklet dar.