C/C++ - Color Bricklet 2.0

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

 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
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_color_v2.h"

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

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

    // Create device object
    ColorV2 c;
    color_v2_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_v2_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_v2_destroy(&c);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

Callback

Download (example_callback.c)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_color_v2.h"

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

// 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
    ColorV2 c;
    color_v2_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_v2_register_callback(&c,
                               COLOR_V2_CALLBACK_COLOR,
                               (void (*)(void))cb_color,
                               NULL);

    // Set period for color callback to 0.1s (100ms)
    color_v2_set_color_callback_configuration(&c, 100, false);

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

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

void color_v2_create(ColorV2 *color_v2, const char *uid, IPConnection *ipcon)

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

ColorV2 color_v2;
color_v2_create(&color_v2, "YOUR_DEVICE_UID", &ipcon);

Dieses Geräteobjekt kann benutzt werden, nachdem die IP Connection verbunden wurde (siehe Beispiele oben).

void color_v2_destroy(ColorV2 *color_v2)

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

int color_v2_get_color(ColorV2 *color_v2, uint16_t *ret_r, uint16_t *ret_g, uint16_t *ret_b, uint16_t *ret_c)

Gibt die gemessene Farbe des Sensors zurück. Der Wertebereich ist von 0 bis 65535.

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

Chart Responsivity / Wavelength

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

int color_v2_get_illuminance(ColorV2 *color_v2, uint32_t *ret_illuminance)

Gibt die Beleuchtungsstärke beeinflusst durch die Verstärkung und die Integrationszeit zurück. Verstärkung und Integrationszeit können mit color_v2_set_configuration() 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_v2_set_configuration() reduziert werden.

Wenn der Wert periodisch benötigt wird, kann auch der COLOR_V2_CALLBACK_ILLUMINANCE Callback verwendet werden. Der Callback wird mit der Funktion color_v2_set_illuminance_callback_configuration() konfiguriert.

int color_v2_get_color_temperature(ColorV2 *color_v2, uint16_t *ret_color_temperature)

Gibt die Farbtemperatur in Kelvin zurück.

Für eine korrekte Messung der Farbtemperatur 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_v2_set_configuration() reduziert werden.

Wenn der Wert periodisch benötigt wird, kann auch der COLOR_V2_CALLBACK_COLOR_TEMPERATURE Callback verwendet werden. Der Callback wird mit der Funktion color_v2_set_color_temperature_callback_configuration() konfiguriert.

int color_v2_set_light(ColorV2 *color_v2, bool enable)

Aktiviert/deaktiviert die weiße LED auf dem Bricklet.

int color_v2_get_light(ColorV2 *color_v2, bool *ret_enable)

Gibt den Wert zurück, wie von color_v2_set_light() gesetzt.

int color_v2_set_configuration(ColorV2 *color_v2, uint8_t gain, uint8_t integration_time)

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 Standardwerte sind 60x Verstärkung und 154ms Integrationszeit.

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

  • COLOR_V2_GAIN_1X = 0
  • COLOR_V2_GAIN_4X = 1
  • COLOR_V2_GAIN_16X = 2
  • COLOR_V2_GAIN_60X = 3
  • COLOR_V2_INTEGRATION_TIME_2MS = 0
  • COLOR_V2_INTEGRATION_TIME_24MS = 1
  • COLOR_V2_INTEGRATION_TIME_101MS = 2
  • COLOR_V2_INTEGRATION_TIME_154MS = 3
  • COLOR_V2_INTEGRATION_TIME_700MS = 4
int color_v2_get_configuration(ColorV2 *color_v2, uint8_t *ret_gain, uint8_t *ret_integration_time)

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

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

  • COLOR_V2_GAIN_1X = 0
  • COLOR_V2_GAIN_4X = 1
  • COLOR_V2_GAIN_16X = 2
  • COLOR_V2_GAIN_60X = 3
  • COLOR_V2_INTEGRATION_TIME_2MS = 0
  • COLOR_V2_INTEGRATION_TIME_24MS = 1
  • COLOR_V2_INTEGRATION_TIME_101MS = 2
  • COLOR_V2_INTEGRATION_TIME_154MS = 3
  • COLOR_V2_INTEGRATION_TIME_700MS = 4

