Dies ist die Beschreibung der C/C++ API Bindings für das Current25 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Current25 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_current25.h"
#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Current25 Bricklet
int main(void) {
// Create IP connection
IPConnection ipcon;
ipcon_create(&ipcon);
// Create device object
Current25 c;
current25_create(&c, 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 current
int16_t current;
if(current25_get_current(&c, ¤t) < 0) {
fprintf(stderr, "Could not get current, probably timeout\n");
return 1;
}
printf("Current: %f A\n", current/1000.0);
printf("Press key to exit\n");
getchar();
current25_destroy(&c);
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_current25.h"
#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Current25 Bricklet
// Callback function for current callback
void cb_current(int16_t current, void *user_data) {
(void)user_data; // avoid unused parameter warning
printf("Current: %f A\n", current/1000.0);
}
int main(void) {
// Create IP connection
IPConnection ipcon;
ipcon_create(&ipcon);
// Create device object
Current25 c;
current25_create(&c, 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 current callback to function cb_current
current25_register_callback(&c,
CURRENT25_CALLBACK_CURRENT,
(void (*)(void))cb_current,
NULL);
// 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!
current25_set_current_callback_period(&c, 1000);
printf("Press key to exit\n");
getchar();
current25_destroy(&c);
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_current25.h"
#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Current25 Bricklet
// Callback function for current reached callback
void cb_current_reached(int16_t current, void *user_data) {
(void)user_data; // avoid unused parameter warning
printf("Current: %f A\n", current/1000.0);
}
int main(void) {
// Create IP connection
IPConnection ipcon;
ipcon_create(&ipcon);
// Create device object
Current25 c;
current25_create(&c, 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 10 seconds (10000ms)
current25_set_debounce_period(&c, 10000);
// Register current reached callback to function cb_current_reached
current25_register_callback(&c,
CURRENT25_CALLBACK_CURRENT_REACHED,
(void (*)(void))cb_current_reached,
NULL);
// Configure threshold for current "greater than 5 A"
current25_set_current_callback_threshold(&c, '>', 5*1000, 0);
printf("Press key to exit\n");
getchar();
current25_destroy(&c);
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.
current25_create
(Current25 *current25, const char *uid, IPConnection *ipcon)¶Parameter: |
|
---|
Erzeugt ein Geräteobjekt current25
mit der eindeutigen Geräte ID uid
und
fügt es der IP Connection ipcon
hinzu:
Current25 current25;
current25_create(¤t25, "YOUR_DEVICE_UID", &ipcon);
Dieses Geräteobjekt kann benutzt werden, nachdem die IP Connection verbunden.
current25_destroy
(Current25 *current25)¶Parameter: |
|
---|
Entfernt das Geräteobjekt current25
von dessen IP Connection und zerstört es.
Das Geräteobjekt kann hiernach nicht mehr verwendet werden.
current25_get_current
(Current25 *current25, int16_t *ret_current)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die gemessene Stromstärke des Sensors zurück.
Wenn die Stromstärke periodisch abgefragt werden soll, wird empfohlen
den CURRENT25_CALLBACK_CURRENT
Callback zu nutzen und die Periode mit
current25_set_current_callback_period()
vorzugeben.
current25_calibrate
(Current25 *current25)¶Parameter: |
|
---|---|
Rückgabe: |
|
Kalibriert den Nullwert des Sensors. Diese Funktion muss aufgerufen werden, wenn kein Strom fließt.
Der Nullwert des Stromsensors ist abhängig von den exakten Eigenschaften des Analog-Digital-Wandlers, der Länge des Bricklet Kabels und der Temperatur. Daher ist es, bei Wechsel des Brick oder bei Veränderung der Umgebung in welcher das Bricklet genutzt wird, ratsam erneut zu kalibrieren.
Die resultierende Kalibrierung wird in den EEPROM des Current Bricklet gespeichert.
current25_is_over_current
(Current25 *current25, bool *ret_over)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt true zurück wenn mehr als 25A gemessen wurden.
Bemerkung
Um diesen Wert zurückzusetzen ist ein Aus- und Wiedereinschalten des Bricklet notwendig.
current25_get_analog_value
(Current25 *current25, uint16_t *ret_value)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück.
Bemerkung
Der von current25_get_current()
zurückgegebene Wert ist über mehrere
Messwerte gemittelt um das Rauschen zu vermindern, während current25_get_analog_value()
unverarbeitete Analogwerte zurück gibt. Der einzige Grund current25_get_analog_value()
zu nutzen, ist die volle Auflösung des Analog-Digital-Wandlers zu erhalten.
Wenn der Analogwert periodisch abgefragt werden soll, wird empfohlen
den CURRENT25_CALLBACK_ANALOG_VALUE
Callback zu nutzen und die Periode mit
current25_set_analog_value_callback_period()
vorzugeben.
current25_get_identity
(Current25 *current25, 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.
current25_register_callback
(Current25 *current25, 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.
current25_set_current_callback_period
(Current25 *current25, uint32_t period)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode mit welcher der CURRENT25_CALLBACK_CURRENT
Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
Der CURRENT25_CALLBACK_CURRENT
Callback wird nur ausgelöst, wenn sich die Stromstärke seit
der letzten Auslösung geändert hat.
current25_get_current_callback_period
(Current25 *current25, uint32_t *ret_period)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Periode zurück, wie von current25_set_current_callback_period()
gesetzt.
current25_set_analog_value_callback_period
(Current25 *current25, uint32_t period)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode mit welcher der CURRENT25_CALLBACK_ANALOG_VALUE
Callback ausgelöst
wird. Ein Wert von 0 deaktiviert den Callback.
Der CURRENT25_CALLBACK_ANALOG_VALUE
Callback wird nur ausgelöst, wenn sich der Analogwert
seit der letzten Auslösung geändert hat.
current25_get_analog_value_callback_period
(Current25 *current25, uint32_t *ret_period)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Periode zurück, wie von current25_set_analog_value_callback_period()
gesetzt.
current25_set_current_callback_threshold
(Current25 *current25, char option, int16_t min, int16_t max)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt den Schwellwert für den CURRENT25_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:
current25_get_current_callback_threshold
(Current25 *current25, char *ret_option, int16_t *ret_min, int16_t *ret_max)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt den Schwellwert zurück, wie von current25_set_current_callback_threshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für ret_option:
current25_set_analog_value_callback_threshold
(Current25 *current25, char option, uint16_t min, uint16_t max)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt den Schwellwert für den CURRENT25_CALLBACK_ANALOG_VALUE_REACHED
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Callback ist inaktiv |
'o' | Callback wird ausgelöst, wenn der Analogwert außerhalb des min und max Wertes ist |
'i' | Callback wird ausgelöst, wenn der Analogwert innerhalb des min und max Wertes ist |
'<' | Callback wird ausgelöst, wenn der Analogwert kleiner als der min Wert ist (max wird ignoriert) |
'>' | Callback wird ausgelöst, wenn der Analogwert größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
current25_get_analog_value_callback_threshold
(Current25 *current25, char *ret_option, uint16_t *ret_min, uint16_t *ret_max)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt den Schwellwert zurück, wie von current25_set_analog_value_callback_threshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für ret_option:
current25_set_debounce_period
(Current25 *current25, uint32_t debounce)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode mit welcher die Schwellwert Callbacks
ausgelöst werden, wenn die Schwellwerte
weiterhin erreicht bleiben.
current25_get_debounce_period
(Current25 *current25, uint32_t *ret_debounce)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Entprellperiode zurück, wie von current25_set_debounce_period()
gesetzt.
Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten
vom Gerät zu erhalten. Die Registrierung kann mit der current25_register_callback()
Funktion durchgeführt werden:
void my_callback(int value, void *user_data) { printf("Value: %d\n", value); } current25_register_callback(¤t25, CURRENT25_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.
CURRENT25_CALLBACK_CURRENT
¶void callback(int16_t current, void *user_data)
Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit current25_set_current_callback_period()
,
ausgelöst. Der Parameter ist die Stromstärke des Sensors.
Der CURRENT25_CALLBACK_CURRENT
Callback wird nur ausgelöst, wenn sich die Stromstärke seit der
letzten Auslösung geändert hat.
CURRENT25_CALLBACK_ANALOG_VALUE
¶void callback(uint16_t value, void *user_data)
Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit current25_set_analog_value_callback_period()
,
ausgelöst. Der Parameter ist der Analogwert des Sensors.
Der CURRENT25_CALLBACK_ANALOG_VALUE
Callback wird nur ausgelöst, wenn sich der Analogwert seit der
letzten Auslösung geändert hat.
CURRENT25_CALLBACK_CURRENT_REACHED
¶void callback(int16_t current, void *user_data)
Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
current25_set_current_callback_threshold()
gesetzt, erreicht wird.
Der Parameter ist die Stromstärke des Sensors.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit current25_set_debounce_period()
gesetzt, ausgelöst.
CURRENT25_CALLBACK_ANALOG_VALUE_REACHED
¶void callback(uint16_t value, void *user_data)
Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
current25_set_analog_value_callback_threshold()
gesetzt, erreicht wird.
Der Parameter ist der Analogwert des Sensors.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit current25_set_debounce_period()
gesetzt, ausgelöst.
CURRENT25_CALLBACK_OVER_CURRENT
¶void callback(void *user_data)
Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn ein Überstrom gemessen wurde
(siehe current25_is_over_current()
).
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.
current25_get_api_version
(Current25 *current25, 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.
current25_get_response_expected
(Current25 *current25, 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 current25_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:
current25_set_response_expected
(Current25 *current25, 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:
current25_set_response_expected_all
(Current25 *current25, bool response_expected)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
CURRENT25_DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein Current25 Bricklet zu identifizieren.
Die current25_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.
CURRENT25_DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Current25 Bricklet dar.