C/C++ - Voltage/Current Bricklet 2.0

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.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Callback

Download (example_callback.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
#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;
}

Threshold

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;
}

Simple

Download (example_simple.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
#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, &current) < 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;
}

API

Jede Funktion der C/C++ Bindings gibt einen Integer zurück, welcher einen Fehlercode beschreibt. 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:

  • E_OK = 0
  • E_TIMEOUT = -1
  • E_NO_STREAM_SOCKET = -2
  • E_HOSTNAME_INVALID = -3
  • E_NO_CONNECT = -4
  • E_NO_THREAD = -5
  • E_NOT_ADDED = -6 (wird seit C/C++ Bindings Version 2.0.0 nicht mehr verwendet)
  • E_ALREADY_CONNECTED = -7
  • E_NOT_CONNECTED = -8
  • E_INVALID_PARAMETER = -9
  • E_NOT_SUPPORTED = -10
  • E_UNKNOWN_ERROR_CODE = -11
  • E_STREAM_OUT_OF_SYNC = -12
  • E_INVALID_UID = -13
  • E_NON_ASCII_CHAR_IN_SECRET = -14

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

void voltage_current_v2_create(VoltageCurrentV2 *voltage_current_v2, const char *uid, IPConnection *ipcon)
Parameter:
  • voltage_current_v2 – Typ: VoltageCurrentV2 *
  • uid – Typ: const char *
  • ipcon – Typ: IPConnection *

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 wurde (siehe Beispiele oben).

void voltage_current_v2_destroy(VoltageCurrentV2 *voltage_current_v2)
Parameter:
  • voltage_current_v2 – Typ: VoltageCurrentV2 *

Entfernt das Geräteobjekt voltage_current_v2 von dessen IP Connection und zerstört es. Das Geräteobjekt kann hiernach nicht mehr verwendet werden.

int voltage_current_v2_get_current(VoltageCurrentV2 *voltage_current_v2, int32_t *ret_current)
Parameter:
  • voltage_current_v2 – Typ: VoltageCurrentV2 *
Ausgabeparameter:
  • ret_current – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
Rückgabe:
  • error_code – Typ: int

Gibt die gemessenen Stromstärke zurück. Der Wert ist in mA und im Bereich von -20000mA bis 20000mA.

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.

int voltage_current_v2_get_voltage(VoltageCurrentV2 *voltage_current_v2, int32_t *ret_voltage)
Parameter:
  • voltage_current_v2 – Typ: VoltageCurrentV2 *
Ausgabeparameter:
  • ret_voltage – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
Rückgabe:
  • error_code – Typ: int

Gibt die gemessenen Spannung zurück. Der Wert ist in mV und im Bereich von 0mV bis 36000mV.

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.

int voltage_current_v2_get_power(VoltageCurrentV2 *voltage_current_v2, int32_t *ret_power)
Parameter:
  • voltage_current_v2 – Typ: VoltageCurrentV2 *
Ausgabeparameter:
  • ret_power – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
Rückgabe:
  • error_code – Typ: int

Gibt die gemessenen Leistung zurück. Der Wert ist in mW und im Bereich von 0mW bis 720000mW.

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.

int voltage_current_v2_set_configuration(VoltageCurrentV2 *voltage_current_v2, uint8_t averaging, uint8_t voltage_conversion_time, uint8_t current_conversion_time)
Parameter:
  • voltage_current_v2 – Typ: VoltageCurrentV2 *
  • averaging – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • voltage_conversion_time – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • current_conversion_time – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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.

Durchschnittsbildung:

Wert Anzahl
0 1
1 4
2 16
3 64
4 128
5 256
6 512
>=7 1024

Wandlungszeit für Spannung/Stromstärke:

Wert Wandlungszeit
0 140µs
1 204µs
2 332µs
3 588µs
4 1.1ms
5 2.116ms
6 4.156ms
>=7 8.244ms

Die Standardwerte sind 3, 4 und 4 (64, 1.1ms, 1.1ms) für die Durchschnittsbildung und die Spannungs/Stromstärkenwandlungszeit.

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

Für averaging:

  • VOLTAGE_CURRENT_V2_AVERAGING_1 = 0
  • VOLTAGE_CURRENT_V2_AVERAGING_4 = 1
  • VOLTAGE_CURRENT_V2_AVERAGING_16 = 2
  • VOLTAGE_CURRENT_V2_AVERAGING_64 = 3
  • VOLTAGE_CURRENT_V2_AVERAGING_128 = 4
  • VOLTAGE_CURRENT_V2_AVERAGING_256 = 5
  • VOLTAGE_CURRENT_V2_AVERAGING_512 = 6
  • VOLTAGE_CURRENT_V2_AVERAGING_1024 = 7

