Software / API Bindings / C/C++ / API Referenz und Beispiele / Bricklets / Industrial Digital In 4 Bricklet 2.0

C/C++ - Industrial Digital In 4 Bricklet 2.0¶

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

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_industrial_digital_in_4_v2.h"

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

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

    // Create device object
    IndustrialDigitalIn4V2 idi4;
    industrial_digital_in_4_v2_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
    bool value[4];
    if(industrial_digital_in_4_v2_get_value(&idi4, value) < 0) {
        fprintf(stderr, "Could not get value, probably timeout\n");
        return 1;
    }

    printf("Channel 0: %s\n", value[0] ? "true" : "false");
    printf("Channel 1: %s\n", value[1] ? "true" : "false");
    printf("Channel 2: %s\n", value[2] ? "true" : "false");
    printf("Channel 3: %s\n", value[3] ? "true" : "false");

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

Edge Count¶

Download (example_edge_count.c)

#define IPCON_EXPOSE_MILLISLEEP

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_industrial_digital_in_4_v2.h"

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

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

    // Create device object
    IndustrialDigitalIn4V2 idi4;
    industrial_digital_in_4_v2_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

    // Configure rising edge count (channel 3) with 10ms debounce
    industrial_digital_in_4_v2_set_edge_count_configuration(&idi4, 3, 0, 10);

    // Get edge count 10 times with 1s delay
    int i;
    for(i = 0; i < 10; ++i) {
        millisleep(1000);

        // Get current edge count
        uint32_t count;
        if(industrial_digital_in_4_v2_get_edge_count(&idi4, 3, false, &count) < 0) {
            fprintf(stderr, "Could not get edge count, probably timeout\n");
            return 1;
        }

        printf("Count: %u\n", count);
    }

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

Callback¶

Download (example_callback.c)

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_industrial_digital_in_4_v2.h"

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

// Callback function for value callback
void cb_value(uint8_t channel, bool changed, bool value, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    if(channel == INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_0) {
        printf("Channel: 0\n");
    } else if(channel == INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_1) {
        printf("Channel: 1\n");
    } else if(channel == INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_2) {
        printf("Channel: 2\n");
    } else if(channel == INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_3) {
        printf("Channel: 3\n");
    }

    printf("Changed: %s\n", changed ? "true" : "false");
    printf("Value: %s\n", value ? "true" : "false");
    printf("\n");
}

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

    // Create device object
    IndustrialDigitalIn4V2 idi4;
    industrial_digital_in_4_v2_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 value callback to function cb_value
    industrial_digital_in_4_v2_register_callback(&idi4,
                                                 INDUSTRIAL_DIGITAL_IN_4_V2_CALLBACK_VALUE,
                                                 (void (*)(void))cb_value,
                                                 NULL);

    // Set period for value (channel 1) callback to 0.1s (100ms)
    industrial_digital_in_4_v2_set_value_callback_configuration(&idi4, 1, 100, false);

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

API¶

Die meistens Funktionen der C/C++ Bindings geben einen Fehlercode (e_code) zurück. Vom Gerät zurückgegebene Daten werden, wenn eine Abfrage aufgerufen wurde, über Ausgabeparameter gehandhabt. Diese Parameter sind mit dem ret_ Präfix gekennzeichnet.

Mögliche Fehlercodes sind:

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

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen¶

void industrial_digital_in_4_v2_create(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, const char *uid, IPConnection *ipcon)¶

Parameter:	industrial_digital_in_4_v2 – Typ: IndustrialDigitalIn4V2 * uid – Typ: const char * ipcon – Typ: IPConnection *

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

IndustrialDigitalIn4V2 industrial_digital_in_4_v2;
industrial_digital_in_4_v2_create(&industrial_digital_in_4_v2, "YOUR_DEVICE_UID", &ipcon);

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

void industrial_digital_in_4_v2_destroy(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2)¶

Parameter:	industrial_digital_in_4_v2 – Typ: IndustrialDigitalIn4V2 *

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

int industrial_digital_in_4_v2_get_value(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, bool ret_value[4])¶

