C/C++ - Moisture Bricklet

This is the description of the C/C++ API bindings for the Moisture Bricklet. General information and technical specifications for the Moisture Bricklet are summarized in its hardware description.

An installation guide for the C/C++ API bindings is part of their general description.

Examples

The example code below is 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

Every function of the C/C++ bindings returns an integer which describes an error code. Data returned from the device, when a getter is called, is handled via call by reference. These parameters are labeled with the ret_ prefix.

Possible error codes are:

  • 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 (unused since bindings version 2.0.0)
  • 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

as defined in ip_connection.h.

All functions listed below are thread-safe.

Basic Functions

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

Creates the device object moisture with the unique device ID uid and adds it to the IPConnection ipcon:

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

This device object can be used after the IP connection has been connected (see examples above).

void moisture_destroy(Moisture *moisture)

Removes the device object moisture from its IPConnection and destroys it. The device object cannot be used anymore afterwards.

int moisture_get_moisture_value(Moisture *moisture, uint16_t *ret_moisture)

Returns the current moisture value. The value has a range of 0 to 4095. A small value corresponds to little moisture, a big value corresponds to much moisture.

If you want to get the moisture value periodically, it is recommended to use the MOISTURE_CALLBACK_MOISTURE callback and set the period with moisture_set_moisture_callback_period().

Advanced Functions

int moisture_set_moving_average(Moisture *moisture, uint8_t average)

Sets the length of a moving averaging for the moisture value.

Setting the length to 0 will turn the averaging completely off. With less averaging, there is more noise on the data.

The range for the averaging is 0-100.

The default value is 100.

int moisture_get_moving_average(Moisture *moisture, uint8_t *ret_average)

Returns the length moving average as set by moisture_set_moving_average().

int moisture_get_api_version(Moisture *moisture, uint8_t ret_api_version[3])

Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

int moisture_get_response_expected(Moisture *moisture, uint8_t function_id, bool *ret_response_expected)

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by moisture_set_response_expected(). For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

See moisture_set_response_expected() for the list of function ID defines available for this function.

int moisture_set_response_expected(Moisture *moisture, uint8_t function_id, bool response_expected)

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

The following function ID defines are available for this function:

  • 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)

Changes the response expected flag for all setter and callback configuration functions of this device at once.

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)

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c' or 'd'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions

void moisture_register_callback(Moisture *moisture, int16_t callback_id, void *function, void *user_data)

Registers the given function with the given callback_id. The user_data will be passed as the last parameter to the function.

The available callback IDs with corresponding function signatures are listed below.

int moisture_set_moisture_callback_period(Moisture *moisture, uint32_t period)

Sets the period in ms with which the MOISTURE_CALLBACK_MOISTURE callback is triggered periodically. A value of 0 turns the callback off.

The MOISTURE_CALLBACK_MOISTURE callback is only triggered if the moisture value has changed since the last triggering.

The default value is 0.

int moisture_get_moisture_callback_period(Moisture *moisture, uint32_t *ret_period)

Returns the period as set by moisture_set_moisture_callback_period().

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

Sets the thresholds for the MOISTURE_CALLBACK_MOISTURE_REACHED callback.

The following options are possible:

Option Description
'x' Callback is turned off
'o' Callback is triggered when the moisture value is outside the min and max values
'i' Callback is triggered when the moisture value is inside the min and max values
'<' Callback is triggered when the moisture value is smaller than the min value (max is ignored)
'>' Callback is triggered when the moisture value is greater than the min value (max is ignored)

The default value is ('x', 0, 0).

The following defines are available for this function:

  • 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)

Returns the threshold as set by moisture_set_moisture_callback_threshold().

The following defines are available for this function:

  • 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)

Sets the period in ms with which the threshold callback

is triggered, if the threshold

keeps being reached.

The default value is 100.

int moisture_get_debounce_period(Moisture *moisture, uint32_t *ret_debounce)

Returns the debounce period as set by moisture_set_debounce_period().

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the moisture_register_callback() function. The parameters consist of the device object, the callback ID, the callback function and optional user data:

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

moisture_register_callback(&moisture, MOISTURE_CALLBACK_EXAMPLE, (void *)my_callback, NULL);

The available constants with corresponding callback function signatures are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

MOISTURE_CALLBACK_MOISTURE
void callback(uint16_t moisture, void *user_data)

This callback is triggered periodically with the period that is set by moisture_set_moisture_callback_period(). The parameter is the moisture value of the sensor.

The MOISTURE_CALLBACK_MOISTURE callback is only triggered if the moisture value has changed since the last triggering.

MOISTURE_CALLBACK_MOISTURE_REACHED
void callback(uint16_t moisture, void *user_data)

This callback is triggered when the threshold as set by moisture_set_moisture_callback_threshold() is reached. The parameter is the moisture value of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by moisture_set_debounce_period().

Constants

MOISTURE_DEVICE_IDENTIFIER

This constant is used to identify a Moisture Bricklet.

The moisture_get_identity() function and the IPCON_CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

MOISTURE_DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Moisture Bricklet.