C# - Industrial Dual 0-20mA 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
27

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 Industrial Dual 0-20mA Bricklet

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

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

        // Get current current from sensor 1
        int current = id020.GetCurrent(1);
        Console.WriteLine("Current (Sensor 1): " + current/1000000.0 + " mA");

        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
37
38
39

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 Industrial Dual 0-20mA Bricklet

    // Callback function for current callback
    static void CurrentCB(BrickletIndustrialDual020mA sender, byte sensor, int current)
    {
        Console.WriteLine("Sensor: " + sensor);
        Console.WriteLine("Current: " + current/1000000.0 + " mA");
        Console.WriteLine("");
    }

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletIndustrialDual020mA id020 =
          new BrickletIndustrialDual020mA(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
        id020.CurrentCallback += CurrentCB;

        // Set period for current (sensor 1) callback to 1s (1000ms)
        // Note: The current (sensor 1) callback is only called every second
        //       if the current (sensor 1) has changed since the last call!
        id020.SetCurrentCallbackPeriod(1, 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
38
39
40
41

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 Industrial Dual 0-20mA Bricklet

    // Callback function for current reached callback
    static void CurrentReachedCB(BrickletIndustrialDual020mA sender, byte sensor,
                                 int current)
    {
        Console.WriteLine("Sensor: " + sensor);
        Console.WriteLine("Current: " + current/1000000.0 + " mA");
        Console.WriteLine("");
    }

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletIndustrialDual020mA id020 =
          new BrickletIndustrialDual020mA(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)
        id020.SetDebouncePeriod(10000);

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

        // Configure threshold for current (sensor 1) "greater than 10 mA"
        id020.SetCurrentCallbackThreshold(1, '>', 10*1000000, 0);

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

Basic Functions¶

class BrickletIndustrialDual020mA(string uid, IPConnection ipcon)¶

Parameters:	uid – Type: string ipcon – Type: IPConnection
Returns:	industrialDual020mA – Type: BrickletIndustrialDual020mA

Creates an object with the unique device ID uid:

BrickletIndustrialDual020mA industrialDual020mA = new BrickletIndustrialDual020mA("YOUR_DEVICE_UID", ipcon);

This object can then be used after the IP Connection is connected.

int BrickletIndustrialDual020mA.GetCurrent(byte sensor)¶

Parameters:	sensor – Type: byte, Range: [0 to 1]
Returns:	current – Type: int, Unit: 1 nA, Range: [0 to 22505322]

Returns the current of the specified sensor.

It is possible to detect if an IEC 60381-1 compatible sensor is connected and if it works properly.

If the returned current is below 4mA, there is likely no sensor connected or the sensor may be defect. If the returned current is over 20mA, there might be a short circuit or the sensor may be defect.

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 BrickletIndustrialDual020mA.SetSampleRate(byte rate)¶

Parameters:	rate – Type: byte, Range: See constants, Default: 3

Sets the sample rate to either 240, 60, 15 or 4 samples per second. The resolution for the rates is 12, 14, 16 and 18 bit respectively.

Value	Description
0	240 samples per second, 12 bit resolution
1	60 samples per second, 14 bit resolution
2	15 samples per second, 16 bit resolution
3	4 samples per second, 18 bit resolution

The following constants are available for this function:

For rate:

• BrickletIndustrialDual020mA.SAMPLE_RATE_240_SPS = 0
• BrickletIndustrialDual020mA.SAMPLE_RATE_60_SPS = 1
• BrickletIndustrialDual020mA.SAMPLE_RATE_15_SPS = 2
• BrickletIndustrialDual020mA.SAMPLE_RATE_4_SPS = 3

byte BrickletIndustrialDual020mA.GetSampleRate()¶

Returns:	rate – Type: byte, Range: See constants, Default: 3

Returns the sample rate as set by SetSampleRate().

The following constants are available for this function:

For rate:

• BrickletIndustrialDual020mA.SAMPLE_RATE_240_SPS = 0
• BrickletIndustrialDual020mA.SAMPLE_RATE_60_SPS = 1
• BrickletIndustrialDual020mA.SAMPLE_RATE_15_SPS = 2
• BrickletIndustrialDual020mA.SAMPLE_RATE_4_SPS = 3

void BrickletIndustrialDual020mA.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 BrickletIndustrialDual020mA.SetCurrentCallbackPeriod(byte sensor, long period)¶

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

Sets the period with which the CurrentCallback callback is triggered periodically for the given sensor. A value of 0 turns the callback off.

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

long BrickletIndustrialDual020mA.GetCurrentCallbackPeriod(byte sensor)¶

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

Returns the period as set by SetCurrentCallbackPeriod().

void BrickletIndustrialDual020mA.SetCurrentCallbackThreshold(byte sensor, char option, int min, int max)¶

Parameters:	sensor – Type: byte, Range: [0 to 1] option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1 nA, Range: [-231 to 231 - 1], Default: 0 max – Type: int, Unit: 1 nA, Range: [-231 to 231 - 1], Default: 0

Sets the thresholds for the CurrentReachedCallback callback for the given sensor.

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:

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

void BrickletIndustrialDual020mA.GetCurrentCallbackThreshold(byte sensor, out char option, out int min, out int max)¶

Parameters:	sensor – Type: byte, Range: [0 to 1]
Output Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1 nA, Range: [-231 to 231 - 1], Default: 0 max – Type: int, Unit: 1 nA, Range: [-231 to 231 - 1], Default: 0

Returns the threshold as set by SetCurrentCallbackThreshold().

The following constants are available for this function:

For option:

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

void BrickletIndustrialDual020mA.SetDebouncePeriod(long debounce)¶

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

Sets the period with which the threshold callback

• CurrentReachedCallback

is triggered, if the threshold

• SetCurrentCallbackThreshold()

keeps being reached.

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

industrialDual020mA.ExampleCallback += MyCallback;

The available events are described below.

event BrickletIndustrialDual020mA.CurrentCallback(BrickletIndustrialDual020mA sender, byte sensor, int current)¶

Callback Parameters:	sender – Type: BrickletIndustrialDual020mA sensor – Type: byte, Range: [0 to 1] current – Type: int, Unit: 1 nA, Range: [0 to 22505322]

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 BrickletIndustrialDual020mA.CurrentReachedCallback(BrickletIndustrialDual020mA sender, byte sensor, int current)¶

Callback Parameters:	sender – Type: BrickletIndustrialDual020mA sensor – Type: byte, Range: [0 to 1] current – Type: int, Unit: 1 nA, Range: [0 to 22505322]

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

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[] BrickletIndustrialDual020mA.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 BrickletIndustrialDual020mA.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:

• BrickletIndustrialDual020mA.FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 2
• BrickletIndustrialDual020mA.FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 4
• BrickletIndustrialDual020mA.FUNCTION_SET_DEBOUNCE_PERIOD = 6
• BrickletIndustrialDual020mA.FUNCTION_SET_SAMPLE_RATE = 8

void BrickletIndustrialDual020mA.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:

• BrickletIndustrialDual020mA.FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 2
• BrickletIndustrialDual020mA.FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 4
• BrickletIndustrialDual020mA.FUNCTION_SET_DEBOUNCE_PERIOD = 6
• BrickletIndustrialDual020mA.FUNCTION_SET_SAMPLE_RATE = 8

void BrickletIndustrialDual020mA.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 BrickletIndustrialDual020mA.DEVICE_IDENTIFIER¶

This constant is used to identify a Industrial Dual 0-20mA 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 BrickletIndustrialDual020mA.DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a Industrial Dual 0-20mA Bricklet.