C# - Analog In Bricklet 2.0 – Tinkerforge

- Getting Started
- Hardware
- Software
- Starter Kits
- Embedded Boards
- Specifications

# C# - Analog In Bricklet 2.0

Note

This Bricklet is currently in the prototype stage and the software/hardware as well as the documentation is in an incomplete state.

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

    class Example
    {
        private static string HOST = "localhost";
        private static int PORT = 4223;
        private static string UID = "ABC"; // Change to your UID

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

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

            // Get current voltage (unit is mV)
            int voltage = ai.GetVoltage();

            System.Console.WriteLine("Voltage: " + voltage/1000.0 + " V");

            System.Console.WriteLine("Press enter to exit");
            System.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

    using Tinkerforge;

    class Example
    {
        private static string HOST = "localhost";
        private static int PORT = 4223;
        private static string UID = "ABC"; // Change to your UID

        // Callback function for voltage callback (parameter has unit mV)
        static void VoltageCB(BrickletAnalogInV2 sender, int voltage)
        {
            System.Console.WriteLine("Voltage: " + voltage/1000.0 + " V");
        }

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

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

            // 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!
            ai.SetVoltageCallbackPeriod(1000);

            // Register voltage callback to function VoltageCB
            ai.Voltage += VoltageCB;

            System.Console.WriteLine("Press enter to exit");
            System.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

    using Tinkerforge;

    class Example
    {
        private static string HOST = "localhost";
        private static int PORT = 4223;
        private static string UID = "ABC"; // Change to your UID

        // Callback for voltage smaller than 5V
        static void ReachedCB(BrickletAnalogInV2 sender, int voltage)
        {
            System.Console.WriteLine("Voltage dopped below 5V: " + voltage/1000.0 + "V");
        }

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

            // Register threshold reached callback to function ReachedCB
            ai.VoltageReached += ReachedCB;

            // Configure threshold for "smaller than 5V" (unit is mV)
            ai.SetVoltageCallbackThreshold('<', 5*1000, 0);

            System.Console.WriteLine("Press enter to exit");
            System.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 `BrickletAnalogInV2`(String uid, IPConnection ipcon)

  Creates an object with the unique device ID `uid`:

      BrickletAnalogInV2 analogInV2 = new BrickletAnalogInV2("YOUR_DEVICE_UID", ipcon);

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

public int `GetVoltage`()

  Returns the measured voltage. The value is in mV and between 0V and 42V. The resolution is approximately 10mV.

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

### Advanced Functions

public int `GetAnalogValue`()

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

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

public void `SetMovingAverage`(byte average)

  Sets the length of a moving averaging for the moisture value.

  Setting the length to 1 will turn the averaging off. With less averaging, there is more noise on the data.

  The range for the averaging is 1-50.

  The default value is 50.

public byte `GetMovingAverage`()

  Returns the length of the 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 and callbacks it is always disabled.

  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:

  - BrickletAnalogInV2.FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 3
  - BrickletAnalogInV2.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  - BrickletAnalogInV2.FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 7
  - BrickletAnalogInV2.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  - BrickletAnalogInV2.FUNCTION_SET_DEBOUNCE_PERIOD = 11
  - BrickletAnalogInV2.FUNCTION_SET_MOVING_AVERAGE = 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 `SetVoltageCallbackPeriod`(long period)

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

  `Voltage` is only triggered if the voltage has changed since the last triggering.

  The default value is 0.

public long `GetVoltageCallbackPeriod`()

  Returns the period as set by `SetVoltageCallbackPeriod()`.

public void `SetAnalogValueCallbackPeriod`(long period)

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

  `AnalogValue` 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 `SetVoltageCallbackThreshold`(char option, short min, short max)

  Sets the thresholds for the `VoltageReached` 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:

  - BrickletAnalogInV2.THRESHOLD_OPTION_OFF = 'x'
  - BrickletAnalogInV2.THRESHOLD_OPTION_OUTSIDE = 'o'
  - BrickletAnalogInV2.THRESHOLD_OPTION_INSIDE = 'i'
  - BrickletAnalogInV2.THRESHOLD_OPTION_SMALLER = '<'
  - BrickletAnalogInV2.THRESHOLD_OPTION_GREATER = '>'

public void `GetVoltageCallbackThreshold`(out char option, out short min, out short max)

  Returns the threshold as set by `SetVoltageCallbackThreshold()`.

  The following constants are available for this function:

  - BrickletAnalogInV2.THRESHOLD_OPTION_OFF = 'x'
  - BrickletAnalogInV2.THRESHOLD_OPTION_OUTSIDE = 'o'
  - BrickletAnalogInV2.THRESHOLD_OPTION_INSIDE = 'i'
  - BrickletAnalogInV2.THRESHOLD_OPTION_SMALLER = '<'
  - BrickletAnalogInV2.THRESHOLD_OPTION_GREATER = '>'

public void `SetAnalogValueCallbackThreshold`(char option, int min, int max)

  Sets the thresholds for the `AnalogValueReached` 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:

  - BrickletAnalogInV2.THRESHOLD_OPTION_OFF = 'x'
  - BrickletAnalogInV2.THRESHOLD_OPTION_OUTSIDE = 'o'
  - BrickletAnalogInV2.THRESHOLD_OPTION_INSIDE = 'i'
  - BrickletAnalogInV2.THRESHOLD_OPTION_SMALLER = '<'
  - BrickletAnalogInV2.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:

  - BrickletAnalogInV2.THRESHOLD_OPTION_OFF = 'x'
  - BrickletAnalogInV2.THRESHOLD_OPTION_OUTSIDE = 'o'
  - BrickletAnalogInV2.THRESHOLD_OPTION_INSIDE = 'i'
  - BrickletAnalogInV2.THRESHOLD_OPTION_SMALLER = '<'
  - BrickletAnalogInV2.THRESHOLD_OPTION_GREATER = '>'

public void `SetDebouncePeriod`(long debounce)

  Sets the period in ms with which the threshold callbacks

  - `VoltageReached`,
  - `AnalogValueReached`

  are triggered, if the thresholds

  - `SetVoltageCallbackThreshold()`,
  - `SetAnalogValueCallbackThreshold()`

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

    analogInV2.ExampleCallback += Callback;

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 `Voltage`(BrickletAnalogInV2 sender, int voltage)

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

  `Voltage` is only triggered if the voltage has changed since the last triggering.

public event `AnalogValue`(BrickletAnalogInV2 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.

  `AnalogValue` is only triggered if the voltage has changed since the last triggering.

public event `VoltageReached`(BrickletAnalogInV2 sender, int voltage)

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

public event `AnalogValueReached`(BrickletAnalogInV2 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()`.

### Constants

public int `DEVICE_IDENTIFIER`

  This constant is used to identify a Analog In Bricklet 2.0.

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

The content of this page is licensed under Creative Commons Attribution 3.0 Unported License.