C/C++ - Industrial Digital In 4 Bricklet

Dies ist die Beschreibung der C/C++ API Bindings für das Industrial Digital In 4 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Industrial Digital In 4 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_digital_in_4.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Industrial Digital In 4 Bricklet

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

    // Create device object
    IndustrialDigitalIn4 idi4;
    industrial_digital_in_4_create(&idi4, 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 value as bitmask
    uint16_t value_mask;
    if(industrial_digital_in_4_get_value(&idi4, &value_mask) < 0) {
        fprintf(stderr, "Could not get value as bitmask, probably timeout\n");
        return 1;
    }

    printf("Value Mask: %u\n", value_mask);

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

Interrupt

Download (example_interrupt.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_digital_in_4.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Industrial Digital In 4 Bricklet

// Callback function for interrupt callback
void cb_interrupt(uint16_t interrupt_mask, uint16_t value_mask, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Interrupt Mask: %u\n", interrupt_mask);
    printf("Value Mask: %u\n", value_mask);
    printf("\n");
}

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

    // Create device object
    IndustrialDigitalIn4 idi4;
    industrial_digital_in_4_create(&idi4, 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 interrupt callback to function cb_interrupt
    industrial_digital_in_4_register_callback(&idi4,
                                              INDUSTRIAL_DIGITAL_IN_4_CALLBACK_INTERRUPT,
                                              (void (*)(void))cb_interrupt,
                                              NULL);

    // Enable interrupt on pin 0
    industrial_digital_in_4_set_interrupt(&idi4, 1 << 0);

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

API

Jede Funktion der C/C++ Bindings gibt einen Integer zurück, welcher einen Fehlercode beschreibt. Vom Gerät zurückgegebene Daten werden, wenn eine Abfrage aufgerufen wurde, über Ausgabeparameter gehandhabt. Diese Parameter sind mit dem ret_ Präfix gekennzeichnet.

Mögliche Fehlercodes sind:

  • E_OK = 0
  • E_TIMEOUT = -1
  • E_NO_STREAM_SOCKET = -2
  • E_HOSTNAME_INVALID = -3
  • E_NO_CONNECT = -4
  • E_NO_THREAD = -5
  • E_NOT_ADDED = -6 (wird seit C/C++ Bindings Version 2.0.0 nicht mehr verwendet)
  • E_ALREADY_CONNECTED = -7
  • E_NOT_CONNECTED = -8
  • E_INVALID_PARAMETER = -9
  • E_NOT_SUPPORTED = -10
  • E_UNKNOWN_ERROR_CODE = -11
  • E_STREAM_OUT_OF_SYNC = -12
  • E_INVALID_UID = -13
  • E_NON_ASCII_CHAR_IN_SECRET = -14
  • E_WRONG_DEVICE_TYPE = -15
  • E_DEVICE_REPLACED = -16
  • E_WRONG_RESPONSE_LENGTH = -17

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

void industrial_digital_in_4_create(IndustrialDigitalIn4 *industrial_digital_in_4, const char *uid, IPConnection *ipcon)
Parameter:
  • industrial_digital_in_4 – Typ: IndustrialDigitalIn4 *
  • uid – Typ: const char *
  • ipcon – Typ: IPConnection *

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

IndustrialDigitalIn4 industrial_digital_in_4;
industrial_digital_in_4_create(&industrial_digital_in_4, "YOUR_DEVICE_UID", &ipcon);

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

void industrial_digital_in_4_destroy(IndustrialDigitalIn4 *industrial_digital_in_4)
Parameter:
  • industrial_digital_in_4 – Typ: IndustrialDigitalIn4 *

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

int industrial_digital_in_4_get_value(IndustrialDigitalIn4 *industrial_digital_in_4, uint16_t *ret_value_mask)
Parameter:
  • industrial_digital_in_4 – Typ: IndustrialDigitalIn4 *
Ausgabeparameter:
  • ret_value_mask – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int

Gibt die Ausgabewerte mit einer Bitmaske zurück. Die Bitmaske ist 16Bit lang. true bedeutet logisch 1 und false logisch 0.

Zum Beispiel: Der Wert 3 bzw. 0b0011 bedeutet, dass die Pins 0-1 auf logisch 1 und alle anderen auf logisch 0 sind.

Falls keine Gruppen verwendet werden (siehe industrial_digital_in_4_set_group()), entsprechen die Pins der Beschriftung auf dem Industrial Digital In 4 Bricklet.

Falls Gruppen verwendet werden, entsprechen die Pins den Elementen der Gruppe. Element 1 in der Gruppe bekommt Pins 0-3, Element 2 Pins 4-7, Element 3 Pins 8-11 und Element 4 Pins 12-15.

int industrial_digital_in_4_get_edge_count(IndustrialDigitalIn4 *industrial_digital_in_4, uint8_t pin, bool reset_counter, uint32_t *ret_count)
Parameter:
  • industrial_digital_in_4 – Typ: IndustrialDigitalIn4 *
  • pin – Typ: uint8_t, Wertebereich: [0 bis 3]
  • reset_counter – Typ: bool
Ausgabeparameter:
  • ret_count – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_code – Typ: int

Gibt den aktuellen Wert des Flankenzählers für den ausgewählten Pin zurück. Die zu zählenden Flanken können mit industrial_digital_in_4_set_edge_count_config() konfiguriert werden.

Wenn reset counter auf true gesetzt wird, wird der Zählerstand direkt nach dem auslesen auf 0 zurückgesetzt.

Die Flankenzähler benutzen die Gruppierung, wie von industrial_digital_in_4_set_group() gesetzt.

Neu in Version 2.0.1 (Plugin).

Fortgeschrittene Funktionen

int industrial_digital_in_4_set_group(IndustrialDigitalIn4 *industrial_digital_in_4, char group[4])
Parameter:
  • industrial_digital_in_4 – Typ: IndustrialDigitalIn4 *
  • group – Typ: char[4], Wertebereich: ['a' bis 'd', 'n']
Rückgabe:
  • error_code – Typ: int

Setzt eine Gruppe von Digital In 4 Bricklets die zusammenarbeiten sollen. Mögliche Gruppierungen können mit der Funktion industrial_digital_in_4_get_available_for_group() gefunden werden.

Eine Gruppe besteht aus 4 Element. Element 1 in der Gruppe bekommt Pins 0-3, Element 2 Pins 4-7, Element 3 Pins 8-11 und Element 4 Pins 12-15.

Jedes Element kann entweder auf einen der Ports ('a' bis 'd') gesetzt werden oder falls nicht genutzt 'n' gesetzt werden.

Zum Beispiel: Falls zwei Digital In 4 Bricklets mit Port A und Port B verbunden sind, könnte diese Funktion mit ['a', 'b', 'n', 'n'] aufgerufen werden.

In diesem Fall wären die Pins von Port A den Werten 0-3 zugewiesen und die Pins von Port B den Werten 4-7. Es ist jetzt möglich mit der Funktion industrial_digital_in_4_get_value() beide Bricklets gleichzeitig auszulesen.

Änderungen an der Gruppeneinteilung setzt die Konfiguration und Zählerwerte aller Flankenzähler zurück.

int industrial_digital_in_4_get_group(IndustrialDigitalIn4 *industrial_digital_in_4, char ret_group[4])
Parameter:
  • industrial_digital_in_4 – Typ: IndustrialDigitalIn4 *
Ausgabeparameter:
  • ret_group – Typ: char[4], Wertebereich: ['a' bis 'd', 'n']
Rückgabe:
  • error_code – Typ: int

Gibt die Gruppierung zurück, wie von industrial_digital_in_4_set_group() gesetzt.

int industrial_digital_in_4_get_available_for_group(IndustrialDigitalIn4 *industrial_digital_in_4, uint8_t *ret_available)
Parameter:
  • industrial_digital_in_4 – Typ: IndustrialDigitalIn4 *
Ausgabeparameter:
  • ret_available – Typ: uint8_t, Wertebereich: [0 bis 15]
Rückgabe:
  • error_code – Typ: int

Gibt eine Bitmaske von Ports zurück die für die Gruppierung zur Verfügung stehen. Zum Beispiel bedeutet der Wert 5 bzw. 0b0101: Port A und Port C sind mit Bricklets verbunden die zusammen gruppiert werden können.

int industrial_digital_in_4_set_edge_count_config(IndustrialDigitalIn4 *industrial_digital_in_4, uint16_t selection_mask, uint8_t edge_type, uint8_t debounce)
Parameter:
  • industrial_digital_in_4 – Typ: IndustrialDigitalIn4 *
  • selection_mask – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • edge_type – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
  • debounce – Typ: uint8_t, Einheit: 1 ms, Wertebereich: [0 bis 255], Standardwert: 100
Rückgabe:
  • error_code – Typ: int

Konfiguriert den Flankenzähler für die ausgewählten Pins. Eine Bitmaske von 9 bzw. 0b1001 aktiviert den Flankenzähler für die Pins 0 und 3.

Der edge type Parameter konfiguriert den zu zählenden Flankentyp. Es können steigende, fallende oder beide Flanken gezählt werden für Pins die als Eingang konfiguriert sind. Mögliche Flankentypen sind:

  • 0 = steigend
  • 1 = fallend
  • 2 = beide

Durch das Konfigurieren wird der Wert des Flankenzählers auf 0 zurückgesetzt.

Falls unklar ist was dies alles bedeutet, kann diese Funktion einfach ignoriert werden. Die Standardwerte sind in fast allen Situationen OK.

Die Flankenzähler benutzen die Gruppierung, wie von industrial_digital_in_4_set_group() gesetzt.

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

Für edge_type:

  • INDUSTRIAL_DIGITAL_IN_4_EDGE_TYPE_RISING = 0
  • INDUSTRIAL_DIGITAL_IN_4_EDGE_TYPE_FALLING = 1
  • INDUSTRIAL_DIGITAL_IN_4_EDGE_TYPE_BOTH = 2

Neu in Version 2.0.1 (Plugin).

int industrial_digital_in_4_get_edge_count_config(IndustrialDigitalIn4 *industrial_digital_in_4, uint8_t pin, uint8_t *ret_edge_type, uint8_t *ret_debounce)
Parameter:
  • industrial_digital_in_4 – Typ: IndustrialDigitalIn4 *
  • pin – Typ: uint8_t, Wertebereich: [0 bis 255]
Ausgabeparameter:
  • ret_edge_type – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
  • ret_debounce – Typ: uint8_t, Einheit: 1 ms, Wertebereich: [0 bis 255], Standardwert: 100
Rückgabe:
  • error_code – Typ: int

Gibt den Flankentyp sowie die Entprellzeit für den ausgewählten Pin zurück, wie von industrial_digital_in_4_set_edge_count_config() gesetzt.

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

Für ret_edge_type:

  • INDUSTRIAL_DIGITAL_IN_4_EDGE_TYPE_RISING = 0
  • INDUSTRIAL_DIGITAL_IN_4_EDGE_TYPE_FALLING = 1
  • INDUSTRIAL_DIGITAL_IN_4_EDGE_TYPE_BOTH = 2

Neu in Version 2.0.1 (Plugin).

int industrial_digital_in_4_get_identity(IndustrialDigitalIn4 *industrial_digital_in_4, 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_digital_in_4 – Typ: IndustrialDigitalIn4 *
Ausgabeparameter:
  • ret_uid – Typ: char[8]
  • ret_connected_uid – Typ: char[8]
  • ret_position – Typ: char, Wertebereich: ['a' bis 'h', 'i', 'z']
  • ret_hardware_version – Typ: uint8_t[3]
    • 0: major – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255]
  • ret_firmware_version – Typ: uint8_t[3]
    • 0: major – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255]
  • ret_device_identifier – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

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

Konfigurationsfunktionen für Callbacks

void industrial_digital_in_4_register_callback(IndustrialDigitalIn4 *industrial_digital_in_4, int16_t callback_id, void (*function)(void), void *user_data)
Parameter:
  • industrial_digital_in_4 – Typ: IndustrialDigitalIn4 *
  • 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_digital_in_4_set_debounce_period(IndustrialDigitalIn4 *industrial_digital_in_4, uint32_t debounce)
Parameter:
  • industrial_digital_in_4 – Typ: IndustrialDigitalIn4 *
  • debounce – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Rückgabe:
  • error_code – Typ: int

Setzt die Entprellperiode der INDUSTRIAL_DIGITAL_IN_4_CALLBACK_INTERRUPT Callback.

Beispiel: Wenn dieser Wert auf 100 gesetzt wird, erhält man den Interrupt maximal alle 100ms. Dies ist notwendig falls etwas prellendes an das Digital In 4 Bricklet angeschlossen ist, wie z.B. einen Schalter.

int industrial_digital_in_4_get_debounce_period(IndustrialDigitalIn4 *industrial_digital_in_4, uint32_t *ret_debounce)
Parameter:
  • industrial_digital_in_4 – Typ: IndustrialDigitalIn4 *
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_digital_in_4_set_debounce_period() gesetzt.

int industrial_digital_in_4_set_interrupt(IndustrialDigitalIn4 *industrial_digital_in_4, uint16_t interrupt_mask)
Parameter:
  • industrial_digital_in_4 – Typ: IndustrialDigitalIn4 *
  • interrupt_mask – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int

Setzt durch eine Bitmaske die Pins für welche der Interrupt aktiv ist. Interrupts werden ausgelöst bei Änderung des Spannungspegels eines Pins, z.B. ein Wechsel von logisch 1 zu logisch 0 und logisch 0 zu logisch 1.

Beispiel: Eine Interrupt Bitmaske von 9 bzw. 0b1001 aktiviert den Interrupt für die Pins 0 und 3.

Die Interrupts benutzen die Gruppierung, wie von industrial_digital_in_4_set_group() gesetzt.

Der Interrupt wird mit dem INDUSTRIAL_DIGITAL_IN_4_CALLBACK_INTERRUPT Callback zugestellt.

int industrial_digital_in_4_get_interrupt(IndustrialDigitalIn4 *industrial_digital_in_4, uint16_t *ret_interrupt_mask)
Parameter:
  • industrial_digital_in_4 – Typ: IndustrialDigitalIn4 *
Ausgabeparameter:
  • ret_interrupt_mask – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int

Gibt die Interrupt Bitmaske zurück, wie von industrial_digital_in_4_set_interrupt() gesetzt.

Callbacks

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

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

industrial_digital_in_4_register_callback(&industrial_digital_in_4,
                                          INDUSTRIAL_DIGITAL_IN_4_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_DIGITAL_IN_4_CALLBACK_INTERRUPT
void callback(uint16_t interrupt_mask, uint16_t value_mask, void *user_data)
Callback-Parameter:
  • interrupt_mask – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • value_mask – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • user_data – Typ: void *

Dieser Callback wird ausgelöst sobald eine Änderung des Spannungspegels detektiert wird, an Pins für welche der Interrupt mit industrial_digital_in_4_set_interrupt() aktiviert wurde.

Die Rückgabewerte sind eine Bitmaske der aufgetretenen Interrupts und der aktuellen Zustände.

Beispiele:

  • (1, 1) bzw. (0b0001, 0b0001) bedeutet, dass ein Interrupt am Pin 0 aufgetreten ist und aktuell Pin 0 logisch 1 ist und die Pins 1-3 logisch 0 sind.
  • (9, 14) bzw. (0b1001, 0b1110) bedeutet, dass Interrupts an den Pins 0 und 3 aufgetreten sind und aktuell Pin 0 logisch 0 ist und die Pins 1-3 logisch 1 sind.

Die Interrupts benutzen die Gruppierung, wie von industrial_digital_in_4_set_group() gesetzt.

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_digital_in_4_get_api_version(IndustrialDigitalIn4 *industrial_digital_in_4, uint8_t ret_api_version[3])
Parameter:
  • industrial_digital_in_4 – Typ: IndustrialDigitalIn4 *
Ausgabeparameter:
  • ret_api_version – Typ: uint8_t[3]
    • 0: major – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:
  • error_code – Typ: int

Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

int industrial_digital_in_4_get_response_expected(IndustrialDigitalIn4 *industrial_digital_in_4, uint8_t function_id, bool *ret_response_expected)
Parameter:
  • industrial_digital_in_4 – Typ: IndustrialDigitalIn4 *
  • 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_digital_in_4_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_DIGITAL_IN_4_FUNCTION_SET_GROUP = 2
  • INDUSTRIAL_DIGITAL_IN_4_FUNCTION_SET_DEBOUNCE_PERIOD = 5
  • INDUSTRIAL_DIGITAL_IN_4_FUNCTION_SET_INTERRUPT = 7
  • INDUSTRIAL_DIGITAL_IN_4_FUNCTION_SET_EDGE_COUNT_CONFIG = 11
int industrial_digital_in_4_set_response_expected(IndustrialDigitalIn4 *industrial_digital_in_4, uint8_t function_id, bool response_expected)
Parameter:
  • industrial_digital_in_4 – Typ: IndustrialDigitalIn4 *
  • 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_DIGITAL_IN_4_FUNCTION_SET_GROUP = 2
  • INDUSTRIAL_DIGITAL_IN_4_FUNCTION_SET_DEBOUNCE_PERIOD = 5
  • INDUSTRIAL_DIGITAL_IN_4_FUNCTION_SET_INTERRUPT = 7
  • INDUSTRIAL_DIGITAL_IN_4_FUNCTION_SET_EDGE_COUNT_CONFIG = 11
int industrial_digital_in_4_set_response_expected_all(IndustrialDigitalIn4 *industrial_digital_in_4, bool response_expected)
Parameter:
  • industrial_digital_in_4 – Typ: IndustrialDigitalIn4 *
  • response_expected – Typ: bool
Rückgabe:
  • error_code – Typ: int

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

Konstanten

INDUSTRIAL_DIGITAL_IN_4_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Industrial Digital In 4 Bricklet zu identifizieren.

Die industrial_digital_in_4_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_DIGITAL_IN_4_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Industrial Digital In 4 Bricklet dar.