C/C++ - Industrial Dual 0-20mA Bricklet

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.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.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
#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, &current) < 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;
}

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

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

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.

Es können zwei Sensoren an das Bricklet angeschlossen werden. Funktionen die sich direkt auf einen der Sensoren beziehen haben einen sensor Parameter, um den Sensor anzugeben. Gültige Werte für den sensor Parameter sind 0 und 1.

Grundfunktionen

void industrial_dual_0_20ma_create(IndustrialDual020mA *industrial_dual_0_20ma, const char *uid, IPConnection *ipcon)
Parameter:
  • industrial_dual_0_20ma – Typ: IndustrialDual020mA *
  • uid – Typ: const char *
  • ipcon – Typ: IPConnection *

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

void industrial_dual_0_20ma_destroy(IndustrialDual020mA *industrial_dual_0_20ma)
Parameter:
  • industrial_dual_0_20ma – Typ: IndustrialDual020mA *

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.

int industrial_dual_0_20ma_get_current(IndustrialDual020mA *industrial_dual_0_20ma, uint8_t sensor, int32_t *ret_current)
Parameter:
  • industrial_dual_0_20ma – Typ: IndustrialDual020mA *
  • sensor – Typ: uint8_t, Wertebereich: [0 bis 255]
Ausgabeparameter:
  • ret_current – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
Rückgabe:
  • error_code – Typ: int

Gibt die gemessenen Stromstärke des angegebenen Sensors (0 oder 1) zurück. Der Wert ist in nA und im Bereich von 0nA bis 22505322nA (22,5mA).

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.

Fortgeschrittene Funktionen

int industrial_dual_0_20ma_set_sample_rate(IndustrialDual020mA *industrial_dual_0_20ma, uint8_t rate)
Parameter:
  • industrial_dual_0_20ma – Typ: IndustrialDual020mA *
  • rate – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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

Der Standardwert ist 3 (4 Samples pro Sekunde mit 18 Bit Auflösung).

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

Für rate:

  • INDUSTRIAL_DUAL_0_20MA_SAMPLE_RATE_240_SPS = 0
  • INDUSTRIAL_DUAL_0_20MA_SAMPLE_RATE_60_SPS = 1
  • INDUSTRIAL_DUAL_0_20MA_SAMPLE_RATE_15_SPS = 2
  • INDUSTRIAL_DUAL_0_20MA_SAMPLE_RATE_4_SPS = 3
int industrial_dual_0_20ma_get_sample_rate(IndustrialDual020mA *industrial_dual_0_20ma, uint8_t *ret_rate)
Parameter:
  • industrial_dual_0_20ma – Typ: IndustrialDual020mA *
Ausgabeparameter:
  • ret_rate – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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_SAMPLE_RATE_240_SPS = 0
  • INDUSTRIAL_DUAL_0_20MA_SAMPLE_RATE_60_SPS = 1
  • INDUSTRIAL_DUAL_0_20MA_SAMPLE_RATE_15_SPS = 2
  • INDUSTRIAL_DUAL_0_20MA_SAMPLE_RATE_4_SPS = 3
int industrial_dual_0_20ma_get_api_version(IndustrialDual020mA *industrial_dual_0_20ma, uint8_t ret_api_version[3])
Parameter:
  • industrial_dual_0_20ma – Typ: IndustrialDual020mA *
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 industrial_dual_0_20ma_get_response_expected(IndustrialDual020mA *industrial_dual_0_20ma, uint8_t function_id, bool *ret_response_expected)
Parameter:
  • industrial_dual_0_20ma – Typ: IndustrialDual020mA *
  • 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 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_FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 2
  • INDUSTRIAL_DUAL_0_20MA_FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 4
  • INDUSTRIAL_DUAL_0_20MA_FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • INDUSTRIAL_DUAL_0_20MA_FUNCTION_SET_SAMPLE_RATE = 8
