C/C++ - Industrial Dual 0-20mA Bricklet 2.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_v2.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet 2.0

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

    // Create device object
    IndustrialDual020mAV2 id020;
    industrial_dual_0_20ma_v2_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 channel 0
    int32_t current;
    if(industrial_dual_0_20ma_v2_get_current(&id020, 0, &current) < 0) {
        fprintf(stderr, "Could not get current from channel 0, probably timeout\n");
        return 1;
    }

    printf("Current (Channel 0): %f mA\n", current/1000000.0);

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

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_industrial_dual_0_20ma_v2.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet 2.0

// Callback function for current callback
void cb_current(uint8_t channel, int32_t current, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Channel: %u\n", channel);
    printf("Current: %f mA\n", current/1000000.0);
    printf("\n");
}

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

    // Create device object
    IndustrialDual020mAV2 id020;
    industrial_dual_0_20ma_v2_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_v2_register_callback(&id020,
                                                INDUSTRIAL_DUAL_0_20MA_V2_CALLBACK_CURRENT,
                                                (void (*)(void))cb_current,
                                                NULL);

    // Set period for current (channel 0) callback to 1s (1000ms) without a threshold
    industrial_dual_0_20ma_v2_set_current_callback_configuration(&id020, 0, 1000, false, 'x', 0, 0);

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

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_industrial_dual_0_20ma_v2.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet 2.0

// Callback function for current callback
void cb_current(uint8_t channel, int32_t current, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Channel: %u\n", channel);
    printf("Current: %f mA\n", current/1000000.0);
    printf("\n");
}

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

    // Create device object
    IndustrialDual020mAV2 id020;
    industrial_dual_0_20ma_v2_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_v2_register_callback(&id020,
                                                INDUSTRIAL_DUAL_0_20MA_V2_CALLBACK_CURRENT,
                                                (void (*)(void))cb_current,
                                                NULL);

    // Configure threshold for current (channel 0) "greater than 10 mA"
    // with a debounce period of 10s (10000ms)
    industrial_dual_0_20ma_v2_set_current_callback_configuration(&id020, 0, 10000, false, '>', 10*1000000, 0);

    printf("Press key to exit\n");
    getchar();
    industrial_dual_0_20ma_v2_destroy(&id020);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

Grundfunktionen¶

void industrial_dual_0_20ma_v2_create(IndustrialDual020mAV2 *industrial_dual_0_20ma_v2, const char *uid, IPConnection *ipcon)¶

Parameter:	industrial_dual_0_20ma_v2 – Typ: IndustrialDual020mAV2 * uid – Typ: const char * ipcon – Typ: IPConnection *

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

IndustrialDual020mAV2 industrial_dual_0_20ma_v2;
industrial_dual_0_20ma_v2_create(&industrial_dual_0_20ma_v2, "YOUR_DEVICE_UID", &ipcon);

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

void industrial_dual_0_20ma_v2_destroy(IndustrialDual020mAV2 *industrial_dual_0_20ma_v2)¶

Parameter:	industrial_dual_0_20ma_v2 – Typ: IndustrialDual020mAV2 *

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

int industrial_dual_0_20ma_v2_get_current(IndustrialDual020mAV2 *industrial_dual_0_20ma_v2, uint8_t channel, int32_t *ret_current)¶

Parameter:	industrial_dual_0_20ma_v2 – Typ: IndustrialDual020mAV2 * channel – Typ: uint8_t, Wertebereich: [0 bis 1]
Ausgabeparameter:	ret_current – Typ: int32_t, Einheit: 1 nA, Wertebereich: [0 bis 22505322]
Rückgabe:	e_code – Typ: int

Gibt die gemessenen Stromstärke des spezifizierten Kanals 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 der Wert periodisch benötigt wird, kann auch der INDUSTRIAL_DUAL_0_20MA_V2_CALLBACK_CURRENT Callback verwendet werden. Der Callback wird mit der Funktion industrial_dual_0_20ma_v2_set_current_callback_configuration() konfiguriert.