Parameter:	industrial_digital_in_4_v2 – Typ: IndustrialDigitalIn4V2 *
Ausgabeparameter:	ret_value – Typ: bool[4]
Rückgabe:	e_code – Typ: int

Gibt die Eingangswerte als Bools zurück, true bedeutet logisch 1 und false logisch 0.

int industrial_digital_in_4_v2_set_channel_led_config(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t channel, uint8_t config)¶

Parameter:	industrial_digital_in_4_v2 – Typ: IndustrialDigitalIn4V2 * channel – Typ: uint8_t, Wertebereich: Siehe Konstanten 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 ist die LED an wenn ein High-Signal am Kanal anliegt und sonst aus.

Standardmäßig sind die LEDs für alle Kanäle auf Kanalstatus konfiguriert.

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

Für channel:

INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_0 = 0
INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_1 = 1
INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_2 = 2
INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_3 = 3

Für config:

INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_LED_CONFIG_OFF = 0
INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_LED_CONFIG_ON = 1
INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

int industrial_digital_in_4_v2_get_channel_led_config(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t channel, uint8_t *ret_config)¶

Parameter:	industrial_digital_in_4_v2 – Typ: IndustrialDigitalIn4V2 * channel – Typ: uint8_t, Wertebereich: Siehe Konstanten
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_digital_in_4_v2_set_channel_led_config() gesetzt.

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

Für channel:

INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_0 = 0
INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_1 = 1
INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_2 = 2
INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_3 = 3

Für ret_config:

INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_LED_CONFIG_OFF = 0
INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_LED_CONFIG_ON = 1
INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

Fortgeschrittene Funktionen¶

int industrial_digital_in_4_v2_get_edge_count(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t channel, bool reset_counter, uint32_t *ret_count)¶

Parameter:	industrial_digital_in_4_v2 – Typ: IndustrialDigitalIn4V2 * channel – Typ: uint8_t, Wertebereich: Siehe Konstanten reset_counter – Typ: bool
Ausgabeparameter:	ret_count – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

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

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

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

Für channel:

INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_0 = 0
INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_1 = 1
INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_2 = 2
INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_3 = 3

int industrial_digital_in_4_v2_set_edge_count_configuration(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t channel, uint8_t edge_type, uint8_t debounce)¶

Parameter:	industrial_digital_in_4_v2 – Typ: IndustrialDigitalIn4V2 * channel – Typ: uint8_t, Wertebereich: Siehe Konstanten 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:	e_code – Typ: int

Konfiguriert den Flankenzähler für einen bestimmten Kanal.

Der edge type Parameter konfiguriert den zu zählenden Flankentyp. Es können steigende, fallende oder beide Flanken gezählt werden. 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 folgenden Konstanten sind für diese Funktion verfügbar:

Für channel:

INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_0 = 0
INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_1 = 1
INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_2 = 2
INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_3 = 3

Für edge_type:

INDUSTRIAL_DIGITAL_IN_4_V2_EDGE_TYPE_RISING = 0
INDUSTRIAL_DIGITAL_IN_4_V2_EDGE_TYPE_FALLING = 1
INDUSTRIAL_DIGITAL_IN_4_V2_EDGE_TYPE_BOTH = 2

int industrial_digital_in_4_v2_get_edge_count_configuration(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t channel, uint8_t *ret_edge_type, uint8_t *ret_debounce)¶

Parameter:	industrial_digital_in_4_v2 – Typ: IndustrialDigitalIn4V2 * channel – Typ: uint8_t, Wertebereich: Siehe Konstanten
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:	e_code – Typ: int

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

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

Für channel:

INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_0 = 0
INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_1 = 1
INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_2 = 2
INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_3 = 3

Für ret_edge_type:

INDUSTRIAL_DIGITAL_IN_4_V2_EDGE_TYPE_RISING = 0
INDUSTRIAL_DIGITAL_IN_4_V2_EDGE_TYPE_FALLING = 1
INDUSTRIAL_DIGITAL_IN_4_V2_EDGE_TYPE_BOTH = 2

