PHP - Voltage/Current Bricklet 2.0

Dies ist die Beschreibung der PHP 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 PHP API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (ExampleSimple.php)

 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
<?php

require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletVoltageCurrentV2.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletVoltageCurrentV2;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your Voltage/Current Bricklet 2.0

$ipcon = new IPConnection(); // Create IP connection
$vc = new BrickletVoltageCurrentV2(UID, $ipcon); // Create device object

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

// Get current voltage
$voltage = $vc->getVoltage();
echo "Voltage: " . $voltage/1000.0 . " V\n";

// Get current current
$current = $vc->getCurrent();
echo "Current: " . $current/1000.0 . " A\n";

echo "Press key to exit\n";
fgetc(fopen('php://stdin', 'r'));
$ipcon->disconnect();

?>

Callback

Download (ExampleCallback.php)

 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
<?php

require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletVoltageCurrentV2.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletVoltageCurrentV2;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your Voltage/Current Bricklet 2.0

// Callback function for current callback
function cb_current($current)
{
    echo "Current: " . $current/1000.0 . " A\n";
}

$ipcon = new IPConnection(); // Create IP connection
$vc = new BrickletVoltageCurrentV2(UID, $ipcon); // Create device object

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

// Register current callback to function cb_current
$vc->registerCallback(BrickletVoltageCurrentV2::CALLBACK_CURRENT, 'cb_current');

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

echo "Press ctrl+c to exit\n";
$ipcon->dispatchCallbacks(-1); // Dispatch callbacks forever

?>

Threshold

Download (ExampleThreshold.php)

 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
<?php

require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletVoltageCurrentV2.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletVoltageCurrentV2;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your Voltage/Current Bricklet 2.0

// Callback function for power callback
function cb_power($power)
{
    echo "power: " . $power/1000.0 . " W\n";
}

$ipcon = new IPConnection(); // Create IP connection
$vc = new BrickletVoltageCurrentV2(UID, $ipcon); // Create device object

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

// Register power callback to function cb_power
$vc->registerCallback(BrickletVoltageCurrentV2::CALLBACK_POWER, 'cb_power');

// Configure threshold for power "greater than 10 W"
// with a debounce period of 1s (1000ms)
$vc->setPowerCallbackConfiguration(1000, FALSE, '>', 10*1000, 0);

echo "Press ctrl+c to exit\n";
$ipcon->dispatchCallbacks(-1); // Dispatch callbacks forever

?>

API

Funktion die mehrere Werte zurückgeben geben diese in einem assoziativen Array zurück.

Grundfunktionen

class BrickletVoltageCurrentV2(string $uid, IPConnection $ipcon)
Parameter:
  • $uid – Typ: string
  • $ipcon – Typ: IPConnection
Rückgabe:
  • $voltage_current_v2 – Typ: BrickletVoltageCurrentV2

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

<?php   $voltage_current_v2 = new BrickletVoltageCurrentV2('YOUR_DEVICE_UID', $ipcon);   ?>

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

int BrickletVoltageCurrentV2::getCurrent()
Rückgabe:
  • $current – Typ: int, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]

Gibt die gemessenen Stromstärke zurück.

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

int BrickletVoltageCurrentV2::getVoltage()
Rückgabe:
  • $voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 36000]

Gibt die gemessenen Spannung zurück.

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

int BrickletVoltageCurrentV2::getPower()
Rückgabe:
  • $power – Typ: int, Einheit: 1 mW, Wertebereich: [0 bis 720000]

Gibt die gemessenen Leistung zurück.

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

void BrickletVoltageCurrentV2::setConfiguration(int $averaging, int $voltage_conversion_time, int $current_conversion_time)
Parameter:
  • $averaging – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3
  • $voltage_conversion_time – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 4
  • $current_conversion_time – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 4

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.

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

Für $averaging:

  • 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