int industrial_dual_0_20ma_v2_set_channel_led_config(IndustrialDual020mAV2 *industrial_dual_0_20ma_v2, uint8_t channel, uint8_t config)¶

Parameter:	industrial_dual_0_20ma_v2 – Typ: IndustrialDual020mAV2 * channel – Typ: uint8_t, Wertebereich: [0 bis 1] config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

Jeder Kanal hat eine dazugehörige LED. Die LEDs können individuell an- oder ausgeschaltet werden. Zusätzlich kann ein Heartbeat oder der Kanalstatus angezeigt werden. Falls Kanalstatus gewählt wird kann die LED entweder ab einem vordefinierten Schwellwert eingeschaltet werden oder ihre Helligkeit anhand des gemessenen Wertes skaliert werden.

Das Verhalten des Kanalstatus kann mittels industrial_dual_0_20ma_v2_set_channel_led_status_config() eingestellt werden.

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

Für config:

• INDUSTRIAL_DUAL_0_20MA_V2_CHANNEL_LED_CONFIG_OFF = 0
• INDUSTRIAL_DUAL_0_20MA_V2_CHANNEL_LED_CONFIG_ON = 1
• INDUSTRIAL_DUAL_0_20MA_V2_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
• INDUSTRIAL_DUAL_0_20MA_V2_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

int industrial_dual_0_20ma_v2_get_channel_led_config(IndustrialDual020mAV2 *industrial_dual_0_20ma_v2, uint8_t channel, uint8_t *ret_config)¶

Parameter:	industrial_dual_0_20ma_v2 – Typ: IndustrialDual020mAV2 * channel – Typ: uint8_t, Wertebereich: [0 bis 1]
Ausgabeparameter:	ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

Gibt die Kanal-LED-Konfiguration zurück, wie von industrial_dual_0_20ma_v2_set_channel_led_config() gesetzt.

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

Für ret_config:

• INDUSTRIAL_DUAL_0_20MA_V2_CHANNEL_LED_CONFIG_OFF = 0
• INDUSTRIAL_DUAL_0_20MA_V2_CHANNEL_LED_CONFIG_ON = 1
• INDUSTRIAL_DUAL_0_20MA_V2_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
• INDUSTRIAL_DUAL_0_20MA_V2_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

int industrial_dual_0_20ma_v2_set_channel_led_status_config(IndustrialDual020mAV2 *industrial_dual_0_20ma_v2, uint8_t channel, int32_t min, int32_t max, uint8_t config)¶

Parameter:	industrial_dual_0_20ma_v2 – Typ: IndustrialDual020mAV2 * channel – Typ: uint8_t, Wertebereich: [0 bis 1] min – Typ: int32_t, Einheit: 1 nA, Wertebereich: [-231 bis 231 - 1], Standardwert: 4000000 max – Typ: int32_t, Einheit: 1 nA, Wertebereich: [-231 bis 231 - 1], Standardwert: 20000000 config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 1
Rückgabe:	e_code – Typ: int

Setzt die Kanal-LED-Status-Konfiguration. Diese Einstellung wird verwendet wenn die Kanal-LED auf Kanalstatus eingestellt ist, siehe industrial_dual_0_20ma_v2_set_channel_led_config().

Für jeden Kanal kann zwischen Schwellwert- und Intensitätsmodus gewählt werden.

Im Schwellwertmodus kann ein positiver oder negativer Schwellwert definiert werden. Für einen positiven Schwellwert muss der "min" Parameter auf den gewünschten Schwellwert in nA gesetzt werden, über dem die LED eingeschaltet werden soll. Der "max" Parameter muss auf 0 gesetzt werden. Beispiel: Bei einem positiven Schwellwert von 10mA wird die LED eingeschaltet sobald der gemessene Strom über 10mA steigt und wieder ausgeschaltet sobald der Strom unter 10mA fällt. Für einen negativen Schwellwert muss der "max" Parameter auf den gewünschten Schwellwert in nA gesetzt werden, unter dem die LED eingeschaltet werden soll. Der "max" Parameter muss auf 0 gesetzt werden. Beispiel: Bei einem negativen Schwellwert von 10mA wird die LED eingeschaltet sobald der gemessene Strom unter 10mA fällt und wieder ausgeschaltet sobald der Strom über 10mA steigt.

