C# - Current12 Bricklet¶

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();
    }
}

Basic Functions¶

class BrickletCurrent12(string uid, IPConnection ipcon)¶

Parameters:	uid – Type: string ipcon – Type: IPConnection
Returns:	current12 – Type: BrickletCurrent12

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.

short BrickletCurrent12.GetCurrent()¶

Returns:	current – Type: short, Unit: 1 mA, Range: [-12500 to 12500]

Returns the current of the sensor.

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

Advanced Functions¶

void BrickletCurrent12.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.

bool BrickletCurrent12.IsOverCurrent()¶

Returns:	over – Type: bool

Returns true if more than 12.5A were measured.

Note

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

int BrickletCurrent12.GetAnalogValue()¶

Returns:	value – Type: int, Range: [0 to 212 - 1]

Returns the value as read by a 12-bit analog-to-digital converter.

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().

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

Output Parameters:

uid – Type: string, Length: up to 8 connectedUid – Type: string, Length: up to 8 position – Type: char, Range: ['a' to 'h', 'z'] hardwareVersion – Type: byte[], Length: 3 0: major – Type: byte, Range: [0 to 255] 1: minor – Type: byte, Range: [0 to 255] 2: revision – Type: byte, Range: [0 to 255] firmwareVersion – Type: byte[], Length: 3 0: major – Type: byte, Range: [0 to 255] 1: minor – Type: byte, Range: [0 to 255] 2: revision – Type: byte, Range: [0 to 255] deviceIdentifier – Type: int, Range: [0 to 216 - 1]

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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

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

Callback Configuration Functions¶

void BrickletCurrent12.SetCurrentCallbackPeriod(long period)¶

Parameters:	period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Sets the period 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.

long BrickletCurrent12.GetCurrentCallbackPeriod()¶

Returns:	period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by SetCurrentCallbackPeriod().

void BrickletCurrent12.SetAnalogValueCallbackPeriod(long period)¶

Parameters:	period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Sets the period 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.

long BrickletCurrent12.GetAnalogValueCallbackPeriod()¶

Returns:	period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by SetAnalogValueCallbackPeriod().

void BrickletCurrent12.SetCurrentCallbackThreshold(char option, short min, short max)¶

Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: short, Unit: 1 mA, Range: [-215 to 215 - 1], Default: 0 max – Type: short, Unit: 1 mA, Range: [-215 to 215 - 1], Default: 0

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

For option:

• BrickletCurrent12.THRESHOLD_OPTION_OFF = 'x'
• BrickletCurrent12.THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletCurrent12.THRESHOLD_OPTION_INSIDE = 'i'
• BrickletCurrent12.THRESHOLD_OPTION_SMALLER = '<'
• BrickletCurrent12.THRESHOLD_OPTION_GREATER = '>'

void BrickletCurrent12.GetCurrentCallbackThreshold(out char option, out short min, out short max)¶

Output Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: short, Unit: 1 mA, Range: [-215 to 215 - 1], Default: 0 max – Type: short, Unit: 1 mA, Range: [-215 to 215 - 1], Default: 0

Returns the threshold as set by SetCurrentCallbackThreshold().

The following constants are available for this function:

For option:

• BrickletCurrent12.THRESHOLD_OPTION_OFF = 'x'
• BrickletCurrent12.THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletCurrent12.THRESHOLD_OPTION_INSIDE = 'i'
• BrickletCurrent12.THRESHOLD_OPTION_SMALLER = '<'
• BrickletCurrent12.THRESHOLD_OPTION_GREATER = '>'

void BrickletCurrent12.SetAnalogValueCallbackThreshold(char option, int min, int max)¶

Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: int, Range: [0 to 216 - 1], Default: 0 max – Type: int, Range: [0 to 216 - 1], Default: 0

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

For option:

• BrickletCurrent12.THRESHOLD_OPTION_OFF = 'x'
• BrickletCurrent12.THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletCurrent12.THRESHOLD_OPTION_INSIDE = 'i'
• BrickletCurrent12.THRESHOLD_OPTION_SMALLER = '<'
• BrickletCurrent12.THRESHOLD_OPTION_GREATER = '>'

void BrickletCurrent12.GetAnalogValueCallbackThreshold(out char option, out int min, out int max)¶

Output Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: int, Range: [0 to 216 - 1], Default: 0 max – Type: int, Range: [0 to 216 - 1], Default: 0

Returns the threshold as set by SetAnalogValueCallbackThreshold().

The following constants are available for this function:

For option:

• BrickletCurrent12.THRESHOLD_OPTION_OFF = 'x'
• BrickletCurrent12.THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletCurrent12.THRESHOLD_OPTION_INSIDE = 'i'
• BrickletCurrent12.THRESHOLD_OPTION_SMALLER = '<'
• BrickletCurrent12.THRESHOLD_OPTION_GREATER = '>'

void BrickletCurrent12.SetDebouncePeriod(long debounce)¶

Parameters:	debounce – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Sets the period with which the threshold callbacks

• CurrentReachedCallback,
• AnalogValueReachedCallback

are triggered, if the thresholds

• SetCurrentCallbackThreshold(),
• SetAnalogValueCallbackThreshold()

keep being reached.

long BrickletCurrent12.GetDebouncePeriod()¶

Returns:	debounce – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

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.

event BrickletCurrent12.CurrentCallback(BrickletCurrent12 sender, short current)¶

Callback Parameters:	sender – Type: BrickletCurrent12 current – Type: short, Unit: 1 mA, Range: [-12500 to 12500]

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.

event BrickletCurrent12.AnalogValueCallback(BrickletCurrent12 sender, int value)¶

Callback Parameters:	sender – Type: BrickletCurrent12 value – Type: int, Range: [0 to 212 - 1]

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.

event BrickletCurrent12.CurrentReachedCallback(BrickletCurrent12 sender, short current)¶

Callback Parameters:	sender – Type: BrickletCurrent12 current – Type: short, Unit: 1 mA, Range: [-12500 to 12500]

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().

event BrickletCurrent12.AnalogValueReachedCallback(BrickletCurrent12 sender, int value)¶

Callback Parameters:	sender – Type: BrickletCurrent12 value – Type: int, Range: [0 to 212 - 1]

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().

event BrickletCurrent12.OverCurrentCallback(BrickletCurrent12 sender)¶

Callback Parameters:	sender – Type: BrickletCurrent12

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

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

byte[] BrickletCurrent12.GetAPIVersion()¶

Output Parameters:	apiVersion – Type: byte[], Length: 3 0: major – Type: byte, Range: [0 to 255] 1: minor – Type: byte, Range: [0 to 255] 2: revision – Type: byte, Range: [0 to 255]

Returns the version of the API definition 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.

bool BrickletCurrent12.GetResponseExpected(byte functionId)¶

Parameters:	functionId – Type: byte, Range: See constants
Returns:	responseExpected – Type: bool

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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

• 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

void BrickletCurrent12.SetResponseExpected(byte functionId, bool responseExpected)¶

Parameters:	functionId – Type: byte, Range: See constants responseExpected – Type: bool

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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

• 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

void BrickletCurrent12.SetResponseExpectedAll(bool responseExpected)¶

Parameters:	responseExpected – Type: bool

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

Constants¶

int BrickletCurrent12.DEVICE_IDENTIFIER¶

This constant is used to identify a Current12 Bricklet.

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

string BrickletCurrent12.DEVICE_DISPLAY_NAME¶

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