C/C++ - Ambient Light Bricklet 3.0

Dies ist die Beschreibung der C/C++ API Bindings für das Ambient Light Bricklet 3.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Ambient Light Bricklet 3.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
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_ambient_light_v3.h"

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

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

    // Create device object
    AmbientLightV3 al;
    ambient_light_v3_create(&al, 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 Illuminance
    uint32_t illuminance;
    if(ambient_light_v3_get_illuminance(&al, &illuminance) < 0) {
        fprintf(stderr, "Could not get Illuminance, probably timeout\n");
        return 1;
    }

    printf("Illuminance: %f lx\n", illuminance/100.0);

    printf("Press key to exit\n");
    getchar();
    ambient_light_v3_destroy(&al);
    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
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_ambient_light_v3.h"

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

// Callback function for illuminance callback
void cb_illuminance(uint32_t illuminance, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Illuminance: %f lx\n", illuminance/100.0);
}

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

    // Create device object
    AmbientLightV3 al;
    ambient_light_v3_create(&al, 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 illuminance callback to function cb_illuminance
    ambient_light_v3_register_callback(&al,
                                       AMBIENT_LIGHT_V3_CALLBACK_ILLUMINANCE,
                                       (void (*)(void))cb_illuminance,
                                       NULL);

    // Set period for illuminance callback to 1s (1000ms) without a threshold
    ambient_light_v3_set_illuminance_callback_configuration(&al, 1000, false, 'x', 0, 0);

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

Threshold

Download (example_threshold.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_ambient_light_v3.h"

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

// Callback function for illuminance callback
void cb_illuminance(uint32_t illuminance, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Illuminance: %f lx\n", illuminance/100.0);
    printf("Too bright, close the curtains!\n");
}

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

    // Create device object
    AmbientLightV3 al;
    ambient_light_v3_create(&al, 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 illuminance callback to function cb_illuminance
    ambient_light_v3_register_callback(&al,
                                       AMBIENT_LIGHT_V3_CALLBACK_ILLUMINANCE,
                                       (void (*)(void))cb_illuminance,
                                       NULL);

    // Configure threshold for illuminance "greater than 500 lx"
    // with a debounce period of 1s (1000ms)
    ambient_light_v3_set_illuminance_callback_configuration(&al, 1000, false, '>', 500*100, 0);

    printf("Press key to exit\n");
    getchar();
    ambient_light_v3_destroy(&al);
    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 ambient_light_v3_create(AmbientLightV3 *ambient_light_v3, const char *uid, IPConnection *ipcon)

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

AmbientLightV3 ambient_light_v3;
ambient_light_v3_create(&ambient_light_v3, "YOUR_DEVICE_UID", &ipcon);

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

void ambient_light_v3_destroy(AmbientLightV3 *ambient_light_v3)

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

int ambient_light_v3_get_illuminance(AmbientLightV3 *ambient_light_v3, uint32_t *ret_illuminance)

Gibt die Beleuchtungsstärke des Umgebungslichtsensors zurück. Der Messbereich erstreckt sich bis über 100000Lux, aber ab 64000Lux nimmt die Messgenauigkeit ab. Die Beleuchtungsstärke ist in Lux/100 angegeben, d.h. bei einem Wert von 450000 wurde eine Beleuchtungsstärke von 4500Lux gemessen.

Eine Beleuchtungsstärke von 0Lux bedeutet, dass der Sensor gesättigt (saturated) ist und die Konfiguration angepasst werden sollte, siehe ambient_light_v3_set_configuration().

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

int ambient_light_v3_set_configuration(AmbientLightV3 *ambient_light_v3, uint8_t illuminance_range, uint8_t integration_time)

Setzt die Konfiguration. Es ist möglich den Helligkeitswertebereich zwischen 0-600Lux und 0-64000Lux sowie eine Integrationszeit zwischen 50ms und 400ms zu konfigurieren.

Der unbeschränkt (unlimited) Helligkeitswertebereich ermöglicht es bis über 100000Lux zu messen, aber ab 64000Lux nimmt die Messgenauigkeit ab.

Ein kleinerer Helligkeitswertebereich erhöht die Auflösung der Daten. Eine längere Integrationszeit verringert das Rauschen auf den Daten.

Wenn der eigentliche Messwert außerhalb des eingestellten Helligkeitswertebereichs liegt, dann geben ambient_light_v3_get_illuminance() und der AMBIENT_LIGHT_V3_CALLBACK_ILLUMINANCE Callback das Maximum des eingestellten Helligkeitswertebereichs +0,01Lux zurück. Also z.B. 800001 für den 0-8000Lux Bereich.

Bei einer langen Integrationszeit kann es sein, dass der Sensor gesättigt (saturated) ist bevor der Messwert das Maximum des ausgewählten Helligkeitswertebereichs erreicht hat. In diesem Fall geben ambient_light_v3_get_illuminance() und der AMBIENT_LIGHT_V3_CALLBACK_ILLUMINANCE Callback 0Lux zurück.

Wenn der Messwert außerhalb des eingestellten Helligkeitswertebereichs liegt oder der Sensor gesättigt ist, dann sollte der nächst höhere Helligkeitswertebereich eingestellt werden. Wenn der höchste Helligkeitswertebereich schon erreicht ist, dann kann noch die Integrationszeit verringert werden.

Die Standardwerte sind 0-8000Lux Helligkeitsbereich und 150ms Integrationszeit.

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

  • AMBIENT_LIGHT_V3_ILLUMINANCE_RANGE_UNLIMITED = 6
  • AMBIENT_LIGHT_V3_ILLUMINANCE_RANGE_64000LUX = 0
  • AMBIENT_LIGHT_V3_ILLUMINANCE_RANGE_32000LUX = 1
  • AMBIENT_LIGHT_V3_ILLUMINANCE_RANGE_16000LUX = 2
  • AMBIENT_LIGHT_V3_ILLUMINANCE_RANGE_8000LUX = 3
  • AMBIENT_LIGHT_V3_ILLUMINANCE_RANGE_1300LUX = 4
  • AMBIENT_LIGHT_V3_ILLUMINANCE_RANGE_600LUX = 5
  • AMBIENT_LIGHT_V3_INTEGRATION_TIME_50MS = 0
  • AMBIENT_LIGHT_V3_INTEGRATION_TIME_100MS = 1
  • AMBIENT_LIGHT_V3_INTEGRATION_TIME_150MS = 2
  • AMBIENT_LIGHT_V3_INTEGRATION_TIME_200MS = 3
  • AMBIENT_LIGHT_V3_INTEGRATION_TIME_250MS = 4
  • AMBIENT_LIGHT_V3_INTEGRATION_TIME_300MS = 5
  • AMBIENT_LIGHT_V3_INTEGRATION_TIME_350MS = 6
  • AMBIENT_LIGHT_V3_INTEGRATION_TIME_400MS = 7
int ambient_light_v3_get_configuration(AmbientLightV3 *ambient_light_v3, uint8_t *ret_illuminance_range, uint8_t *ret_integration_time)

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

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

  • AMBIENT_LIGHT_V3_ILLUMINANCE_RANGE_UNLIMITED = 6
  • AMBIENT_LIGHT_V3_ILLUMINANCE_RANGE_64000LUX = 0
  • AMBIENT_LIGHT_V3_ILLUMINANCE_RANGE_32000LUX = 1
  • AMBIENT_LIGHT_V3_ILLUMINANCE_RANGE_16000LUX = 2
  • AMBIENT_LIGHT_V3_ILLUMINANCE_RANGE_8000LUX = 3
  • AMBIENT_LIGHT_V3_ILLUMINANCE_RANGE_1300LUX = 4
  • AMBIENT_LIGHT_V3_ILLUMINANCE_RANGE_600LUX = 5
  • AMBIENT_LIGHT_V3_INTEGRATION_TIME_50MS = 0
  • AMBIENT_LIGHT_V3_INTEGRATION_TIME_100MS = 1
  • AMBIENT_LIGHT_V3_INTEGRATION_TIME_150MS = 2
  • AMBIENT_LIGHT_V3_INTEGRATION_TIME_200MS = 3
  • AMBIENT_LIGHT_V3_INTEGRATION_TIME_250MS = 4
  • AMBIENT_LIGHT_V3_INTEGRATION_TIME_300MS = 5
  • AMBIENT_LIGHT_V3_INTEGRATION_TIME_350MS = 6
  • AMBIENT_LIGHT_V3_INTEGRATION_TIME_400MS = 7

Fortgeschrittene Funktionen

int ambient_light_v3_get_api_version(AmbientLightV3 *ambient_light_v3, 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 ambient_light_v3_get_response_expected(AmbientLightV3 *ambient_light_v3, 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 ambient_light_v3_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:

  • AMBIENT_LIGHT_V3_FUNCTION_SET_ILLUMINANCE_CALLBACK_CONFIGURATION = 2
  • AMBIENT_LIGHT_V3_FUNCTION_SET_CONFIGURATION = 5
  • AMBIENT_LIGHT_V3_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • AMBIENT_LIGHT_V3_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • AMBIENT_LIGHT_V3_FUNCTION_RESET = 243
  • AMBIENT_LIGHT_V3_FUNCTION_WRITE_UID = 248
int ambient_light_v3_set_response_expected(AmbientLightV3 *ambient_light_v3, 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:

  • AMBIENT_LIGHT_V3_FUNCTION_SET_ILLUMINANCE_CALLBACK_CONFIGURATION = 2
  • AMBIENT_LIGHT_V3_FUNCTION_SET_CONFIGURATION = 5
  • AMBIENT_LIGHT_V3_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • AMBIENT_LIGHT_V3_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • AMBIENT_LIGHT_V3_FUNCTION_RESET = 243
  • AMBIENT_LIGHT_V3_FUNCTION_WRITE_UID = 248
int ambient_light_v3_set_response_expected_all(AmbientLightV3 *ambient_light_v3, bool response_expected)

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

int ambient_light_v3_get_spitfp_error_count(AmbientLightV3 *ambient_light_v3, 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 ambient_light_v3_set_bootloader_mode(AmbientLightV3 *ambient_light_v3, 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:

  • AMBIENT_LIGHT_V3_BOOTLOADER_MODE_BOOTLOADER = 0
  • AMBIENT_LIGHT_V3_BOOTLOADER_MODE_FIRMWARE = 1
  • AMBIENT_LIGHT_V3_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • AMBIENT_LIGHT_V3_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • AMBIENT_LIGHT_V3_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • AMBIENT_LIGHT_V3_BOOTLOADER_STATUS_OK = 0
  • AMBIENT_LIGHT_V3_BOOTLOADER_STATUS_INVALID_MODE = 1
  • AMBIENT_LIGHT_V3_BOOTLOADER_STATUS_NO_CHANGE = 2
  • AMBIENT_LIGHT_V3_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • AMBIENT_LIGHT_V3_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • AMBIENT_LIGHT_V3_BOOTLOADER_STATUS_CRC_MISMATCH = 5
int ambient_light_v3_get_bootloader_mode(AmbientLightV3 *ambient_light_v3, uint8_t *ret_mode)

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

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

  • AMBIENT_LIGHT_V3_BOOTLOADER_MODE_BOOTLOADER = 0
  • AMBIENT_LIGHT_V3_BOOTLOADER_MODE_FIRMWARE = 1
  • AMBIENT_LIGHT_V3_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • AMBIENT_LIGHT_V3_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • AMBIENT_LIGHT_V3_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
int ambient_light_v3_set_write_firmware_pointer(AmbientLightV3 *ambient_light_v3, uint32_t pointer)

Setzt den Firmware-Pointer für ambient_light_v3_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 ambient_light_v3_write_firmware(AmbientLightV3 *ambient_light_v3, uint8_t data[64], uint8_t *ret_status)

Schreibt 64 Bytes Firmware an die Position die vorher von ambient_light_v3_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 ambient_light_v3_set_status_led_config(AmbientLightV3 *ambient_light_v3, 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:

  • AMBIENT_LIGHT_V3_STATUS_LED_CONFIG_OFF = 0
  • AMBIENT_LIGHT_V3_STATUS_LED_CONFIG_ON = 1
  • AMBIENT_LIGHT_V3_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • AMBIENT_LIGHT_V3_STATUS_LED_CONFIG_SHOW_STATUS = 3
int ambient_light_v3_get_status_led_config(AmbientLightV3 *ambient_light_v3, uint8_t *ret_config)

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

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

  • AMBIENT_LIGHT_V3_STATUS_LED_CONFIG_OFF = 0
  • AMBIENT_LIGHT_V3_STATUS_LED_CONFIG_ON = 1
  • AMBIENT_LIGHT_V3_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • AMBIENT_LIGHT_V3_STATUS_LED_CONFIG_SHOW_STATUS = 3
int ambient_light_v3_get_chip_temperature(AmbientLightV3 *ambient_light_v3, 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 ambient_light_v3_reset(AmbientLightV3 *ambient_light_v3)

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 ambient_light_v3_write_uid(AmbientLightV3 *ambient_light_v3, 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 ambient_light_v3_read_uid(AmbientLightV3 *ambient_light_v3, 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 ambient_light_v3_get_identity(AmbientLightV3 *ambient_light_v3, 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 ambient_light_v3_register_callback(AmbientLightV3 *ambient_light_v3, 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 ambient_light_v3_set_illuminance_callback_configuration(AmbientLightV3 *ambient_light_v3, 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 AMBIENT_LIGHT_V3_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 AMBIENT_LIGHT_V3_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:

  • AMBIENT_LIGHT_V3_THRESHOLD_OPTION_OFF = 'x'
  • AMBIENT_LIGHT_V3_THRESHOLD_OPTION_OUTSIDE = 'o'
  • AMBIENT_LIGHT_V3_THRESHOLD_OPTION_INSIDE = 'i'
  • AMBIENT_LIGHT_V3_THRESHOLD_OPTION_SMALLER = '<'
  • AMBIENT_LIGHT_V3_THRESHOLD_OPTION_GREATER = '>'
int ambient_light_v3_get_illuminance_callback_configuration(AmbientLightV3 *ambient_light_v3, 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 ambient_light_v3_set_illuminance_callback_configuration() gesetzt.

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

  • AMBIENT_LIGHT_V3_THRESHOLD_OPTION_OFF = 'x'
  • AMBIENT_LIGHT_V3_THRESHOLD_OPTION_OUTSIDE = 'o'
  • AMBIENT_LIGHT_V3_THRESHOLD_OPTION_INSIDE = 'i'
  • AMBIENT_LIGHT_V3_THRESHOLD_OPTION_SMALLER = '<'
  • AMBIENT_LIGHT_V3_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 ambient_light_v3_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);
}

ambient_light_v3_register_callback(&ambient_light_v3, AMBIENT_LIGHT_V3_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.

AMBIENT_LIGHT_V3_CALLBACK_ILLUMINANCE
void callback(uint32_t illuminance, void *user_data)

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

Der Parameter ist der gleiche wie ambient_light_v3_get_illuminance().

Konstanten

AMBIENT_LIGHT_V3_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Ambient Light Bricklet 3.0 zu identifizieren.

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

AMBIENT_LIGHT_V3_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Ambient Light Bricklet 3.0 dar.