Software / API Bindings / C/C++ / API Referenz und Beispiele / Bricklets / Color Bricklet

C/C++ - Color Bricklet¶

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

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_color.h"

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

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

    // Create device object
    Color c;
    color_create(&c, 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 color
    uint16_t r, g, b, c_;
    if(color_get_color(&c, &r, &g, &b, &c_) < 0) {
        fprintf(stderr, "Could not get color, probably timeout\n");
        return 1;
    }

    printf("Color [R]: %u\n", r);
    printf("Color [G]: %u\n", g);
    printf("Color [B]: %u\n", b);
    printf("Color [C]: %u\n", c_);

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

Callback¶

Download (example_callback.c)

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_color.h"

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

// Callback function for color callback
void cb_color(uint16_t r, uint16_t g, uint16_t b, uint16_t c, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Color [R]: %u\n", r);
    printf("Color [G]: %u\n", g);
    printf("Color [B]: %u\n", b);
    printf("Color [C]: %u\n", c);
    printf("\n");
}

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

    // Create device object
    Color c;
    color_create(&c, 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 color callback to function cb_color
    color_register_callback(&c,
                            COLOR_CALLBACK_COLOR,
                            (void (*)(void))cb_color,
                            NULL);

    // Set period for color callback to 1s (1000ms)
    // Note: The color callback is only called every second
    //       if the color has changed since the last call!
    color_set_color_callback_period(&c, 1000);

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

Threshold¶

Download (example_threshold.c)

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_color.h"

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

// Callback function for color reached callback
void cb_color_reached(uint16_t r, uint16_t g, uint16_t b, uint16_t c, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Color [R]: %u\n", r);
    printf("Color [G]: %u\n", g);
    printf("Color [B]: %u\n", b);
    printf("Color [C]: %u\n", c);
    printf("\n");
}

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

    // Create device object
    Color c;
    color_create(&c, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Get threshold callbacks with a debounce time of 10 seconds (10000ms)
    color_set_debounce_period(&c, 10000);

    // Register color reached callback to function cb_color_reached
    color_register_callback(&c,
                            COLOR_CALLBACK_COLOR_REACHED,
                            (void (*)(void))cb_color_reached,
                            NULL);

    // Configure threshold for color "greater than 100, 200, 300, 400"
    color_set_color_callback_threshold(&c, '>', 100, 0, 200, 0, 300, 0, 400, 0);

    printf("Press key to exit\n");
    getchar();
    color_destroy(&c);
    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 color_create(Color *color, const char *uid, IPConnection *ipcon)¶

Parameter:	color – Typ: Color * uid – Typ: const char * ipcon – Typ: IPConnection *

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

Color color;
color_create(&color, "YOUR_DEVICE_UID", &ipcon);

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

void color_destroy(Color *color)¶

Parameter:	color – Typ: Color *

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

int color_get_color(Color *color, uint16_t *ret_r, uint16_t *ret_g, uint16_t *ret_b, uint16_t *ret_c)¶

Parameter:	color – Typ: Color *
Ausgabeparameter:	ret_r – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] ret_g – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] ret_b – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] ret_c – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

Gibt die gemessene Farbe des Sensors zurück.

Die rot (r), grün (g), blau (b) und clear (c) werden mit vier unterschiedlichen Fotodioden gemessen. Diese sind Empfindlich in unterschiedlichen Wellenlängen:

Wenn die Farbe periodisch abgefragt werden soll, wird empfohlen den COLOR_CALLBACK_COLOR Callback zu nutzen und die Periode mit color_set_color_callback_period() vorzugeben.

int color_light_on(Color *color)¶

Parameter:	color – Typ: Color *
Rückgabe:	e_code – Typ: int

Aktiviert die LED.

int color_light_off(Color *color)¶

Parameter:	color – Typ: Color *
Rückgabe:	e_code – Typ: int

Deaktiviert die LED.

int color_is_light_on(Color *color, uint8_t *ret_light)¶

Parameter:	color – Typ: Color *
Ausgabeparameter:	ret_light – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 1
Rückgabe:	e_code – Typ: int

Gibt den Zustand der LED zurück. Mögliche Werte sind:

0: On
1: Off

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

Für ret_light:

COLOR_LIGHT_ON = 0
COLOR_LIGHT_OFF = 1

int color_set_config(Color *color, uint8_t gain, uint8_t integration_time)¶