Fortgeschrittene Funktionen

int color_v2_get_api_version(ColorV2 *color_v2, uint8_t ret_api_version[3])

Gibt die Version der API Definition (Major, Minor, Revision) 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_v2_get_response_expected(ColorV2 *color_v2, uint8_t function_id, bool *ret_response_expected)

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_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:

  • COLOR_V2_FUNCTION_SET_COLOR_CALLBACK_CONFIGURATION = 2
  • COLOR_V2_FUNCTION_SET_ILLUMINANCE_CALLBACK_CONFIGURATION = 6
  • COLOR_V2_FUNCTION_SET_COLOR_TEMPERATURE_CALLBACK_CONFIGURATION = 10
  • COLOR_V2_FUNCTION_SET_LIGHT = 13
  • COLOR_V2_FUNCTION_SET_CONFIGURATION = 15
  • COLOR_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • COLOR_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • COLOR_V2_FUNCTION_RESET = 243
  • COLOR_V2_FUNCTION_WRITE_UID = 248
int color_v2_set_response_expected(ColorV2 *color_v2, uint8_t function_id, bool response_expected)

Ä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:

  • COLOR_V2_FUNCTION_SET_COLOR_CALLBACK_CONFIGURATION = 2
  • COLOR_V2_FUNCTION_SET_ILLUMINANCE_CALLBACK_CONFIGURATION = 6
  • COLOR_V2_FUNCTION_SET_COLOR_TEMPERATURE_CALLBACK_CONFIGURATION = 10
  • COLOR_V2_FUNCTION_SET_LIGHT = 13
  • COLOR_V2_FUNCTION_SET_CONFIGURATION = 15
  • COLOR_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • COLOR_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • COLOR_V2_FUNCTION_RESET = 243
  • COLOR_V2_FUNCTION_WRITE_UID = 248
int color_v2_set_response_expected_all(ColorV2 *color_v2, bool response_expected)

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

int color_v2_get_spitfp_error_count(ColorV2 *color_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)

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 color_v2_set_bootloader_mode(ColorV2 *color_v2, uint8_t mode, uint8_t *ret_status)

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 Bootlodaer- 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:

  • COLOR_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • COLOR_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • COLOR_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • COLOR_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • COLOR_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • COLOR_V2_BOOTLOADER_STATUS_OK = 0
  • COLOR_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
  • COLOR_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
  • COLOR_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • COLOR_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • COLOR_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5
int color_v2_get_bootloader_mode(ColorV2 *color_v2, uint8_t *ret_mode)

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

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

  • COLOR_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • COLOR_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • COLOR_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • COLOR_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • COLOR_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
int color_v2_set_write_firmware_pointer(ColorV2 *color_v2, uint32_t pointer)

Setzt den Firmware-Pointer für color_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 color_v2_write_firmware(ColorV2 *color_v2, uint8_t data[64], uint8_t *ret_status)

Schreibt 64 Bytes Firmware an die Position die vorher von color_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 color_v2_set_status_led_config(ColorV2 *color_v2, uint8_t config)

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:

  • COLOR_V2_STATUS_LED_CONFIG_OFF = 0
  • COLOR_V2_STATUS_LED_CONFIG_ON = 1
  • COLOR_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • COLOR_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
int color_v2_get_status_led_config(ColorV2 *color_v2, uint8_t *ret_config)

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

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

  • COLOR_V2_STATUS_LED_CONFIG_OFF = 0
  • COLOR_V2_STATUS_LED_CONFIG_ON = 1
  • COLOR_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • COLOR_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
int color_v2_get_chip_temperature(ColorV2 *color_v2, int16_t *ret_temperature)

Gibt die Temperatur in °C, 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 color_v2_reset(ColorV2 *color_v2)

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 color_v2_write_uid(ColorV2 *color_v2, uint32_t uid)

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 color_v2_read_uid(ColorV2 *color_v2, uint32_t *ret_uid)

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