Für voltage_conversion_time:

  • VOLTAGE_CURRENT_V2_CONVERSION_TIME_140US = 0
  • VOLTAGE_CURRENT_V2_CONVERSION_TIME_204US = 1
  • VOLTAGE_CURRENT_V2_CONVERSION_TIME_332US = 2
  • VOLTAGE_CURRENT_V2_CONVERSION_TIME_588US = 3
  • VOLTAGE_CURRENT_V2_CONVERSION_TIME_1_1MS = 4
  • VOLTAGE_CURRENT_V2_CONVERSION_TIME_2_116MS = 5
  • VOLTAGE_CURRENT_V2_CONVERSION_TIME_4_156MS = 6
  • VOLTAGE_CURRENT_V2_CONVERSION_TIME_8_244MS = 7

Für current_conversion_time:

  • VOLTAGE_CURRENT_V2_CONVERSION_TIME_140US = 0
  • VOLTAGE_CURRENT_V2_CONVERSION_TIME_204US = 1
  • VOLTAGE_CURRENT_V2_CONVERSION_TIME_332US = 2
  • VOLTAGE_CURRENT_V2_CONVERSION_TIME_588US = 3
  • VOLTAGE_CURRENT_V2_CONVERSION_TIME_1_1MS = 4
  • VOLTAGE_CURRENT_V2_CONVERSION_TIME_2_116MS = 5
  • VOLTAGE_CURRENT_V2_CONVERSION_TIME_4_156MS = 6
  • VOLTAGE_CURRENT_V2_CONVERSION_TIME_8_244MS = 7
int 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:
  • voltage_current_v2 – Typ: VoltageCurrentV2 *
Ausgabeparameter:
  • ret_averaging – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • ret_voltage_conversion_time – Typ: uint8_t, Wertebereich: [0 bis 255]
  • ret_current_conversion_time – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:
  • error_code – Typ: int

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:

  • VOLTAGE_CURRENT_V2_AVERAGING_1 = 0
  • VOLTAGE_CURRENT_V2_AVERAGING_4 = 1
  • VOLTAGE_CURRENT_V2_AVERAGING_16 = 2
  • VOLTAGE_CURRENT_V2_AVERAGING_64 = 3
  • VOLTAGE_CURRENT_V2_AVERAGING_128 = 4
  • VOLTAGE_CURRENT_V2_AVERAGING_256 = 5
  • VOLTAGE_CURRENT_V2_AVERAGING_512 = 6
  • VOLTAGE_CURRENT_V2_AVERAGING_1024 = 7

Fortgeschrittene Funktionen

int 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:
  • voltage_current_v2 – Typ: VoltageCurrentV2 *
  • voltage_multiplier – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • voltage_divisor – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • current_multiplier – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • current_divisor – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int

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.

int 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:
  • voltage_current_v2 – Typ: VoltageCurrentV2 *
Ausgabeparameter:
  • ret_voltage_multiplier – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • ret_voltage_divisor – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • ret_current_multiplier – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • ret_current_divisor – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int

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

int voltage_current_v2_get_api_version(VoltageCurrentV2 *voltage_current_v2, uint8_t ret_api_version[3])
Parameter:
  • voltage_current_v2 – Typ: VoltageCurrentV2 *
Ausgabeparameter:
  • ret_api_version – Typ: uint8_t[3], Wertebereich: [0 bis 255]
Rückgabe:
  • error_code – Typ: int

Gibt die Version der API Definition (Major, Minor, Revision) 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.

int voltage_current_v2_get_response_expected(VoltageCurrentV2 *voltage_current_v2, uint8_t function_id, bool *ret_response_expected)
Parameter:
  • voltage_current_v2 – Typ: VoltageCurrentV2 *
  • function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:
  • ret_response_expected – Typ: bool
Rückgabe:
  • error_code – Typ: int

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_FUNCTION_SET_CURRENT_CALLBACK_CONFIGURATION = 2
  • VOLTAGE_CURRENT_V2_FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION = 6
  • VOLTAGE_CURRENT_V2_FUNCTION_SET_POWER_CALLBACK_CONFIGURATION = 10
  • VOLTAGE_CURRENT_V2_FUNCTION_SET_CONFIGURATION = 13
  • VOLTAGE_CURRENT_V2_FUNCTION_SET_CALIBRATION = 15
  • VOLTAGE_CURRENT_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • VOLTAGE_CURRENT_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • VOLTAGE_CURRENT_V2_FUNCTION_RESET = 243
  • VOLTAGE_CURRENT_V2_FUNCTION_WRITE_UID = 248
int voltage_current_v2_set_response_expected(VoltageCurrentV2 *voltage_current_v2, uint8_t function_id, bool response_expected)
Parameter:
  • voltage_current_v2 – Typ: VoltageCurrentV2 *
  • function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • response_expected – Typ: bool
