Dies ist die Beschreibung der C/C++ API Bindings für das Industrial Dual Analog In Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Industrial Dual Analog In Bricklet sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die C/C++ API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
1#include <stdio.h>
2
3#include "ip_connection.h"
4#include "bricklet_industrial_dual_analog_in.h"
5
6#define HOST "localhost"
7#define PORT 4223
8#define UID "XYZ" // Change XYZ to the UID of your Industrial Dual Analog In Bricklet
9
10int main(void) {
11 // Create IP connection
12 IPConnection ipcon;
13 ipcon_create(&ipcon);
14
15 // Create device object
16 IndustrialDualAnalogIn idai;
17 industrial_dual_analog_in_create(&idai, UID, &ipcon);
18
19 // Connect to brickd
20 if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
21 fprintf(stderr, "Could not connect\n");
22 return 1;
23 }
24 // Don't use device before ipcon is connected
25
26 // Get current voltage from channel 1
27 int32_t voltage;
28 if(industrial_dual_analog_in_get_voltage(&idai, 1, &voltage) < 0) {
29 fprintf(stderr, "Could not get voltage from channel 1, probably timeout\n");
30 return 1;
31 }
32
33 printf("Voltage (Channel 1): %f V\n", voltage/1000.0);
34
35 printf("Press key to exit\n");
36 getchar();
37 industrial_dual_analog_in_destroy(&idai);
38 ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
39 return 0;
40}
1#include <stdio.h>
2
3#include "ip_connection.h"
4#include "bricklet_industrial_dual_analog_in.h"
5
6#define HOST "localhost"
7#define PORT 4223
8#define UID "XYZ" // Change XYZ to the UID of your Industrial Dual Analog In Bricklet
9
10// Callback function for voltage callback
11void cb_voltage(uint8_t channel, int32_t voltage, void *user_data) {
12 (void)user_data; // avoid unused parameter warning
13
14 printf("Channel: %u\n", channel);
15 printf("Voltage: %f V\n", voltage/1000.0);
16 printf("\n");
17}
18
19int main(void) {
20 // Create IP connection
21 IPConnection ipcon;
22 ipcon_create(&ipcon);
23
24 // Create device object
25 IndustrialDualAnalogIn idai;
26 industrial_dual_analog_in_create(&idai, UID, &ipcon);
27
28 // Connect to brickd
29 if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
30 fprintf(stderr, "Could not connect\n");
31 return 1;
32 }
33 // Don't use device before ipcon is connected
34
35 // Register voltage callback to function cb_voltage
36 industrial_dual_analog_in_register_callback(&idai,
37 INDUSTRIAL_DUAL_ANALOG_IN_CALLBACK_VOLTAGE,
38 (void (*)(void))cb_voltage,
39 NULL);
40
41 // Set period for voltage (channel 1) callback to 1s (1000ms)
42 // Note: The voltage (channel 1) callback is only called every second
43 // if the voltage (channel 1) has changed since the last call!
44 industrial_dual_analog_in_set_voltage_callback_period(&idai, 1, 1000);
45
46 printf("Press key to exit\n");
47 getchar();
48 industrial_dual_analog_in_destroy(&idai);
49 ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
50 return 0;
51}
Download (example_threshold.c)
1#include <stdio.h>
2
3#include "ip_connection.h"
4#include "bricklet_industrial_dual_analog_in.h"
5
6#define HOST "localhost"
7#define PORT 4223
8#define UID "XYZ" // Change XYZ to the UID of your Industrial Dual Analog In Bricklet
9
10// Callback function for voltage reached callback
11void cb_voltage_reached(uint8_t channel, int32_t voltage, void *user_data) {
12 (void)user_data; // avoid unused parameter warning
13
14 printf("Channel: %u\n", channel);
15 printf("Voltage: %f V\n", voltage/1000.0);
16 printf("\n");
17}
18
19int main(void) {
20 // Create IP connection
21 IPConnection ipcon;
22 ipcon_create(&ipcon);
23
24 // Create device object
25 IndustrialDualAnalogIn idai;
26 industrial_dual_analog_in_create(&idai, UID, &ipcon);
27
28 // Connect to brickd
29 if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
30 fprintf(stderr, "Could not connect\n");
31 return 1;
32 }
33 // Don't use device before ipcon is connected
34
35 // Get threshold callbacks with a debounce time of 10 seconds (10000ms)
36 industrial_dual_analog_in_set_debounce_period(&idai, 10000);
37
38 // Register voltage reached callback to function cb_voltage_reached
39 industrial_dual_analog_in_register_callback(&idai,
40 INDUSTRIAL_DUAL_ANALOG_IN_CALLBACK_VOLTAGE_REACHED,
41 (void (*)(void))cb_voltage_reached,
42 NULL);
43
44 // Configure threshold for voltage (channel 1) "greater than 10 V"
45 industrial_dual_analog_in_set_voltage_callback_threshold(&idai, 1, '>', 10*1000, 0);
46
47 printf("Press key to exit\n");
48 getchar();
49 industrial_dual_analog_in_destroy(&idai);
50 ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
51 return 0;
52}
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:
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 (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.
| Parameter: |
|
|---|
Erzeugt ein Geräteobjekt industrial_dual_analog_in mit der eindeutigen Geräte ID uid und
fügt es der IP Connection ipcon hinzu:
IndustrialDualAnalogIn industrial_dual_analog_in;
industrial_dual_analog_in_create(&industrial_dual_analog_in, "YOUR_DEVICE_UID", &ipcon);
Dieses Geräteobjekt kann benutzt werden, nachdem die IP Connection verbunden.
| Parameter: |
|
|---|
Entfernt das Geräteobjekt industrial_dual_analog_in von dessen IP Connection und zerstört es.
Das Geräteobjekt kann hiernach nicht mehr verwendet werden.
| Parameter: |
|
|---|---|
| Ausgabeparameter: |
|
| Rückgabe: |
|
Gibt die Spannung für den übergebenen Kanal zurück.
Wenn die Spannung periodisch abgefragt werden soll, wird empfohlen
den INDUSTRIAL_DUAL_ANALOG_IN_CALLBACK_VOLTAGE Callback zu nutzen und die Periode mit
industrial_dual_analog_in_set_voltage_callback_period() vorzugeben.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Setzt die Abtastrate. Der Wertebereich der verfügbare Abtastraten liegt zwischen 1 Wert pro Sekunde und 976 Werte pro Sekunde. Ein Verringern der Abtastrate wird auch das Rauschen auf den Daten verringern.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für rate:
INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_976_SPS = 0
INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_488_SPS = 1
INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_244_SPS = 2
INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_122_SPS = 3
INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_61_SPS = 4
INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_4_SPS = 5
INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_2_SPS = 6
INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_1_SPS = 7
| Parameter: |
|
|---|---|
| Ausgabeparameter: |
|
| Rückgabe: |
|
Gibt die Abtastrate zurück, wie von industrial_dual_analog_in_set_sample_rate() gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für ret_rate:
INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_976_SPS = 0
INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_488_SPS = 1
INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_244_SPS = 2
INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_122_SPS = 3
INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_61_SPS = 4
INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_4_SPS = 5
INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_2_SPS = 6
INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_1_SPS = 7
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Setzt Offset und Gain der MCP3911 internen Kalibrierungsregister.
Siehe MCP3911 Datenblatt 7.7 und 7.8. Das Industrial Dual Analog In Bricklet wird von Tinkerforge werkskalibriert. Ein Aufruf dieser Funktion sollte nicht notwendig sein.
| Parameter: |
|
|---|---|
| Ausgabeparameter: |
|
| Rückgabe: |
|
Gibt die Kalibrierung zurück, wie von industrial_dual_analog_in_set_calibration() gesetzt.
| Parameter: |
|
|---|---|
| Ausgabeparameter: |
|
| Rückgabe: |
|
Gibt die ADC-Werte des MCP3911 ICs zurück. Diese Funktion
wird für die Kalibrierung benötigt, siehe industrial_dual_analog_in_set_calibration().
| 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.
| 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.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Setzt die Periode mit welcher der INDUSTRIAL_DUAL_ANALOG_IN_CALLBACK_VOLTAGE Callback für den
übergebenen Kanal ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
Der INDUSTRIAL_DUAL_ANALOG_IN_CALLBACK_VOLTAGE Callback wird nur ausgelöst, wenn sich die Spannung seit der
letzten Auslösung geändert hat.
| Parameter: |
|
|---|---|
| Ausgabeparameter: |
|
| Rückgabe: |
|
Gibt die Periode zurück, wie von industrial_dual_analog_in_set_voltage_callback_period() gesetzt.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Setzt den Schwellwert des INDUSTRIAL_DUAL_ANALOG_IN_CALLBACK_VOLTAGE_REACHED Callbacks für den übergebenen
Kanal.
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:
INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_OFF = 'x'
INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_OUTSIDE = 'o'
INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_INSIDE = 'i'
INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_SMALLER = '<'
INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_GREATER = '>'
| Parameter: |
|
|---|---|
| Ausgabeparameter: |
|
| Rückgabe: |
|
Gibt den Schwellwert zurück, wie von industrial_dual_analog_in_set_voltage_callback_threshold() gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für ret_option:
INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_OFF = 'x'
INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_OUTSIDE = 'o'
INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_INSIDE = 'i'
INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_SMALLER = '<'
INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_GREATER = '>'
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Setzt die Periode mit welcher der Schwellwert Callback
ausgelöst werden, wenn der Schwellwert
weiterhin erreicht bleibt.
| Parameter: |
|
|---|---|
| Ausgabeparameter: |
|
| Rückgabe: |
|
Gibt die Entprellperiode zurück, wie von industrial_dual_analog_in_set_debounce_period() gesetzt.
Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten
vom Gerät zu erhalten. Die Registrierung kann mit der industrial_dual_analog_in_register_callback()
Funktion durchgeführt werden:
void my_callback(int value, void *user_data) { printf("Value: %d\n", value); } industrial_dual_analog_in_register_callback(&industrial_dual_analog_in, INDUSTRIAL_DUAL_ANALOG_IN_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.
void callback(uint8_t channel, int32_t voltage, void *user_data)
| Callback-Parameter: |
|
|---|
Dieser Callback wird mit der Periode, wie gesetzt mit industrial_dual_analog_in_set_voltage_callback_period(),
ausgelöst. Der Parameter ist die Spannung des Kanals.
Der INDUSTRIAL_DUAL_ANALOG_IN_CALLBACK_VOLTAGE Callback wird nur ausgelöst, wenn sich die Spannung seit der
letzten Auslösung geändert hat.
void callback(uint8_t channel, int32_t voltage, void *user_data)
| Callback-Parameter: |
|
|---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
industrial_dual_analog_in_set_voltage_callback_threshold() gesetzt, erreicht wird.
Der Parameter ist die Spannung des Kanals.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit industrial_dual_analog_in_set_debounce_period() gesetzt, ausgelöst.
Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.
| 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.
| 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 industrial_dual_analog_in_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:
INDUSTRIAL_DUAL_ANALOG_IN_FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 2
INDUSTRIAL_DUAL_ANALOG_IN_FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 4
INDUSTRIAL_DUAL_ANALOG_IN_FUNCTION_SET_DEBOUNCE_PERIOD = 6
INDUSTRIAL_DUAL_ANALOG_IN_FUNCTION_SET_SAMPLE_RATE = 8
INDUSTRIAL_DUAL_ANALOG_IN_FUNCTION_SET_CALIBRATION = 10
| 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:
INDUSTRIAL_DUAL_ANALOG_IN_FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 2
INDUSTRIAL_DUAL_ANALOG_IN_FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 4
INDUSTRIAL_DUAL_ANALOG_IN_FUNCTION_SET_DEBOUNCE_PERIOD = 6
INDUSTRIAL_DUAL_ANALOG_IN_FUNCTION_SET_SAMPLE_RATE = 8
INDUSTRIAL_DUAL_ANALOG_IN_FUNCTION_SET_CALIBRATION = 10
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
Diese Konstante wird verwendet um ein Industrial Dual Analog In Bricklet zu identifizieren.
Die industrial_dual_analog_in_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.
Diese Konstante stellt den Anzeigenamen eines Industrial Dual Analog In Bricklet dar.