Dies ist die Beschreibung der C/C++ API Bindings für das Industrial Dual 0-20mA Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Industrial Dual 0-20mA Bricklet sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die C/C++ API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 | #include <stdio.h>
#include "ip_connection.h"
#include "bricklet_industrial_dual_0_20ma.h"
#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet
int main(void) {
// Create IP connection
IPConnection ipcon;
ipcon_create(&ipcon);
// Create device object
IndustrialDual020mA id020;
industrial_dual_0_20ma_create(&id020, UID, &ipcon);
// Connect to brickd
if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
fprintf(stderr, "Could not connect\n");
return 1;
}
// Don't use device before ipcon is connected
// Get current current from sensor 1
int32_t current;
if(industrial_dual_0_20ma_get_current(&id020, 1, ¤t) < 0) {
fprintf(stderr, "Could not get current from sensor 1, probably timeout\n");
return 1;
}
printf("Current (Sensor 1): %f mA\n", current/1000000.0);
printf("Press key to exit\n");
getchar();
industrial_dual_0_20ma_destroy(&id020);
ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
return 0;
}
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 | #include <stdio.h>
#include "ip_connection.h"
#include "bricklet_industrial_dual_0_20ma.h"
#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet
// Callback function for current callback
void cb_current(uint8_t sensor, int32_t current, void *user_data) {
(void)user_data; // avoid unused parameter warning
printf("Sensor: %u\n", sensor);
printf("Current: %f mA\n", current/1000000.0);
printf("\n");
}
int main(void) {
// Create IP connection
IPConnection ipcon;
ipcon_create(&ipcon);
// Create device object
IndustrialDual020mA id020;
industrial_dual_0_20ma_create(&id020, 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
industrial_dual_0_20ma_register_callback(&id020,
INDUSTRIAL_DUAL_0_20MA_CALLBACK_CURRENT,
(void (*)(void))cb_current,
NULL);
// Set period for current (sensor 1) callback to 1s (1000ms)
// Note: The current (sensor 1) callback is only called every second
// if the current (sensor 1) has changed since the last call!
industrial_dual_0_20ma_set_current_callback_period(&id020, 1, 1000);
printf("Press key to exit\n");
getchar();
industrial_dual_0_20ma_destroy(&id020);
ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
return 0;
}
|
Download (example_threshold.c)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 | #include <stdio.h>
#include "ip_connection.h"
#include "bricklet_industrial_dual_0_20ma.h"
#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet
// Callback function for current reached callback
void cb_current_reached(uint8_t sensor, int32_t current, void *user_data) {
(void)user_data; // avoid unused parameter warning
printf("Sensor: %u\n", sensor);
printf("Current: %f mA\n", current/1000000.0);
printf("\n");
}
int main(void) {
// Create IP connection
IPConnection ipcon;
ipcon_create(&ipcon);
// Create device object
IndustrialDual020mA id020;
industrial_dual_0_20ma_create(&id020, 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)
industrial_dual_0_20ma_set_debounce_period(&id020, 10000);
// Register current reached callback to function cb_current_reached
industrial_dual_0_20ma_register_callback(&id020,
INDUSTRIAL_DUAL_0_20MA_CALLBACK_CURRENT_REACHED,
(void (*)(void))cb_current_reached,
NULL);
// Configure threshold for current (sensor 1) "greater than 10 mA"
industrial_dual_0_20ma_set_current_callback_threshold(&id020, 1, '>', 10*1000000, 0);
printf("Press key to exit\n");
getchar();
industrial_dual_0_20ma_destroy(&id020);
ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
return 0;
}
|
Die meistens Funktionen der C/C++ Bindings geben einen Fehlercode (e_code
)
zurück. Vom Gerät zurückgegebene Daten werden, wenn eine
Abfrage aufgerufen wurde, über Ausgabeparameter gehandhabt. Diese Parameter
sind mit dem ret_
Präfix gekennzeichnet.
Mögliche Fehlercodes sind:
wie in ip_connection.h
definiert.
Alle folgend aufgelisteten Funktionen sind Thread-sicher.
industrial_dual_0_20ma_create
(IndustrialDual020mA *industrial_dual_0_20ma, const char *uid, IPConnection *ipcon)¶Parameter: |
|
---|
Erzeugt ein Geräteobjekt industrial_dual_0_20ma
mit der eindeutigen Geräte ID uid
und
fügt es der IP Connection ipcon
hinzu:
IndustrialDual020mA industrial_dual_0_20ma;
industrial_dual_0_20ma_create(&industrial_dual_0_20ma, "YOUR_DEVICE_UID", &ipcon);
Dieses Geräteobjekt kann benutzt werden, nachdem die IP Connection verbunden.
industrial_dual_0_20ma_destroy
(IndustrialDual020mA *industrial_dual_0_20ma)¶Parameter: |
|
---|
Entfernt das Geräteobjekt industrial_dual_0_20ma
von dessen IP Connection und zerstört es.
Das Geräteobjekt kann hiernach nicht mehr verwendet werden.
industrial_dual_0_20ma_get_current
(IndustrialDual020mA *industrial_dual_0_20ma, uint8_t sensor, int32_t *ret_current)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die gemessenen Stromstärke des angegebenen Sensors zurück.
Es ist möglich zu erkennen ob ein IEC 60381-1-kompatibler Sensor angeschlossen ist und ob er funktionsfähig ist.
Falls die zurückgegebene Stromstärke kleiner als 4mA ist, ist wahrscheinlich kein Sensor angeschlossen oder der Sensor ist defekt. Falls die zurückgegebene Stromstärke über 20mA ist, besteht entweder ein Kurzschluss oder der Sensor ist defekt. Somit ist erkennbar ob ein Sensor angeschlossen und funktionsfähig ist.
Wenn die Stromstärke periodisch abgefragt werden soll, wird empfohlen
den INDUSTRIAL_DUAL_0_20MA_CALLBACK_CURRENT
Callback zu nutzen und die Periode mit
industrial_dual_0_20ma_set_current_callback_period()
vorzugeben.
industrial_dual_0_20ma_set_sample_rate
(IndustrialDual020mA *industrial_dual_0_20ma, uint8_t rate)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Abtastrate auf 240, 60, 15 oder 4 Samples pro Sekunde. Die Auflösung für die Raten sind 12, 14, 16 und 18 Bit respektive.
Wert | Beschreibung |
---|---|
0 | 240 Samples pro Sekunde, 12 Bit Auflösung |
1 | 60 Samples pro Sekunde, 14 Bit Auflösung |
2 | 15 Samples pro Sekunde, 16 Bit Auflösung |
3 | 4 Samples pro Sekunde, 18 Bit Auflösung |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für rate:
industrial_dual_0_20ma_get_sample_rate
(IndustrialDual020mA *industrial_dual_0_20ma, uint8_t *ret_rate)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Abtastrate zurück, wie von industrial_dual_0_20ma_set_sample_rate()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für ret_rate:
industrial_dual_0_20ma_get_identity
(IndustrialDual020mA *industrial_dual_0_20ma, char ret_uid[8], char ret_connected_uid[8], char *ret_position, uint8_t ret_hardware_version[3], uint8_t ret_firmware_version[3], uint16_t *ret_device_identifier)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.
Die Position ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.
Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.
industrial_dual_0_20ma_register_callback
(IndustrialDual020mA *industrial_dual_0_20ma, int16_t callback_id, void (*function)(void), void *user_data)¶Parameter: |
|
---|
Registriert die function
für die gegebene callback_id
. Die user_data
werden der Funktion als letztes Parameter mit übergeben.
Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.
industrial_dual_0_20ma_set_current_callback_period
(IndustrialDual020mA *industrial_dual_0_20ma, uint8_t sensor, uint32_t period)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode mit welcher der INDUSTRIAL_DUAL_0_20MA_CALLBACK_CURRENT
Callback für den
übergebenen Sensor ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.
Der INDUSTRIAL_DUAL_0_20MA_CALLBACK_CURRENT
Callback wird nur ausgelöst, wenn sich die Stromstärke seit der
letzten Auslösung geändert hat.
industrial_dual_0_20ma_get_current_callback_period
(IndustrialDual020mA *industrial_dual_0_20ma, uint8_t sensor, uint32_t *ret_period)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Periode zurück, wie von industrial_dual_0_20ma_set_current_callback_period()
gesetzt.
industrial_dual_0_20ma_set_current_callback_threshold
(IndustrialDual020mA *industrial_dual_0_20ma, uint8_t sensor, char option, int32_t min, int32_t max)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt den Schwellwert des INDUSTRIAL_DUAL_0_20MA_CALLBACK_CURRENT_REACHED
Callbacks für den übergebenen
Sensor.
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:
industrial_dual_0_20ma_get_current_callback_threshold
(IndustrialDual020mA *industrial_dual_0_20ma, uint8_t sensor, char *ret_option, int32_t *ret_min, int32_t *ret_max)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt den Schwellwert zurück, wie von industrial_dual_0_20ma_set_current_callback_threshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für ret_option:
industrial_dual_0_20ma_set_debounce_period
(IndustrialDual020mA *industrial_dual_0_20ma, uint32_t debounce)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode mit welcher der Schwellwert Callback
ausgelöst werden, wenn der Schwellwert
weiterhin erreicht bleibt.
industrial_dual_0_20ma_get_debounce_period
(IndustrialDual020mA *industrial_dual_0_20ma, uint32_t *ret_debounce)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Entprellperiode zurück, wie von industrial_dual_0_20ma_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_0_20ma_register_callback()
Funktion durchgeführt werden:
void my_callback(int value, void *user_data) { printf("Value: %d\n", value); } industrial_dual_0_20ma_register_callback(&industrial_dual_0_20ma, INDUSTRIAL_DUAL_0_20MA_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.
INDUSTRIAL_DUAL_0_20MA_CALLBACK_CURRENT
¶void callback(uint8_t sensor, int32_t current, void *user_data)
Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit industrial_dual_0_20ma_set_current_callback_period()
,
ausgelöst. Der Parameter ist die Stromstärke des Sensors.
Der INDUSTRIAL_DUAL_0_20MA_CALLBACK_CURRENT
Callback wird nur ausgelöst, wenn sich die Stromstärke seit der
letzten Auslösung geändert hat.
INDUSTRIAL_DUAL_0_20MA_CALLBACK_CURRENT_REACHED
¶void callback(uint8_t sensor, int32_t current, void *user_data)
Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
industrial_dual_0_20ma_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 industrial_dual_0_20ma_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.
industrial_dual_0_20ma_get_api_version
(IndustrialDual020mA *industrial_dual_0_20ma, uint8_t ret_api_version[3])¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.
industrial_dual_0_20ma_get_response_expected
(IndustrialDual020mA *industrial_dual_0_20ma, uint8_t function_id, bool *ret_response_expected)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.
Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt
werden, da diese Funktionen immer eine Antwort senden. Für
Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber
entfernt werden mittels industrial_dual_0_20ma_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_0_20ma_set_response_expected
(IndustrialDual020mA *industrial_dual_0_20ma, uint8_t function_id, bool response_expected)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.
Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für function_id:
industrial_dual_0_20ma_set_response_expected_all
(IndustrialDual020mA *industrial_dual_0_20ma, bool response_expected)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
INDUSTRIAL_DUAL_0_20MA_DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein Industrial Dual 0-20mA Bricklet zu identifizieren.
Die industrial_dual_0_20ma_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.
INDUSTRIAL_DUAL_0_20MA_DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Industrial Dual 0-20mA Bricklet dar.