Rückgabe:
  • error_code – Typ: int

Ä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_FUNCTION_SET_CURRENT_CALLBACK_CONFIGURATION = 2
  • VOLTAGE_CURRENT_V2_FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION = 6
  • VOLTAGE_CURRENT_V2_FUNCTION_SET_POWER_CALLBACK_CONFIGURATION = 10
  • VOLTAGE_CURRENT_V2_FUNCTION_SET_CONFIGURATION = 13
  • VOLTAGE_CURRENT_V2_FUNCTION_SET_CALIBRATION = 15
  • VOLTAGE_CURRENT_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • VOLTAGE_CURRENT_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • VOLTAGE_CURRENT_V2_FUNCTION_RESET = 243
  • VOLTAGE_CURRENT_V2_FUNCTION_WRITE_UID = 248
int voltage_current_v2_set_response_expected_all(VoltageCurrentV2 *voltage_current_v2, bool response_expected)
Parameter:
  • voltage_current_v2 – Typ: VoltageCurrentV2 *
  • response_expected – Typ: bool
Rückgabe:
  • error_code – Typ: int

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

int 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:
  • voltage_current_v2 – Typ: VoltageCurrentV2 *
Ausgabeparameter:
  • ret_error_count_ack_checksum – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
  • ret_error_count_message_checksum – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
  • ret_error_count_frame – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
  • ret_error_count_overflow – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_code – Typ: int

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

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.

int voltage_current_v2_set_bootloader_mode(VoltageCurrentV2 *voltage_current_v2, uint8_t mode, uint8_t *ret_status)
Parameter:
  • voltage_current_v2 – Typ: VoltageCurrentV2 *
  • mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:
  • ret_status – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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

  • VOLTAGE_CURRENT_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • VOLTAGE_CURRENT_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • VOLTAGE_CURRENT_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • VOLTAGE_CURRENT_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • VOLTAGE_CURRENT_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

  • VOLTAGE_CURRENT_V2_BOOTLOADER_STATUS_OK = 0
  • VOLTAGE_CURRENT_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
  • VOLTAGE_CURRENT_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
  • VOLTAGE_CURRENT_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • VOLTAGE_CURRENT_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • VOLTAGE_CURRENT_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5
int voltage_current_v2_get_bootloader_mode(VoltageCurrentV2 *voltage_current_v2, uint8_t *ret_mode)
Parameter:
  • voltage_current_v2 – Typ: VoltageCurrentV2 *
Ausgabeparameter:
  • ret_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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_BOOTLOADER_MODE_BOOTLOADER = 0
  • VOLTAGE_CURRENT_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • VOLTAGE_CURRENT_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • VOLTAGE_CURRENT_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • VOLTAGE_CURRENT_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
int voltage_current_v2_set_write_firmware_pointer(VoltageCurrentV2 *voltage_current_v2, uint32_t pointer)
Parameter:
  • voltage_current_v2 – Typ: VoltageCurrentV2 *
  • pointer – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_code – Typ: int

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.

int voltage_current_v2_write_firmware(VoltageCurrentV2 *voltage_current_v2, uint8_t data[64], uint8_t *ret_status)
Parameter:
  • voltage_current_v2 – Typ: VoltageCurrentV2 *
  • data – Typ: uint8_t[64], Wertebereich: [0 bis 255]
Ausgabeparameter:
  • ret_status – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:
  • error_code – Typ: int

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.

int voltage_current_v2_set_status_led_config(VoltageCurrentV2 *voltage_current_v2, uint8_t config)
Parameter:
  • voltage_current_v2 – Typ: VoltageCurrentV2 *
  • config – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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_STATUS_LED_CONFIG_OFF = 0
  • VOLTAGE_CURRENT_V2_STATUS_LED_CONFIG_ON = 1
  • VOLTAGE_CURRENT_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • VOLTAGE_CURRENT_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
int voltage_current_v2_get_status_led_config(VoltageCurrentV2 *voltage_current_v2, uint8_t *ret_config)
Parameter:
  • voltage_current_v2 – Typ: VoltageCurrentV2 *
Ausgabeparameter:
  • ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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_STATUS_LED_CONFIG_OFF = 0
  • VOLTAGE_CURRENT_V2_STATUS_LED_CONFIG_ON = 1
  • VOLTAGE_CURRENT_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • VOLTAGE_CURRENT_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
int voltage_current_v2_get_chip_temperature(VoltageCurrentV2 *voltage_current_v2, int16_t *ret_temperature)
Parameter:
  • voltage_current_v2 – Typ: VoltageCurrentV2 *
Ausgabeparameter:
  • ret_temperature – Typ: int16_t, Wertebereich: [-215 bis 215 - 1]
Rückgabe:
  • error_code – Typ: int