int color_v2_get_identity(ColorV2 *color_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)

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 kann 'a', 'b', 'c' oder 'd' sein.

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_v2_register_callback(ColorV2 *color_v2, int16_t callback_id, void (*function)(void), void *user_data)

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_v2_set_color_callback_configuration(ColorV2 *color_v2, uint32_t period, bool value_has_to_change)

Die Periode in ms ist die Periode mit der der COLOR_V2_CALLBACK_COLOR 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.

Der Standardwert ist (0, false).

int color_v2_get_color_callback_configuration(ColorV2 *color_v2, uint32_t *ret_period, bool *ret_value_has_to_change)

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

int color_v2_set_illuminance_callback_configuration(ColorV2 *color_v2, uint32_t period, bool value_has_to_change, char option, uint32_t min, uint32_t max)

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

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

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

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter`zusammen mit min/max setzt einen Threshold für den COLOR_V2_CALLBACK_ILLUMINANCE Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

Der Standardwert ist (0, false, 'x', 0, 0).

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

  • COLOR_V2_THRESHOLD_OPTION_OFF = 'x'
  • COLOR_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • COLOR_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • COLOR_V2_THRESHOLD_OPTION_SMALLER = '<'
  • COLOR_V2_THRESHOLD_OPTION_GREATER = '>'
int color_v2_get_illuminance_callback_configuration(ColorV2 *color_v2, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, uint32_t *ret_min, uint32_t *ret_max)

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

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

  • COLOR_V2_THRESHOLD_OPTION_OFF = 'x'
  • COLOR_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • COLOR_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • COLOR_V2_THRESHOLD_OPTION_SMALLER = '<'
  • COLOR_V2_THRESHOLD_OPTION_GREATER = '>'
int color_v2_set_color_temperature_callback_configuration(ColorV2 *color_v2, uint32_t period, bool value_has_to_change, char option, uint16_t min, uint16_t max)

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

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

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

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter`zusammen mit min/max setzt einen Threshold für den COLOR_V2_CALLBACK_COLOR_TEMPERATURE Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

Der Standardwert ist (0, false, 'x', 0, 0).

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

  • COLOR_V2_THRESHOLD_OPTION_OFF = 'x'
  • COLOR_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • COLOR_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • COLOR_V2_THRESHOLD_OPTION_SMALLER = '<'
  • COLOR_V2_THRESHOLD_OPTION_GREATER = '>'
int color_v2_get_color_temperature_callback_configuration(ColorV2 *color_v2, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, uint16_t *ret_min, uint16_t *ret_max)

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

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

  • COLOR_V2_THRESHOLD_OPTION_OFF = 'x'
  • COLOR_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • COLOR_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • COLOR_V2_THRESHOLD_OPTION_SMALLER = '<'
  • COLOR_V2_THRESHOLD_OPTION_GREATER = '>'

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion color_v2_register_callback() durchgeführt werden. Die Parameter bestehen aus dem Geräteobjekt, der Callback ID, der Callback Funktion und optionalen Benutzer Daten:

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

color_v2_register_callback(&color_v2, COLOR_V2_CALLBACK_EXAMPLE, (void (*)(void))my_callback, NULL);

Die verfügbaren IDs mit den zugehörigen Callback 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_V2_CALLBACK_COLOR
void callback(uint16_t r, uint16_t g, uint16_t b, uint16_t c, void *user_data)

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

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

COLOR_V2_CALLBACK_ILLUMINANCE
void callback(uint32_t illuminance, void *user_data)

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

Der Parameter ist der gleiche wie color_v2_get_illuminance().

COLOR_V2_CALLBACK_COLOR_TEMPERATURE
void callback(uint16_t color_temperature, void *user_data)

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

Der Parameter ist der gleiche wie color_v2_get_color_temperature().

Konstanten

COLOR_V2_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Color Bricklet 2.0 zu identifizieren.

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

COLOR_V2_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Color Bricklet 2.0 dar.