Im Intensitätsmodus kann ein Bereich in nA angegeben werden über den die Helligkeit der LED skaliert wird. Beispiel mit min=4mA und max=20mA: Die LED ist bei 4mA und darunter aus, bei 20mA und darüber an und zwischen 4mA und 20mA wird die Helligkeit linear skaliert. Wenn der min Wert größer als der max Wert ist, dann wird die Helligkeit andersherum skaliert.

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

Für config:

• INDUSTRIAL_DUAL_0_20MA_V2_CHANNEL_LED_STATUS_CONFIG_THRESHOLD = 0
• INDUSTRIAL_DUAL_0_20MA_V2_CHANNEL_LED_STATUS_CONFIG_INTENSITY = 1

int industrial_dual_0_20ma_v2_get_channel_led_status_config(IndustrialDual020mAV2 *industrial_dual_0_20ma_v2, uint8_t channel, int32_t *ret_min, int32_t *ret_max, uint8_t *ret_config)¶

Parameter:	industrial_dual_0_20ma_v2 – Typ: IndustrialDual020mAV2 * channel – Typ: uint8_t, Wertebereich: [0 bis 1]
Ausgabeparameter:	ret_min – Typ: int32_t, Einheit: 1 nA, Wertebereich: [-231 bis 231 - 1], Standardwert: 4000000 ret_max – Typ: int32_t, Einheit: 1 nA, Wertebereich: [-231 bis 231 - 1], Standardwert: 20000000 ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 1
Rückgabe:	e_code – Typ: int

Gibt die Kanal-LED-Status-Konfiguration zurück, wie von industrial_dual_0_20ma_v2_set_channel_led_status_config() gesetzt.

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

Für ret_config:

• INDUSTRIAL_DUAL_0_20MA_V2_CHANNEL_LED_STATUS_CONFIG_THRESHOLD = 0
• INDUSTRIAL_DUAL_0_20MA_V2_CHANNEL_LED_STATUS_CONFIG_INTENSITY = 1

Fortgeschrittene Funktionen¶

int industrial_dual_0_20ma_v2_set_sample_rate(IndustrialDual020mAV2 *industrial_dual_0_20ma_v2, uint8_t rate)¶

Parameter:	industrial_dual_0_20ma_v2 – Typ: IndustrialDual020mAV2 * rate – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_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

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

Für rate:

• INDUSTRIAL_DUAL_0_20MA_V2_SAMPLE_RATE_240_SPS = 0
• INDUSTRIAL_DUAL_0_20MA_V2_SAMPLE_RATE_60_SPS = 1
• INDUSTRIAL_DUAL_0_20MA_V2_SAMPLE_RATE_15_SPS = 2
• INDUSTRIAL_DUAL_0_20MA_V2_SAMPLE_RATE_4_SPS = 3

int industrial_dual_0_20ma_v2_get_sample_rate(IndustrialDual020mAV2 *industrial_dual_0_20ma_v2, uint8_t *ret_rate)¶

Parameter:	industrial_dual_0_20ma_v2 – Typ: IndustrialDual020mAV2 *
Ausgabeparameter:	ret_rate – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

Gibt die Abtastrate zurück, wie von industrial_dual_0_20ma_v2_set_sample_rate() gesetzt.

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

Für ret_rate:

• INDUSTRIAL_DUAL_0_20MA_V2_SAMPLE_RATE_240_SPS = 0
• INDUSTRIAL_DUAL_0_20MA_V2_SAMPLE_RATE_60_SPS = 1
• INDUSTRIAL_DUAL_0_20MA_V2_SAMPLE_RATE_15_SPS = 2
• INDUSTRIAL_DUAL_0_20MA_V2_SAMPLE_RATE_4_SPS = 3

