C# - Analog Out Bricklet

This is the API description for the C# bindings of the Analog Out Bricklet. General information on what this device does and the technical specifications can be found here.

A tutorial on how to test the Analog Out Bricklet and get the first examples running can be found here.

Examples

The example code below is public domain.

Simple

Download

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
        BrickletAnalogOut ao = new BrickletAnalogOut(UID, ipcon); // Create device object

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

        // Set output voltage to 3.3V
        ao.SetVoltage(3300);

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

Creates an object with the unique device ID uid:

BrickletAnalogOut analogOut = new BrickletAnalogOut("YOUR_DEVICE_UID", ipcon);

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

public void SetVoltage(int voltage)

Sets the voltage in mV. The possible range is 0V to 5V (0-5000). Calling this function will set the mode to 0 (see SetMode()).

The default value is 0 (with mode 1).

public int GetVoltage()

Returns the voltage as set by SetVoltage().

Changed in version 1.1.0 (Bindings): Result is returned. Previously it was passed as out parameter.

public void SetMode(byte mode)

Sets the mode of the analog value. Possible modes:

• 0: Normal Mode (Analog value as set by SetVoltage() is applied)
• 1: 1k Ohm resistor to ground
• 2: 100k Ohm resistor to ground
• 3: 500k Ohm resistor to ground

Setting the mode to 0 will result in an output voltage of 0. You can jump to a higher output voltage directly by calling SetVoltage().

The default mode is 1.

The following constants are available for this function:

• BrickletAnalogOut.MODE_ANALOG_VALUE = 0
• BrickletAnalogOut.MODE_1K_TO_GROUND = 1
• BrickletAnalogOut.MODE_100K_TO_GROUND = 2
• BrickletAnalogOut.MODE_500K_TO_GROUND = 3

public byte GetMode()

Returns the mode as set by SetMode().

The following constants are available for this function:

• BrickletAnalogOut.MODE_ANALOG_VALUE = 0
• BrickletAnalogOut.MODE_1K_TO_GROUND = 1
• BrickletAnalogOut.MODE_100K_TO_GROUND = 2
• BrickletAnalogOut.MODE_500K_TO_GROUND = 3

Changed in version 1.1.0 (Bindings): Result is returned. Previously it was passed as out parameter.

Advanced Functions

public byte[] GetAPIVersion()

Returns the API version (major, minor, revision) of the bindings for this device.

Changed in version 1.1.0 (Bindings): Result is returned. Previously it was passed as out parameter.

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.

Changed in version 1.1.0 (Bindings): Result is returned. Previously it was passed as out parameter.

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:

• BrickletAnalogOut.FUNCTION_SET_VOLTAGE = 1
• BrickletAnalogOut.FUNCTION_SET_MODE = 3

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 identifiers can be found here.

New in version 2.0.0 (Plugin).

Constants

public int DEVICE_IDENTIFIER

This constant is used to identify a AnalogOut Bricklet.

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