Für $voltage_conversion_time:

  • BrickletVoltageCurrentV2::CONVERSION_TIME_140US = 0
  • BrickletVoltageCurrentV2::CONVERSION_TIME_204US = 1
  • BrickletVoltageCurrentV2::CONVERSION_TIME_332US = 2
  • BrickletVoltageCurrentV2::CONVERSION_TIME_588US = 3
  • BrickletVoltageCurrentV2::CONVERSION_TIME_1_1MS = 4
  • BrickletVoltageCurrentV2::CONVERSION_TIME_2_116MS = 5
  • BrickletVoltageCurrentV2::CONVERSION_TIME_4_156MS = 6
  • BrickletVoltageCurrentV2::CONVERSION_TIME_8_244MS = 7

Für $current_conversion_time:

  • BrickletVoltageCurrentV2::CONVERSION_TIME_140US = 0
  • BrickletVoltageCurrentV2::CONVERSION_TIME_204US = 1
  • BrickletVoltageCurrentV2::CONVERSION_TIME_332US = 2
  • BrickletVoltageCurrentV2::CONVERSION_TIME_588US = 3
  • BrickletVoltageCurrentV2::CONVERSION_TIME_1_1MS = 4
  • BrickletVoltageCurrentV2::CONVERSION_TIME_2_116MS = 5
  • BrickletVoltageCurrentV2::CONVERSION_TIME_4_156MS = 6
  • BrickletVoltageCurrentV2::CONVERSION_TIME_8_244MS = 7
array BrickletVoltageCurrentV2::getConfiguration()
Rückgabe-Array:
  • 'averaging' – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3
  • 'voltage_conversion_time' – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 4
  • 'current_conversion_time' – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 4

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

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

Für $averaging:

  • 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

Für $voltage_conversion_time:

  • BrickletVoltageCurrentV2::CONVERSION_TIME_140US = 0
  • BrickletVoltageCurrentV2::CONVERSION_TIME_204US = 1
  • BrickletVoltageCurrentV2::CONVERSION_TIME_332US = 2
  • BrickletVoltageCurrentV2::CONVERSION_TIME_588US = 3
  • BrickletVoltageCurrentV2::CONVERSION_TIME_1_1MS = 4
  • BrickletVoltageCurrentV2::CONVERSION_TIME_2_116MS = 5
  • BrickletVoltageCurrentV2::CONVERSION_TIME_4_156MS = 6
  • BrickletVoltageCurrentV2::CONVERSION_TIME_8_244MS = 7

Für $current_conversion_time:

  • BrickletVoltageCurrentV2::CONVERSION_TIME_140US = 0
  • BrickletVoltageCurrentV2::CONVERSION_TIME_204US = 1
  • BrickletVoltageCurrentV2::CONVERSION_TIME_332US = 2
  • BrickletVoltageCurrentV2::CONVERSION_TIME_588US = 3
  • BrickletVoltageCurrentV2::CONVERSION_TIME_1_1MS = 4
  • BrickletVoltageCurrentV2::CONVERSION_TIME_2_116MS = 5
  • BrickletVoltageCurrentV2::CONVERSION_TIME_4_156MS = 6
  • BrickletVoltageCurrentV2::CONVERSION_TIME_8_244MS = 7

Fortgeschrittene Funktionen

void BrickletVoltageCurrentV2::setCalibration(int $voltage_multiplier, int $voltage_divisor, int $current_multiplier, int $current_divisor)
Parameter:
  • $voltage_multiplier – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $voltage_divisor – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $current_multiplier – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $current_divisor – Typ: int, Wertebereich: [0 bis 216 - 1]

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.

Die Kalibrierung wird in den EEPROM des Voltage/Current Bricklet gespeichert und muss nur einmal gesetzt werden.

array BrickletVoltageCurrentV2::getCalibration()
Rückgabe-Array:
  • 'voltage_multiplier' – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 'voltage_divisor' – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 'current_multiplier' – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 'current_divisor' – Typ: int, Wertebereich: [0 bis 216 - 1]

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

array BrickletVoltageCurrentV2::getSPITFPErrorCount()
Rückgabe-Array:
  • 'error_count_ack_checksum' – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 'error_count_message_checksum' – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 'error_count_frame' – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 'error_count_overflow' – Typ: int, Wertebereich: [0 bis 232 - 1]

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.

