Dies ist die Beschreibung der C/C++ 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 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 41 42 43 44 45 46 47 | #include <stdio.h>
#include "ip_connection.h"
#include "bricklet_voltage_current_v2.h"
#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Voltage/Current Bricklet 2.0
// Callback function for current callback
void cb_current(int32_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
VoltageCurrentV2 vc;
voltage_current_v2_create(&vc, 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
voltage_current_v2_register_callback(&vc,
VOLTAGE_CURRENT_V2_CALLBACK_CURRENT,
(void (*)(void))cb_current,
NULL);
// Set period for current callback to 1s (1000ms) without a threshold
voltage_current_v2_set_current_callback_configuration(&vc, 1000, false, 'x', 0, 0);
printf("Press key to exit\n");
getchar();
voltage_current_v2_destroy(&vc);
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 | #include <stdio.h>
#include "ip_connection.h"
#include "bricklet_voltage_current_v2.h"
#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Voltage/Current Bricklet 2.0
// Callback function for power callback
void cb_power(int32_t power, void *user_data) {
(void)user_data; // avoid unused parameter warning
printf("power: %f W\n", power/1000.0);
}
int main(void) {
// Create IP connection
IPConnection ipcon;
ipcon_create(&ipcon);
// Create device object
VoltageCurrentV2 vc;
voltage_current_v2_create(&vc, 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 power callback to function cb_power
voltage_current_v2_register_callback(&vc,
VOLTAGE_CURRENT_V2_CALLBACK_POWER,
(void (*)(void))cb_power,
NULL);
// Configure threshold for power "greater than 10 W"
// with a debounce period of 1s (1000ms)
voltage_current_v2_set_power_callback_configuration(&vc, 1000, false, '>', 10*1000, 0);
printf("Press key to exit\n");
getchar();
voltage_current_v2_destroy(&vc);
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_voltage_current_v2.h"
#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Voltage/Current Bricklet 2.0
int main(void) {
// Create IP connection
IPConnection ipcon;
ipcon_create(&ipcon);
// Create device object
VoltageCurrentV2 vc;
voltage_current_v2_create(&vc, 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 voltage
int32_t voltage;
if(voltage_current_v2_get_voltage(&vc, &voltage) < 0) {
fprintf(stderr, "Could not get voltage, probably timeout\n");
return 1;
}
printf("Voltage: %f V\n", voltage/1000.0);
// Get current current
int32_t current;
if(voltage_current_v2_get_current(&vc, ¤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();
voltage_current_v2_destroy(&vc);
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.
voltage_current_v2_create
(VoltageCurrentV2 *voltage_current_v2, const char *uid, IPConnection *ipcon)¶Parameter: |
|
---|
Erzeugt ein Geräteobjekt voltage_current_v2
mit der eindeutigen Geräte ID uid
und
fügt es der IP Connection ipcon
hinzu:
VoltageCurrentV2 voltage_current_v2;
voltage_current_v2_create(&voltage_current_v2, "YOUR_DEVICE_UID", &ipcon);
Dieses Geräteobjekt kann benutzt werden, nachdem die IP Connection verbunden.
voltage_current_v2_destroy
(VoltageCurrentV2 *voltage_current_v2)¶Parameter: |
|
---|
Entfernt das Geräteobjekt voltage_current_v2
von dessen IP Connection und zerstört es.
Das Geräteobjekt kann hiernach nicht mehr verwendet werden.
voltage_current_v2_get_current
(VoltageCurrentV2 *voltage_current_v2, int32_t *ret_current)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die gemessenen Stromstärke zurück.
Wenn der Wert periodisch benötigt wird, kann auch der VOLTAGE_CURRENT_V2_CALLBACK_CURRENT
Callback
verwendet werden. Der Callback wird mit der Funktion
voltage_current_v2_set_current_callback_configuration()
konfiguriert.
voltage_current_v2_get_voltage
(VoltageCurrentV2 *voltage_current_v2, int32_t *ret_voltage)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die gemessenen Spannung zurück.
Wenn der Wert periodisch benötigt wird, kann auch der VOLTAGE_CURRENT_V2_CALLBACK_VOLTAGE
Callback
verwendet werden. Der Callback wird mit der Funktion
voltage_current_v2_set_voltage_callback_configuration()
konfiguriert.
voltage_current_v2_get_power
(VoltageCurrentV2 *voltage_current_v2, int32_t *ret_power)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die gemessenen Leistung zurück.
Wenn der Wert periodisch benötigt wird, kann auch der VOLTAGE_CURRENT_V2_CALLBACK_POWER
Callback
verwendet werden. Der Callback wird mit der Funktion
voltage_current_v2_set_power_callback_configuration()
konfiguriert.
voltage_current_v2_set_configuration
(VoltageCurrentV2 *voltage_current_v2, uint8_t averaging, uint8_t voltage_conversion_time, uint8_t current_conversion_time)¶Parameter: |
|
---|---|
Rückgabe: |
|
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:
Für voltage_conversion_time:
Für current_conversion_time:
voltage_current_v2_get_configuration
(VoltageCurrentV2 *voltage_current_v2, uint8_t *ret_averaging, uint8_t *ret_voltage_conversion_time, uint8_t *ret_current_conversion_time)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Konfiguration zurück, wie von voltage_current_v2_set_configuration()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für ret_averaging:
Für ret_voltage_conversion_time:
Für ret_current_conversion_time:
voltage_current_v2_set_calibration
(VoltageCurrentV2 *voltage_current_v2, uint16_t voltage_multiplier, uint16_t voltage_divisor, uint16_t current_multiplier, uint16_t current_divisor)¶Parameter: |
|
---|---|
Rückgabe: |
|
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.
voltage_current_v2_get_calibration
(VoltageCurrentV2 *voltage_current_v2, uint16_t *ret_voltage_multiplier, uint16_t *ret_voltage_divisor, uint16_t *ret_current_multiplier, uint16_t *ret_current_divisor)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Kalibrierung zurück, wie von voltage_current_v2_set_calibration()
gesetzt.
voltage_current_v2_get_spitfp_error_count
(VoltageCurrentV2 *voltage_current_v2, uint32_t *ret_error_count_ack_checksum, uint32_t *ret_error_count_message_checksum, uint32_t *ret_error_count_frame, uint32_t *ret_error_count_overflow)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.
Die Fehler sind aufgeteilt in
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.
voltage_current_v2_set_status_led_config
(VoltageCurrentV2 *voltage_current_v2, uint8_t config)¶Parameter: |
|
---|---|
Rückgabe: |
|
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:
voltage_current_v2_get_status_led_config
(VoltageCurrentV2 *voltage_current_v2, uint8_t *ret_config)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Konfiguration zurück, wie von voltage_current_v2_set_status_led_config()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für ret_config:
voltage_current_v2_get_chip_temperature
(VoltageCurrentV2 *voltage_current_v2, int16_t *ret_temperature)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
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.
voltage_current_v2_reset
(VoltageCurrentV2 *voltage_current_v2)¶Parameter: |
|
---|---|
Rückgabe: |
|
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.
voltage_current_v2_get_identity
(VoltageCurrentV2 *voltage_current_v2, 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.
voltage_current_v2_register_callback
(VoltageCurrentV2 *voltage_current_v2, 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.
voltage_current_v2_set_current_callback_configuration
(VoltageCurrentV2 *voltage_current_v2, uint32_t period, bool value_has_to_change, char option, int32_t min, int32_t max)¶Parameter: |
|
---|---|
Rückgabe: |
|
Die Periode ist die Periode mit der der VOLTAGE_CURRENT_V2_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 VOLTAGE_CURRENT_V2_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:
voltage_current_v2_get_current_callback_configuration
(VoltageCurrentV2 *voltage_current_v2, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, int32_t *ret_min, int32_t *ret_max)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Callback-Konfiguration zurück, wie mittels voltage_current_v2_set_current_callback_configuration()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für ret_option:
voltage_current_v2_set_voltage_callback_configuration
(VoltageCurrentV2 *voltage_current_v2, uint32_t period, bool value_has_to_change, char option, int32_t min, int32_t max)¶Parameter: |
|
---|---|
Rückgabe: |
|
Die Periode ist die Periode mit der der VOLTAGE_CURRENT_V2_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 VOLTAGE_CURRENT_V2_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:
voltage_current_v2_get_voltage_callback_configuration
(VoltageCurrentV2 *voltage_current_v2, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, int32_t *ret_min, int32_t *ret_max)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Callback-Konfiguration zurück, wie mittels voltage_current_v2_set_voltage_callback_configuration()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für ret_option:
voltage_current_v2_set_power_callback_configuration
(VoltageCurrentV2 *voltage_current_v2, uint32_t period, bool value_has_to_change, char option, int32_t min, int32_t max)¶Parameter: |
|
---|---|
Rückgabe: |
|
Die Periode ist die Periode mit der der VOLTAGE_CURRENT_V2_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 VOLTAGE_CURRENT_V2_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:
voltage_current_v2_get_power_callback_configuration
(VoltageCurrentV2 *voltage_current_v2, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, int32_t *ret_min, int32_t *ret_max)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Callback-Konfiguration zurück, wie mittels voltage_current_v2_set_power_callback_configuration()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für ret_option:
Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten
vom Gerät zu erhalten. Die Registrierung kann mit der voltage_current_v2_register_callback()
Funktion durchgeführt werden:
void my_callback(int value, void *user_data) { printf("Value: %d\n", value); } voltage_current_v2_register_callback(&voltage_current_v2, VOLTAGE_CURRENT_V2_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.
VOLTAGE_CURRENT_V2_CALLBACK_CURRENT
¶void callback(int32_t current, void *user_data)
Callback-Parameter: |
|
---|
Dieser Callback wird periodisch ausgelöst abhängig von der mittels
voltage_current_v2_set_current_callback_configuration()
gesetzten Konfiguration
Der Parameter ist der gleiche wie voltage_current_v2_get_current()
.
VOLTAGE_CURRENT_V2_CALLBACK_VOLTAGE
¶void callback(int32_t voltage, void *user_data)
Callback-Parameter: |
|
---|
Dieser Callback wird periodisch ausgelöst abhängig von der mittels
voltage_current_v2_set_voltage_callback_configuration()
gesetzten Konfiguration
Der Parameter ist der gleiche wie voltage_current_v2_get_voltage()
.
VOLTAGE_CURRENT_V2_CALLBACK_POWER
¶void callback(int32_t power, void *user_data)
Callback-Parameter: |
|
---|
Dieser Callback wird periodisch ausgelöst abhängig von der mittels
voltage_current_v2_set_power_callback_configuration()
gesetzten Konfiguration
Der Parameter ist der gleiche wie voltage_current_v2_get_power()
.
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.
voltage_current_v2_get_api_version
(VoltageCurrentV2 *voltage_current_v2, 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.
voltage_current_v2_get_response_expected
(VoltageCurrentV2 *voltage_current_v2, 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 voltage_current_v2_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:
voltage_current_v2_set_response_expected
(VoltageCurrentV2 *voltage_current_v2, 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:
voltage_current_v2_set_response_expected_all
(VoltageCurrentV2 *voltage_current_v2, bool response_expected)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.
voltage_current_v2_set_bootloader_mode
(VoltageCurrentV2 *voltage_current_v2, uint8_t mode, uint8_t *ret_status)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
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:
Für ret_status:
voltage_current_v2_get_bootloader_mode
(VoltageCurrentV2 *voltage_current_v2, uint8_t *ret_mode)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt den aktuellen Bootloader-Modus zurück, siehe voltage_current_v2_set_bootloader_mode()
.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für ret_mode:
voltage_current_v2_set_write_firmware_pointer
(VoltageCurrentV2 *voltage_current_v2, uint32_t pointer)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt den Firmware-Pointer für voltage_current_v2_write_firmware()
. 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.
voltage_current_v2_write_firmware
(VoltageCurrentV2 *voltage_current_v2, uint8_t data[64], uint8_t *ret_status)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Schreibt 64 Bytes Firmware an die Position die vorher von
voltage_current_v2_set_write_firmware_pointer()
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.
voltage_current_v2_write_uid
(VoltageCurrentV2 *voltage_current_v2, uint32_t uid)¶Parameter: |
|
---|---|
Rückgabe: |
|
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.
voltage_current_v2_read_uid
(VoltageCurrentV2 *voltage_current_v2, uint32_t *ret_uid)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.
VOLTAGE_CURRENT_V2_DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein Voltage/Current Bricklet 2.0 zu identifizieren.
Die voltage_current_v2_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.
VOLTAGE_CURRENT_V2_DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Voltage/Current Bricklet 2.0 dar.