C# - Moisture Bricklet

This is the description of the 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# API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

Simple

Download (ExampleSimple.cs)

 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
using System;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your Moisture Bricklet

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletMoisture m = new BrickletMoisture(UID, ipcon); // Create device object

        ipcon.Connect(HOST, PORT); // Connect to brickd
        // Don't use device before ipcon is connected

        // Get current moisture value
        int moisture = m.GetMoistureValue();
        Console.WriteLine("Moisture Value: " + moisture);

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        ipcon.Disconnect();
    }
}

Callback

Download (ExampleCallback.cs)

 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
using System;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your Moisture Bricklet

    // Callback function for moisture value callback
    static void MoistureCB(BrickletMoisture sender, int moisture)
    {
        Console.WriteLine("Moisture Value: " + moisture);
    }

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletMoisture m = new BrickletMoisture(UID, ipcon); // Create device object

        ipcon.Connect(HOST, PORT); // Connect to brickd
        // Don't use device before ipcon is connected

        // Register moisture value callback to function MoistureCB
        m.MoistureCallback += MoistureCB;

        // 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!
        m.SetMoistureCallbackPeriod(1000);

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        ipcon.Disconnect();
    }
}

Threshold

Download (ExampleThreshold.cs)

 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
using System;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your Moisture Bricklet

    // Callback function for moisture value reached callback
    static void MoistureReachedCB(BrickletMoisture sender, int moisture)
    {
        Console.WriteLine("Moisture Value: " + moisture);
    }

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletMoisture m = new BrickletMoisture(UID, ipcon); // Create device object

        ipcon.Connect(HOST, PORT); // Connect to brickd
        // Don't use device before ipcon is connected

        // Get threshold callbacks with a debounce time of 1 second (1000ms)
        m.SetDebouncePeriod(1000);

        // Register moisture value reached callback to function MoistureReachedCB
        m.MoistureReachedCallback += MoistureReachedCB;

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

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        ipcon.Disconnect();
    }
}

API

Generally, every method of the C# bindings that returns a value can throw a Tinkerforge.TimeoutException. This exception gets thrown if the device did not respond. If a cable based connection is used, it is unlikely that this exception gets thrown (assuming nobody plugs the device out). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

Since C# does not support multiple return values directly, we use the out keyword to return multiple values from a method.

The namespace for all Brick/Bricklet bindings and the IPConnection is Tinkerforge.*.

All methods listed below are thread-safe.

Basic Functions

public class BrickletMoisture(String uid, IPConnection ipcon)

Creates an object with the unique device ID uid:

BrickletMoisture moisture = new BrickletMoisture("YOUR_DEVICE_UID", ipcon);

This object can then be used after the IP Connection is connected (see examples above).

public int GetMoistureValue()

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 MoistureCallback callback and set the period with SetMoistureCallbackPeriod().

Advanced Functions

public void SetMovingAverage(byte 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.

public byte GetMovingAverage()

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

public byte[] GetAPIVersion()

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.

public bool GetResponseExpected(byte functionId)

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 SetResponseExpected(). 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 SetResponseExpected() for the list of function ID constants available for this function.

public void SetResponseExpected(byte functionId, bool responseExpected)

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 constants are available for this function:

  • BrickletMoisture.FUNCTION_SET_MOISTURE_CALLBACK_PERIOD = 2
  • BrickletMoisture.FUNCTION_SET_MOISTURE_CALLBACK_THRESHOLD = 4
  • BrickletMoisture.FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletMoisture.FUNCTION_SET_MOVING_AVERAGE = 10
public void SetResponseExpectedAll(bool responseExpected)

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

public void GetIdentity(out string uid, out string connectedUid, out char position, out byte[] hardwareVersion, out byte[] firmwareVersion, out int deviceIdentifier)

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

public void SetMoistureCallbackPeriod(long period)

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

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

The default value is 0.

public long GetMoistureCallbackPeriod()

Returns the period as set by SetMoistureCallbackPeriod().

public void SetMoistureCallbackThreshold(char option, int min, int max)

Sets the thresholds for the MoistureReachedCallback 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 constants are available for this function:

  • BrickletMoisture.THRESHOLD_OPTION_OFF = 'x'
  • BrickletMoisture.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletMoisture.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletMoisture.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletMoisture.THRESHOLD_OPTION_GREATER = '>'
public void GetMoistureCallbackThreshold(out char option, out int min, out int max)

Returns the threshold as set by SetMoistureCallbackThreshold().

The following constants are available for this function:

  • BrickletMoisture.THRESHOLD_OPTION_OFF = 'x'
  • BrickletMoisture.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletMoisture.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletMoisture.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletMoisture.THRESHOLD_OPTION_GREATER = '>'
public void SetDebouncePeriod(long debounce)

Sets the period in ms with which the threshold callback

is triggered, if the threshold

keeps being reached.

The default value is 100.

public long GetDebouncePeriod()

Returns the debounce period as set by SetDebouncePeriod().

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done by appending your callback handler to the corresponding event:

void MyCallback(BrickletMoisture sender, int value)
{
    System.Console.WriteLine("Value: " + value);
}

moisture.ExampleCallback += MyCallback;

The available events 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.

public event MoistureCallback(BrickletMoisture sender, int moisture)

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

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

public event MoistureReachedCallback(BrickletMoisture sender, int moisture)

This callback is triggered when the threshold as set by SetMoistureCallbackThreshold() 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 SetDebouncePeriod().

Constants

public int DEVICE_IDENTIFIER

This constant is used to identify a Moisture Bricklet.

The GetIdentity() function and the EnumerateCallback callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

public string DEVICE_DISPLAY_NAME

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