Parameter:	color – Typ: Color * gain – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3 integration_time – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

Setzt die Konfiguration des Sensors. Verstärkung und Integrationszeit können eingestellt werden.

Für die Konfiguration der Verstärkung:

0: 1x Gain
1: 4x Gain
2: 16x Gain
3: 60x Gain

Für die Konfiguration der Integrationszeit:

0: 2,4ms
1: 24ms
2: 101ms
3: 154ms
4: 700ms

Eine Erhöhung der Verstärkung ermöglicht es dem Sensor Farben aus größeren Entfernungen zu erkennen.

Die Integrationszeit ist ein Trade-off zwischen Konvertierungszeit und Genauigkeit. Mit einer höheren Integrationszeit werden die Werte genauer, es dauert allerdings länger bis ein Resultat bereitsteht.

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

Für gain:

COLOR_GAIN_1X = 0
COLOR_GAIN_4X = 1
COLOR_GAIN_16X = 2
COLOR_GAIN_60X = 3

Für integration_time:

COLOR_INTEGRATION_TIME_2MS = 0
COLOR_INTEGRATION_TIME_24MS = 1
COLOR_INTEGRATION_TIME_101MS = 2
COLOR_INTEGRATION_TIME_154MS = 3
COLOR_INTEGRATION_TIME_700MS = 4

int color_get_config(Color *color, uint8_t *ret_gain, uint8_t *ret_integration_time)¶

Parameter:	color – Typ: Color *
Ausgabeparameter:	ret_gain – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3 ret_integration_time – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

Gibt die Einstellungen zurück, wie von color_set_config() gesetzt.

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

Für ret_gain:

COLOR_GAIN_1X = 0
COLOR_GAIN_4X = 1
COLOR_GAIN_16X = 2
COLOR_GAIN_60X = 3

Für ret_integration_time:

COLOR_INTEGRATION_TIME_2MS = 0
COLOR_INTEGRATION_TIME_24MS = 1
COLOR_INTEGRATION_TIME_101MS = 2
COLOR_INTEGRATION_TIME_154MS = 3
COLOR_INTEGRATION_TIME_700MS = 4

int color_get_illuminance(Color *color, uint32_t *ret_illuminance)¶

Parameter:	color – Typ: Color *
Ausgabeparameter:	ret_illuminance – Typ: uint32_t, Einheit: ? lx, Wertebereich: [0 bis 103438]
Rückgabe:	e_code – Typ: int

Gibt die Beleuchtungsstärke beeinflusst durch die Verstärkung und die Integrationszeit zurück. Verstärkung und Integrationszeit können mit color_set_config() eingestellt werden. Um die Beleuchtungsstärke in Lux zu ermitteln muss folgende Formel angewendet werden:

lux = illuminance * 700 / gain / integration_time

Für eine korrekte Messung der Beleuchtungsstärke muss sichergestellt sein, dass die Farbwerte (R, G oder B) nicht saturiert sind. Ein Farbwert ist saturiert wenn der Wert 65535 beträgt. In diesem Fall kann die Verstärkung per color_set_config() reduziert werden.

int color_get_color_temperature(Color *color, uint16_t *ret_color_temperature)¶

Parameter:	color – Typ: Color *
Ausgabeparameter:	ret_color_temperature – Typ: uint16_t, Einheit: 1 K, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

Gibt die Farbtemperatur zurück.

Für eine korrekte Messung der Farbtemperatur muss sichergestellt sein das die Farbwerte (R, G oder B) nicht saturiert sind. Ein Farbwert ist saturiert wenn der Wert 65535 beträgt. In diesem Fall kann die Verstärkung per color_set_config() reduziert werden.

Fortgeschrittene Funktionen¶

