C# - Current12 Bricklet

This is the description of the C# API bindings for the Current12 Bricklet. General information and technical specifications for the Current12 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 Current12 Bricklet

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

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

        // Get current current
        short current = c.GetCurrent();
        Console.WriteLine("Current: " + current/1000.0 + " A");

        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 Current12 Bricklet

    // Callback function for current callback
    static void CurrentCB(BrickletCurrent12 sender, short current)
    {
        Console.WriteLine("Current: " + current/1000.0 + " A");
    }

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

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

        // Register current callback to function CurrentCB
        c.CurrentCallback += CurrentCB;

        // Set period for current callback to 1s (1000ms)
        // Note: The current callback is only called every second
        //       if the current has changed since the last call!
        c.SetCurrentCallbackPeriod(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 Current12 Bricklet

    // Callback function for current reached callback
    static void CurrentReachedCB(BrickletCurrent12 sender, short current)
    {
        Console.WriteLine("Current: " + current/1000.0 + " A");
    }

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletCurrent12 c = new BrickletCurrent12(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 10 seconds (10000ms)
        c.SetDebouncePeriod(10000);

        // Register current reached callback to function CurrentReachedCB
        c.CurrentReachedCallback += CurrentReachedCB;

        // Configure threshold for current "greater than 5 A"
        c.SetCurrentCallbackThreshold('>', 5*1000, 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 BrickletCurrent12(String uid, IPConnection ipcon)

Creates an object with the unique device ID uid:

BrickletCurrent12 current12 = new BrickletCurrent12("YOUR_DEVICE_UID", ipcon);

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

public short GetCurrent()

Returns the current of the sensor. The value is in mA and between -12500mA and 12500mA.

If you want to get the current periodically, it is recommended to use the CurrentCallback callback and set the period with SetCurrentCallbackPeriod().

Advanced Functions

public void Calibrate()

Calibrates the 0 value of the sensor. You have to call this function when there is no current present.

The zero point of the current sensor is depending on the exact properties of the analog-to-digital converter, the length of the Bricklet cable and the temperature. Thus, if you change the Brick or the environment in which the Bricklet is used, you might have to recalibrate.

The resulting calibration will be saved on the EEPROM of the Current Bricklet.

public bool IsOverCurrent()

Returns true if more than 12.5A were measured.

Note

To reset this value you have to power cycle the Bricklet.

public int GetAnalogValue()

Returns the value as read by a 12-bit analog-to-digital converter. The value is between 0 and 4095.

Note

The value returned by GetCurrent() is averaged over several samples to yield less noise, while GetAnalogValue() gives back raw unfiltered analog values. The only reason to use GetAnalogValue() is, if you need the full resolution of the analog-to-digital converter.

If you want the analog value periodically, it is recommended to use the AnalogValueCallback callback and set the period with SetAnalogValueCallbackPeriod().

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:

  • BrickletCurrent12.FUNCTION_CALIBRATE = 2
  • BrickletCurrent12.FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 5
  • BrickletCurrent12.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
  • BrickletCurrent12.FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 9
  • BrickletCurrent12.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
  • BrickletCurrent12.FUNCTION_SET_DEBOUNCE_PERIOD = 13
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 SetCurrentCallbackPeriod(long period)

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

The CurrentCallback callback is only triggered if the current has changed since the last triggering.

The default value is 0.

public long GetCurrentCallbackPeriod()

Returns the period as set by SetCurrentCallbackPeriod().

public void SetAnalogValueCallbackPeriod(long period)

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

The AnalogValueCallback callback is only triggered if the analog value has changed since the last triggering.

The default value is 0.

public long GetAnalogValueCallbackPeriod()

Returns the period as set by SetAnalogValueCallbackPeriod().

public void SetCurrentCallbackThreshold(char option, short min, short max)

Sets the thresholds for the CurrentReachedCallback callback.

The following options are possible:

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

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

The following constants are available for this function:

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

Returns the threshold as set by SetCurrentCallbackThreshold().

The following constants are available for this function:

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

Sets the thresholds for the AnalogValueReachedCallback callback.

The following options are possible:

Option Description
'x' Callback is turned off
'o' Callback is triggered when the analog value is outside the min and max values
'i' Callback is triggered when the analog value is inside the min and max values
'<' Callback is triggered when the analog value is smaller than the min value (max is ignored)
'>' Callback is triggered when the analog 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:

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

Returns the threshold as set by SetAnalogValueCallbackThreshold().

The following constants are available for this function:

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

Sets the period in ms with which the threshold callbacks

are triggered, if the thresholds

keep 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(BrickletCurrent12 sender, int value)
{
    System.Console.WriteLine("Value: " + value);
}

current12.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 CurrentCallback(BrickletCurrent12 sender, short current)

This callback is triggered periodically with the period that is set by SetCurrentCallbackPeriod(). The parameter is the current of the sensor.

The CurrentCallback callback is only triggered if the current has changed since the last triggering.

public event AnalogValueCallback(BrickletCurrent12 sender, int value)

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

The AnalogValueCallback callback is only triggered if the current has changed since the last triggering.

public event CurrentReachedCallback(BrickletCurrent12 sender, short current)

This callback is triggered when the threshold as set by SetCurrentCallbackThreshold() is reached. The parameter is the current of the sensor.

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

public event AnalogValueReachedCallback(BrickletCurrent12 sender, int value)

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

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

public event OverCurrentCallback(BrickletCurrent12 sender)

This callback is triggered when an over current is measured (see IsOverCurrent()).

Constants

public int DEVICE_IDENTIFIER

This constant is used to identify a Current12 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 Current12 Bricklet.