C/C++ - Voltage/Current Bricklet

Dies ist die Beschreibung der C/C++ API Bindings für das Voltage/Current Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Voltage/Current Bricklet 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
48
49
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_voltage_current.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Voltage/Current Bricklet

// 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
    VoltageCurrent vc;
    voltage_current_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_register_callback(&vc,
                                      VOLTAGE_CURRENT_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!
    voltage_current_set_current_callback_period(&vc, 1000);

    printf("Press key to exit\n");
    getchar();
    voltage_current_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.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Voltage/Current Bricklet

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    VoltageCurrent vc;
    voltage_current_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_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_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_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
49
50
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_voltage_current.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Voltage/Current Bricklet

// Callback function for power reached callback
void cb_power_reached(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
    VoltageCurrent vc;
    voltage_current_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 threshold callbacks with a debounce time of 10 seconds (10000ms)
    voltage_current_set_debounce_period(&vc, 10000);

    // Register power reached callback to function cb_power_reached
    voltage_current_register_callback(&vc,
                                      VOLTAGE_CURRENT_CALLBACK_POWER_REACHED,
                                      (void (*)(void))cb_power_reached,
                                      NULL);

    // Configure threshold for power "greater than 10 W"
    voltage_current_set_power_callback_threshold(&vc, '>', 10*1000, 0);

    printf("Press key to exit\n");
    getchar();
    voltage_current_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
  • E_WRONG_DEVICE_TYPE = -15
  • E_DEVICE_REPLACED = -16
  • E_WRONG_RESPONSE_LENGTH = -17

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

void voltage_current_create(VoltageCurrent *voltage_current, const char *uid, IPConnection *ipcon)
Parameter:
  • voltage_current – Typ: VoltageCurrent *
  • uid – Typ: const char *
  • ipcon – Typ: IPConnection *

Erzeugt ein Geräteobjekt voltage_current mit der eindeutigen Geräte ID uid und fügt es der IP Connection ipcon hinzu:

VoltageCurrent voltage_current;
voltage_current_create(&voltage_current, "YOUR_DEVICE_UID", &ipcon);

Dieses Geräteobjekt kann benutzt werden, nachdem die IP Connection verbunden.

void voltage_current_destroy(VoltageCurrent *voltage_current)
Parameter:
  • voltage_current – Typ: VoltageCurrent *

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

int voltage_current_get_current(VoltageCurrent *voltage_current, int32_t *ret_current)
Parameter:
  • voltage_current – Typ: VoltageCurrent *
Ausgabeparameter:
  • ret_current – Typ: int32_t, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]
Rückgabe:
  • error_code – Typ: int

Gibt die gemessenen Stromstärke zurück.

Wenn die Stromstärke periodisch abgefragt werden soll, wird empfohlen den VOLTAGE_CURRENT_CALLBACK_CURRENT Callback zu nutzen und die Periode mit voltage_current_set_current_callback_period() vorzugeben.

int voltage_current_get_voltage(VoltageCurrent *voltage_current, int32_t *ret_voltage)
Parameter:
  • voltage_current – Typ: VoltageCurrent *
Ausgabeparameter:
  • ret_voltage – Typ: int32_t, Einheit: 1 mV, Wertebereich: [0 bis 36000]
Rückgabe:
  • error_code – Typ: int

Gibt die gemessenen Spannung zurück.

Wenn die Spannung periodisch abgefragt werden soll, wird empfohlen den VOLTAGE_CURRENT_CALLBACK_VOLTAGE Callback zu nutzen und die Periode mit voltage_current_set_voltage_callback_period() vorzugeben.

int voltage_current_get_power(VoltageCurrent *voltage_current, int32_t *ret_power)
Parameter:
  • voltage_current – Typ: VoltageCurrent *
Ausgabeparameter:
  • ret_power – Typ: int32_t, Einheit: 1 mW, Wertebereich: [0 bis 720000]
Rückgabe:
  • error_code – Typ: int

Gibt die gemessenen Leistung zurück.

Wenn die Leistung periodisch abgefragt werden soll, wird empfohlen den VOLTAGE_CURRENT_CALLBACK_POWER Callback zu nutzen und die Periode mit voltage_current_set_power_callback_period() vorzugeben.

int voltage_current_set_configuration(VoltageCurrent *voltage_current, uint8_t averaging, uint8_t voltage_conversion_time, uint8_t current_conversion_time)
Parameter:
  • voltage_current – Typ: VoltageCurrent *
  • averaging – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
  • voltage_conversion_time – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 4
  • current_conversion_time – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 4
Rückgabe:
  • error_code – Typ: int

Setzt die Konfiguration des Voltage/Current Bricklet. 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:

  • VOLTAGE_CURRENT_AVERAGING_1 = 0
  • VOLTAGE_CURRENT_AVERAGING_4 = 1
  • VOLTAGE_CURRENT_AVERAGING_16 = 2
  • VOLTAGE_CURRENT_AVERAGING_64 = 3
  • VOLTAGE_CURRENT_AVERAGING_128 = 4
  • VOLTAGE_CURRENT_AVERAGING_256 = 5
  • VOLTAGE_CURRENT_AVERAGING_512 = 6
  • VOLTAGE_CURRENT_AVERAGING_1024 = 7

Für voltage_conversion_time:

  • VOLTAGE_CURRENT_CONVERSION_TIME_140US = 0
  • VOLTAGE_CURRENT_CONVERSION_TIME_204US = 1
  • VOLTAGE_CURRENT_CONVERSION_TIME_332US = 2
  • VOLTAGE_CURRENT_CONVERSION_TIME_588US = 3
  • VOLTAGE_CURRENT_CONVERSION_TIME_1_1MS = 4
  • VOLTAGE_CURRENT_CONVERSION_TIME_2_116MS = 5
  • VOLTAGE_CURRENT_CONVERSION_TIME_4_156MS = 6
  • VOLTAGE_CURRENT_CONVERSION_TIME_8_244MS = 7

Für current_conversion_time:

  • VOLTAGE_CURRENT_CONVERSION_TIME_140US = 0
  • VOLTAGE_CURRENT_CONVERSION_TIME_204US = 1
  • VOLTAGE_CURRENT_CONVERSION_TIME_332US = 2
  • VOLTAGE_CURRENT_CONVERSION_TIME_588US = 3
  • VOLTAGE_CURRENT_CONVERSION_TIME_1_1MS = 4
  • VOLTAGE_CURRENT_CONVERSION_TIME_2_116MS = 5
  • VOLTAGE_CURRENT_CONVERSION_TIME_4_156MS = 6
  • VOLTAGE_CURRENT_CONVERSION_TIME_8_244MS = 7
int voltage_current_get_configuration(VoltageCurrent *voltage_current, uint8_t *ret_averaging, uint8_t *ret_voltage_conversion_time, uint8_t *ret_current_conversion_time)
Parameter:
  • voltage_current – Typ: VoltageCurrent *
Ausgabeparameter:
  • ret_averaging – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
  • ret_voltage_conversion_time – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 4
  • ret_current_conversion_time – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 4
Rückgabe:
  • error_code – Typ: int

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

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

Für ret_averaging:

  • VOLTAGE_CURRENT_AVERAGING_1 = 0
  • VOLTAGE_CURRENT_AVERAGING_4 = 1
  • VOLTAGE_CURRENT_AVERAGING_16 = 2
  • VOLTAGE_CURRENT_AVERAGING_64 = 3
  • VOLTAGE_CURRENT_AVERAGING_128 = 4
  • VOLTAGE_CURRENT_AVERAGING_256 = 5
  • VOLTAGE_CURRENT_AVERAGING_512 = 6
  • VOLTAGE_CURRENT_AVERAGING_1024 = 7

Für ret_voltage_conversion_time:

  • VOLTAGE_CURRENT_CONVERSION_TIME_140US = 0
  • VOLTAGE_CURRENT_CONVERSION_TIME_204US = 1
  • VOLTAGE_CURRENT_CONVERSION_TIME_332US = 2
  • VOLTAGE_CURRENT_CONVERSION_TIME_588US = 3
  • VOLTAGE_CURRENT_CONVERSION_TIME_1_1MS = 4
  • VOLTAGE_CURRENT_CONVERSION_TIME_2_116MS = 5
  • VOLTAGE_CURRENT_CONVERSION_TIME_4_156MS = 6
  • VOLTAGE_CURRENT_CONVERSION_TIME_8_244MS = 7

Für ret_current_conversion_time:

  • VOLTAGE_CURRENT_CONVERSION_TIME_140US = 0
  • VOLTAGE_CURRENT_CONVERSION_TIME_204US = 1
  • VOLTAGE_CURRENT_CONVERSION_TIME_332US = 2
  • VOLTAGE_CURRENT_CONVERSION_TIME_588US = 3
  • VOLTAGE_CURRENT_CONVERSION_TIME_1_1MS = 4
  • VOLTAGE_CURRENT_CONVERSION_TIME_2_116MS = 5
  • VOLTAGE_CURRENT_CONVERSION_TIME_4_156MS = 6
  • VOLTAGE_CURRENT_CONVERSION_TIME_8_244MS = 7

Fortgeschrittene Funktionen

int voltage_current_set_calibration(VoltageCurrent *voltage_current, uint16_t gain_multiplier, uint16_t gain_divisor)
Parameter:
  • voltage_current – Typ: VoltageCurrent *
  • gain_multiplier – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • gain_divisor – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int

Da der Shunt-Widerstand über den die Stromstärke gemessen wird keine perfekte Genauigkeit hat, 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 aber 1023mA zurück gibt, sollte der Multiplikator auf 1000 und der Divisor auf 1023 gesetzt werden.

int voltage_current_get_calibration(VoltageCurrent *voltage_current, uint16_t *ret_gain_multiplier, uint16_t *ret_gain_divisor)
Parameter:
  • voltage_current – Typ: VoltageCurrent *
Ausgabeparameter:
  • ret_gain_multiplier – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • ret_gain_divisor – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int

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

int voltage_current_get_identity(VoltageCurrent *voltage_current, 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 – Typ: VoltageCurrent *
Ausgabeparameter:
  • ret_uid – Typ: char[8]
  • ret_connected_uid – Typ: char[8]
  • ret_position – Typ: char, Wertebereich: ['a' bis 'h', 'i', 'z']
  • ret_hardware_version – Typ: uint8_t[3]
    • 0: major – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255]
  • ret_firmware_version – Typ: uint8_t[3]
    • 0: major – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8_t, 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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks

void voltage_current_register_callback(VoltageCurrent *voltage_current, int16_t callback_id, void (*function)(void), void *user_data)
Parameter:
  • voltage_current – Typ: VoltageCurrent *
  • 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_set_current_callback_period(VoltageCurrent *voltage_current, uint32_t period)
Parameter:
  • voltage_current – Typ: VoltageCurrent *
  • period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

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

Der VOLTAGE_CURRENT_CALLBACK_CURRENT Callback wird nur ausgelöst, wenn sich die Stromstärke seit der letzten Auslösung geändert hat.

int voltage_current_get_current_callback_period(VoltageCurrent *voltage_current, uint32_t *ret_period)
Parameter:
  • voltage_current – Typ: VoltageCurrent *
Ausgabeparameter:
  • ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

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

int voltage_current_set_voltage_callback_period(VoltageCurrent *voltage_current, uint32_t period)
Parameter:
  • voltage_current – Typ: VoltageCurrent *
  • period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

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

Der VOLTAGE_CURRENT_CALLBACK_VOLTAGE Callback wird nur ausgelöst, wenn sich die Spannung seit der letzten Auslösung geändert hat.

int voltage_current_get_voltage_callback_period(VoltageCurrent *voltage_current, uint32_t *ret_period)
Parameter:
  • voltage_current – Typ: VoltageCurrent *
Ausgabeparameter:
  • ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

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

int voltage_current_set_power_callback_period(VoltageCurrent *voltage_current, uint32_t period)
Parameter:
  • voltage_current – Typ: VoltageCurrent *
  • period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

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

Der VOLTAGE_CURRENT_CALLBACK_POWER Callback wird nur ausgelöst, wenn sich die Leistung seit der letzten Auslösung geändert hat.

int voltage_current_get_power_callback_period(VoltageCurrent *voltage_current, uint32_t *ret_period)
Parameter:
  • voltage_current – Typ: VoltageCurrent *
Ausgabeparameter:
  • ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

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

int voltage_current_set_current_callback_threshold(VoltageCurrent *voltage_current, char option, int32_t min, int32_t max)
Parameter:
  • voltage_current – Typ: VoltageCurrent *
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int32_t, Einheit: 1 mA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int32_t, Einheit: 1 mA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Setzt den Schwellwert für den VOLTAGE_CURRENT_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:

  • VOLTAGE_CURRENT_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_GREATER = '>'
int voltage_current_get_current_callback_threshold(VoltageCurrent *voltage_current, char *ret_option, int32_t *ret_min, int32_t *ret_max)
Parameter:
  • voltage_current – Typ: VoltageCurrent *
Ausgabeparameter:
  • ret_option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • ret_min – Typ: int32_t, Einheit: 1 mA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • ret_max – Typ: int32_t, Einheit: 1 mA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

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

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

Für ret_option:

  • VOLTAGE_CURRENT_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_GREATER = '>'
int voltage_current_set_voltage_callback_threshold(VoltageCurrent *voltage_current, char option, int32_t min, int32_t max)
Parameter:
  • voltage_current – Typ: VoltageCurrent *
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int32_t, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int32_t, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Setzt den Schwellwert für den VOLTAGE_CURRENT_CALLBACK_VOLTAGE_REACHED Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

  • VOLTAGE_CURRENT_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_GREATER = '>'
int voltage_current_get_voltage_callback_threshold(VoltageCurrent *voltage_current, char *ret_option, int32_t *ret_min, int32_t *ret_max)
Parameter:
  • voltage_current – Typ: VoltageCurrent *
Ausgabeparameter:
  • ret_option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • ret_min – Typ: int32_t, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • ret_max – Typ: int32_t, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

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

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

Für ret_option:

  • VOLTAGE_CURRENT_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_GREATER = '>'
int voltage_current_set_power_callback_threshold(VoltageCurrent *voltage_current, char option, int32_t min, int32_t max)
Parameter:
  • voltage_current – Typ: VoltageCurrent *
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int32_t, Einheit: 1 mW, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int32_t, Einheit: 1 mW, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Setzt den Schwellwert für den VOLTAGE_CURRENT_CALLBACK_POWER_REACHED Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

  • VOLTAGE_CURRENT_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_GREATER = '>'
int voltage_current_get_power_callback_threshold(VoltageCurrent *voltage_current, char *ret_option, int32_t *ret_min, int32_t *ret_max)
Parameter:
  • voltage_current – Typ: VoltageCurrent *
Ausgabeparameter:
  • ret_option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • ret_min – Typ: int32_t, Einheit: 1 mW, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • ret_max – Typ: int32_t, Einheit: 1 mW, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

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

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

Für ret_option:

  • VOLTAGE_CURRENT_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_GREATER = '>'
int voltage_current_set_debounce_period(VoltageCurrent *voltage_current, uint32_t debounce)
Parameter:
  • voltage_current – Typ: VoltageCurrent *
  • debounce – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Rückgabe:
  • error_code – Typ: int

Setzt die Periode mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

int voltage_current_get_debounce_period(VoltageCurrent *voltage_current, uint32_t *ret_debounce)
Parameter:
  • voltage_current – Typ: VoltageCurrent *
Ausgabeparameter:
  • ret_debounce – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Rückgabe:
  • error_code – Typ: int

Gibt die Entprellperiode zurück, wie von voltage_current_set_debounce_period() gesetzt.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der voltage_current_register_callback() Funktion durchgeführt werden:

void my_callback(int value, void *user_data) {
    printf("Value: %d\n", value);
}

voltage_current_register_callback(&voltage_current,
                                  VOLTAGE_CURRENT_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_CALLBACK_CURRENT
void callback(int32_t current, void *user_data)
Callback-Parameter:
  • current – Typ: int32_t, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]
  • user_data – Typ: void *

Dieser Callback wird mit der Periode, wie gesetzt mit voltage_current_set_current_callback_period(), ausgelöst. Der Parameter ist die Stromstärke des Sensors.

Der VOLTAGE_CURRENT_CALLBACK_CURRENT Callback wird nur ausgelöst, wenn sich die Stromstärke seit der letzten Auslösung geändert hat.

VOLTAGE_CURRENT_CALLBACK_VOLTAGE
void callback(int32_t voltage, void *user_data)
Callback-Parameter:
  • voltage – Typ: int32_t, Einheit: 1 mV, Wertebereich: [0 bis 36000]
  • user_data – Typ: void *

Dieser Callback wird mit der Periode, wie gesetzt mit voltage_current_set_voltage_callback_period(), ausgelöst. Der Parameter ist die Spannung des Sensors.

Der VOLTAGE_CURRENT_CALLBACK_VOLTAGE Callback wird nur ausgelöst, wenn sich die Spannung seit der letzten Auslösung geändert hat.

VOLTAGE_CURRENT_CALLBACK_POWER
void callback(int32_t power, void *user_data)
Callback-Parameter:
  • power – Typ: int32_t, Einheit: 1 mW, Wertebereich: [0 bis 720000]
  • user_data – Typ: void *

Dieser Callback wird mit der Periode, wie gesetzt mit voltage_current_set_power_callback_period(), ausgelöst. Der Parameter ist die Leistung des Sensors.

Der VOLTAGE_CURRENT_CALLBACK_POWER Callback wird nur ausgelöst, wenn sich die Leistung seit der letzten Auslösung geändert hat.

VOLTAGE_CURRENT_CALLBACK_CURRENT_REACHED
void callback(int32_t current, void *user_data)
Callback-Parameter:
  • current – Typ: int32_t, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]
  • user_data – Typ: void *

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von voltage_current_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 voltage_current_set_debounce_period() gesetzt, ausgelöst.

