PHP - Load Cell Bricklet

Dies ist die Beschreibung der PHP API Bindings für das Load Cell Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Load Cell 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
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletLoadCell;

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

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

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

// Get current weight
$weight = $lc->getWeight();
echo "Weight: $weight g\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/BrickletLoadCell.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletLoadCell;

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

// Callback function for weight callback
function cb_weight($weight)
{
    echo "Weight: $weight g\n";
}

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

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

// Register weight callback to function cb_weight
$lc->registerCallback(BrickletLoadCell::CALLBACK_WEIGHT, 'cb_weight');

// Set period for weight callback to 1s (1000ms)
// Note: The weight callback is only called every second
//       if the weight has changed since the last call!
$lc->setWeightCallbackPeriod(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/BrickletLoadCell.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletLoadCell;

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

// Callback function for weight reached callback
function cb_weightReached($weight)
{
    echo "Weight: $weight g\n";
}

$ipcon = new IPConnection(); // Create IP connection
$lc = new BrickletLoadCell(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 1 second (1000ms)
$lc->setDebouncePeriod(1000);

// Register weight reached callback to function cb_weightReached
$lc->registerCallback(BrickletLoadCell::CALLBACK_WEIGHT_REACHED, 'cb_weightReached');

// Configure threshold for weight "greater than 200 g"
$lc->setWeightCallbackThreshold('>', 200, 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 BrickletLoadCell(string $uid, IPConnection $ipcon)
Parameter:
  • $uid – Typ: string
  • $ipcon – Typ: IPConnection
Rückgabe:
  • $load_cell – Typ: BrickletLoadCell

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

<?php   $load_cell = new BrickletLoadCell('YOUR_DEVICE_UID', $ipcon);   ?>

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

int BrickletLoadCell::getWeight()
Rückgabe:
  • $weight – Typ: int, Einheit: 1 g, Wertebereich: [-231 bis 231 - 1]

Gibt das aktuell gemessene Gewicht zurück.

Wenn das Gewicht periodisch abgefragt werden soll, wird empfohlen den CALLBACK_WEIGHT Callback zu nutzen und die Periode mit setWeightCallbackPeriod() vorzugeben.

void BrickletLoadCell::ledOn()

Aktiviert die LED.

void BrickletLoadCell::ledOff()

Deaktiviert die LED.

bool BrickletLoadCell::isLEDOn()
Rückgabe:
  • $on – Typ: bool, Standardwert: FALSE

Gibt true zurück wenn die LED aktiviert ist, false sonst.

void BrickletLoadCell::tare()

Setzt das aktuell gemessene Gewicht als Leergewicht.

Fortgeschrittene Funktionen

void BrickletLoadCell::setMovingAverage(int $average)
Parameter:
  • $average – Typ: int, Wertebereich: [1 bis 40], Standardwert: 4

Setzt die Länge eines gleitenden Mittelwerts für den Gewichtswert.

Wenn die Länge auf 1 gesetzt wird, ist das Averaging aus. Desto kleiner die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

int BrickletLoadCell::getMovingAverage()
Rückgabe:
  • $average – Typ: int, Wertebereich: [1 bis 40], Standardwert: 4

Gibt die Länge des gleitenden Mittelwerts zurück, wie von setMovingAverage() gesetzt.

void BrickletLoadCell::calibrate(int $weight)
Parameter:
  • $weight – Typ: int, Einheit: 1 g, Wertebereich: [0 bis 232 - 1]

Zum Kalibrieren des Load Cell Bricklet müssen die folgenden zwei Schritte durchgeführt werden:

  • Die Waage leeren und die Funktion mit 0 aufrufen.
  • Eine bekanntes Gewicht auf die Waage legen und die Funktion mit dem Gewicht aufrufen.

Die Kalibrierung wird auf dem EEPROM des Bricklets gespeichert und muss nur einmal gesetzt werden.

Wir empfehlen die Kalibrierung über den Brick Viewer zu setzen, diese Funktion muss nicht im Quelltext genutzt werden.

void BrickletLoadCell::setConfiguration(int $rate, int $gain)
Parameter:
  • $rate – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
  • $gain – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0

Für die Messungen sind Rate und Gain konfigurierbar.

Die Rate kann auf 10Hz oder 80Hz gesetzt werden. Eine schnellere Rate erzeugt mehr Störungen. Zusätzlich ist es möglich einen gleitenden Mittelwert auf die Werte anzuwenden (siehe setMovingAverage()).

Der Gain kann zwischen 128x, 64x und 32x konfiguriert werden. Er repräsentiert einen Messbereich von ±20mV, ±40mV und ±80mV respektive. Das Load Cell Bricklet nutzt eine Erregerspannung (Excitation Voltage) von 5V und die meisten Wägezellen haben eine Ausgabe von 2mV/V. Dies bedeutet, der Spannungsbereich ist ±15mV für die meisten Wägezellen (d.h. ein Gain von 128x ist am geeignetsten). Falls nicht klar ist was dies alles bedeutet, ein Gain von 128x ist höchstwahrscheinlich korrekt.

Die Konfiguration wird auf dem EEPROM des Bricklets gespeichert und muss nur einmal gesetzt werden.

Wir empfehlen die Konfiguration über den Brick Viewer zu setzen, diese Funktion muss nicht im Quelltext genutzt werden.

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

Für $rate:

  • BrickletLoadCell::RATE_10HZ = 0
  • BrickletLoadCell::RATE_80HZ = 1

Für $gain:

  • BrickletLoadCell::GAIN_128X = 0
  • BrickletLoadCell::GAIN_64X = 1
  • BrickletLoadCell::GAIN_32X = 2
array BrickletLoadCell::getConfiguration()
Rückgabe-Array:
  • 'rate' – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
  • 'gain' – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0

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

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

Für $rate:

  • BrickletLoadCell::RATE_10HZ = 0
  • BrickletLoadCell::RATE_80HZ = 1

Für $gain:

  • BrickletLoadCell::GAIN_128X = 0
  • BrickletLoadCell::GAIN_64X = 1
  • BrickletLoadCell::GAIN_32X = 2
array BrickletLoadCell::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 BrickletLoadCell::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 BrickletLoadCell::setWeightCallbackPeriod(int $period)
Parameter:
  • $period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

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

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

void BrickletLoadCell::setWeightCallbackThreshold(string $option, int $min, int $max)
Parameter:
  • $option – Typ: string, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • $min – Typ: int, Einheit: 1 g, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • $max – Typ: int, Einheit: 1 g, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Setzt den Schwellwert für den CALLBACK_WEIGHT_REACHED Callback.

Die folgenden Optionen sind möglich:

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

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

Für $option:

  • BrickletLoadCell::THRESHOLD_OPTION_OFF = 'x'
  • BrickletLoadCell::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletLoadCell::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletLoadCell::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletLoadCell::THRESHOLD_OPTION_GREATER = '>'
array BrickletLoadCell::getWeightCallbackThreshold()
Rückgabe-Array:
  • 'option' – Typ: string, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • 'min' – Typ: int, Einheit: 1 g, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • 'max' – Typ: int, Einheit: 1 g, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

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

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

Für $option:

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

Setzt die Periode mit welcher die Schwellwert Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

int BrickletLoadCell::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";
}

$load_cell->registerCallback(BrickletLoadCell::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 BrickletLoadCell::CALLBACK_WEIGHT
<?php   void callback(int $weight [, mixed $user_data])   ?>
Callback-Parameter:
  • $weight – Typ: int, Einheit: 1 g, Wertebereich: [-231 bis 231 - 1]
  • $user_data – Typ: mixed

Dieser Callback wird mit der Periode, wie gesetzt mit setWeightCallbackPeriod(), ausgelöst. Der Parameter ist das Gewicht wie von der Wägezelle gemessen.

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

int BrickletLoadCell::CALLBACK_WEIGHT_REACHED
<?php   void callback(int $weight [, mixed $user_data])   ?>
Callback-Parameter:
  • $weight – Typ: int, Einheit: 1 g, Wertebereich: [-231 bis 231 - 1]
  • $user_data – Typ: mixed

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von setWeightCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist das Gewicht wie von der Wägezelle gemessen.

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

  • BrickletLoadCell::FUNCTION_SET_WEIGHT_CALLBACK_PERIOD = 2
  • BrickletLoadCell::FUNCTION_SET_WEIGHT_CALLBACK_THRESHOLD = 4
  • BrickletLoadCell::FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletLoadCell::FUNCTION_SET_MOVING_AVERAGE = 8
  • BrickletLoadCell::FUNCTION_LED_ON = 10
  • BrickletLoadCell::FUNCTION_LED_OFF = 11
  • BrickletLoadCell::FUNCTION_CALIBRATE = 13
  • BrickletLoadCell::FUNCTION_TARE = 14
  • BrickletLoadCell::FUNCTION_SET_CONFIGURATION = 15
void BrickletLoadCell::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:

  • BrickletLoadCell::FUNCTION_SET_WEIGHT_CALLBACK_PERIOD = 2
  • BrickletLoadCell::FUNCTION_SET_WEIGHT_CALLBACK_THRESHOLD = 4
  • BrickletLoadCell::FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletLoadCell::FUNCTION_SET_MOVING_AVERAGE = 8
  • BrickletLoadCell::FUNCTION_LED_ON = 10
  • BrickletLoadCell::FUNCTION_LED_OFF = 11
  • BrickletLoadCell::FUNCTION_CALIBRATE = 13
  • BrickletLoadCell::FUNCTION_TARE = 14
  • BrickletLoadCell::FUNCTION_SET_CONFIGURATION = 15
void BrickletLoadCell::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 BrickletLoadCell::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Load Cell 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 BrickletLoadCell::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Load Cell Bricklet dar.