int color_get_identity(Color *color, 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:	color – Typ: Color *
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 color_register_callback(Color *color, int16_t callback_id, void (*function)(void), void *user_data)¶

Parameter:	color – Typ: Color * 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 color_set_color_callback_period(Color *color, uint32_t period)¶

Parameter:	color – Typ: Color * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

Setzt die Periode mit welcher der COLOR_CALLBACK_COLOR Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der COLOR_CALLBACK_COLOR Callback wird nur ausgelöst, wenn sich die Color seit der letzten Auslösung geändert hat.

int color_get_color_callback_period(Color *color, uint32_t *ret_period)¶

Parameter:	color – Typ: Color *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

Gibt die Periode zurück, wie von color_set_color_callback_period() gesetzt.

int color_set_color_callback_threshold(Color *color, char option, uint16_t min_r, uint16_t max_r, uint16_t min_g, uint16_t max_g, uint16_t min_b, uint16_t max_b, uint16_t min_c, uint16_t max_c)¶

Parameter:

Parameter:	color – Typ: Color * option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min_r – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 max_r – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 min_g – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 max_g – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 min_b – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 max_b – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 min_c – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 max_c – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

color – Typ: Color *
option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
min_r – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0
max_r – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0
min_g – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0
max_g – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0
min_b – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0
max_b – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0
min_c – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0
max_c – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0

Rückgabe:

e_code – Typ: int

Setzt den Schwellwert für den COLOR_CALLBACK_COLOR_REACHED Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Callback ist inaktiv
'o'	Callback wird ausgelöst, wenn die Temperatur außerhalb des min und max Wertes ist
'i'	Callback wird ausgelöst, wenn die Temperatur innerhalb des min und max Wertes ist
'<'	Callback wird ausgelöst, wenn die Temperatur kleiner als der min Wert ist (max wird ignoriert)
'>'	Callback wird ausgelöst, wenn die Temperatur größer als der min Wert ist (max wird ignoriert)

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

Für option:

COLOR_THRESHOLD_OPTION_OFF = 'x'
COLOR_THRESHOLD_OPTION_OUTSIDE = 'o'
COLOR_THRESHOLD_OPTION_INSIDE = 'i'
COLOR_THRESHOLD_OPTION_SMALLER = '<'
COLOR_THRESHOLD_OPTION_GREATER = '>'

int color_get_color_callback_threshold(Color *color, char *ret_option, uint16_t *ret_min_r, uint16_t *ret_max_r, uint16_t *ret_min_g, uint16_t *ret_max_g, uint16_t *ret_min_b, uint16_t *ret_max_b, uint16_t *ret_min_c, uint16_t *ret_max_c)¶

Parameter:	color – Typ: Color *
Ausgabeparameter:	ret_option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' ret_min_r – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 ret_max_r – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 ret_min_g – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 ret_max_g – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 ret_min_b – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 ret_max_b – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 ret_min_c – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 ret_max_c – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

Gibt den Schwellwert zurück, wie von color_set_color_callback_threshold() gesetzt.

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

Für ret_option:

COLOR_THRESHOLD_OPTION_OFF = 'x'
COLOR_THRESHOLD_OPTION_OUTSIDE = 'o'
COLOR_THRESHOLD_OPTION_INSIDE = 'i'
COLOR_THRESHOLD_OPTION_SMALLER = '<'
COLOR_THRESHOLD_OPTION_GREATER = '>'

int color_set_debounce_period(Color *color, uint32_t debounce)¶

Parameter:	color – Typ: Color * debounce – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 100
Rückgabe:	e_code – Typ: int

Setzt die Periode mit welcher die Schwellwert Callback

COLOR_CALLBACK_COLOR_REACHED

ausgelöst wird, wenn der Schwellwert

color_set_color_callback_threshold()

weiterhin erreicht bleibt.

int color_get_debounce_period(Color *color, uint32_t *ret_debounce)¶

Parameter:	color – Typ: Color *
Ausgabeparameter:	ret_debounce – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 100
Rückgabe:	e_code – Typ: int

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

int color_set_illuminance_callback_period(Color *color, uint32_t period)¶

Parameter:	color – Typ: Color * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

Setzt die Periode mit welcher der COLOR_CALLBACK_ILLUMINANCE Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der COLOR_CALLBACK_ILLUMINANCE Callback wird nur ausgelöst, wenn sich die Beleuchtungsstärke seit der letzten Auslösung geändert hat.

int color_get_illuminance_callback_period(Color *color, uint32_t *ret_period)¶

Parameter:	color – Typ: Color *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

Gibt die Periode zurück, wie von color_set_illuminance_callback_period() gesetzt.

int color_set_color_temperature_callback_period(Color *color, uint32_t period)¶

Parameter:	color – Typ: Color * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

Setzt die Periode mit welcher der COLOR_CALLBACK_COLOR_TEMPERATURE Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der COLOR_CALLBACK_COLOR_TEMPERATURE Callback wird nur ausgelöst, wenn sich die Farbtemperatur seit der letzten Auslösung geändert hat.

int color_get_color_temperature_callback_period(Color *color, uint32_t *ret_period)¶

Parameter:	color – Typ: Color *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

Gibt die Periode zurück, wie von color_set_color_temperature_callback_period() gesetzt.

Callbacks¶

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

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

color_register_callback(&color,
                        COLOR_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.

COLOR_CALLBACK_COLOR¶

void callback(uint16_t r, uint16_t g, uint16_t b, uint16_t c, void *user_data)

Callback-Parameter:	r – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] g – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] b – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] c – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] user_data – Typ: void *