int industrial_digital_in_4_v2_get_spitfp_error_count(IndustrialDigitalIn4V2 *industrial_digital_in_4_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_digital_in_4_v2 – Typ: IndustrialDigitalIn4V2 *
Ausgabeparameter:	ret_error_count_ack_checksum – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_message_checksum – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_frame – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_overflow – Typ: uint32_t, Wertebereich: [0 bis 2³² - 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_digital_in_4_v2_set_status_led_config(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t config)¶

Parameter:	industrial_digital_in_4_v2 – Typ: IndustrialDigitalIn4V2 * 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_DIGITAL_IN_4_V2_STATUS_LED_CONFIG_OFF = 0
INDUSTRIAL_DIGITAL_IN_4_V2_STATUS_LED_CONFIG_ON = 1
INDUSTRIAL_DIGITAL_IN_4_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
INDUSTRIAL_DIGITAL_IN_4_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int industrial_digital_in_4_v2_get_status_led_config(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t *ret_config)¶

Parameter:	industrial_digital_in_4_v2 – Typ: IndustrialDigitalIn4V2 *
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_digital_in_4_v2_set_status_led_config() gesetzt.

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

Für ret_config:

INDUSTRIAL_DIGITAL_IN_4_V2_STATUS_LED_CONFIG_OFF = 0
INDUSTRIAL_DIGITAL_IN_4_V2_STATUS_LED_CONFIG_ON = 1
INDUSTRIAL_DIGITAL_IN_4_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
INDUSTRIAL_DIGITAL_IN_4_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int industrial_digital_in_4_v2_get_chip_temperature(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, int16_t *ret_temperature)¶

Parameter:	industrial_digital_in_4_v2 – Typ: IndustrialDigitalIn4V2 *
Ausgabeparameter:	ret_temperature – Typ: int16_t, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 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_digital_in_4_v2_reset(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2)¶

Parameter:	industrial_digital_in_4_v2 – Typ: IndustrialDigitalIn4V2 *
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_digital_in_4_v2_get_identity(IndustrialDigitalIn4V2 *industrial_digital_in_4_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_digital_in_4_v2 – Typ: IndustrialDigitalIn4V2 *
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 2¹⁶ - 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_digital_in_4_v2_register_callback(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, int16_t callback_id, void (*function)(void), void *user_data)¶

Parameter:	industrial_digital_in_4_v2 – Typ: IndustrialDigitalIn4V2 * 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_v2_set_value_callback_configuration(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t channel, uint32_t period, bool value_has_to_change)¶

Parameter:	industrial_digital_in_4_v2 – Typ: IndustrialDigitalIn4V2 * channel – Typ: uint8_t, Wertebereich: Siehe Konstanten period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Dieser Callback kann pro Kanal konfiguriert werden.

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

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

Für channel:

INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_0 = 0
INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_1 = 1
INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_2 = 2
INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_3 = 3

int industrial_digital_in_4_v2_get_value_callback_configuration(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t channel, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameter:	industrial_digital_in_4_v2 – Typ: IndustrialDigitalIn4V2 * channel – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 ret_value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Gibt die Callback-Konfiguration für den gegebenen Kanal zurück, wie mittels industrial_digital_in_4_v2_set_value_callback_configuration() gesetzt.

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

Für channel:

INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_0 = 0
INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_1 = 1
INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_2 = 2
INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_3 = 3

int industrial_digital_in_4_v2_set_all_value_callback_configuration(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint32_t period, bool value_has_to_change)¶

Parameter:	industrial_digital_in_4_v2 – Typ: IndustrialDigitalIn4V2 * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Die Periode ist die Periode mit der der INDUSTRIAL_DIGITAL_IN_4_V2_CALLBACK_ALL_VALUE Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

int industrial_digital_in_4_v2_get_all_value_callback_configuration(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameter:	industrial_digital_in_4_v2 – Typ: IndustrialDigitalIn4V2 *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 ret_value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Gibt die Callback-Konfiguration zurück, wie mittels industrial_digital_in_4_v2_set_all_value_callback_configuration() 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_v2_register_callback() Funktion durchgeführt werden:

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

industrial_digital_in_4_v2_register_callback(&industrial_digital_in_4_v2,
                                             INDUSTRIAL_DIGITAL_IN_4_V2_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_V2_CALLBACK_VALUE¶

void callback(uint8_t channel, bool changed, bool value, void *user_data)

Callback-Parameter:	channel – Typ: uint8_t, Wertebereich: Siehe Konstanten changed – Typ: bool value – Typ: bool user_data – Typ: void *

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

Die Parameter sind der Kanal, Changed und der Wert. Der changed-Parameter ist True wenn sich der Wert seit dem letzten Callback geändert hat.

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

Für channel:

INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_0 = 0
INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_1 = 1
INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_2 = 2
INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_3 = 3

INDUSTRIAL_DIGITAL_IN_4_V2_CALLBACK_ALL_VALUE¶

void callback(bool changed[4], bool value[4], void *user_data)

Callback-Parameter:	changed – Typ: bool[4] value – Typ: bool[4] user_data – Typ: void *

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

Die Parameter sind der gleiche wie industrial_digital_in_4_v2_get_value(). Zusätzlich ist der changed-Parameter True wenn sich der Wert seit dem letzten Callback geändert hat.

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_v2_get_api_version(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t ret_api_version[3])¶

Parameter:	industrial_digital_in_4_v2 – Typ: IndustrialDigitalIn4V2 *
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_digital_in_4_v2_get_response_expected(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	industrial_digital_in_4_v2 – Typ: IndustrialDigitalIn4V2 * 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_digital_in_4_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_DIGITAL_IN_4_V2_FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION = 2
INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION = 4
INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 7
INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_CHANNEL_LED_CONFIG = 9
INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_RESET = 243
INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_WRITE_UID = 248

int industrial_digital_in_4_v2_set_response_expected(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t function_id, bool response_expected)¶

Parameter:	industrial_digital_in_4_v2 – Typ: IndustrialDigitalIn4V2 * 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.

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

Für function_id:

INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION = 2
INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION = 4
INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 7
INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_CHANNEL_LED_CONFIG = 9
INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_RESET = 243
INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_WRITE_UID = 248

int industrial_digital_in_4_v2_set_response_expected_all(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, bool response_expected)¶

Parameter:	industrial_digital_in_4_v2 – Typ: IndustrialDigitalIn4V2 * 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_digital_in_4_v2_set_bootloader_mode(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t mode, uint8_t *ret_status)¶

Parameter:	industrial_digital_in_4_v2 – Typ: IndustrialDigitalIn4V2 * 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_DIGITAL_IN_4_V2_BOOTLOADER_MODE_BOOTLOADER = 0
INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_MODE_FIRMWARE = 1
INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_STATUS_OK = 0
INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int industrial_digital_in_4_v2_get_bootloader_mode(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t *ret_mode)¶

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

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

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

Für ret_mode:

INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_MODE_BOOTLOADER = 0
INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_MODE_FIRMWARE = 1
INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int industrial_digital_in_4_v2_set_write_firmware_pointer(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint32_t pointer)¶

Parameter:	industrial_digital_in_4_v2 – Typ: IndustrialDigitalIn4V2 * pointer – Typ: uint32_t, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

Setzt den Firmware-Pointer für industrial_digital_in_4_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_digital_in_4_v2_write_firmware(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t data[64], uint8_t *ret_status)¶

Parameter:	industrial_digital_in_4_v2 – Typ: IndustrialDigitalIn4V2 * 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_digital_in_4_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_digital_in_4_v2_write_uid(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint32_t uid)¶

Parameter:	industrial_digital_in_4_v2 – Typ: IndustrialDigitalIn4V2 * uid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 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_digital_in_4_v2_read_uid(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint32_t *ret_uid)¶

Parameter:	industrial_digital_in_4_v2 – Typ: IndustrialDigitalIn4V2 *
Ausgabeparameter:	ret_uid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 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_DIGITAL_IN_4_V2_DEVICE_IDENTIFIER¶

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

Die industrial_digital_in_4_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_DIGITAL_IN_4_V2_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Industrial Digital In 4 Bricklet 2.0 dar.