C# - Industrial Analog Out Bricklet¶

Simple Current¶

Download (ExampleSimpleCurrent.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

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 Industrial Analog Out Bricklet

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

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

        // Set output current to 4.5mA
        iao.SetCurrent(4500);
        iao.Enable();

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

        iao.Disable();

        ipcon.Disconnect();
    }
}

Simple Voltage¶

Download (ExampleSimpleVoltage.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

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 Industrial Analog Out Bricklet

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletIndustrialAnalogOut iao =
          new BrickletIndustrialAnalogOut(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
        iao.SetVoltage(3300);
        iao.Enable();

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

        iao.Disable();

        ipcon.Disconnect();
    }
}

Grundfunktionen¶

class BrickletIndustrialAnalogOut(string uid, IPConnection ipcon)¶

Parameter:	uid – Typ: string ipcon – Typ: IPConnection
Rückgabe:	industrialAnalogOut – Typ: BrickletIndustrialAnalogOut

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

BrickletIndustrialAnalogOut industrialAnalogOut = new BrickletIndustrialAnalogOut("YOUR_DEVICE_UID", ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

void BrickletIndustrialAnalogOut.Enable()¶

Aktiviert die Ausgabe von Spannung und Strom.

Der Standardwert ist deaktiviert.

void BrickletIndustrialAnalogOut.Disable()¶

Deaktiviert die Ausgabe von Spannung und Strom.

Der Standardwert ist deaktiviert.

bool BrickletIndustrialAnalogOut.IsEnabled()¶

Rückgabe:	enabled – Typ: bool, Standardwert: false

Gibt true zurück falls die Ausgabe von Spannung und Strom aktiviert ist, false sonst.

void BrickletIndustrialAnalogOut.SetVoltage(int voltage)¶

Parameter:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 10000]

Setzt die Ausgangsspannung.

Die Ausgangsspannung und der Ausgangsstrom sind gekoppelt. Eine Änderung der Ausgangsspannung führt auch zu einer Änderung des Ausgangsstroms.

int BrickletIndustrialAnalogOut.GetVoltage()¶

Rückgabe:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 10000]

Gibt die Spannung zurück, wie von SetVoltage() gesetzt.

void BrickletIndustrialAnalogOut.SetCurrent(int current)¶

Parameter:	current – Typ: int, Einheit: 1 µA, Wertebereich: [0 bis 24000]

Setzt den Ausgangsstrom.

Der Ausgangsstrom und die Ausgangsspannung sind gekoppelt. Eine Änderung des Ausgangsstroms führt auch zu einer Änderung der Ausgangsspannung.

int BrickletIndustrialAnalogOut.GetCurrent()¶

Rückgabe:	current – Typ: int, Einheit: 1 µA, Wertebereich: [0 bis 24000]

Gibt die Spannung zurück, wie von SetCurrent() gesetzt.

Fortgeschrittene Funktionen¶

void BrickletIndustrialAnalogOut.SetConfiguration(byte voltageRange, byte currentRange)¶

Parameter:	voltageRange – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 1 currentRange – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0

Konfiguriert die Spannungs- und Stromwertebereiche.

Einstellbare Spannungswertebereiche sind:

• 0V bis 5V
• 0V bis 10V

Einstellbare Stromwertebereiche sind:

• 4mA bis 20mA
• 0mA bis 20mA
• 0mA bis 24mA

Die Auflösung ist immer 12 Bit. Dass heißt, die Genauigkeit erhöht sich bei kleineren Wertebereichen.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für voltageRange:

• BrickletIndustrialAnalogOut.VOLTAGE_RANGE_0_TO_5V = 0
• BrickletIndustrialAnalogOut.VOLTAGE_RANGE_0_TO_10V = 1

Für currentRange:

• BrickletIndustrialAnalogOut.CURRENT_RANGE_4_TO_20MA = 0
• BrickletIndustrialAnalogOut.CURRENT_RANGE_0_TO_20MA = 1
• BrickletIndustrialAnalogOut.CURRENT_RANGE_0_TO_24MA = 2

