C# - Industrial Analog Out Bricklet 2.0

Dies ist die Beschreibung der C# API Bindings für das Industrial Analog Out Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Industrial Analog Out Bricklet 2.0 sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die C# API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

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

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletIndustrialAnalogOutV2 iao =
          new BrickletIndustrialAnalogOutV2(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.SetEnabled(true);

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        iao.SetEnabled(false);
        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
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 2.0

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletIndustrialAnalogOutV2 iao =
          new BrickletIndustrialAnalogOutV2(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.SetEnabled(true);

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

API

Prinzipiell kann jede Funktion der C# Bindings, welche einen Wert zurück gibt eine Tinkerforge.TimeoutException werfen. Diese Exception wird geworfen wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu groß wird.

Da C# nicht mehrere Rückgabewerte direkt unterstützt, wird das out Schlüsselwort genutzt, um mehrere Werte aus einer Funktion zurückzugeben.

Der Namensraum für alle Brick/Bricklet Bindings und die IPConnection ist Tinkerforge.*.

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

public class BrickletIndustrialAnalogOutV2(String uid, IPConnection ipcon)

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

BrickletIndustrialAnalogOutV2 industrialAnalogOutV2 = new BrickletIndustrialAnalogOutV2("YOUR_DEVICE_UID", ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

public void SetEnabled(bool enabled)

Aktiviert/deaktiviert die Ausgabe von Spannung und Strom.

Der Standardwert ist deaktiviert.

public bool GetEnabled()

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

public void SetVoltage(int voltage)

Setzt die Ausgangsspannung in mV.

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

public int GetVoltage()

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

public void SetCurrent(int current)

Setzt den Ausgangsstrom in µA.

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

public int GetCurrent()

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

public void SetOutLEDConfig(byte config)

Die Out LED kann an- oder ausgeschaltet werden. Zusätzlich kann ein Heartbeat oder der "Out-Status" angezeigt werden. Falls Out-Status gewählt wird kann die LED entweder ab einem vordefinierten Schwellwert eingeschaltet werden oder ihre Helligkeit anhand des Ausgabewertes (Spannung oder Strom) skaliert werden.

Das Verhalten des Out-Status kann mittels SetOutLEDStatusConfig() eingestellt werden.

Standardmäßig ist die LED auf Out-Status konfiguriert.

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

  • BrickletIndustrialAnalogOutV2.OUT_LED_CONFIG_OFF = 0
  • BrickletIndustrialAnalogOutV2.OUT_LED_CONFIG_ON = 1
  • BrickletIndustrialAnalogOutV2.OUT_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialAnalogOutV2.OUT_LED_CONFIG_SHOW_OUT_STATUS = 3
public byte GetOutLEDConfig()

Gibt die Out-LED-Konfiguration zurück, wie von SetOutLEDConfig() gesetzt.

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

  • BrickletIndustrialAnalogOutV2.OUT_LED_CONFIG_OFF = 0
  • BrickletIndustrialAnalogOutV2.OUT_LED_CONFIG_ON = 1
  • BrickletIndustrialAnalogOutV2.OUT_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialAnalogOutV2.OUT_LED_CONFIG_SHOW_OUT_STATUS = 3
public void SetOutLEDStatusConfig(int min, int max, byte config)

Setzt die Out-LED-Status-Konfiguration. Diese Einstellung wird verwendet wenn die Out-LED auf Out-Status eingestellt ist, siehe SetOutLEDConfig().

Für jeden Kanal kann zwischen Schwellwert- und Intensitätsmodus gewählt werden.

Im Schwellwertmodus kann ein positiver oder negativer Schwellwert definiert werden. Für einen positiven Schwellwert muss das "min" Parameter auf den gewünschten Schwellwert in mV oder µA gesetzt werden, über dem die LED eingeschaltet werden soll. Der "max" Parameter muss auf 0 gesetzt werden. Beispiel: Bei einem positiven Schwellwert von 5V wird die LED eingeschaltet sobald der Ausgabewert über 5V steigt und wieder ausgeschaltet sobald der Ausgabewert unter 5V fällt. Für einen negativen Schwellwert muss das "max" Parameter auf den gewünschten Schwellwert in mV oder µA gesetzt werden, unter dem die LED eingeschaltet werden soll. Der "max" Parameter muss auf 0 gesetzt werden. Beispiel: Bei einem negativen Schwellwert von 5V wird die LED eingeschaltet sobald der Ausgabewert unter 5V fällt und wieder ausgeschaltet sobald der Ausgabewert über 5V steigt.

Im Intensitätsmodus kann ein Bereich in mV oder µA angegeben werden über den die Helligkeit der LED skaliert wird. Beispiel mit min=2V und max=8V: Die LED ist bei 2V und darunter aus, bei 8V und darüber an und zwischen 2V und 8V wird die Helligkeit linear skaliert. Wenn der min Wert größer als der max Wert ist, dann wird die Helligkeit andersherum skaliert.

Standardwerte: Intensitätsmodus mit min=0V und max=10V.

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

  • BrickletIndustrialAnalogOutV2.OUT_LED_STATUS_CONFIG_THRESHOLD = 0
  • BrickletIndustrialAnalogOutV2.OUT_LED_STATUS_CONFIG_INTENSITY = 1
public void GetOutLEDStatusConfig(out int min, out int max, out byte config)

Gibt die Out-LED-Status-Konfiguration zurück, wie von SetOutLEDStatusConfig() gesetzt.

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

  • BrickletIndustrialAnalogOutV2.OUT_LED_STATUS_CONFIG_THRESHOLD = 0
  • BrickletIndustrialAnalogOutV2.OUT_LED_STATUS_CONFIG_INTENSITY = 1

Fortgeschrittene Funktionen

public void SetConfiguration(byte voltageRange, byte currentRange)

Konfiguriert die Spannungs- und Stromwertebereiche.

Einstellbare Spannungswertebereiche sind:

  • 0V bis 5V
  • 0V bis 10V (Standard)

Einstellbare Stromwertebereiche sind:

  • 4mA bis 20mA (Standard)
  • 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:

  • BrickletIndustrialAnalogOutV2.VOLTAGE_RANGE_0_TO_5V = 0
  • BrickletIndustrialAnalogOutV2.VOLTAGE_RANGE_0_TO_10V = 1
  • BrickletIndustrialAnalogOutV2.CURRENT_RANGE_4_TO_20MA = 0
  • BrickletIndustrialAnalogOutV2.CURRENT_RANGE_0_TO_20MA = 1
  • BrickletIndustrialAnalogOutV2.CURRENT_RANGE_0_TO_24MA = 2
public void GetConfiguration(out byte voltageRange, out byte currentRange)

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

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

  • BrickletIndustrialAnalogOutV2.VOLTAGE_RANGE_0_TO_5V = 0
  • BrickletIndustrialAnalogOutV2.VOLTAGE_RANGE_0_TO_10V = 1
  • BrickletIndustrialAnalogOutV2.CURRENT_RANGE_4_TO_20MA = 0
  • BrickletIndustrialAnalogOutV2.CURRENT_RANGE_0_TO_20MA = 1
  • BrickletIndustrialAnalogOutV2.CURRENT_RANGE_0_TO_24MA = 2
public byte[] GetAPIVersion()

Gibt die Version der API Definition (Major, Minor, Revision) 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.

public bool GetResponseExpected(byte functionId)

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.

Siehe SetResponseExpected() für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

public void SetResponseExpected(byte functionId, bool responseExpected)

Ä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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • BrickletIndustrialAnalogOutV2.FUNCTION_SET_ENABLED = 1
  • BrickletIndustrialAnalogOutV2.FUNCTION_SET_VOLTAGE = 3
  • BrickletIndustrialAnalogOutV2.FUNCTION_SET_CURRENT = 5
  • BrickletIndustrialAnalogOutV2.FUNCTION_SET_CONFIGURATION = 7
  • BrickletIndustrialAnalogOutV2.FUNCTION_SET_OUT_LED_CONFIG = 9
  • BrickletIndustrialAnalogOutV2.FUNCTION_SET_OUT_LED_STATUS_CONFIG = 11
  • BrickletIndustrialAnalogOutV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIndustrialAnalogOutV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIndustrialAnalogOutV2.FUNCTION_RESET = 243
  • BrickletIndustrialAnalogOutV2.FUNCTION_WRITE_UID = 248
public void SetResponseExpectedAll(bool responseExpected)

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

public void GetSPITFPErrorCount(out long errorCountAckChecksum, out long errorCountMessageChecksum, out long errorCountFrame, out long errorCountOverflow)

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

public byte SetBootloaderMode(byte mode)

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootlodaer- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

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

Gibt den aktuellen Bootloader-Modus zurück, siehe SetBootloaderMode().

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

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

Setzt den Firmware-Pointer für WriteFirmware(). Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

public byte WriteFirmware(byte[] data)

Schreibt 64 Bytes Firmware an die Position die vorher von SetWriteFirmwarePointer() gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

public void SetStatusLEDConfig(byte config)

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

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

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

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

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

Gibt die Temperatur in °C, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

public void Reset()

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

public void WriteUID(long uid)

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

public long ReadUID()

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

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

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 kann 'a', 'b', 'c' oder 'd' sein.

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

Konstanten

public int DEVICE_IDENTIFIER

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

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

public string DEVICE_DISPLAY_NAME

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