Dieser Callback wird mit der Periode, wie gesetzt mit color_set_color_callback_period(), ausgelöst. Der Parameter ist die Farbe des Sensors als RGBC.

Der COLOR_CALLBACK_COLOR Callback wird nur ausgelöst, wenn sich die Farbe seit der letzten Auslösung geändert hat.

COLOR_CALLBACK_COLOR_REACHED¶

void callback(uint16_t r, uint16_t g, uint16_t b, uint16_t c, void *user_data)

Callback-Parameter:	r – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] g – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] b – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] c – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] user_data – Typ: void *

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von color_set_color_callback_threshold() gesetzt, erreicht wird. Der Parameter ist die Farbe des Sensors als RGBC.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit color_set_debounce_period() gesetzt, ausgelöst.

COLOR_CALLBACK_ILLUMINANCE¶

void callback(uint32_t illuminance, void *user_data)

Callback-Parameter:	illuminance – Typ: uint32_t, Einheit: ? lx, Wertebereich: [0 bis 103438] user_data – Typ: void *

Dieser Callback wird mit der Periode, wie gesetzt mit color_set_illuminance_callback_period(), ausgelöst. Der Parameter ist die Beleuchtungsstärke des Sensors. Siehe color_get_illuminance() für eine Erklärung wie dieser zu interpretieren ist.

Der COLOR_CALLBACK_ILLUMINANCE Callback wird nur ausgelöst, wenn sich die Beleuchtungsstärke seit der letzten Auslösung geändert hat.

COLOR_CALLBACK_COLOR_TEMPERATURE¶

void callback(uint16_t color_temperature, void *user_data)

Callback-Parameter:	color_temperature – Typ: uint16_t, Einheit: 1 K, Wertebereich: [0 bis 2¹⁶ - 1] user_data – Typ: void *

Dieser Callback wird mit der Periode, wie gesetzt mit color_set_color_temperature_callback_period(), ausgelöst. Der Parameter ist die Farbtemperatur des Sensors.

Der COLOR_CALLBACK_COLOR_TEMPERATURE Callback wird nur ausgelöst, wenn sich die Farbtemperatur seit der letzten Auslösung 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 color_get_api_version(Color *color, uint8_t ret_api_version[3])¶

Parameter:	color – Typ: Color *
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 color_get_response_expected(Color *color, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	color – Typ: Color * 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 color_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:

COLOR_FUNCTION_SET_COLOR_CALLBACK_PERIOD = 2
COLOR_FUNCTION_SET_COLOR_CALLBACK_THRESHOLD = 4
COLOR_FUNCTION_SET_DEBOUNCE_PERIOD = 6
COLOR_FUNCTION_LIGHT_ON = 10
COLOR_FUNCTION_LIGHT_OFF = 11
COLOR_FUNCTION_SET_CONFIG = 13
COLOR_FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 17
COLOR_FUNCTION_SET_COLOR_TEMPERATURE_CALLBACK_PERIOD = 19

int color_set_response_expected(Color *color, uint8_t function_id, bool response_expected)¶

Parameter:	color – Typ: Color * 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:

COLOR_FUNCTION_SET_COLOR_CALLBACK_PERIOD = 2
COLOR_FUNCTION_SET_COLOR_CALLBACK_THRESHOLD = 4
COLOR_FUNCTION_SET_DEBOUNCE_PERIOD = 6
COLOR_FUNCTION_LIGHT_ON = 10
COLOR_FUNCTION_LIGHT_OFF = 11
COLOR_FUNCTION_SET_CONFIG = 13
COLOR_FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 17
COLOR_FUNCTION_SET_COLOR_TEMPERATURE_CALLBACK_PERIOD = 19

int color_set_response_expected_all(Color *color, bool response_expected)¶

Parameter:	color – Typ: Color * 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¶

COLOR_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Color Bricklet zu identifizieren.

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

COLOR_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Color Bricklet dar.