int BrickletVoltageCurrentV2::setBootloaderMode(int $mode)
Parameter:
  • $mode – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • $status – Typ: int, Wertebereich: Siehe Konstanten

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

Für $mode:

  • 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

Für $status:

  • 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
int BrickletVoltageCurrentV2::getBootloaderMode()
Rückgabe:
  • $mode – Typ: int, Wertebereich: Siehe Konstanten

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

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

Für $mode:

  • 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
void BrickletVoltageCurrentV2::setWriteFirmwarePointer(int $pointer)
Parameter:
  • $pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]

Setzt den Firmware-Pointer für writeFirmware(). 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.

int BrickletVoltageCurrentV2::writeFirmware(array $data)
Parameter:
  • $data – Typ: array(int, ...), Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:
  • $status – Typ: int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von setWriteFirmwarePointer() 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.

void BrickletVoltageCurrentV2::setStatusLEDConfig(int $config)
Parameter:
  • $config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

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:

Für $config:

  • 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
int BrickletVoltageCurrentV2::getStatusLEDConfig()
Rückgabe:
  • $config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für $config:

  • 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
int BrickletVoltageCurrentV2::getChipTemperature()
Rückgabe:
  • $temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur, 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.

void BrickletVoltageCurrentV2::reset()

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 bestehenden führen zu undefiniertem Verhalten.

void BrickletVoltageCurrentV2::writeUID(int $uid)
Parameter:
  • $uid – Typ: int, Wertebereich: [0 bis 232 - 1]

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.

int BrickletVoltageCurrentV2::readUID()
Rückgabe:
  • $uid – Typ: int, Wertebereich: [0 bis 232 - 1]

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

array BrickletVoltageCurrentV2::getIdentity()
Rückgabe-Array:
  • 'uid' – Typ: string, Länge: bis zu 8
  • 'connected_uid' – Typ: string, Länge: bis zu 8
  • 'position' – Typ: string, Wertebereich: ['a' bis 'h', 'i', 'z']
  • 'hardware_version' – Typ: array(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]
  • 'firmware_version' – Typ: array(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]
  • '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 '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.

Konfigurationsfunktionen für Callbacks

void BrickletVoltageCurrentV2::registerCallback(int $callback_id, callable $callback, mixed $user_data=NULL)
Parameter:
  • $callback_id – Typ: int
  • $callback – Typ: callable
  • $user_data – Typ: mixed

Registriert die $function für die gegebene $callback_id. Die optionalen $user_data werden der Funktion als letztes Parameter mit übergeben.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

void BrickletVoltageCurrentV2::setCurrentCallbackConfiguration(int $period, bool $value_has_to_change, string $option, int $min, int $max)
Parameter:
  • $period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • $value_has_to_change – Typ: bool, Standardwert: FALSE
  • $option – Typ: string, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • $min – Typ: int, Einheit: 1 mA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • $max – Typ: int, Einheit: 1 mA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Die Periode 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.

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

Für $option:

  • BrickletVoltageCurrentV2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletVoltageCurrentV2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletVoltageCurrentV2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletVoltageCurrentV2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletVoltageCurrentV2::THRESHOLD_OPTION_GREATER = '>'
array BrickletVoltageCurrentV2::getCurrentCallbackConfiguration()
Rückgabe-Array:
  • 'period' – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • 'value_has_to_change' – Typ: bool, Standardwert: FALSE
  • 'option' – Typ: string, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • 'min' – Typ: int, Einheit: 1 mA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • 'max' – Typ: int, Einheit: 1 mA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

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

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

Für $option:

  • BrickletVoltageCurrentV2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletVoltageCurrentV2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletVoltageCurrentV2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletVoltageCurrentV2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletVoltageCurrentV2::THRESHOLD_OPTION_GREATER = '>'
void BrickletVoltageCurrentV2::setVoltageCallbackConfiguration(int $period, bool $value_has_to_change, string $option, int $min, int $max)
Parameter:
  • $period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • $value_has_to_change – Typ: bool, Standardwert: FALSE
  • $option – Typ: string, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • $min – Typ: int, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • $max – Typ: int, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Die Periode 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.

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