int industrial_dual_0_20ma_v2_set_gain(IndustrialDual020mAV2 *industrial_dual_0_20ma_v2, uint8_t gain)¶

Parameter:	industrial_dual_0_20ma_v2 – Typ: IndustrialDual020mAV2 * gain – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	e_code – Typ: int

Setzt die Verstärkung zwischen 1x und 8x. Wenn ein sehr kleiner Strom gemessen werden soll, dann kann die Verstärkung hochgesetzt werden, um die Auflösung zu verbessern.

Beispiel: Wenn 0,5mA gemessen werden mit einer Verstärkung von 8x dann wird 4mA zurückgegeben.

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

Für gain:

• INDUSTRIAL_DUAL_0_20MA_V2_GAIN_1X = 0
• INDUSTRIAL_DUAL_0_20MA_V2_GAIN_2X = 1
• INDUSTRIAL_DUAL_0_20MA_V2_GAIN_4X = 2
• INDUSTRIAL_DUAL_0_20MA_V2_GAIN_8X = 3

int industrial_dual_0_20ma_v2_get_gain(IndustrialDual020mAV2 *industrial_dual_0_20ma_v2, uint8_t *ret_gain)¶

Parameter:	industrial_dual_0_20ma_v2 – Typ: IndustrialDual020mAV2 *
Ausgabeparameter:	ret_gain – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	e_code – Typ: int

Gibt die Verstärkung zurück, wie von industrial_dual_0_20ma_v2_set_gain() gesetzt.

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

Für ret_gain:

• INDUSTRIAL_DUAL_0_20MA_V2_GAIN_1X = 0
• INDUSTRIAL_DUAL_0_20MA_V2_GAIN_2X = 1
• INDUSTRIAL_DUAL_0_20MA_V2_GAIN_4X = 2
• INDUSTRIAL_DUAL_0_20MA_V2_GAIN_8X = 3

int industrial_dual_0_20ma_v2_get_spitfp_error_count(IndustrialDual020mAV2 *industrial_dual_0_20ma_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:	industrial_dual_0_20ma_v2 – Typ: IndustrialDual020mAV2 *
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:	e_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 industrial_dual_0_20ma_v2_set_status_led_config(IndustrialDual020mAV2 *industrial_dual_0_20ma_v2, uint8_t config)¶

Parameter:	industrial_dual_0_20ma_v2 – Typ: IndustrialDual020mAV2 * config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_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:

• INDUSTRIAL_DUAL_0_20MA_V2_STATUS_LED_CONFIG_OFF = 0
• INDUSTRIAL_DUAL_0_20MA_V2_STATUS_LED_CONFIG_ON = 1
• INDUSTRIAL_DUAL_0_20MA_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• INDUSTRIAL_DUAL_0_20MA_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int industrial_dual_0_20ma_v2_get_status_led_config(IndustrialDual020mAV2 *industrial_dual_0_20ma_v2, uint8_t *ret_config)¶

Parameter:	industrial_dual_0_20ma_v2 – Typ: IndustrialDual020mAV2 *
Ausgabeparameter:	ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

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

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

Für ret_config:

• INDUSTRIAL_DUAL_0_20MA_V2_STATUS_LED_CONFIG_OFF = 0
• INDUSTRIAL_DUAL_0_20MA_V2_STATUS_LED_CONFIG_ON = 1
• INDUSTRIAL_DUAL_0_20MA_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• INDUSTRIAL_DUAL_0_20MA_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int industrial_dual_0_20ma_v2_get_chip_temperature(IndustrialDual020mAV2 *industrial_dual_0_20ma_v2, int16_t *ret_temperature)¶

Parameter:	industrial_dual_0_20ma_v2 – Typ: IndustrialDual020mAV2 *
Ausgabeparameter:	ret_temperature – Typ: int16_t, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]
Rückgabe:	e_code – Typ: int

