PHP - Voltage/Current Bricklet

Dies ist die Beschreibung der PHP API Bindings für das Voltage/Current Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Voltage/Current Bricklet 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/BrickletVoltageCurrent.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletVoltageCurrent;

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

$ipcon = new IPConnection(); // Create IP connection
$vc = new BrickletVoltageCurrent(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
35
36
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletVoltageCurrent;

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

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

$ipcon = new IPConnection(); // Create IP connection
$vc = new BrickletVoltageCurrent(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(BrickletVoltageCurrent::CALLBACK_CURRENT, 'cb_current');

// Set period for current callback to 1s (1000ms)
// Note: The current callback is only called every second
//       if the current has changed since the last call!
$vc->setCurrentCallbackPeriod(1000);

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

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletVoltageCurrent;

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

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

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

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

// Get threshold callbacks with a debounce time of 10 seconds (10000ms)
$vc->setDebouncePeriod(10000);

// Register power reached callback to function cb_powerReached
$vc->registerCallback(BrickletVoltageCurrent::CALLBACK_POWER_REACHED, 'cb_powerReached');

// Configure threshold for power "greater than 10 W"
$vc->setPowerCallbackThreshold('>', 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 BrickletVoltageCurrent(string $uid, IPConnection $ipcon)
Parameter:
  • $uid – Typ: string
  • $ipcon – Typ: IPConnection
Rückgabe:
  • $voltage_current – Typ: BrickletVoltageCurrent

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

<?php   $voltage_current = new BrickletVoltageCurrent('YOUR_DEVICE_UID', $ipcon);   ?>

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

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

Gibt die gemessenen Stromstärke zurück.

Wenn die Stromstärke periodisch abgefragt werden soll, wird empfohlen den CALLBACK_CURRENT Callback zu nutzen und die Periode mit setCurrentCallbackPeriod() vorzugeben.

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

Gibt die gemessenen Spannung zurück.

Wenn die Spannung periodisch abgefragt werden soll, wird empfohlen den CALLBACK_VOLTAGE Callback zu nutzen und die Periode mit setVoltageCallbackPeriod() vorzugeben.

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

Gibt die gemessenen Leistung zurück.

Wenn die Leistung periodisch abgefragt werden soll, wird empfohlen den CALLBACK_POWER Callback zu nutzen und die Periode mit setPowerCallbackPeriod() vorzugeben.

void BrickletVoltageCurrent::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. 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:

  • BrickletVoltageCurrent::AVERAGING_1 = 0
  • BrickletVoltageCurrent::AVERAGING_4 = 1
  • BrickletVoltageCurrent::AVERAGING_16 = 2
  • BrickletVoltageCurrent::AVERAGING_64 = 3
  • BrickletVoltageCurrent::AVERAGING_128 = 4
  • BrickletVoltageCurrent::AVERAGING_256 = 5
  • BrickletVoltageCurrent::AVERAGING_512 = 6
  • BrickletVoltageCurrent::AVERAGING_1024 = 7

Für $voltage_conversion_time:

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

Für $current_conversion_time:

  • BrickletVoltageCurrent::CONVERSION_TIME_140US = 0
  • BrickletVoltageCurrent::CONVERSION_TIME_204US = 1
  • BrickletVoltageCurrent::CONVERSION_TIME_332US = 2
  • BrickletVoltageCurrent::CONVERSION_TIME_588US = 3
  • BrickletVoltageCurrent::CONVERSION_TIME_1_1MS = 4
  • BrickletVoltageCurrent::CONVERSION_TIME_2_116MS = 5
  • BrickletVoltageCurrent::CONVERSION_TIME_4_156MS = 6
  • BrickletVoltageCurrent::CONVERSION_TIME_8_244MS = 7
array BrickletVoltageCurrent::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:

  • BrickletVoltageCurrent::AVERAGING_1 = 0
  • BrickletVoltageCurrent::AVERAGING_4 = 1
  • BrickletVoltageCurrent::AVERAGING_16 = 2
  • BrickletVoltageCurrent::AVERAGING_64 = 3
  • BrickletVoltageCurrent::AVERAGING_128 = 4
  • BrickletVoltageCurrent::AVERAGING_256 = 5
  • BrickletVoltageCurrent::AVERAGING_512 = 6
  • BrickletVoltageCurrent::AVERAGING_1024 = 7

Für $voltage_conversion_time:

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

Für $current_conversion_time:

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

Fortgeschrittene Funktionen

void BrickletVoltageCurrent::setCalibration(int $gain_multiplier, int $gain_divisor)
Parameter:
  • $gain_multiplier – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $gain_divisor – Typ: int, Wertebereich: [0 bis 216 - 1]

Da der Shunt-Widerstand über den die Stromstärke gemessen wird keine perfekte Genauigkeit hat, 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 aber 1023mA zurück gibt, sollte der Multiplikator auf 1000 und der Divisor auf 1023 gesetzt werden.

array BrickletVoltageCurrent::getCalibration()
Rückgabe-Array:
  • 'gain_multiplier' – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 'gain_divisor' – Typ: int, Wertebereich: [0 bis 216 - 1]

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

array BrickletVoltageCurrent::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 BrickletVoltageCurrent::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 BrickletVoltageCurrent::setCurrentCallbackPeriod(int $period)
Parameter:
  • $period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

int BrickletVoltageCurrent::getCurrentCallbackPeriod()
Rückgabe:
  • $period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

void BrickletVoltageCurrent::setVoltageCallbackPeriod(int $period)
Parameter:
  • $period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

int BrickletVoltageCurrent::getVoltageCallbackPeriod()
Rückgabe:
  • $period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

void BrickletVoltageCurrent::setPowerCallbackPeriod(int $period)
Parameter:
  • $period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

int BrickletVoltageCurrent::getPowerCallbackPeriod()
Rückgabe:
  • $period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

void BrickletVoltageCurrent::setCurrentCallbackThreshold(string $option, int $min, int $max)
Parameter:
  • $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

Setzt den Schwellwert für den CALLBACK_CURRENT_REACHED Callback.

Die folgenden Optionen sind möglich:

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

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

Für $option:

  • BrickletVoltageCurrent::THRESHOLD_OPTION_OFF = 'x'
  • BrickletVoltageCurrent::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletVoltageCurrent::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletVoltageCurrent::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletVoltageCurrent::THRESHOLD_OPTION_GREATER = '>'
array BrickletVoltageCurrent::getCurrentCallbackThreshold()
Rückgabe-Array:
  • '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 den Schwellwert zurück, wie von setCurrentCallbackThreshold() gesetzt.

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

Für $option:

  • BrickletVoltageCurrent::THRESHOLD_OPTION_OFF = 'x'
  • BrickletVoltageCurrent::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletVoltageCurrent::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletVoltageCurrent::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletVoltageCurrent::THRESHOLD_OPTION_GREATER = '>'
void BrickletVoltageCurrent::setVoltageCallbackThreshold(string $option, int $min, int $max)
Parameter:
  • $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

Setzt den Schwellwert für den CALLBACK_VOLTAGE_REACHED Callback.

Die folgenden Optionen sind möglich:

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

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

Für $option:

  • BrickletVoltageCurrent::THRESHOLD_OPTION_OFF = 'x'
  • BrickletVoltageCurrent::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletVoltageCurrent::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletVoltageCurrent::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletVoltageCurrent::THRESHOLD_OPTION_GREATER = '>'
array BrickletVoltageCurrent::getVoltageCallbackThreshold()
Rückgabe-Array:
  • '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 den Schwellwert zurück, wie von setVoltageCallbackThreshold() gesetzt.

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

Für $option:

  • BrickletVoltageCurrent::THRESHOLD_OPTION_OFF = 'x'
  • BrickletVoltageCurrent::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletVoltageCurrent::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletVoltageCurrent::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletVoltageCurrent::THRESHOLD_OPTION_GREATER = '>'
void BrickletVoltageCurrent::setPowerCallbackThreshold(string $option, int $min, int $max)
Parameter:
  • $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

Setzt den Schwellwert für den CALLBACK_POWER_REACHED Callback.

Die folgenden Optionen sind möglich:

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

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

Für $option:

  • BrickletVoltageCurrent::THRESHOLD_OPTION_OFF = 'x'
  • BrickletVoltageCurrent::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletVoltageCurrent::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletVoltageCurrent::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletVoltageCurrent::THRESHOLD_OPTION_GREATER = '>'
array BrickletVoltageCurrent::getPowerCallbackThreshold()
Rückgabe-Array:
  • '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 den Schwellwert zurück, wie von setPowerCallbackThreshold() gesetzt.

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

Für $option:

  • BrickletVoltageCurrent::THRESHOLD_OPTION_OFF = 'x'
  • BrickletVoltageCurrent::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletVoltageCurrent::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletVoltageCurrent::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletVoltageCurrent::THRESHOLD_OPTION_GREATER = '>'
void BrickletVoltageCurrent::setDebouncePeriod(int $debounce)
Parameter:
  • $debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Setzt die Periode mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

int BrickletVoltageCurrent::getDebouncePeriod()
Rückgabe:
  • $debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von setDebouncePeriod() gesetzt.

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->registerCallback(BrickletVoltageCurrent::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 BrickletVoltageCurrent::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 mit der Periode, wie gesetzt mit setCurrentCallbackPeriod(), ausgelöst. Der Parameter ist die Stromstärke des Sensors.

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

int BrickletVoltageCurrent::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 mit der Periode, wie gesetzt mit setVoltageCallbackPeriod(), ausgelöst. Der Parameter ist die Spannung des Sensors.

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

int BrickletVoltageCurrent::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 mit der Periode, wie gesetzt mit setPowerCallbackPeriod(), ausgelöst. Der Parameter ist die Leistung des Sensors.

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

int BrickletVoltageCurrent::CALLBACK_CURRENT_REACHED
<?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 ausgelöst, wenn der Schwellwert, wie von setCurrentCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Stromstärke des Sensors.

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

int BrickletVoltageCurrent::CALLBACK_VOLTAGE_REACHED
<?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 ausgelöst, wenn der Schwellwert, wie von setVoltageCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Spannung des Sensors.

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

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von setPowerCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Spannung des Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit setDebouncePeriod() 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.

array BrickletVoltageCurrent::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 BrickletVoltageCurrent::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:

  • BrickletVoltageCurrent::FUNCTION_SET_CONFIGURATION = 4
  • BrickletVoltageCurrent::FUNCTION_SET_CALIBRATION = 6
  • BrickletVoltageCurrent::FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 8
  • BrickletVoltageCurrent::FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 10
  • BrickletVoltageCurrent::FUNCTION_SET_POWER_CALLBACK_PERIOD = 12
  • BrickletVoltageCurrent::FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 14
  • BrickletVoltageCurrent::FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 16
  • BrickletVoltageCurrent::FUNCTION_SET_POWER_CALLBACK_THRESHOLD = 18
  • BrickletVoltageCurrent::FUNCTION_SET_DEBOUNCE_PERIOD = 20
void BrickletVoltageCurrent::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:

  • BrickletVoltageCurrent::FUNCTION_SET_CONFIGURATION = 4
  • BrickletVoltageCurrent::FUNCTION_SET_CALIBRATION = 6
  • BrickletVoltageCurrent::FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 8
  • BrickletVoltageCurrent::FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 10
  • BrickletVoltageCurrent::FUNCTION_SET_POWER_CALLBACK_PERIOD = 12
  • BrickletVoltageCurrent::FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 14
  • BrickletVoltageCurrent::FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 16
  • BrickletVoltageCurrent::FUNCTION_SET_POWER_CALLBACK_THRESHOLD = 18
  • BrickletVoltageCurrent::FUNCTION_SET_DEBOUNCE_PERIOD = 20
void BrickletVoltageCurrent::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 BrickletVoltageCurrent::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Voltage/Current Bricklet 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 BrickletVoltageCurrent::DEVICE_DISPLAY_NAME

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