Für $option:

  • BrickletVoltageCurrentV2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletVoltageCurrentV2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletVoltageCurrentV2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletVoltageCurrentV2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletVoltageCurrentV2::THRESHOLD_OPTION_GREATER = '>'
array BrickletVoltageCurrentV2::getVoltageCallbackConfiguration()
Rückgabe-Array:
  • 'period' – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • 'value_has_to_change' – Typ: bool, Standardwert: FALSE
  • 'option' – Typ: string, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • 'min' – Typ: int, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • 'max' – Typ: int, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

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

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

Für $option:

  • BrickletVoltageCurrentV2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletVoltageCurrentV2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletVoltageCurrentV2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletVoltageCurrentV2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletVoltageCurrentV2::THRESHOLD_OPTION_GREATER = '>'
void BrickletVoltageCurrentV2::setPowerCallbackConfiguration(int $period, bool $value_has_to_change, string $option, int $min, int $max)
Parameter:
  • $period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • $value_has_to_change – Typ: bool, Standardwert: FALSE
  • $option – Typ: string, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • $min – Typ: int, Einheit: 1 mW, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • $max – Typ: int, Einheit: 1 mW, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Die Periode 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.

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

Für $option:

  • BrickletVoltageCurrentV2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletVoltageCurrentV2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletVoltageCurrentV2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletVoltageCurrentV2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletVoltageCurrentV2::THRESHOLD_OPTION_GREATER = '>'
array BrickletVoltageCurrentV2::getPowerCallbackConfiguration()
Rückgabe-Array:
  • 'period' – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • 'value_has_to_change' – Typ: bool, Standardwert: FALSE
  • 'option' – Typ: string, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • 'min' – Typ: int, Einheit: 1 mW, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • 'max' – Typ: int, Einheit: 1 mW, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

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

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

Für $option:

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

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion registerCallback() des Geräte Objektes durchgeführt werden. Der erste Parameter ist der Callback ID und der zweite die Callback-Funktion:

<?php

function myCallback($param)
{
    echo $param . "\n";
}

$voltage_current_v2->registerCallback(BrickletVoltageCurrentV2::CALLBACK_EXAMPLE, 'myCallback');

?>

Die verfügbaren IDs mit den dazugehörigen Funktionssignaturen 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.

int BrickletVoltageCurrentV2::CALLBACK_CURRENT
<?php   void callback(int $current [, mixed $user_data])   ?>
Callback-Parameter:
  • $current – Typ: int, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]
  • $user_data – Typ: mixed

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

Der Parameter ist der gleiche wie getCurrent().

int BrickletVoltageCurrentV2::CALLBACK_VOLTAGE
<?php   void callback(int $voltage [, mixed $user_data])   ?>
Callback-Parameter:
  • $voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 36000]
  • $user_data – Typ: mixed

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

Der Parameter ist der gleiche wie getVoltage().

int BrickletVoltageCurrentV2::CALLBACK_POWER
<?php   void callback(int $power [, mixed $user_data])   ?>
Callback-Parameter:
  • $power – Typ: int, Einheit: 1 mW, Wertebereich: [0 bis 720000]
  • $user_data – Typ: mixed

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

Der Parameter ist der gleiche wie getPower().

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.

array BrickletVoltageCurrentV2::getAPIVersion()
Rückgabe-Array:
  • $api_version – Typ: array(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.

bool BrickletVoltageCurrentV2::getResponseExpected(int $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 setResponseExpected(). 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:

  • 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
void BrickletVoltageCurrentV2::setResponseExpected(int $function_id, bool $response_expected)
Parameter:
  • $function_id – Typ: int, Wertebereich: Siehe Konstanten
  • $response_expected – Typ: bool

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

  • 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
void BrickletVoltageCurrentV2::setResponseExpectedAll(bool $response_expected)
Parameter:
  • $response_expected – Typ: bool

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Konstanten

int BrickletVoltageCurrentV2::DEVICE_IDENTIFIER

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

Die getIdentity() Funktion und der IPConnection::CALLBACK_ENUMERATE Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

string BrickletVoltageCurrentV2::DEVICE_DISPLAY_NAME

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