Dies ist die Beschreibung der C/C++ 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 C/C++ API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 | #include <stdio.h>
#include "ip_connection.h"
#include "bricklet_load_cell.h"
#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Load Cell Bricklet
int main(void) {
// Create IP connection
IPConnection ipcon;
ipcon_create(&ipcon);
// Create device object
LoadCell lc;
load_cell_create(&lc, UID, &ipcon);
// Connect to brickd
if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
fprintf(stderr, "Could not connect\n");
return 1;
}
// Don't use device before ipcon is connected
// Get current weight
int32_t weight;
if(load_cell_get_weight(&lc, &weight) < 0) {
fprintf(stderr, "Could not get weight, probably timeout\n");
return 1;
}
printf("Weight: %d g\n", weight);
printf("Press key to exit\n");
getchar();
load_cell_destroy(&lc);
ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
return 0;
}
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 | #include <stdio.h>
#include "ip_connection.h"
#include "bricklet_load_cell.h"
#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Load Cell Bricklet
// Callback function for weight callback
void cb_weight(int32_t weight, void *user_data) {
(void)user_data; // avoid unused parameter warning
printf("Weight: %d g\n", weight);
}
int main(void) {
// Create IP connection
IPConnection ipcon;
ipcon_create(&ipcon);
// Create device object
LoadCell lc;
load_cell_create(&lc, UID, &ipcon);
// Connect to brickd
if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
fprintf(stderr, "Could not connect\n");
return 1;
}
// Don't use device before ipcon is connected
// Register weight callback to function cb_weight
load_cell_register_callback(&lc,
LOAD_CELL_CALLBACK_WEIGHT,
(void (*)(void))cb_weight,
NULL);
// 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!
load_cell_set_weight_callback_period(&lc, 1000);
printf("Press key to exit\n");
getchar();
load_cell_destroy(&lc);
ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
return 0;
}
|
Download (example_threshold.c)
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 38 39 40 41 42 43 44 45 46 47 48 49 50 | #include <stdio.h>
#include "ip_connection.h"
#include "bricklet_load_cell.h"
#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Load Cell Bricklet
// Callback function for weight reached callback
void cb_weight_reached(int32_t weight, void *user_data) {
(void)user_data; // avoid unused parameter warning
printf("Weight: %d g\n", weight);
}
int main(void) {
// Create IP connection
IPConnection ipcon;
ipcon_create(&ipcon);
// Create device object
LoadCell lc;
load_cell_create(&lc, UID, &ipcon);
// Connect to brickd
if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
fprintf(stderr, "Could not connect\n");
return 1;
}
// Don't use device before ipcon is connected
// Get threshold callbacks with a debounce time of 1 second (1000ms)
load_cell_set_debounce_period(&lc, 1000);
// Register weight reached callback to function cb_weight_reached
load_cell_register_callback(&lc,
LOAD_CELL_CALLBACK_WEIGHT_REACHED,
(void (*)(void))cb_weight_reached,
NULL);
// Configure threshold for weight "greater than 200 g"
load_cell_set_weight_callback_threshold(&lc, '>', 200, 0);
printf("Press key to exit\n");
getchar();
load_cell_destroy(&lc);
ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
return 0;
}
|
Die meistens Funktionen der C/C++ Bindings geben einen Fehlercode (e_code
)
zurück. Vom Gerät zurückgegebene Daten werden, wenn eine
Abfrage aufgerufen wurde, über Ausgabeparameter gehandhabt. Diese Parameter
sind mit dem ret_
Präfix gekennzeichnet.
Mögliche Fehlercodes sind:
wie in ip_connection.h
definiert.
Alle folgend aufgelisteten Funktionen sind Thread-sicher.
load_cell_create
(LoadCell *load_cell, const char *uid, IPConnection *ipcon)¶Parameter: |
|
---|
Erzeugt ein Geräteobjekt load_cell
mit der eindeutigen Geräte ID uid
und
fügt es der IP Connection ipcon
hinzu:
LoadCell load_cell;
load_cell_create(&load_cell, "YOUR_DEVICE_UID", &ipcon);
Dieses Geräteobjekt kann benutzt werden, nachdem die IP Connection verbunden.
load_cell_destroy
(LoadCell *load_cell)¶Parameter: |
|
---|
Entfernt das Geräteobjekt load_cell
von dessen IP Connection und zerstört es.
Das Geräteobjekt kann hiernach nicht mehr verwendet werden.
load_cell_get_weight
(LoadCell *load_cell, int32_t *ret_weight)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt das aktuell gemessene Gewicht zurück.
Wenn das Gewicht periodisch abgefragt werden soll, wird empfohlen
den LOAD_CELL_CALLBACK_WEIGHT
Callback zu nutzen und die Periode mit
load_cell_set_weight_callback_period()
vorzugeben.
load_cell_led_on
(LoadCell *load_cell)¶Parameter: |
|
---|---|
Rückgabe: |
|
Aktiviert die LED.
load_cell_led_off
(LoadCell *load_cell)¶Parameter: |
|
---|---|
Rückgabe: |
|
Deaktiviert die LED.
load_cell_is_led_on
(LoadCell *load_cell, bool *ret_on)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt true zurück wenn die LED aktiviert ist, false sonst.
load_cell_tare
(LoadCell *load_cell)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt das aktuell gemessene Gewicht als Leergewicht.
load_cell_set_moving_average
(LoadCell *load_cell, uint8_t average)¶Parameter: |
|
---|---|
Rückgabe: |
|
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.
load_cell_get_moving_average
(LoadCell *load_cell, uint8_t *ret_average)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Länge des gleitenden Mittelwerts zurück, wie von
load_cell_set_moving_average()
gesetzt.
load_cell_calibrate
(LoadCell *load_cell, uint32_t weight)¶Parameter: |
|
---|---|
Rückgabe: |
|
Zum Kalibrieren des Load Cell Bricklet müssen die folgenden zwei Schritte durchgeführt werden:
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.
load_cell_set_configuration
(LoadCell *load_cell, uint8_t rate, uint8_t gain)¶Parameter: |
|
---|---|
Rückgabe: |
|
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 load_cell_set_moving_average()
).
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:
Für gain:
load_cell_get_configuration
(LoadCell *load_cell, uint8_t *ret_rate, uint8_t *ret_gain)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Konfiguration zurück, wie von load_cell_set_configuration()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für ret_rate:
Für ret_gain:
load_cell_get_identity
(LoadCell *load_cell, char ret_uid[8], char ret_connected_uid[8], char *ret_position, uint8_t ret_hardware_version[3], uint8_t ret_firmware_version[3], uint16_t *ret_device_identifier)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
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 ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein 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.
load_cell_register_callback
(LoadCell *load_cell, int16_t callback_id, void (*function)(void), void *user_data)¶Parameter: |
|
---|
Registriert die function
für die gegebene callback_id
. Die user_data
werden der Funktion als letztes Parameter mit übergeben.
Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.
load_cell_set_weight_callback_period
(LoadCell *load_cell, uint32_t period)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode mit welcher der LOAD_CELL_CALLBACK_WEIGHT
Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
Der LOAD_CELL_CALLBACK_WEIGHT
Callback wird nur ausgelöst, wenn sich das Gewicht seit der
letzten Auslösung geändert hat.
load_cell_get_weight_callback_period
(LoadCell *load_cell, uint32_t *ret_period)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Periode zurück, wie von load_cell_set_weight_callback_period()
gesetzt.
load_cell_set_weight_callback_threshold
(LoadCell *load_cell, char option, int32_t min, int32_t max)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt den Schwellwert für den LOAD_CELL_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:
load_cell_get_weight_callback_threshold
(LoadCell *load_cell, char *ret_option, int32_t *ret_min, int32_t *ret_max)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt den Schwellwert zurück, wie von load_cell_set_weight_callback_threshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für ret_option:
load_cell_set_debounce_period
(LoadCell *load_cell, uint32_t debounce)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode mit welcher die Schwellwert Callback
ausgelöst wird, wenn der Schwellwert
weiterhin erreicht bleibt.
load_cell_get_debounce_period
(LoadCell *load_cell, uint32_t *ret_debounce)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Entprellperiode zurück, wie von load_cell_set_debounce_period()
gesetzt.
Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten
vom Gerät zu erhalten. Die Registrierung kann mit der load_cell_register_callback()
Funktion durchgeführt werden:
void my_callback(int value, void *user_data) { printf("Value: %d\n", value); } load_cell_register_callback(&load_cell, LOAD_CELL_CALLBACK_EXAMPLE, (void (*)(void))my_callback, NULL);
Die verfügbaren Konstanten mit den zugehö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.
LOAD_CELL_CALLBACK_WEIGHT
¶void callback(int32_t weight, void *user_data)
Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit load_cell_set_weight_callback_period()
,
ausgelöst. Der Parameter ist das Gewicht wie von der Wägezelle gemessen.
Der LOAD_CELL_CALLBACK_WEIGHT
Callback wird nur ausgelöst, wenn sich das Gewicht seit der
letzten Auslösung geändert hat.
LOAD_CELL_CALLBACK_WEIGHT_REACHED
¶void callback(int32_t weight, void *user_data)
Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
load_cell_set_weight_callback_threshold()
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 load_cell_set_debounce_period()
gesetzt, ausgelöst.
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.
load_cell_get_api_version
(LoadCell *load_cell, uint8_t ret_api_version[3])¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
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.
load_cell_get_response_expected
(LoadCell *load_cell, uint8_t function_id, bool *ret_response_expected)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.
Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt
werden, da diese Funktionen immer eine Antwort senden. Für
Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber
entfernt werden mittels load_cell_set_response_expected()
. Für Setter-Funktionen ist
es standardmäßig nicht gesetzt, kann aber gesetzt werden.
Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für function_id:
load_cell_set_response_expected
(LoadCell *load_cell, uint8_t function_id, bool response_expected)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.
Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für function_id:
load_cell_set_response_expected_all
(LoadCell *load_cell, bool response_expected)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
LOAD_CELL_DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein Load Cell Bricklet zu identifizieren.
Die load_cell_get_identity()
Funktion und der IPCON_CALLBACK_ENUMERATE
Callback der IP Connection haben ein device_identifier
Parameter um den Typ
des Bricks oder Bricklets anzugeben.
LOAD_CELL_DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Load Cell Bricklet dar.