Gibt die Temperatur, 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 industrial_dual_0_20ma_v2_reset(IndustrialDual020mAV2 *industrial_dual_0_20ma_v2)¶

Parameter:	industrial_dual_0_20ma_v2 – Typ: IndustrialDual020mAV2 *
Rückgabe:	e_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 industrial_dual_0_20ma_v2_get_identity(IndustrialDual020mAV2 *industrial_dual_0_20ma_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:	industrial_dual_0_20ma_v2 – Typ: IndustrialDual020mAV2 *
Ausgabeparameter:	ret_uid – Typ: char[8] ret_connected_uid – Typ: char[8] ret_position – Typ: char, Wertebereich: ['a' bis 'h', '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:	e_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 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.

Konfigurationsfunktionen für Callbacks¶

void industrial_dual_0_20ma_v2_register_callback(IndustrialDual020mAV2 *industrial_dual_0_20ma_v2, int16_t callback_id, void (*function)(void), void *user_data)¶

Parameter:	industrial_dual_0_20ma_v2 – Typ: IndustrialDual020mAV2 * 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_v2_set_current_callback_configuration(IndustrialDual020mAV2 *industrial_dual_0_20ma_v2, uint8_t channel, uint32_t period, bool value_has_to_change, char option, int32_t min, int32_t max)¶

Parameter:

industrial_dual_0_20ma_v2 – Typ: IndustrialDual020mAV2 * channel – Typ: uint8_t, Wertebereich: [0 bis 1] 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, Einheit: 1 nA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: int32_t, Einheit: 1 nA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Rückgabe:

e_code – Typ: int

Die Periode ist die Periode mit der der INDUSTRIAL_DUAL_0_20MA_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 INDUSTRIAL_DUAL_0_20MA_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.

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

Für option:

• INDUSTRIAL_DUAL_0_20MA_V2_THRESHOLD_OPTION_OFF = 'x'
• INDUSTRIAL_DUAL_0_20MA_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
• INDUSTRIAL_DUAL_0_20MA_V2_THRESHOLD_OPTION_INSIDE = 'i'
• INDUSTRIAL_DUAL_0_20MA_V2_THRESHOLD_OPTION_SMALLER = '<'
• INDUSTRIAL_DUAL_0_20MA_V2_THRESHOLD_OPTION_GREATER = '>'

int industrial_dual_0_20ma_v2_get_current_callback_configuration(IndustrialDual020mAV2 *industrial_dual_0_20ma_v2, uint8_t channel, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, int32_t *ret_min, int32_t *ret_max)¶

Parameter:	industrial_dual_0_20ma_v2 – Typ: IndustrialDual020mAV2 * channel – Typ: uint8_t, Wertebereich: [0 bis 1]
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, Einheit: 1 nA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 ret_max – Typ: int32_t, Einheit: 1 nA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

Gibt die Callback-Konfiguration zurück, wie mittels industrial_dual_0_20ma_v2_set_current_callback_configuration() gesetzt.

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

Für ret_option:

• INDUSTRIAL_DUAL_0_20MA_V2_THRESHOLD_OPTION_OFF = 'x'
• INDUSTRIAL_DUAL_0_20MA_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
• INDUSTRIAL_DUAL_0_20MA_V2_THRESHOLD_OPTION_INSIDE = 'i'
• INDUSTRIAL_DUAL_0_20MA_V2_THRESHOLD_OPTION_SMALLER = '<'
• INDUSTRIAL_DUAL_0_20MA_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 industrial_dual_0_20ma_v2_register_callback() Funktion durchgeführt werden:

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

industrial_dual_0_20ma_v2_register_callback(&industrial_dual_0_20ma_v2,
                                            INDUSTRIAL_DUAL_0_20MA_V2_CALLBACK_EXAMPLE,
                                            (void (*)(void))my_callback,
                                            NULL);

Die verfügbaren Konstanten mit den zugehörigen Funktionssignaturen werden weiter unten beschrieben.

INDUSTRIAL_DUAL_0_20MA_V2_CALLBACK_CURRENT¶

void callback(uint8_t channel, int32_t current, void *user_data)

Callback-Parameter:	channel – Typ: uint8_t, Wertebereich: [0 bis 1] current – Typ: int32_t, Einheit: 1 nA, Wertebereich: [0 bis 22505322] user_data – Typ: void *

Dieser Callback wird periodisch ausgelöst abhängig von der mittels industrial_dual_0_20ma_v2_set_current_callback_configuration() gesetzten Konfiguration

Der Parameter ist der gleiche wie industrial_dual_0_20ma_v2_get_current().

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 industrial_dual_0_20ma_v2_get_api_version(IndustrialDual020mAV2 *industrial_dual_0_20ma_v2, uint8_t ret_api_version[3])¶

Parameter:	industrial_dual_0_20ma_v2 – Typ: IndustrialDual020mAV2 *
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:	e_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 industrial_dual_0_20ma_v2_get_response_expected(IndustrialDual020mAV2 *industrial_dual_0_20ma_v2, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	industrial_dual_0_20ma_v2 – Typ: IndustrialDual020mAV2 * function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_response_expected – Typ: bool
Rückgabe:	e_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_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:

• INDUSTRIAL_DUAL_0_20MA_V2_FUNCTION_SET_CURRENT_CALLBACK_CONFIGURATION = 2
• INDUSTRIAL_DUAL_0_20MA_V2_FUNCTION_SET_SAMPLE_RATE = 5
• INDUSTRIAL_DUAL_0_20MA_V2_FUNCTION_SET_GAIN = 7
• INDUSTRIAL_DUAL_0_20MA_V2_FUNCTION_SET_CHANNEL_LED_CONFIG = 9
• INDUSTRIAL_DUAL_0_20MA_V2_FUNCTION_SET_CHANNEL_LED_STATUS_CONFIG = 11
• INDUSTRIAL_DUAL_0_20MA_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• INDUSTRIAL_DUAL_0_20MA_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
• INDUSTRIAL_DUAL_0_20MA_V2_FUNCTION_RESET = 243
• INDUSTRIAL_DUAL_0_20MA_V2_FUNCTION_WRITE_UID = 248

int industrial_dual_0_20ma_v2_set_response_expected(IndustrialDual020mAV2 *industrial_dual_0_20ma_v2, uint8_t function_id, bool response_expected)¶

Parameter:	industrial_dual_0_20ma_v2 – Typ: IndustrialDual020mAV2 * function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten response_expected – Typ: bool
Rückgabe:	e_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_V2_FUNCTION_SET_CURRENT_CALLBACK_CONFIGURATION = 2
• INDUSTRIAL_DUAL_0_20MA_V2_FUNCTION_SET_SAMPLE_RATE = 5
• INDUSTRIAL_DUAL_0_20MA_V2_FUNCTION_SET_GAIN = 7
• INDUSTRIAL_DUAL_0_20MA_V2_FUNCTION_SET_CHANNEL_LED_CONFIG = 9
• INDUSTRIAL_DUAL_0_20MA_V2_FUNCTION_SET_CHANNEL_LED_STATUS_CONFIG = 11
• INDUSTRIAL_DUAL_0_20MA_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• INDUSTRIAL_DUAL_0_20MA_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
• INDUSTRIAL_DUAL_0_20MA_V2_FUNCTION_RESET = 243
• INDUSTRIAL_DUAL_0_20MA_V2_FUNCTION_WRITE_UID = 248

int industrial_dual_0_20ma_v2_set_response_expected_all(IndustrialDual020mAV2 *industrial_dual_0_20ma_v2, bool response_expected)¶

Parameter:	industrial_dual_0_20ma_v2 – Typ: IndustrialDual020mAV2 * response_expected – Typ: bool
Rückgabe:	e_code – Typ: int

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

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

int industrial_dual_0_20ma_v2_set_bootloader_mode(IndustrialDual020mAV2 *industrial_dual_0_20ma_v2, uint8_t mode, uint8_t *ret_status)¶

Parameter:	industrial_dual_0_20ma_v2 – Typ: IndustrialDual020mAV2 * mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_status – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_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 Bootloader- 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:

• INDUSTRIAL_DUAL_0_20MA_V2_BOOTLOADER_MODE_BOOTLOADER = 0
• INDUSTRIAL_DUAL_0_20MA_V2_BOOTLOADER_MODE_FIRMWARE = 1
• INDUSTRIAL_DUAL_0_20MA_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• INDUSTRIAL_DUAL_0_20MA_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• INDUSTRIAL_DUAL_0_20MA_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

• INDUSTRIAL_DUAL_0_20MA_V2_BOOTLOADER_STATUS_OK = 0
• INDUSTRIAL_DUAL_0_20MA_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
• INDUSTRIAL_DUAL_0_20MA_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
• INDUSTRIAL_DUAL_0_20MA_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• INDUSTRIAL_DUAL_0_20MA_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• INDUSTRIAL_DUAL_0_20MA_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int industrial_dual_0_20ma_v2_get_bootloader_mode(IndustrialDual020mAV2 *industrial_dual_0_20ma_v2, uint8_t *ret_mode)¶

Parameter:	industrial_dual_0_20ma_v2 – Typ: IndustrialDual020mAV2 *
Ausgabeparameter:	ret_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

Gibt den aktuellen Bootloader-Modus zurück, siehe industrial_dual_0_20ma_v2_set_bootloader_mode().

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

Für ret_mode:

• INDUSTRIAL_DUAL_0_20MA_V2_BOOTLOADER_MODE_BOOTLOADER = 0
• INDUSTRIAL_DUAL_0_20MA_V2_BOOTLOADER_MODE_FIRMWARE = 1
• INDUSTRIAL_DUAL_0_20MA_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• INDUSTRIAL_DUAL_0_20MA_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• INDUSTRIAL_DUAL_0_20MA_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int industrial_dual_0_20ma_v2_set_write_firmware_pointer(IndustrialDual020mAV2 *industrial_dual_0_20ma_v2, uint32_t pointer)¶

Parameter:	industrial_dual_0_20ma_v2 – Typ: IndustrialDual020mAV2 * pointer – Typ: uint32_t, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Rückgabe:	e_code – Typ: int

Setzt den Firmware-Pointer für industrial_dual_0_20ma_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 industrial_dual_0_20ma_v2_write_firmware(IndustrialDual020mAV2 *industrial_dual_0_20ma_v2, uint8_t data[64], uint8_t *ret_status)¶

Parameter:	industrial_dual_0_20ma_v2 – Typ: IndustrialDual020mAV2 * data – Typ: uint8_t[64], Wertebereich: [0 bis 255]
Ausgabeparameter:	ret_status – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Schreibt 64 Bytes Firmware an die Position die vorher von industrial_dual_0_20ma_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 industrial_dual_0_20ma_v2_write_uid(IndustrialDual020mAV2 *industrial_dual_0_20ma_v2, uint32_t uid)¶

Parameter:	industrial_dual_0_20ma_v2 – Typ: IndustrialDual020mAV2 * uid – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:	e_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 industrial_dual_0_20ma_v2_read_uid(IndustrialDual020mAV2 *industrial_dual_0_20ma_v2, uint32_t *ret_uid)¶

Parameter:	industrial_dual_0_20ma_v2 – Typ: IndustrialDual020mAV2 *
Ausgabeparameter:	ret_uid – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:	e_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.

Konstanten¶

INDUSTRIAL_DUAL_0_20MA_V2_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Industrial Dual 0-20mA Bricklet 2.0 zu identifizieren.

Die industrial_dual_0_20ma_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.

INDUSTRIAL_DUAL_0_20MA_V2_DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Industrial Dual 0-20mA Bricklet 2.0 dar.