VOLTAGE_CURRENT_CALLBACK_VOLTAGE_REACHED
void callback(int32_t voltage, void *user_data)
Callback-Parameter:
  • voltage – Typ: int32_t, Einheit: 1 mV, Wertebereich: [0 bis 36000]
  • user_data – Typ: void *

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von voltage_current_set_voltage_callback_threshold() gesetzt, erreicht wird. Der Parameter ist die Spannung des Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit voltage_current_set_debounce_period() gesetzt, ausgelöst.

VOLTAGE_CURRENT_CALLBACK_POWER_REACHED
void callback(int32_t power, void *user_data)
Callback-Parameter:
  • power – Typ: int32_t, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]
  • user_data – Typ: void *

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von voltage_current_set_power_callback_threshold() gesetzt, erreicht wird. Der Parameter ist die Spannung des Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit voltage_current_set_debounce_period() gesetzt, ausgelöst.

Virtuelle Funktionen

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

int voltage_current_get_api_version(VoltageCurrent *voltage_current, uint8_t ret_api_version[3])
Parameter:
  • voltage_current – Typ: VoltageCurrent *
Ausgabeparameter:
  • ret_api_version – Typ: uint8_t[3]
    • 0: major – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:
  • error_code – Typ: int

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.

int voltage_current_get_response_expected(VoltageCurrent *voltage_current, uint8_t function_id, bool *ret_response_expected)
Parameter:
  • voltage_current – Typ: VoltageCurrent *
  • 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_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_FUNCTION_SET_CONFIGURATION = 4
  • VOLTAGE_CURRENT_FUNCTION_SET_CALIBRATION = 6
  • VOLTAGE_CURRENT_FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 8
  • VOLTAGE_CURRENT_FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 10
  • VOLTAGE_CURRENT_FUNCTION_SET_POWER_CALLBACK_PERIOD = 12
  • VOLTAGE_CURRENT_FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 14
  • VOLTAGE_CURRENT_FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 16
  • VOLTAGE_CURRENT_FUNCTION_SET_POWER_CALLBACK_THRESHOLD = 18
  • VOLTAGE_CURRENT_FUNCTION_SET_DEBOUNCE_PERIOD = 20
int voltage_current_set_response_expected(VoltageCurrent *voltage_current, uint8_t function_id, bool response_expected)
Parameter:
  • voltage_current – Typ: VoltageCurrent *
  • 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_FUNCTION_SET_CONFIGURATION = 4
  • VOLTAGE_CURRENT_FUNCTION_SET_CALIBRATION = 6
  • VOLTAGE_CURRENT_FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 8
  • VOLTAGE_CURRENT_FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 10
  • VOLTAGE_CURRENT_FUNCTION_SET_POWER_CALLBACK_PERIOD = 12
  • VOLTAGE_CURRENT_FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 14
  • VOLTAGE_CURRENT_FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 16
  • VOLTAGE_CURRENT_FUNCTION_SET_POWER_CALLBACK_THRESHOLD = 18
  • VOLTAGE_CURRENT_FUNCTION_SET_DEBOUNCE_PERIOD = 20
int voltage_current_set_response_expected_all(VoltageCurrent *voltage_current, bool response_expected)
Parameter:
  • voltage_current – Typ: VoltageCurrent *
  • 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.

Konstanten

VOLTAGE_CURRENT_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Voltage/Current Bricklet zu identifizieren.

Die voltage_current_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_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Voltage/Current Bricklet dar.