Gibt die Temperatur in °C, 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.

int voltage_current_v2_reset(VoltageCurrentV2 *voltage_current_v2)
Parameter:
  • voltage_current_v2 – Typ: VoltageCurrentV2 *
Rückgabe:
  • error_code – Typ: int

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.

int voltage_current_v2_write_uid(VoltageCurrentV2 *voltage_current_v2, uint32_t uid)
Parameter:
  • voltage_current_v2 – Typ: VoltageCurrentV2 *
  • uid – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_code – Typ: int

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.

int voltage_current_v2_read_uid(VoltageCurrentV2 *voltage_current_v2, uint32_t *ret_uid)
Parameter:
  • voltage_current_v2 – Typ: VoltageCurrentV2 *
Ausgabeparameter:
  • ret_uid – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_code – Typ: int

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

int 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:
  • voltage_current_v2 – Typ: VoltageCurrentV2 *
Ausgabeparameter:
  • ret_uid – Typ: char[8]
  • ret_connected_uid – Typ: char[8]
  • ret_position – Typ: char
  • ret_hardware_version – Typ: uint8_t[3], Wertebereich: [0 bis 255]
  • ret_firmware_version – Typ: uint8_t[3], Wertebereich: [0 bis 255]
  • ret_device_identifier – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int

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 kann 'a', 'b', 'c' oder 'd' sein.

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 voltage_current_v2_register_callback(VoltageCurrentV2 *voltage_current_v2, int16_t callback_id, void (*function)(void), void *user_data)
Parameter:
  • voltage_current_v2 – Typ: VoltageCurrentV2 *
  • callback_id – Typ: int16_t
  • function – Typ: void (*)(void)
  • user_data – Typ: void *

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.

int 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:
  • voltage_current_v2 – Typ: VoltageCurrentV2 *
  • period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
  • max – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
Rückgabe:
  • error_code – Typ: int

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.

Der Standardwert ist (0, false, 'x', 0, 0).

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

Für option:

  • VOLTAGE_CURRENT_V2_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_CURRENT_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_CURRENT_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_CURRENT_V2_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_CURRENT_V2_THRESHOLD_OPTION_GREATER = '>'
int 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:
  • voltage_current_v2 – Typ: VoltageCurrentV2 *
Ausgabeparameter:
  • ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • ret_value_has_to_change – Typ: bool, Standardwert: false
  • ret_option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • ret_min – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
  • ret_max – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
Rückgabe:
  • error_code – Typ: int

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_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_CURRENT_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_CURRENT_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_CURRENT_V2_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_CURRENT_V2_THRESHOLD_OPTION_GREATER = '>'
int 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:
  • voltage_current_v2 – Typ: VoltageCurrentV2 *
  • period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
  • max – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
Rückgabe:
  • error_code – Typ: int

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.

Der Standardwert ist (0, false, 'x', 0, 0).

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

Für option:

  • VOLTAGE_CURRENT_V2_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_CURRENT_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_CURRENT_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_CURRENT_V2_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_CURRENT_V2_THRESHOLD_OPTION_GREATER = '>'
int 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:
  • voltage_current_v2 – Typ: VoltageCurrentV2 *
Ausgabeparameter:
  • ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • ret_value_has_to_change – Typ: bool, Standardwert: false
  • ret_option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • ret_min – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
  • ret_max – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
Rückgabe:
  • error_code – Typ: int

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_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_CURRENT_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_CURRENT_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_CURRENT_V2_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_CURRENT_V2_THRESHOLD_OPTION_GREATER = '>'
int 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:
  • voltage_current_v2 – Typ: VoltageCurrentV2 *
  • period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
  • max – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
Rückgabe:
  • error_code – Typ: int

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.

Der Standardwert ist (0, false, 'x', 0, 0).

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

Für option:

  • VOLTAGE_CURRENT_V2_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_CURRENT_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_CURRENT_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_CURRENT_V2_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_CURRENT_V2_THRESHOLD_OPTION_GREATER = '>'
int 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:
  • voltage_current_v2 – Typ: VoltageCurrentV2 *
Ausgabeparameter:
  • ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • ret_value_has_to_change – Typ: bool, Standardwert: false
  • ret_option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • ret_min – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
  • ret_max – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
Rückgabe:
  • error_code – Typ: int

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:

  • VOLTAGE_CURRENT_V2_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_CURRENT_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_CURRENT_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_CURRENT_V2_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_CURRENT_V2_THRESHOLD_OPTION_GREATER = '>'

Callbacks

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 p, void *user_data) {
    printf("parameter: %d\n", p);
}

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:
  • current – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
  • user_data – Typ: void *

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:
  • voltage – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
  • user_data – Typ: void *

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:
  • power – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
  • user_data – Typ: void *

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().

Konstanten

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.