C/C++ - Moisture Bricklet

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

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

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

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

    // Create device object
    Moisture m;
    moisture_create(&m, 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 moisture value
    uint16_t moisture;
    if(moisture_get_moisture_value(&m, &moisture) < 0) {
        fprintf(stderr, "Could not get moisture value, probably timeout\n");
        return 1;
    }

    printf("Moisture Value: %u\n", moisture);

    printf("Press key to exit\n");
    getchar();
    moisture_destroy(&m);
    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_moisture.h"

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

// Callback function for moisture value callback
void cb_moisture(uint16_t moisture, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Moisture Value: %u\n", moisture);
}

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

    // Create device object
    Moisture m;
    moisture_create(&m, 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 moisture value callback to function cb_moisture
    moisture_register_callback(&m,
                               MOISTURE_CALLBACK_MOISTURE,
                               (void *)cb_moisture,
                               NULL);

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

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

#include "ip_connection.h"
#include "bricklet_moisture.h"

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

// Callback function for moisture value reached callback
void cb_moisture_reached(uint16_t moisture, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Moisture Value: %u\n", moisture);
}

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

    // Create device object
    Moisture m;
    moisture_create(&m, 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 1 second (1000ms)
    moisture_set_debounce_period(&m, 1000);

    // Register moisture value reached callback to function cb_moisture_reached
    moisture_register_callback(&m,
                               MOISTURE_CALLBACK_MOISTURE_REACHED,
                               (void *)cb_moisture_reached,
                               NULL);

    // Configure threshold for moisture value "greater than 200"
    moisture_set_moisture_callback_threshold(&m, '>', 200, 0);

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

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

void moisture_create(Moisture *moisture, const char *uid, IPConnection *ipcon)

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

Moisture moisture;
moisture_create(&moisture, "YOUR_DEVICE_UID", &ipcon);

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

void moisture_destroy(Moisture *moisture)

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

int moisture_get_moisture_value(Moisture *moisture, uint16_t *ret_moisture)

Gibt den aktuellen Feuchtigkeitswert zurück. Der Wert hat einen Wertebereich von 0 bis 4095. Ein kleiner Wert entspricht einer geringen Feuchtigkeit, ein großer Wert entspricht einer hohen Feuchtigkeit.

Wenn der Feuchtigkeitswert periodisch abgefragt werden soll, wird empfohlen den MOISTURE_CALLBACK_MOISTURE Callback zu nutzen und die Periode mit moisture_set_moisture_callback_period() vorzugeben.

Fortgeschrittene Funktionen

int moisture_set_moving_average(Moisture *moisture, uint8_t average)

Setzt die Länge eines gleitenden Mittelwerts für den Feuchtigkeitswert.

Wenn die Länge auf 0 gesetzt wird, ist das Averaging komplett aus. Desto kleiner die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

Der Wertebereich liegt bei 0-100.

Der Standardwert ist 100.

int moisture_get_moving_average(Moisture *moisture, uint8_t *ret_average)

Gibt die Länge des gleitenden Mittelwerts zurück, wie von moisture_set_moving_average() gesetzt.

int moisture_get_api_version(Moisture *moisture, 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 moisture_get_response_expected(Moisture *moisture, 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 moisture_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.

Siehe moisture_set_response_expected() für die Liste der verfügbaren Funktions ID Defines für diese Funktion.

int moisture_set_response_expected(Moisture *moisture, 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 Funktions ID Defines sind für diese Funktion verfügbar:

  • MOISTURE_FUNCTION_SET_MOISTURE_CALLBACK_PERIOD = 2
  • MOISTURE_FUNCTION_SET_MOISTURE_CALLBACK_THRESHOLD = 4
  • MOISTURE_FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • MOISTURE_FUNCTION_SET_MOVING_AVERAGE = 10
int moisture_set_response_expected_all(Moisture *moisture, bool response_expected)

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

int moisture_get_identity(Moisture *moisture, 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 Bricklet.

Konfigurationsfunktionen für Callbacks

void moisture_register_callback(Moisture *moisture, int16_t callback_id, void *function, 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 moisture_set_moisture_callback_period(Moisture *moisture, uint32_t period)

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

Der MOISTURE_CALLBACK_MOISTURE Callback wird nur ausgelöst wenn sich der Feuchtigkeitswert seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

int moisture_get_moisture_callback_period(Moisture *moisture, uint32_t *ret_period)

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

int moisture_set_moisture_callback_threshold(Moisture *moisture, char option, uint16_t min, uint16_t max)

Setzt den Schwellwert für den MOISTURE_CALLBACK_MOISTURE_REACHED Callback.

Die folgenden Optionen sind möglich:

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

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

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

  • MOISTURE_THRESHOLD_OPTION_OFF = 'x'
  • MOISTURE_THRESHOLD_OPTION_OUTSIDE = 'o'
  • MOISTURE_THRESHOLD_OPTION_INSIDE = 'i'
  • MOISTURE_THRESHOLD_OPTION_SMALLER = '<'
  • MOISTURE_THRESHOLD_OPTION_GREATER = '>'
int moisture_get_moisture_callback_threshold(Moisture *moisture, char *ret_option, uint16_t *ret_min, uint16_t *ret_max)

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

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

  • MOISTURE_THRESHOLD_OPTION_OFF = 'x'
  • MOISTURE_THRESHOLD_OPTION_OUTSIDE = 'o'
  • MOISTURE_THRESHOLD_OPTION_INSIDE = 'i'
  • MOISTURE_THRESHOLD_OPTION_SMALLER = '<'
  • MOISTURE_THRESHOLD_OPTION_GREATER = '>'
int moisture_set_debounce_period(Moisture *moisture, uint32_t debounce)

Setzt die Periode in ms mit welcher die Schwellwert Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

Der Standardwert ist 100.

int moisture_get_debounce_period(Moisture *moisture, uint32_t *ret_debounce)

Gibt die Entprellperiode zurück, wie von moisture_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 Funktion moisture_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);
}

moisture_register_callback(&moisture, MOISTURE_CALLBACK_EXAMPLE, (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.

MOISTURE_CALLBACK_MOISTURE
void callback(uint16_t moisture, void *user_data)

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

The MOISTURE_CALLBACK_MOISTURE Callback wird nur ausgelöst wenn sich der Feuchtigkeitswert seit der letzten Auslösung geändert hat.

MOISTURE_CALLBACK_MOISTURE_REACHED
void callback(uint16_t moisture, void *user_data)

Dieser Callback wird ausgelöst wenn der Schwellwert, wie von moisture_set_moisture_callback_threshold() gesetzt, erreicht wird. Der Parameter ist die Feuchtigkeitswert des Sensors.

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

Konstanten

MOISTURE_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Moisture Bricklet zu identifizieren.

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

MOISTURE_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Moisture Bricklet dar.