C# - Analog In Bricklet 3.0

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

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletAnalogInV3 ai = new BrickletAnalogInV3(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 = ai.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
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 Analog In Bricklet 3.0

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

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletAnalogInV3 ai = new BrickletAnalogInV3(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
        ai.VoltageCallback += VoltageCB;

        // Set period for voltage callback to 1s (1000ms) without a threshold
        ai.SetVoltageCallbackConfiguration(1000, false, 'x', 0, 0);

        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
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 Analog In Bricklet 3.0

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

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletAnalogInV3 ai = new BrickletAnalogInV3(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
        ai.VoltageCallback += VoltageCB;

        // Configure threshold for voltage "smaller than 5 V"
        // with a debounce period of 1s (1000ms)
        ai.SetVoltageCallbackConfiguration(1000, false, '<', 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 BrickletAnalogInV3(String uid, IPConnection ipcon)

Creates an object with the unique device ID uid:

BrickletAnalogInV3 analogInV3 = new BrickletAnalogInV3("YOUR_DEVICE_UID", ipcon);

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

int BrickletAnalogInV3.GetVoltage()

Returns the measured voltage. The value is in mV and between 0V and 42V. The resolution is approximately 10mV to 1mV depending on the oversampling configuration (SetOversampling()).

If you want to get the value periodically, it is recommended to use the VoltageCallback callback. You can set the callback configuration with SetVoltageCallbackConfiguration().

Advanced Functions

void BrickletAnalogInV3.SetOversampling(byte oversampling)

Sets the oversampling between 32x and 16384x. The Bricklet takes one 12bit sample every 17.5µs. Thus an oversampling of 32x is equivalent to an integration time of 0.56ms and a oversampling of 16384x is equivalent to an integration time of 286ms.

The oversampling uses the moving average principle. A new value is always calculated once per millisecond.

With increased oversampling the noise decreases. With decreased oversampling the reaction time increases (changes in voltage will be measured faster).

The default value is 4096x.

The following constants are available for this function:

  • BrickletAnalogInV3.OVERSAMPLING_32 = 0
  • BrickletAnalogInV3.OVERSAMPLING_64 = 1
  • BrickletAnalogInV3.OVERSAMPLING_128 = 2
  • BrickletAnalogInV3.OVERSAMPLING_256 = 3
  • BrickletAnalogInV3.OVERSAMPLING_512 = 4
  • BrickletAnalogInV3.OVERSAMPLING_1024 = 5
  • BrickletAnalogInV3.OVERSAMPLING_2048 = 6
  • BrickletAnalogInV3.OVERSAMPLING_4096 = 7
  • BrickletAnalogInV3.OVERSAMPLING_8192 = 8
  • BrickletAnalogInV3.OVERSAMPLING_16384 = 9
byte BrickletAnalogInV3.GetOversampling()

Returns the oversampling value as set by SetOversampling().

The following constants are available for this function:

  • BrickletAnalogInV3.OVERSAMPLING_32 = 0
  • BrickletAnalogInV3.OVERSAMPLING_64 = 1
  • BrickletAnalogInV3.OVERSAMPLING_128 = 2
  • BrickletAnalogInV3.OVERSAMPLING_256 = 3
  • BrickletAnalogInV3.OVERSAMPLING_512 = 4
  • BrickletAnalogInV3.OVERSAMPLING_1024 = 5
  • BrickletAnalogInV3.OVERSAMPLING_2048 = 6
  • BrickletAnalogInV3.OVERSAMPLING_4096 = 7
  • BrickletAnalogInV3.OVERSAMPLING_8192 = 8
  • BrickletAnalogInV3.OVERSAMPLING_16384 = 9
void BrickletAnalogInV3.SetCalibration(short offset, int multiplier, int divisor)

Sets a calibration for the measured voltage value. The formula for the calibration is as follows:

Calibrated Value = (Value + Offset) * Multiplier / Divisor

We recommend that you use the Brick Viewer to calibrate the Bricklet. The calibration will be saved internally and only has to be done once.

void BrickletAnalogInV3.GetCalibration(out short offset, out int multiplier, out int divisor)

Returns the calibration as set by SetCalibration().

byte[] BrickletAnalogInV3.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.

bool BrickletAnalogInV3.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.

The following constants are available for this function:

  • BrickletAnalogInV3.FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION = 2
  • BrickletAnalogInV3.FUNCTION_SET_OVERSAMPLING = 5
  • BrickletAnalogInV3.FUNCTION_SET_CALIBRATION = 7
  • BrickletAnalogInV3.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletAnalogInV3.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletAnalogInV3.FUNCTION_RESET = 243
  • BrickletAnalogInV3.FUNCTION_WRITE_UID = 248
void BrickletAnalogInV3.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 constants are available for this function:

  • BrickletAnalogInV3.FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION = 2
  • BrickletAnalogInV3.FUNCTION_SET_OVERSAMPLING = 5
  • BrickletAnalogInV3.FUNCTION_SET_CALIBRATION = 7
  • BrickletAnalogInV3.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletAnalogInV3.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletAnalogInV3.FUNCTION_RESET = 243
  • BrickletAnalogInV3.FUNCTION_WRITE_UID = 248
void BrickletAnalogInV3.SetResponseExpectedAll(bool responseExpected)

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

void BrickletAnalogInV3.GetSPITFPErrorCount(out long errorCountAckChecksum, out long errorCountMessageChecksum, out long errorCountFrame, out long errorCountOverflow)

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

  • ACK checksum errors,
  • message checksum errors,
  • framing errors and
  • overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

byte BrickletAnalogInV3.SetBootloaderMode(byte mode)

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following constants are available for this function:

  • BrickletAnalogInV3.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletAnalogInV3.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletAnalogInV3.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletAnalogInV3.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletAnalogInV3.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletAnalogInV3.BOOTLOADER_STATUS_OK = 0
  • BrickletAnalogInV3.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletAnalogInV3.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletAnalogInV3.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletAnalogInV3.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletAnalogInV3.BOOTLOADER_STATUS_CRC_MISMATCH = 5
byte BrickletAnalogInV3.GetBootloaderMode()

Returns the current bootloader mode, see SetBootloaderMode().

The following constants are available for this function:

  • BrickletAnalogInV3.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletAnalogInV3.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletAnalogInV3.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletAnalogInV3.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletAnalogInV3.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
void BrickletAnalogInV3.SetWriteFirmwarePointer(long pointer)

Sets the firmware pointer for WriteFirmware(). The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

byte BrickletAnalogInV3.WriteFirmware(byte[] data)

Writes 64 Bytes of firmware at the position as written by SetWriteFirmwarePointer() before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

void BrickletAnalogInV3.SetStatusLEDConfig(byte config)

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following constants are available for this function:

  • BrickletAnalogInV3.STATUS_LED_CONFIG_OFF = 0
  • BrickletAnalogInV3.STATUS_LED_CONFIG_ON = 1
  • BrickletAnalogInV3.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletAnalogInV3.STATUS_LED_CONFIG_SHOW_STATUS = 3
byte BrickletAnalogInV3.GetStatusLEDConfig()

Returns the configuration as set by SetStatusLEDConfig()

The following constants are available for this function:

  • BrickletAnalogInV3.STATUS_LED_CONFIG_OFF = 0
  • BrickletAnalogInV3.STATUS_LED_CONFIG_ON = 1
  • BrickletAnalogInV3.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletAnalogInV3.STATUS_LED_CONFIG_SHOW_STATUS = 3
short BrickletAnalogInV3.GetChipTemperature()

Returns the temperature in °C as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

void BrickletAnalogInV3.Reset()

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

void BrickletAnalogInV3.WriteUID(long uid)

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

long BrickletAnalogInV3.ReadUID()

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

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

void BrickletAnalogInV3.SetVoltageCallbackConfiguration(long period, bool valueHasToChange, char option, int min, int max)

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

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the VoltageCallback callback.

The following options are possible:

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

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

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

The following constants are available for this function:

  • BrickletAnalogInV3.THRESHOLD_OPTION_OFF = 'x'
  • BrickletAnalogInV3.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletAnalogInV3.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletAnalogInV3.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletAnalogInV3.THRESHOLD_OPTION_GREATER = '>'
void BrickletAnalogInV3.GetVoltageCallbackConfiguration(out long period, out bool valueHasToChange, out char option, out int min, out int max)

Returns the callback configuration as set by SetVoltageCallbackConfiguration().

The following constants are available for this function:

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

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

analogInV3.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 BrickletAnalogInV3.VoltageCallback(BrickletAnalogInV3 sender, int voltage)

This callback is triggered periodically according to the configuration set by SetVoltageCallbackConfiguration().

The parameter is the same as GetVoltage().

Constants

int BrickletAnalogInV3.DEVICE_IDENTIFIER

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

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 BrickletAnalogInV3.DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Analog In Bricklet 3.0.