C# - Analog Out Bricklet 2.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

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 Out Bricklet 2.0

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletAnalogOutV2 ao = new BrickletAnalogOutV2(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.SetOutputVoltage(3300);

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

Basic Functions¶

class BrickletAnalogOutV2(String uid, IPConnection ipcon)¶

Creates an object with the unique device ID uid:

BrickletAnalogOutV2 analogOutV2 = new BrickletAnalogOutV2("YOUR_DEVICE_UID", ipcon);

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

void BrickletAnalogOutV2.SetOutputVoltage(int voltage)¶

Sets the voltage in mV. The possible range is 0V to 12V (0-12000).

int BrickletAnalogOutV2.GetOutputVoltage()¶

Returns the voltage as set by SetOutputVoltage().

Advanced Functions¶

int BrickletAnalogOutV2.GetInputVoltage()¶

Returns the input voltage in mV.

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

• BrickletAnalogOutV2.FUNCTION_SET_OUTPUT_VOLTAGE = 1

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

• BrickletAnalogOutV2.FUNCTION_SET_OUTPUT_VOLTAGE = 1

void BrickletAnalogOutV2.SetResponseExpectedAll(bool responseExpected)¶

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

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

Constants¶

int BrickletAnalogOutV2.DEVICE_IDENTIFIER¶

This constant is used to identify a Analog Out Bricklet 2.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 BrickletAnalogOutV2.DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a Analog Out Bricklet 2.0.