Perl - Voltage/Current Bricklet 2.0

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

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletVoltageCurrentV2;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your Voltage/Current Bricklet 2.0

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

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

# Get current voltage
my $voltage = $vc->get_voltage();
print "Voltage: " . $voltage/1000.0 . " V\n";

# Get current current
my $current = $vc->get_current();
print "Current: " . $current/1000.0 . " A\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
#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletVoltageCurrentV2;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your Voltage/Current Bricklet 2.0

# Callback subroutine for current callback
sub cb_current
{
    my ($current) = @_;

    print "Current: " . $current/1000.0 . " A\n";
}

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

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

# Register current callback to subroutine cb_current
$vc->register_callback($vc->CALLBACK_CURRENT, 'cb_current');

# Set period for current callback to 1s (1000ms) without a threshold
$vc->set_current_callback_configuration(1000, 0, 'x', 0, 0);

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
#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletVoltageCurrentV2;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your Voltage/Current Bricklet 2.0

# Callback subroutine for power callback
sub cb_power
{
    my ($power) = @_;

    print "power: " . $power/1000.0 . " W\n";
}

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

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

# Register power callback to subroutine cb_power
$vc->register_callback($vc->CALLBACK_POWER, 'cb_power');

# Configure threshold for power "greater than 10 W"
# with a debounce period of 1s (1000ms)
$vc->set_power_callback_configuration(1000, 0, '>', 10*1000, 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

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

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

BrickletVoltageCurrentV2

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

$voltage_current_v2 = BrickletVoltageCurrentV2->new("YOUR_DEVICE_UID", $ipcon);

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

BrickletVoltageCurrentV2->get_current()
Rückgabetyp:int

Gibt die gemessenen Stromstärke zurück. Der Wert ist in mA und im Bereich von -20000mA bis 20000mA.

Wenn der Wert periodisch benötigt wird, kann auch der CALLBACK_CURRENT Callback verwendet werden. Der Callback wird mit der Funktion set_current_callback_configuration() konfiguriert.

BrickletVoltageCurrentV2->get_voltage()
Rückgabetyp:int

Gibt die gemessenen Spannung zurück. Der Wert ist in mV und im Bereich von 0mV bis 36000mV.

Wenn der Wert periodisch benötigt wird, kann auch der CALLBACK_VOLTAGE Callback verwendet werden. Der Callback wird mit der Funktion set_voltage_callback_configuration() konfiguriert.

BrickletVoltageCurrentV2->get_power()
Rückgabetyp:int

Gibt die gemessenen Leistung zurück. Der Wert ist in mW und im Bereich von 0mW bis 720000mW.

Wenn der Wert periodisch benötigt wird, kann auch der CALLBACK_POWER Callback verwendet werden. Der Callback wird mit der Funktion set_power_callback_configuration() konfiguriert.

BrickletVoltageCurrentV2->set_configuration($averaging, $voltage_conversion_time, $current_conversion_time)
Parameter:
  • $averaging -- int
  • $voltage_conversion_time -- int
  • $current_conversion_time -- int
Rückgabetyp:

undef

Setzt die Konfiguration des Voltage/Current Bricklet 2.0. Es ist möglich die Anzahl für die Durchschnittsbildung, und die Wandlungszeit für Spannung und Stromstärke zu definieren.

Durchschnittsbildung:

Wert Anzahl
0 1
1 4
2 16
3 64
4 128
5 256
6 512
>=7 1024

Wandlungszeit für Spannung/Stromstärke:

Wert Wandlungszeit
0 140µs
1 204µs
2 332µs
3 588µs
4 1.1ms
5 2.116ms
6 4.156ms
>=7 8.244ms

Die Standardwerte sind 3, 4 und 4 (64, 1.1ms, 1.1ms) für die Durchschnittsbildung und die Spannungs/Stromstärkenwandlungszeit.

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

  • BrickletVoltageCurrentV2->AVERAGING_1 = 0
  • BrickletVoltageCurrentV2->AVERAGING_4 = 1
  • BrickletVoltageCurrentV2->AVERAGING_16 = 2
  • BrickletVoltageCurrentV2->AVERAGING_64 = 3
  • BrickletVoltageCurrentV2->AVERAGING_128 = 4
  • BrickletVoltageCurrentV2->AVERAGING_256 = 5
  • BrickletVoltageCurrentV2->AVERAGING_512 = 6
  • BrickletVoltageCurrentV2->AVERAGING_1024 = 7
BrickletVoltageCurrentV2->get_configuration()
Rückgabetyp:[int, int, int]

Gibt die Konfiguration zurück, wie von set_configuration() gesetzt.

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

  • BrickletVoltageCurrentV2->AVERAGING_1 = 0
  • BrickletVoltageCurrentV2->AVERAGING_4 = 1
  • BrickletVoltageCurrentV2->AVERAGING_16 = 2
  • BrickletVoltageCurrentV2->AVERAGING_64 = 3
  • BrickletVoltageCurrentV2->AVERAGING_128 = 4
  • BrickletVoltageCurrentV2->AVERAGING_256 = 5
  • BrickletVoltageCurrentV2->AVERAGING_512 = 6
  • BrickletVoltageCurrentV2->AVERAGING_1024 = 7

Das zurückgegebene Array enthält die Elemente averaging, voltage_conversion_time und current_conversion_time.

Fortgeschrittene Funktionen

BrickletVoltageCurrentV2->set_calibration($voltage_multiplier, $voltage_divisor, $current_multiplier, $current_divisor)
Parameter:
  • $voltage_multiplier -- int
  • $voltage_divisor -- int
  • $current_multiplier -- int
  • $current_divisor -- int
Rückgabetyp:

undef

Da der ADC und der Shunt-Widerstand für die Messungen verwendet werden nicht perfekt sind, ist es nötig einen Multiplikator und einen Divisor zu setzen falls sehr genaue Messwerte nötig sind.

Zum Beispiel: Wenn eine Messung von 1000mA erwartet wird, das Voltage/Current Bricklet 2.0 aber 1023mA zurück gibt, sollte der Multiplikator auf 1000 und der Divisor auf 1023 gesetzt werden. Das gleiches gilt für die Spannung.

BrickletVoltageCurrentV2->get_calibration()
Rückgabetyp:[int, int, int, int]

Gibt die Kalibrierung zurück, wie von set_calibration() gesetzt.

Das zurückgegebene Array enthält die Elemente voltage_multiplier, voltage_divisor, current_multiplier und current_divisor.

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

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

Siehe set_response_expected() für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

BrickletVoltageCurrentV2->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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • BrickletVoltageCurrentV2->FUNCTION_SET_CURRENT_CALLBACK_CONFIGURATION = 2
  • BrickletVoltageCurrentV2->FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION = 6
  • BrickletVoltageCurrentV2->FUNCTION_SET_POWER_CALLBACK_CONFIGURATION = 10
  • BrickletVoltageCurrentV2->FUNCTION_SET_CONFIGURATION = 13
  • BrickletVoltageCurrentV2->FUNCTION_SET_CALIBRATION = 15
  • BrickletVoltageCurrentV2->FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletVoltageCurrentV2->FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletVoltageCurrentV2->FUNCTION_RESET = 243
  • BrickletVoltageCurrentV2->FUNCTION_WRITE_UID = 248
BrickletVoltageCurrentV2->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.

BrickletVoltageCurrentV2->get_spitfp_error_count()
Rückgabetyp:[int, int, int, int]

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

Das zurückgegebene Array enthält die Elemente error_count_ack_checksum, error_count_message_checksum, error_count_frame und error_count_overflow.

BrickletVoltageCurrentV2->set_bootloader_mode($mode)
Parameter:$mode -- int
Rückgabetyp:int

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootlodaer- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

  • BrickletVoltageCurrentV2->BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletVoltageCurrentV2->BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletVoltageCurrentV2->BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletVoltageCurrentV2->BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletVoltageCurrentV2->BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletVoltageCurrentV2->BOOTLOADER_STATUS_OK = 0
  • BrickletVoltageCurrentV2->BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletVoltageCurrentV2->BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletVoltageCurrentV2->BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletVoltageCurrentV2->BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletVoltageCurrentV2->BOOTLOADER_STATUS_CRC_MISMATCH = 5
BrickletVoltageCurrentV2->get_bootloader_mode()
Rückgabetyp:int

Gibt den aktuellen Bootloader-Modus zurück, siehe set_bootloader_mode().

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

  • BrickletVoltageCurrentV2->BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletVoltageCurrentV2->BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletVoltageCurrentV2->BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletVoltageCurrentV2->BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletVoltageCurrentV2->BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
BrickletVoltageCurrentV2->set_write_firmware_pointer($pointer)
Parameter:$pointer -- int
Rückgabetyp:undef

Setzt den Firmware-Pointer für write_firmware(). Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

BrickletVoltageCurrentV2->write_firmware(@data)
Parameter:@data -- [int, int, ..61x.., int]
Rückgabetyp:int

Schreibt 64 Bytes Firmware an die Position die vorher von set_write_firmware_pointer() gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

BrickletVoltageCurrentV2->set_status_led_config($config)
Parameter:$config -- int
Rückgabetyp:undef

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

  • BrickletVoltageCurrentV2->STATUS_LED_CONFIG_OFF = 0
  • BrickletVoltageCurrentV2->STATUS_LED_CONFIG_ON = 1
  • BrickletVoltageCurrentV2->STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletVoltageCurrentV2->STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletVoltageCurrentV2->get_status_led_config()
Rückgabetyp:int

Gibt die Konfiguration zurück, wie von set_status_led_config() gesetzt.

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

  • BrickletVoltageCurrentV2->STATUS_LED_CONFIG_OFF = 0
  • BrickletVoltageCurrentV2->STATUS_LED_CONFIG_ON = 1
  • BrickletVoltageCurrentV2->STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletVoltageCurrentV2->STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletVoltageCurrentV2->get_chip_temperature()
Rückgabetyp:int

Gibt die Temperatur in °C, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

BrickletVoltageCurrentV2->reset()
Rückgabetyp:undef

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehende führt zu undefiniertem Verhalten.

BrickletVoltageCurrentV2->write_uid($uid)
Parameter:$uid -- int
Rückgabetyp:undef

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

BrickletVoltageCurrentV2->read_uid()
Rückgabetyp:int

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

BrickletVoltageCurrentV2->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 Bricklet.

Das zurückgegebene Array enthält die Elemente uid, connected_uid, position, hardware_version, firmware_version und device_identifier.

Konfigurationsfunktionen für Callbacks

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

BrickletVoltageCurrentV2->set_current_callback_configuration($period, $value_has_to_change, $option, $min, $max)
Parameter:
  • $period -- int
  • $value_has_to_change -- bool
  • $option -- char
  • $min -- int
  • $max -- int
Rückgabetyp:

undef

Die Periode in ms ist die Periode mit der der CALLBACK_CURRENT Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter`zusammen mit min/max setzt einen Threshold für den CALLBACK_CURRENT Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

Der Standardwert ist (0, false, 'x', 0, 0).

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

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

Gibt die Callback-Konfiguration zurück, wie mittels set_current_callback_configuration() gesetzt.

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

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

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

BrickletVoltageCurrentV2->set_voltage_callback_configuration($period, $value_has_to_change, $option, $min, $max)
Parameter:
  • $period -- int
  • $value_has_to_change -- bool
  • $option -- char
  • $min -- int
  • $max -- int
Rückgabetyp:

undef

Die Periode in ms ist die Periode mit der der CALLBACK_VOLTAGE Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter`zusammen mit min/max setzt einen Threshold für den CALLBACK_VOLTAGE Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

Der Standardwert ist (0, false, 'x', 0, 0).

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

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

Gibt die Callback-Konfiguration zurück, wie mittels set_voltage_callback_configuration() gesetzt.

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

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

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

BrickletVoltageCurrentV2->set_power_callback_configuration($period, $value_has_to_change, $option, $min, $max)
Parameter:
  • $period -- int
  • $value_has_to_change -- bool
  • $option -- char
  • $min -- int
  • $max -- int
Rückgabetyp:

undef

Die Periode in ms ist die Periode mit der der CALLBACK_POWER Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter`zusammen mit min/max setzt einen Threshold für den CALLBACK_POWER Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

Der Standardwert ist (0, false, 'x', 0, 0).

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

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

Gibt die Callback-Konfiguration zurück, wie mittels set_power_callback_configuration() gesetzt.

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

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

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

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

$voltage_current_v2->register_callback(BrickletVoltageCurrentV2->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.

BrickletVoltageCurrentV2->CALLBACK_CURRENT
Parameter:$current -- int

Dieser Callback wird periodisch ausgelöst abhängig von der mittels set_current_callback_configuration() gesetzten Konfiguration

Der Parameter ist der gleiche wie get_current().

BrickletVoltageCurrentV2->CALLBACK_VOLTAGE
Parameter:$voltage -- int

Dieser Callback wird periodisch ausgelöst abhängig von der mittels set_voltage_callback_configuration() gesetzten Konfiguration

Der Parameter ist der gleiche wie get_voltage().

BrickletVoltageCurrentV2->CALLBACK_POWER
Parameter:$power -- int

Dieser Callback wird periodisch ausgelöst abhängig von der mittels set_power_callback_configuration() gesetzten Konfiguration

Der Parameter ist der gleiche wie get_power().

Konstanten

BrickletVoltageCurrentV2->DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Voltage/Current Bricklet 2.0 zu identifizieren.

Die get_identity() Funktion und der CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickletVoltageCurrentV2->DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Voltage/Current Bricklet 2.0 dar.