C/C++ - IO-16 Bricklet¶

Output¶

Download (example_output.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

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_io16.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your IO-16 Bricklet

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

    // Create device object
    IO16 io;
    io16_create(&io, 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

    // Set pin 0 on port A to output low
    io16_set_port_configuration(&io, 'a', 1 << 0, 'o', false);

    // Set pin 0 and 7 on port B to output high
    io16_set_port_configuration(&io, 'b', (1 << 0) | (1 << 7), 'o', true);

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

Input¶

Download (example_input.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_io16.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your IO-16 Bricklet

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

    // Create device object
    IO16 io;
    io16_create(&io, 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 from port A as bitmask
    uint8_t value_mask_a;
    if(io16_get_port(&io, 'a', &value_mask_a) < 0) {
        fprintf(stderr, "Could not get value from port A as bitmask, probably timeout\n");
        return 1;
    }

    printf("Value Mask (Port A): %u\n", value_mask_a);

    // Get current value from port B as bitmask
    uint8_t value_mask_b;
    if(io16_get_port(&io, 'b', &value_mask_b) < 0) {
        fprintf(stderr, "Could not get value from port B as bitmask, probably timeout\n");
        return 1;
    }

    printf("Value Mask (Port B): %u\n", value_mask_b);

    printf("Press key to exit\n");
    getchar();
    io16_destroy(&io);
    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
50
51

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_io16.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your IO-16 Bricklet

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

    printf("Port: %c\n", port);
    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
    IO16 io;
    io16_create(&io, 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
    io16_register_callback(&io,
                           IO16_CALLBACK_INTERRUPT,
                           (void (*)(void))cb_interrupt,
                           NULL);

    // Enable interrupt on pin 2 of port A
    io16_set_port_interrupt(&io, 'a', 1 << 2);

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

Grundfunktionen¶

void io16_create(IO16 *io16, const char *uid, IPConnection *ipcon)¶

Parameter:	io16 – Typ: IO16 * uid – Typ: const char * ipcon – Typ: IPConnection *

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

IO16 io16;
io16_create(&io16, "YOUR_DEVICE_UID", &ipcon);

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

void io16_destroy(IO16 *io16)¶

Parameter:	io16 – Typ: IO16 *

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

int io16_set_port(IO16 *io16, char port, uint8_t value_mask)¶

Parameter:	io16 – Typ: IO16 * port – Typ: char, Wertebereich: ['a' bis 'b'] value_mask – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Setzt den Ausgangszustand (logisch 1 oder logisch 0) für einen Port ("a" oder "b") mittels einer Bitmaske (8Bit). Eine 1 in der Bitmaske bedeutet logisch 1 und eine 0 in der Bitmaske bedeutet logisch 0.

Beispiel: Der Wert 15 bzw. 0b00001111 setzt die Pins 0-3 auf logisch 1 und die Pins 4-7 auf logisch 0.

Alle laufenden Monoflop Timer für den angegebenen Port werden abgebrochen, wenn diese Funktion aufgerufen wird.

Bemerkung

Diese Funktion bewirkt keine Änderung an Pins die als Eingang konfiguriert sind. Pull-Up Widerstände können mit io16_set_port_configuration() zugeschaltet werden.

int io16_get_port(IO16 *io16, char port, uint8_t *ret_value_mask)¶

Parameter:	io16 – Typ: IO16 * port – Typ: char, Wertebereich: ['a' bis 'b']
Ausgabeparameter:	ret_value_mask – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Gibt eine Bitmaske der aktuell gemessenen Zustände des gewählten Ports zurück. Diese Funktion gibt die Zustände aller Pins zurück, unabhängig ob diese als Ein- oder Ausgang konfiguriert sind.

int io16_set_port_configuration(IO16 *io16, char port, uint8_t selection_mask, char direction, bool value)¶

Parameter:	io16 – Typ: IO16 * port – Typ: char, Wertebereich: ['a' bis 'b'] selection_mask – Typ: uint8_t, Wertebereich: [0 bis 255] direction – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'i' value – Typ: bool, Standardwert: true
Rückgabe:	e_code – Typ: int

Konfiguriert den Zustand und die Richtung des angegebenen Ports. Mögliche Richtungen sind 'i' und 'o' für Ein- und Ausgang.

Wenn die Richtung als Ausgang konfiguriert ist, ist der Zustand entweder logisch 1 oder logisch 0 (gesetzt als true oder false).

Wenn die Richtung als Eingang konfiguriert ist, ist der Zustand entweder Pull-Up oder Standard (gesetzt als true oder false).

Beispiele:

• ('a', 255, 'i', true) bzw. ('a', 0b11111111, 'i', true) setzt alle Pins des Ports a als Eingang mit Pull-Up.
• ('a', 128, 'i', false) bzw. ('a', 0b10000000, 'i', false) setzt Pin 7 des Ports A als Standard Eingang (potentialfrei wenn nicht verbunden).
• ('b', 3, 'o', false) bzw. ('b', 0b00000011, 'o', false) setzt die Pins 0 und 1 des Ports B als Ausgang im Zustand logisch 0.
• ('b', 4, 'o', true) bzw. ('b', 0b00000100, 'o', true) setzt Pin 2 des Ports B als Ausgang im Zustand logisch 1.

Laufende Monoflop Timer für die ausgewählten Pins werden abgebrochen, wenn diese Funktion aufgerufen wird.

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

Für direction:

• IO16_DIRECTION_IN = 'i'
• IO16_DIRECTION_OUT = 'o'

int io16_get_port_configuration(IO16 *io16, char port, uint8_t *ret_direction_mask, uint8_t *ret_value_mask)¶

Parameter:	io16 – Typ: IO16 * port – Typ: char, Wertebereich: ['a' bis 'b']
Ausgabeparameter:	ret_direction_mask – Typ: uint8_t, Wertebereich: [0 bis 255] ret_value_mask – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Gibt eine Bitmaske für die Richtung und eine Bitmaske für den Zustand der Pins des gewählten Ports zurück. Eine 1 in der Bitmaske für die Richtung bedeutet Eingang und eine 0 in der Bitmaske bedeutet Ausgang.

Beispiel: Ein Rückgabewert von (15, 51) bzw. (0b00001111, 0b00110011) für Richtung und Zustand bedeutet:

• Pin 0 und 1 sind als Eingang mit Pull-Up konfiguriert,
• Pin 2 und 3 sind als Standard Eingang konfiguriert,
• Pin 4 und 5 sind als Ausgang im Zustand logisch 1 konfiguriert
• und Pin 6 und 7 sind als Ausgang im Zustand logisch 0 konfiguriert.

int io16_get_edge_count(IO16 *io16, uint8_t pin, bool reset_counter, uint32_t *ret_count)¶

Parameter:	io16 – Typ: IO16 * pin – Typ: uint8_t, Wertebereich: [0 bis 1] reset_counter – Typ: bool
Ausgabeparameter:	ret_count – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:	e_code – Typ: int

Gibt den aktuellen Wert des Flankenzählers für den ausgewählten Pin von Port A zurück. Die zu zählenden Flanken können mit io16_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.

Neu in Version 2.0.3 (Plugin).

Fortgeschrittene Funktionen¶

int io16_set_port_monoflop(IO16 *io16, char port, uint8_t selection_mask, uint8_t value_mask, uint32_t time)¶

Parameter:	io16 – Typ: IO16 * port – Typ: char, Wertebereich: ['a' bis 'b'] selection_mask – Typ: uint8_t, Wertebereich: [0 bis 255] value_mask – Typ: uint8_t, Wertebereich: [0 bis 255] time – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]
Rückgabe:	e_code – Typ: int

Konfiguriert einen Monoflop für die Pins, wie mittels der 8 Bit langen Bitmaske des zweiten Parameters festgelegt. Die festgelegten Pins müssen als Ausgänge konfiguriert sein. Als Eingänge konfigurierte Pins werden ignoriert.

Der dritte Parameter ist eine Bitmaske mit den gewünschten Zuständen der festgelegten Ausgangspins. Eine 1 in der Bitmaske bedeutet logisch 1 und eine 0 in der Bitmaske bedeutet logisch 0.

Der vierte Parameter stellt die Zeit dar, welche die Pins den Zustand halten sollen.

Wenn diese Funktion mit den Parametern ('a', 9, 1, 1500) bzw. ('a', 0b00001001, 0b00000001, 1500) aufgerufen wird: Pin 0 wird auf logisch 1 und Pin 3 auf logisch 0 am Port 'a' gesetzt. Nach 1,5s wird Pin 0 wieder logisch 0 und Pin 3 logisch 1 gesetzt.

Ein Monoflop kann zur Ausfallsicherung verwendet werden. Beispiel: Angenommen ein RS485 Bus und ein IO-16 Bricklet ist an ein Slave Stapel verbunden. Jetzt kann diese Funktion sekündlich, mit einem Zeitparameter von 2 Sekunden, aufgerufen werden. Der Pin wird die gesamte Zeit im Zustand logisch 1 sein. Wenn jetzt die RS485 Verbindung getrennt wird, wird der Pin nach spätestens zwei Sekunden in den Zustand logisch 0 wechseln.

int io16_get_port_monoflop(IO16 *io16, char port, uint8_t pin, uint8_t *ret_value, uint32_t *ret_time, uint32_t *ret_time_remaining)¶

Parameter:	io16 – Typ: IO16 * port – Typ: char, Wertebereich: ['a' bis 'b'] pin – Typ: uint8_t, Wertebereich: [0 bis 7]
Ausgabeparameter:	ret_value – Typ: uint8_t, Wertebereich: [0 bis 255] ret_time – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1] ret_time_remaining – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]
Rückgabe:	e_code – Typ: int

Gibt (für den angegebenen Pin) den aktuellen Zustand und die Zeit, wie von io16_set_port_monoflop() gesetzt, sowie die noch verbleibende Zeit bis zum Zustandswechsel, zurück.

Wenn der Timer aktuell nicht läuft, ist die noch verbleibende Zeit 0.

int io16_set_selected_values(IO16 *io16, char port, uint8_t selection_mask, uint8_t value_mask)¶

Parameter:	io16 – Typ: IO16 * port – Typ: char, Wertebereich: ['a' bis 'b'] selection_mask – Typ: uint8_t, Wertebereich: [0 bis 255] value_mask – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Setzt den Ausgangszustand (logisch 1 oder logisch 0) mittels einer Bitmaske, entsprechend der Selektionsmaske. Die Bitmaske hat eine Länge von 8 Bit und eine 1 in der Bitmaske bedeutet logisch 1 und eine 0 in der Bitmaske bedeutet logisch 0.

Beispiel: Die Parameter ('a', 192, 128) bzw. ('a', 0b11000000, 0b10000000) setzen den Pin 7 auf logisch 1 und den Pin 6 auf logisch 0 an Port A. Die Pins 0-6 bleiben unangetastet.

Laufende Monoflop Timer für die ausgewählten Pins werden abgebrochen, wenn diese Funktion aufgerufen wird.

Bemerkung

Diese Funktion bewirkt keine Änderung an Pins die als Eingang konfiguriert sind. Pull-Up Widerstände können mit io16_set_port_configuration() zugeschaltet werden.

int io16_set_edge_count_config(IO16 *io16, uint8_t pin, uint8_t edge_type, uint8_t debounce)¶

Parameter:	io16 – Typ: IO16 * pin – Typ: uint8_t, Wertebereich: [0 bis 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:	e_code – Typ: int

Konfiguriert den Flankenzähler für den ausgewählten Pin von Port A. Der Flankenzähler steht für Pins 0 und 1 zur Verfügung.

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 folgenden Konstanten sind für diese Funktion verfügbar:

Für edge_type:

• IO16_EDGE_TYPE_RISING = 0
• IO16_EDGE_TYPE_FALLING = 1
• IO16_EDGE_TYPE_BOTH = 2

Neu in Version 2.0.3 (Plugin).

int io16_get_edge_count_config(IO16 *io16, uint8_t pin, uint8_t *ret_edge_type, uint8_t *ret_debounce)¶

Parameter:	io16 – Typ: IO16 * pin – Typ: uint8_t, Wertebereich: [0 bis 1]
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 Pin von Port A zurück, wie von io16_set_edge_count_config() gesetzt.

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

Für ret_edge_type:

• IO16_EDGE_TYPE_RISING = 0
• IO16_EDGE_TYPE_FALLING = 1
• IO16_EDGE_TYPE_BOTH = 2

Neu in Version 2.0.3 (Plugin).

int io16_get_identity(IO16 *io16, 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:	io16 – Typ: IO16 *
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 io16_register_callback(IO16 *io16, int16_t callback_id, void (*function)(void), void *user_data)¶

Parameter:	io16 – Typ: IO16 * 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 io16_set_debounce_period(IO16 *io16, uint32_t debounce)¶

Parameter:	io16 – Typ: IO16 * debounce – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Rückgabe:	e_code – Typ: int

Setzt die Entprellperiode der IO16_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 IO-16 Bricklet angeschlossen ist, wie z.B. eine Taste.

int io16_get_debounce_period(IO16 *io16, uint32_t *ret_debounce)¶

Parameter:	io16 – Typ: IO16 *
Ausgabeparameter:	ret_debounce – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Rückgabe:	e_code – Typ: int

Gibt die Entprellperiode zurück, wie von io16_set_debounce_period() gesetzt.

int io16_set_port_interrupt(IO16 *io16, char port, uint8_t interrupt_mask)¶

Parameter:	io16 – Typ: IO16 * port – Typ: char, Wertebereich: ['a' bis 'b'] interrupt_mask – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_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: ('a', 129) bzw. ('a', 0b10000001) aktiviert den Interrupt für die Pins 0 und 7 des Ports a.

Der Interrupt wird mit dem IO16_CALLBACK_INTERRUPT Callback zugestellt.

int io16_get_port_interrupt(IO16 *io16, char port, uint8_t *ret_interrupt_mask)¶

Parameter:	io16 – Typ: IO16 * port – Typ: char, Wertebereich: ['a' bis 'b']
Ausgabeparameter:	ret_interrupt_mask – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Gibt die Interrupt Bitmaske für den angegebenen Port zurück, wie von io16_set_port_interrupt() gesetzt.

Callbacks¶

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

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

io16_register_callback(&io16,
                       IO16_CALLBACK_EXAMPLE,
                       (void (*)(void))my_callback,
                       NULL);

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

IO16_CALLBACK_INTERRUPT¶

void callback(char port, uint8_t interrupt_mask, uint8_t value_mask, void *user_data)

Callback-Parameter:	port – Typ: char, Wertebereich: ['a' bis 'b'] interrupt_mask – Typ: uint8_t, Wertebereich: [0 bis 255] value_mask – Typ: uint8_t, Wertebereich: [0 bis 255] user_data – Typ: void *

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

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

Beispiele:

• ('a', 1, 1) bzw. ('a', 0b00000001, 0b00000001) bedeutet, dass an Port A ein Interrupt am Pin 0 aufgetreten ist und aktuell ist Pin 0 logisch 1 und die Pins 1-7 sind logisch 0.
• ('b', 129, 254) bzw. ('b', 0b10000001, 0b11111110) bedeutet, dass an Port B Interrupts an den Pins 0 und 7 aufgetreten sind und aktuell ist Pin 0 logisch 0 und die Pins 1-7 sind logisch 1.

IO16_CALLBACK_MONOFLOP_DONE¶

void callback(char port, uint8_t selection_mask, uint8_t value_mask, void *user_data)

Callback-Parameter:	port – Typ: char, Wertebereich: ['a' bis 'b'] selection_mask – Typ: uint8_t, Wertebereich: [0 bis 255] value_mask – Typ: uint8_t, Wertebereich: [0 bis 255] user_data – Typ: void *

Dieser Callback wird ausgelöst, wenn ein Monoflop Timer abläuft (0 erreicht). Parameter enthalten den Port, die beteiligten Pins als Bitmaske und den aktuellen Zustand als Bitmaske (der Zustand nach dem Monoflop).

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 io16_get_api_version(IO16 *io16, uint8_t ret_api_version[3])¶

Parameter:	io16 – Typ: IO16 *
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 io16_get_response_expected(IO16 *io16, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	io16 – Typ: IO16 * 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 io16_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:

• IO16_FUNCTION_SET_PORT = 1
• IO16_FUNCTION_SET_PORT_CONFIGURATION = 3
• IO16_FUNCTION_SET_DEBOUNCE_PERIOD = 5
• IO16_FUNCTION_SET_PORT_INTERRUPT = 7
• IO16_FUNCTION_SET_PORT_MONOFLOP = 10
• IO16_FUNCTION_SET_SELECTED_VALUES = 13
• IO16_FUNCTION_SET_EDGE_COUNT_CONFIG = 15

int io16_set_response_expected(IO16 *io16, uint8_t function_id, bool response_expected)¶

Parameter:	io16 – Typ: IO16 * 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:

• IO16_FUNCTION_SET_PORT = 1
• IO16_FUNCTION_SET_PORT_CONFIGURATION = 3
• IO16_FUNCTION_SET_DEBOUNCE_PERIOD = 5
• IO16_FUNCTION_SET_PORT_INTERRUPT = 7
• IO16_FUNCTION_SET_PORT_MONOFLOP = 10
• IO16_FUNCTION_SET_SELECTED_VALUES = 13
• IO16_FUNCTION_SET_EDGE_COUNT_CONFIG = 15

int io16_set_response_expected_all(IO16 *io16, bool response_expected)¶

Parameter:	io16 – Typ: IO16 * 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.

Konstanten¶

IO16_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein IO-16 Bricklet zu identifizieren.

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

IO16_DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines IO-16 Bricklet dar.