C/C++ - UV Light Bricklet¶

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_uv_light.h"

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

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

    // Create device object
    UVLight uvl;
    uv_light_create(&uvl, 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 UV light
    uint32_t uv_light;
    if(uv_light_get_uv_light(&uvl, &uv_light) < 0) {
        fprintf(stderr, "Could not get UV light, probably timeout\n");
        return 1;
    }

    printf("UV Light: %f mW/m²\n", uv_light/10.0);

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

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_uv_light.h"

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

// Callback function for UV light callback
void cb_uv_light(uint32_t uv_light, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("UV Light: %f mW/m²\n", uv_light/10.0);
}

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

    // Create device object
    UVLight uvl;
    uv_light_create(&uvl, 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 UV light callback to function cb_uv_light
    uv_light_register_callback(&uvl,
                               UV_LIGHT_CALLBACK_UV_LIGHT,
                               (void (*)(void))cb_uv_light,
                               NULL);

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

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

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_uv_light.h"

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

// Callback function for UV light reached callback
void cb_uv_light_reached(uint32_t uv_light, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("UV Light: %f mW/m²\n", uv_light/10.0);
    printf("UV Index > 3. Use sunscreen!\n");
}

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

    // Create device object
    UVLight uvl;
    uv_light_create(&uvl, 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)
    uv_light_set_debounce_period(&uvl, 10000);

    // Register UV light reached callback to function cb_uv_light_reached
    uv_light_register_callback(&uvl,
                               UV_LIGHT_CALLBACK_UV_LIGHT_REACHED,
                               (void (*)(void))cb_uv_light_reached,
                               NULL);

    // Configure threshold for UV light "greater than 75 mW/m²"
    uv_light_set_uv_light_callback_threshold(&uvl, '>', 75*10, 0);

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

Grundfunktionen¶

void uv_light_create(UVLight *uv_light, const char *uid, IPConnection *ipcon)¶

Parameter:	uv_light – Typ: UVLight * uid – Typ: const char * ipcon – Typ: IPConnection *

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

UVLight uv_light;
uv_light_create(&uv_light, "YOUR_DEVICE_UID", &ipcon);

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

void uv_light_destroy(UVLight *uv_light)¶

Parameter:	uv_light – Typ: UVLight *

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

int uv_light_get_uv_light(UVLight *uv_light, uint32_t *ret_uv_light)¶

Parameter:	uv_light – Typ: UVLight *
Ausgabeparameter:	ret_uv_light – Typ: uint32_t, Einheit: 1/10 mW/m², Wertebereich: [0 bis 3280]
Rückgabe:	e_code – Typ: int

Gibt die UV-Licht-Intensität des Sensors zurück. Der Sensor hat die Intensität bereits mit dem Erythem-Wirkungsspektrum gewichtet, um die hautbeeinflussende Bestrahlungsstärke zu bestimmen.

Die Intensität kann dann einfach durch 250 geteilt werden um den UV Index zu bestimmen. Beispiel: Eine UV-Licht-Intensität von 500 entspricht einem UV Index von 2.

Wenn die Intensität periodisch abgefragt werden soll, wird empfohlen den UV_LIGHT_CALLBACK_UV_LIGHT Callback zu nutzen und die Periode mit uv_light_set_uv_light_callback_period() vorzugeben.

Fortgeschrittene Funktionen¶

int uv_light_get_identity(UVLight *uv_light, 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:	uv_light – Typ: UVLight *
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 uv_light_register_callback(UVLight *uv_light, int16_t callback_id, void (*function)(void), void *user_data)¶

Parameter:	uv_light – Typ: UVLight * 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 uv_light_set_uv_light_callback_period(UVLight *uv_light, uint32_t period)¶

Parameter:	uv_light – Typ: UVLight * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

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

int uv_light_get_uv_light_callback_period(UVLight *uv_light, uint32_t *ret_period)¶

Parameter:	uv_light – Typ: UVLight *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

int uv_light_set_uv_light_callback_threshold(UVLight *uv_light, char option, uint32_t min, uint32_t max)¶

Parameter:	uv_light – Typ: UVLight * option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: uint32_t, Einheit: 1/10 mW/m², Wertebereich: [0 bis 232 - 1], Standardwert: 0 max – Typ: uint32_t, Einheit: 1/10 mW/m², Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

Setzt den Schwellwert für den UV_LIGHT_CALLBACK_UV_LIGHT_REACHED Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

• UV_LIGHT_THRESHOLD_OPTION_OFF = 'x'
• UV_LIGHT_THRESHOLD_OPTION_OUTSIDE = 'o'
• UV_LIGHT_THRESHOLD_OPTION_INSIDE = 'i'
• UV_LIGHT_THRESHOLD_OPTION_SMALLER = '<'
• UV_LIGHT_THRESHOLD_OPTION_GREATER = '>'

int uv_light_get_uv_light_callback_threshold(UVLight *uv_light, char *ret_option, uint32_t *ret_min, uint32_t *ret_max)¶

Parameter:	uv_light – Typ: UVLight *
Ausgabeparameter:	ret_option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' ret_min – Typ: uint32_t, Einheit: 1/10 mW/m², Wertebereich: [0 bis 232 - 1], Standardwert: 0 ret_max – Typ: uint32_t, Einheit: 1/10 mW/m², Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

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

Für ret_option:

• UV_LIGHT_THRESHOLD_OPTION_OFF = 'x'
• UV_LIGHT_THRESHOLD_OPTION_OUTSIDE = 'o'
• UV_LIGHT_THRESHOLD_OPTION_INSIDE = 'i'
• UV_LIGHT_THRESHOLD_OPTION_SMALLER = '<'
• UV_LIGHT_THRESHOLD_OPTION_GREATER = '>'

int uv_light_set_debounce_period(UVLight *uv_light, uint32_t debounce)¶

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

Setzt die Periode mit welcher die Schwellwert Callbacks

• UV_LIGHT_CALLBACK_UV_LIGHT_REACHED,

ausgelöst werden, wenn die Schwellwerte

• uv_light_set_uv_light_callback_threshold(),

weiterhin erreicht bleiben.

int uv_light_get_debounce_period(UVLight *uv_light, uint32_t *ret_debounce)¶

Parameter:	uv_light – Typ: UVLight *
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 uv_light_set_debounce_period() gesetzt.

Callbacks¶

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

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

uv_light_register_callback(&uv_light,
                           UV_LIGHT_CALLBACK_EXAMPLE,
                           (void (*)(void))my_callback,
                           NULL);

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

UV_LIGHT_CALLBACK_UV_LIGHT¶

void callback(uint32_t uv_light, void *user_data)

Callback-Parameter:	uv_light – Typ: uint32_t, Einheit: 1/10 mW/m², Wertebereich: [0 bis 32800000] user_data – Typ: void *

Dieser Callback wird mit der Periode, wie gesetzt mit uv_light_set_uv_light_callback_period(), ausgelöst. Der Parameter ist die UV-Licht-Intensität des Sensors.

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

UV_LIGHT_CALLBACK_UV_LIGHT_REACHED¶

void callback(uint32_t uv_light, void *user_data)

Callback-Parameter:	uv_light – Typ: uint32_t, Einheit: 1/10 mW/m², Wertebereich: [0 bis 32800000] user_data – Typ: void *

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von uv_light_set_uv_light_callback_threshold() gesetzt, erreicht wird. Der Parameter ist die UV-Licht-Intensität des Sensors.

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

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 uv_light_get_api_version(UVLight *uv_light, uint8_t ret_api_version[3])¶

Parameter:	uv_light – Typ: UVLight *
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 uv_light_get_response_expected(UVLight *uv_light, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	uv_light – Typ: UVLight * 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 uv_light_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:

• UV_LIGHT_FUNCTION_SET_UV_LIGHT_CALLBACK_PERIOD = 2
• UV_LIGHT_FUNCTION_SET_UV_LIGHT_CALLBACK_THRESHOLD = 4
• UV_LIGHT_FUNCTION_SET_DEBOUNCE_PERIOD = 6

int uv_light_set_response_expected(UVLight *uv_light, uint8_t function_id, bool response_expected)¶

Parameter:	uv_light – Typ: UVLight * 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:

• UV_LIGHT_FUNCTION_SET_UV_LIGHT_CALLBACK_PERIOD = 2
• UV_LIGHT_FUNCTION_SET_UV_LIGHT_CALLBACK_THRESHOLD = 4
• UV_LIGHT_FUNCTION_SET_DEBOUNCE_PERIOD = 6

int uv_light_set_response_expected_all(UVLight *uv_light, bool response_expected)¶

Parameter:	uv_light – Typ: UVLight * 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¶

UV_LIGHT_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein UV Light Bricklet zu identifizieren.

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

UV_LIGHT_DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines UV Light Bricklet dar.