void BrickletIndustrialAnalogOut.GetConfiguration(out byte voltageRange, out byte currentRange)¶

Ausgabeparameter:	voltageRange – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 1 currentRange – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0

Gibt die Konfiguration zurück, wie von SetConfiguration() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für voltageRange:

• BrickletIndustrialAnalogOut.VOLTAGE_RANGE_0_TO_5V = 0
• BrickletIndustrialAnalogOut.VOLTAGE_RANGE_0_TO_10V = 1

Für currentRange:

• BrickletIndustrialAnalogOut.CURRENT_RANGE_4_TO_20MA = 0
• BrickletIndustrialAnalogOut.CURRENT_RANGE_0_TO_20MA = 1
• BrickletIndustrialAnalogOut.CURRENT_RANGE_0_TO_24MA = 2

void BrickletIndustrialAnalogOut.GetIdentity(out string uid, out string connectedUid, out char position, out byte[] hardwareVersion, out byte[] firmwareVersion, out int deviceIdentifier)¶

Ausgabeparameter:

uid – Typ: string, Länge: bis zu 8 connectedUid – Typ: string, Länge: bis zu 8 position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] hardwareVersion – Typ: byte[], Länge: 3 0: major – Typ: byte, Wertebereich: [0 bis 255] 1: minor – Typ: byte, Wertebereich: [0 bis 255] 2: revision – Typ: byte, Wertebereich: [0 bis 255] firmwareVersion – Typ: byte[], Länge: 3 0: major – Typ: byte, Wertebereich: [0 bis 255] 1: minor – Typ: byte, Wertebereich: [0 bis 255] 2: revision – Typ: byte, Wertebereich: [0 bis 255] deviceIdentifier – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

byte[] BrickletIndustrialAnalogOut.GetAPIVersion()¶

Ausgabeparameter:	apiVersion – Typ: byte[], Länge: 3 0: major – Typ: byte, Wertebereich: [0 bis 255] 1: minor – Typ: byte, Wertebereich: [0 bis 255] 2: revision – Typ: byte, Wertebereich: [0 bis 255]

Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

bool BrickletIndustrialAnalogOut.GetResponseExpected(byte functionId)¶

Parameter:	functionId – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:	responseExpected – Typ: bool

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels SetResponseExpected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für functionId:

• BrickletIndustrialAnalogOut.FUNCTION_ENABLE = 1
• BrickletIndustrialAnalogOut.FUNCTION_DISABLE = 2
• BrickletIndustrialAnalogOut.FUNCTION_SET_VOLTAGE = 4
• BrickletIndustrialAnalogOut.FUNCTION_SET_CURRENT = 6
• BrickletIndustrialAnalogOut.FUNCTION_SET_CONFIGURATION = 8

void BrickletIndustrialAnalogOut.SetResponseExpected(byte functionId, bool responseExpected)¶

Parameter:	functionId – Typ: byte, Wertebereich: Siehe Konstanten responseExpected – Typ: bool

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für functionId:

• BrickletIndustrialAnalogOut.FUNCTION_ENABLE = 1
• BrickletIndustrialAnalogOut.FUNCTION_DISABLE = 2
• BrickletIndustrialAnalogOut.FUNCTION_SET_VOLTAGE = 4
• BrickletIndustrialAnalogOut.FUNCTION_SET_CURRENT = 6
• BrickletIndustrialAnalogOut.FUNCTION_SET_CONFIGURATION = 8

void BrickletIndustrialAnalogOut.SetResponseExpectedAll(bool responseExpected)¶

Parameter:	responseExpected – Typ: bool

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Konstanten¶

int BrickletIndustrialAnalogOut.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Industrial Analog Out Bricklet zu identifizieren.

Die GetIdentity() Funktion und der IPConnection.EnumerateCallback Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

string BrickletIndustrialAnalogOut.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Industrial Analog Out Bricklet dar.