C# - Voltage Bricklet

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

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

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

        // Get current voltage
        int voltage = v.GetVoltage();
        Console.WriteLine("Voltage: " + voltage/1000.0 + " V");

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

    // Callback function for voltage callback
    static void VoltageCB(BrickletVoltage sender, int voltage)
    {
        Console.WriteLine("Voltage: " + voltage/1000.0 + " V");
    }

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

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

        // Register voltage callback to function VoltageCB
        v.VoltageCallback += VoltageCB;

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

    // Callback function for voltage reached callback
    static void VoltageReachedCB(BrickletVoltage sender, int voltage)
    {
        Console.WriteLine("Voltage: " + voltage/1000.0 + " V");
    }

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

        // Register voltage reached callback to function VoltageReachedCB
        v.VoltageReachedCallback += VoltageReachedCB;

        // Configure threshold for voltage "greater than 5 V"
        v.SetVoltageCallbackThreshold('>', 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

class BrickletVoltage(String uid, IPConnection ipcon)
Parameters:
  • uid – Type: String
  • ipcon – Type: IPConnection
Returns:
  • voltage – Type: BrickletVoltage

Creates an object with the unique device ID uid:

BrickletVoltage voltage = new BrickletVoltage("YOUR_DEVICE_UID", ipcon);

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

int BrickletVoltage.GetVoltage()
Returns:
  • voltage – Type: int, Range: [0 to 216 - 1]

Returns the voltage of the sensor. The value is in mV and between 0mV and 50000mV.

If you want to get the voltage periodically, it is recommended to use the VoltageCallback callback and set the period with SetVoltageCallbackPeriod().

Advanced Functions

int BrickletVoltage.GetAnalogValue()
Returns:
  • value – Type: int, Range: [0 to 216 - 1]

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

byte[] BrickletVoltage.GetAPIVersion()
Returns:
  • apiVersion – Type: byte[], Length: 3, Range: [0 to 255]

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.

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

The following constants are available for this function:

For functionId:

  • BrickletVoltage.FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 3
  • BrickletVoltage.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • BrickletVoltage.FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 7
  • BrickletVoltage.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • BrickletVoltage.FUNCTION_SET_DEBOUNCE_PERIOD = 11
void BrickletVoltage.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 send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

  • BrickletVoltage.FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 3
  • BrickletVoltage.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • BrickletVoltage.FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 7
  • BrickletVoltage.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • BrickletVoltage.FUNCTION_SET_DEBOUNCE_PERIOD = 11
void BrickletVoltage.SetResponseExpectedAll(bool responseExpected)
Parameters:
  • responseExpected – Type: bool

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

void BrickletVoltage.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
  • hardwareVersion – Type: byte[], Length: 3, Range: [0 to 255]
  • firmwareVersion – Type: byte[], Length: 3, 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' 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 BrickletVoltage.SetVoltageCallbackPeriod(long period)
Parameters:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

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

The VoltageCallback callback is only triggered if the voltage has changed since the last triggering.

long BrickletVoltage.GetVoltageCallbackPeriod()
Returns:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by SetVoltageCallbackPeriod().

void BrickletVoltage.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 BrickletVoltage.GetAnalogValueCallbackPeriod()
Returns:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by SetAnalogValueCallbackPeriod().

void BrickletVoltage.SetVoltageCallbackThreshold(char option, int min, int max)
Parameters:
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: int, Range: [0 to 216 - 1]
  • max – Type: int, Range: [0 to 216 - 1]

Sets the thresholds for the VoltageReachedCallback callback.

The following options are possible:

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

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

The following constants are available for this function:

For option:

  • BrickletVoltage.THRESHOLD_OPTION_OFF = 'x'
  • BrickletVoltage.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletVoltage.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletVoltage.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletVoltage.THRESHOLD_OPTION_GREATER = '>'
void BrickletVoltage.GetVoltageCallbackThreshold(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]
  • max – Type: int, Range: [0 to 216 - 1]

Returns the threshold as set by SetVoltageCallbackThreshold().

The following constants are available for this function:

For option:

  • BrickletVoltage.THRESHOLD_OPTION_OFF = 'x'
  • BrickletVoltage.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletVoltage.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletVoltage.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletVoltage.THRESHOLD_OPTION_GREATER = '>'
void BrickletVoltage.SetAnalogValueCallbackThreshold(char option, int min, int max)
Parameters:
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: int, Range: [0 to 216 - 1]
  • max – Type: int, Range: [0 to 216 - 1]

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:

For option:

  • BrickletVoltage.THRESHOLD_OPTION_OFF = 'x'
  • BrickletVoltage.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletVoltage.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletVoltage.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletVoltage.THRESHOLD_OPTION_GREATER = '>'
void BrickletVoltage.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]
  • max – Type: int, Range: [0 to 216 - 1]

Returns the threshold as set by SetAnalogValueCallbackThreshold().

The following constants are available for this function:

For option:

  • BrickletVoltage.THRESHOLD_OPTION_OFF = 'x'
  • BrickletVoltage.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletVoltage.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletVoltage.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletVoltage.THRESHOLD_OPTION_GREATER = '>'
void BrickletVoltage.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

are triggered, if the thresholds

keep being reached.

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

voltage.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.

event BrickletVoltage.VoltageCallback(BrickletVoltage sender, int voltage)
Callback Parameters:
  • sender – Type: BrickletVoltage
  • voltage – Type: int, Range: [0 to 216 - 1]

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

The VoltageCallback callback is only triggered if the voltage has changed since the last triggering.

event BrickletVoltage.AnalogValueCallback(BrickletVoltage sender, int value)
Callback Parameters:
  • sender – Type: BrickletVoltage
  • value – Type: int, Range: [0 to 216 - 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 voltage has changed since the last triggering.

event BrickletVoltage.VoltageReachedCallback(BrickletVoltage sender, int voltage)
Callback Parameters:
  • sender – Type: BrickletVoltage
  • voltage – Type: int, Range: [0 to 216 - 1]

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

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

event BrickletVoltage.AnalogValueReachedCallback(BrickletVoltage sender, int value)
Callback Parameters:
  • sender – Type: BrickletVoltage
  • value – Type: int, Range: [0 to 216 - 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().

Constants

int BrickletVoltage.DEVICE_IDENTIFIER

This constant is used to identify a Voltage 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 BrickletVoltage.DEVICE_DISPLAY_NAME

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