int industrial_dual_0_20ma_set_response_expected(IndustrialDual020mA *industrial_dual_0_20ma, uint8_t function_id, bool response_expected)
Parameter:
  • industrial_dual_0_20ma – Typ: IndustrialDual020mA *
  • 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:

  • INDUSTRIAL_DUAL_0_20MA_FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 2
  • INDUSTRIAL_DUAL_0_20MA_FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 4
  • INDUSTRIAL_DUAL_0_20MA_FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • INDUSTRIAL_DUAL_0_20MA_FUNCTION_SET_SAMPLE_RATE = 8
int industrial_dual_0_20ma_set_response_expected_all(IndustrialDual020mA *industrial_dual_0_20ma, bool response_expected)
Parameter:
  • industrial_dual_0_20ma – Typ: IndustrialDual020mA *
  • 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 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:
  • industrial_dual_0_20ma – Typ: IndustrialDual020mA *
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 industrial_dual_0_20ma_register_callback(IndustrialDual020mA *industrial_dual_0_20ma, int16_t callback_id, void (*function)(void), void *user_data)
Parameter:
  • industrial_dual_0_20ma – Typ: IndustrialDual020mA *
  • 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 industrial_dual_0_20ma_set_current_callback_period(IndustrialDual020mA *industrial_dual_0_20ma, uint8_t sensor, uint32_t period)
Parameter:
  • industrial_dual_0_20ma – Typ: IndustrialDual020mA *
  • sensor – Typ: uint8_t, Wertebereich: [0 bis 255]
  • 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 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.

int industrial_dual_0_20ma_get_current_callback_period(IndustrialDual020mA *industrial_dual_0_20ma, uint8_t sensor, uint32_t *ret_period)
Parameter:
  • industrial_dual_0_20ma – Typ: IndustrialDual020mA *
  • sensor – Typ: uint8_t, Wertebereich: [0 bis 255]
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 industrial_dual_0_20ma_set_current_callback_period() gesetzt.

int 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:
  • industrial_dual_0_20ma – Typ: IndustrialDual020mA *
  • sensor – Typ: uint8_t, Wertebereich: [0 bis 255]
  • 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

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)

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

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

Für option:

  • INDUSTRIAL_DUAL_0_20MA_THRESHOLD_OPTION_OFF = 'x'
  • INDUSTRIAL_DUAL_0_20MA_THRESHOLD_OPTION_OUTSIDE = 'o'
  • INDUSTRIAL_DUAL_0_20MA_THRESHOLD_OPTION_INSIDE = 'i'
  • INDUSTRIAL_DUAL_0_20MA_THRESHOLD_OPTION_SMALLER = '<'
  • INDUSTRIAL_DUAL_0_20MA_THRESHOLD_OPTION_GREATER = '>'
int 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:
  • industrial_dual_0_20ma – Typ: IndustrialDual020mA *
  • sensor – Typ: uint8_t, Wertebereich: [0 bis 255]
Ausgabeparameter:
  • 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 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_THRESHOLD_OPTION_OFF = 'x'
  • INDUSTRIAL_DUAL_0_20MA_THRESHOLD_OPTION_OUTSIDE = 'o'
  • INDUSTRIAL_DUAL_0_20MA_THRESHOLD_OPTION_INSIDE = 'i'
  • INDUSTRIAL_DUAL_0_20MA_THRESHOLD_OPTION_SMALLER = '<'
  • INDUSTRIAL_DUAL_0_20MA_THRESHOLD_OPTION_GREATER = '>'
int industrial_dual_0_20ma_set_debounce_period(IndustrialDual020mA *industrial_dual_0_20ma, uint32_t debounce)
Parameter:
  • industrial_dual_0_20ma – Typ: IndustrialDual020mA *
  • 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 der Schwellwert Callback

ausgelöst werden, wenn der Schwellwert

weiterhin erreicht bleibt.

int industrial_dual_0_20ma_get_debounce_period(IndustrialDual020mA *industrial_dual_0_20ma, uint32_t *ret_debounce)
Parameter:
  • industrial_dual_0_20ma – Typ: IndustrialDual020mA *
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 industrial_dual_0_20ma_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 industrial_dual_0_20ma_register_callback() Funktion durchgeführt werden:

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

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

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

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.

Konstanten

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.