Deutsch
English
Menu
Software / API Bindings / C# / API Referenz und Beispiele / Bricklets (Abgekündigt) / Voltage/Current Bricklet

C# - Voltage/Current Bricklet

Dies ist die Beschreibung der C# API Bindings für das Voltage/Current Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Voltage/Current Bricklet 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

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
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 Voltage/Current Bricklet

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletVoltageCurrent vc = new BrickletVoltageCurrent(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 = vc.GetVoltage();
        Console.WriteLine("Voltage: " + voltage/1000.0 + " V");

        // Get current current
        int current = vc.GetCurrent();
        Console.WriteLine("Current: " + current/1000.0 + " A");

        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
35
36
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 Voltage/Current Bricklet

    // Callback function for current callback
    static void CurrentCB(BrickletVoltageCurrent sender, int current)
    {
        Console.WriteLine("Current: " + current/1000.0 + " A");
    }

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

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

        // Register current callback to function CurrentCB
        vc.CurrentCallback += CurrentCB;

        // Set period for current callback to 1s (1000ms)
        // Note: The current callback is only called every second
        //       if the current has changed since the last call!
        vc.SetCurrentCallbackPeriod(1000);

        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
36
37
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 Voltage/Current Bricklet

    // Callback function for power reached callback
    static void PowerReachedCB(BrickletVoltageCurrent sender, int power)
    {
        Console.WriteLine("Power: " + power/1000.0 + " W");
    }

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

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

        // Get threshold callbacks with a debounce time of 10 seconds (10000ms)
        vc.SetDebouncePeriod(10000);

        // Register power reached callback to function PowerReachedCB
        vc.PowerReachedCallback += PowerReachedCB;

        // Configure threshold for power "greater than 10 W"
        vc.SetPowerCallbackThreshold('>', 10*1000, 0);

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

class BrickletVoltageCurrent(string uid, IPConnection ipcon)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: IPConnection
Rückgabe:
  • voltageCurrent – Typ: BrickletVoltageCurrent

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

BrickletVoltageCurrent voltageCurrent = new BrickletVoltageCurrent("YOUR_DEVICE_UID", ipcon);

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

int BrickletVoltageCurrent.GetCurrent()
Rückgabe:
  • current – Typ: int, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]

Gibt die gemessenen Stromstärke zurück.

Wenn die Stromstärke periodisch abgefragt werden soll, wird empfohlen den CurrentCallback Callback zu nutzen und die Periode mit SetCurrentCallbackPeriod() vorzugeben.

int BrickletVoltageCurrent.GetVoltage()
Rückgabe:
  • voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 36000]

Gibt die gemessenen Spannung zurück.

Wenn die Spannung periodisch abgefragt werden soll, wird empfohlen den VoltageCallback Callback zu nutzen und die Periode mit SetVoltageCallbackPeriod() vorzugeben.

int BrickletVoltageCurrent.GetPower()
Rückgabe:
  • power – Typ: int, Einheit: 1 mW, Wertebereich: [0 bis 720000]

Gibt die gemessenen Leistung zurück.

Wenn die Leistung periodisch abgefragt werden soll, wird empfohlen den PowerCallback Callback zu nutzen und die Periode mit SetPowerCallbackPeriod() vorzugeben.

void BrickletVoltageCurrent.SetConfiguration(byte averaging, byte voltageConversionTime, byte currentConversionTime)
Parameter:
  • averaging – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 3
  • voltageConversionTime – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 4
  • currentConversionTime – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 4

Setzt die Konfiguration des Voltage/Current Bricklet. Es ist möglich die Anzahl für die Durchschnittsbildung, und die Wandlungszeit für Spannung und Stromstärke zu definieren.

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

Für averaging:

  • BrickletVoltageCurrent.AVERAGING_1 = 0
  • BrickletVoltageCurrent.AVERAGING_4 = 1
  • BrickletVoltageCurrent.AVERAGING_16 = 2
  • BrickletVoltageCurrent.AVERAGING_64 = 3
  • BrickletVoltageCurrent.AVERAGING_128 = 4
  • BrickletVoltageCurrent.AVERAGING_256 = 5
  • BrickletVoltageCurrent.AVERAGING_512 = 6
  • BrickletVoltageCurrent.AVERAGING_1024 = 7

Für voltageConversionTime:

  • BrickletVoltageCurrent.CONVERSION_TIME_140US = 0
  • BrickletVoltageCurrent.CONVERSION_TIME_204US = 1
  • BrickletVoltageCurrent.CONVERSION_TIME_332US = 2
  • BrickletVoltageCurrent.CONVERSION_TIME_588US = 3
  • BrickletVoltageCurrent.CONVERSION_TIME_1_1MS = 4
  • BrickletVoltageCurrent.CONVERSION_TIME_2_116MS = 5
  • BrickletVoltageCurrent.CONVERSION_TIME_4_156MS = 6
  • BrickletVoltageCurrent.CONVERSION_TIME_8_244MS = 7

Für currentConversionTime:

  • BrickletVoltageCurrent.CONVERSION_TIME_140US = 0
  • BrickletVoltageCurrent.CONVERSION_TIME_204US = 1
  • BrickletVoltageCurrent.CONVERSION_TIME_332US = 2
  • BrickletVoltageCurrent.CONVERSION_TIME_588US = 3
  • BrickletVoltageCurrent.CONVERSION_TIME_1_1MS = 4
  • BrickletVoltageCurrent.CONVERSION_TIME_2_116MS = 5
  • BrickletVoltageCurrent.CONVERSION_TIME_4_156MS = 6
  • BrickletVoltageCurrent.CONVERSION_TIME_8_244MS = 7
void BrickletVoltageCurrent.GetConfiguration(out byte averaging, out byte voltageConversionTime, out byte currentConversionTime)
Ausgabeparameter:
  • averaging – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 3
  • voltageConversionTime – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 4
  • currentConversionTime – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 4

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

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

Für averaging:

  • BrickletVoltageCurrent.AVERAGING_1 = 0
  • BrickletVoltageCurrent.AVERAGING_4 = 1
  • BrickletVoltageCurrent.AVERAGING_16 = 2
  • BrickletVoltageCurrent.AVERAGING_64 = 3
  • BrickletVoltageCurrent.AVERAGING_128 = 4
  • BrickletVoltageCurrent.AVERAGING_256 = 5
  • BrickletVoltageCurrent.AVERAGING_512 = 6
  • BrickletVoltageCurrent.AVERAGING_1024 = 7

Für voltageConversionTime:

  • BrickletVoltageCurrent.CONVERSION_TIME_140US = 0
  • BrickletVoltageCurrent.CONVERSION_TIME_204US = 1
  • BrickletVoltageCurrent.CONVERSION_TIME_332US = 2
  • BrickletVoltageCurrent.CONVERSION_TIME_588US = 3
  • BrickletVoltageCurrent.CONVERSION_TIME_1_1MS = 4
  • BrickletVoltageCurrent.CONVERSION_TIME_2_116MS = 5
  • BrickletVoltageCurrent.CONVERSION_TIME_4_156MS = 6
  • BrickletVoltageCurrent.CONVERSION_TIME_8_244MS = 7

Für currentConversionTime:

  • BrickletVoltageCurrent.CONVERSION_TIME_140US = 0
  • BrickletVoltageCurrent.CONVERSION_TIME_204US = 1
  • BrickletVoltageCurrent.CONVERSION_TIME_332US = 2
  • BrickletVoltageCurrent.CONVERSION_TIME_588US = 3
  • BrickletVoltageCurrent.CONVERSION_TIME_1_1MS = 4
  • BrickletVoltageCurrent.CONVERSION_TIME_2_116MS = 5
  • BrickletVoltageCurrent.CONVERSION_TIME_4_156MS = 6
  • BrickletVoltageCurrent.CONVERSION_TIME_8_244MS = 7

Fortgeschrittene Funktionen

void BrickletVoltageCurrent.SetCalibration(int gainMultiplier, int gainDivisor)
Parameter:
  • gainMultiplier – Typ: int, Wertebereich: [0 bis 216 - 1]
  • gainDivisor – Typ: int, Wertebereich: [0 bis 216 - 1]

Da der Shunt-Widerstand über den die Stromstärke gemessen wird keine perfekte Genauigkeit hat, ist es nötig einen Multiplikator und einen Divisor zu setzen, falls sehr genaue Messwerte nötig sind.

Zum Beispiel: Wenn eine Messung von 1000mA erwartet wird, das Voltage/Current Bricklet aber 1023mA zurück gibt, sollte der Multiplikator auf 1000 und der Divisor auf 1023 gesetzt werden.

void BrickletVoltageCurrent.GetCalibration(out int gainMultiplier, out int gainDivisor)
Ausgabeparameter:
  • gainMultiplier – Typ: int, Wertebereich: [0 bis 216 - 1]
  • gainDivisor – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die Kalibrierung zurück, wie von SetCalibration() gesetzt.

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

Konfigurationsfunktionen für Callbacks

void BrickletVoltageCurrent.SetCurrentCallbackPeriod(long period)
Parameter:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der CurrentCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der CurrentCallback Callback wird nur ausgelöst, wenn sich die Stromstärke seit der letzten Auslösung geändert hat.

long BrickletVoltageCurrent.GetCurrentCallbackPeriod()
Rückgabe:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von SetCurrentCallbackPeriod() gesetzt

void BrickletVoltageCurrent.SetVoltageCallbackPeriod(long period)
Parameter:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der VoltageCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der VoltageCallback Callback wird nur ausgelöst, wenn sich die Spannung seit der letzten Auslösung geändert hat.

long BrickletVoltageCurrent.GetVoltageCallbackPeriod()
Rückgabe:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von SetVoltageCallbackPeriod() gesetzt

void BrickletVoltageCurrent.SetPowerCallbackPeriod(long period)
Parameter:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der PowerCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der PowerCallback Callback wird nur ausgelöst, wenn sich die Leistung seit der letzten Auslösung geändert hat.

long BrickletVoltageCurrent.GetPowerCallbackPeriod()
Rückgabe:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von GetPowerCallbackPeriod() gesetzt

void BrickletVoltageCurrent.SetCurrentCallbackThreshold(char option, int min, int max)
Parameter:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Einheit: 1 mA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1 mA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Setzt den Schwellwert für den CurrentReachedCallback Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Stromstärke außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn die Stromstärke innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn die Stromstärke kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Stromstärke größer als der min Wert ist (max wird ignoriert)

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

Für option:

  • BrickletVoltageCurrent.THRESHOLD_OPTION_OFF = 'x'
  • BrickletVoltageCurrent.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletVoltageCurrent.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletVoltageCurrent.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletVoltageCurrent.THRESHOLD_OPTION_GREATER = '>'
void BrickletVoltageCurrent.GetCurrentCallbackThreshold(out char option, out int min, out int max)
Ausgabeparameter:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Einheit: 1 mA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1 mA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von SetCurrentCallbackThreshold() gesetzt.

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

Für option:

  • BrickletVoltageCurrent.THRESHOLD_OPTION_OFF = 'x'
  • BrickletVoltageCurrent.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletVoltageCurrent.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletVoltageCurrent.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletVoltageCurrent.THRESHOLD_OPTION_GREATER = '>'
void BrickletVoltageCurrent.SetVoltageCallbackThreshold(char option, int min, int max)
Parameter:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Setzt den Schwellwert für den VoltageReachedCallback Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Spannung außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn die Spannung innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn die Spannung kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Spannung größer als der min Wert ist (max wird ignoriert)

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

Für option:

  • BrickletVoltageCurrent.THRESHOLD_OPTION_OFF = 'x'
  • BrickletVoltageCurrent.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletVoltageCurrent.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletVoltageCurrent.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletVoltageCurrent.THRESHOLD_OPTION_GREATER = '>'
void BrickletVoltageCurrent.GetVoltageCallbackThreshold(out char option, out int min, out int max)
Ausgabeparameter:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von SetVoltageCallbackThreshold() gesetzt.

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

Für option:

  • BrickletVoltageCurrent.THRESHOLD_OPTION_OFF = 'x'
  • BrickletVoltageCurrent.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletVoltageCurrent.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletVoltageCurrent.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletVoltageCurrent.THRESHOLD_OPTION_GREATER = '>'
void BrickletVoltageCurrent.SetPowerCallbackThreshold(char option, int min, int max)
Parameter:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Einheit: 1 mW, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1 mW, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Setzt den Schwellwert für den PowerReachedCallback Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Leistung außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn die Leistung innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn die Leistung kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Leistung größer als der min Wert ist (max wird ignoriert)

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

Für option:

  • BrickletVoltageCurrent.THRESHOLD_OPTION_OFF = 'x'
  • BrickletVoltageCurrent.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletVoltageCurrent.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletVoltageCurrent.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletVoltageCurrent.THRESHOLD_OPTION_GREATER = '>'
void BrickletVoltageCurrent.GetPowerCallbackThreshold(out char option, out int min, out int max)
Ausgabeparameter:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Einheit: 1 mW, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1 mW, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von SetPowerCallbackThreshold() gesetzt.

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

Für option:

  • BrickletVoltageCurrent.THRESHOLD_OPTION_OFF = 'x'
  • BrickletVoltageCurrent.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletVoltageCurrent.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletVoltageCurrent.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletVoltageCurrent.THRESHOLD_OPTION_GREATER = '>'
void BrickletVoltageCurrent.SetDebouncePeriod(long debounce)
Parameter:
  • debounce – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Setzt die Periode mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

long BrickletVoltageCurrent.GetDebouncePeriod()
Rückgabe:
  • debounce – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von SetDebouncePeriod() gesetzt.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung geschieht durch Anhängen des Callback Handlers an den passenden Event:

void MyCallback(BrickletVoltageCurrent sender, int value)
{
    System.Console.WriteLine("Value: " + value);
}

voltageCurrent.ExampleCallback += MyCallback;

Die verfügbaren Events werden weiter unten beschrieben.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

event BrickletVoltageCurrent.CurrentCallback(BrickletVoltageCurrent sender, int current)
Callback-Parameter:
  • sender – Typ: BrickletVoltageCurrent
  • current – Typ: int, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]

Dieser Callback wird mit der Periode, wie gesetzt mit SetCurrentCallbackPeriod(), ausgelöst. Der Parameter ist die Stromstärke des Sensors.

Der CurrentCallback Callback wird nur ausgelöst, wenn sich die Stromstärke seit der letzten Auslösung geändert hat.

event BrickletVoltageCurrent.VoltageCallback(BrickletVoltageCurrent sender, int voltage)
Callback-Parameter:
  • sender – Typ: BrickletVoltageCurrent
  • voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 36000]

Dieser Callback wird mit der Periode, wie gesetzt mit SetVoltageCallbackPeriod(), ausgelöst. Der Parameter ist die Spannung des Sensors.

Der VoltageCallback Callback wird nur ausgelöst, wenn sich die Spannung seit der letzten Auslösung geändert hat.

event BrickletVoltageCurrent.PowerCallback(BrickletVoltageCurrent sender, int power)
Callback-Parameter:
  • sender – Typ: BrickletVoltageCurrent
  • power – Typ: int, Einheit: 1 mW, Wertebereich: [0 bis 720000]

Dieser Callback wird mit der Periode, wie gesetzt mit SetPowerCallbackPeriod(), ausgelöst. Der Parameter ist die Leistung des Sensors.

Der PowerCallback Callback wird nur ausgelöst, wenn sich die Leistung seit der letzten Auslösung geändert hat.

event BrickletVoltageCurrent.CurrentReachedCallback(BrickletVoltageCurrent sender, int current)
Callback-Parameter:
  • sender – Typ: BrickletVoltageCurrent
  • current – Typ: int, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetCurrentCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Stromstärke des Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit SetDebouncePeriod() gesetzt, ausgelöst.

event BrickletVoltageCurrent.VoltageReachedCallback(BrickletVoltageCurrent sender, int voltage)
Callback-Parameter:
  • sender – Typ: BrickletVoltageCurrent
  • voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 36000]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetVoltageCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Spannung des Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit SetDebouncePeriod() gesetzt, ausgelöst.

event BrickletVoltageCurrent.PowerReachedCallback(BrickletVoltageCurrent sender, int power)
Callback-Parameter:
  • sender – Typ: BrickletVoltageCurrent
  • power – Typ: int, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetPowerCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Spannung des Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit SetDebouncePeriod() gesetzt, ausgelöst.

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

  • BrickletVoltageCurrent.FUNCTION_SET_CONFIGURATION = 4
  • BrickletVoltageCurrent.FUNCTION_SET_CALIBRATION = 6
  • BrickletVoltageCurrent.FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 8
  • BrickletVoltageCurrent.FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 10
  • BrickletVoltageCurrent.FUNCTION_SET_POWER_CALLBACK_PERIOD = 12
  • BrickletVoltageCurrent.FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 14
  • BrickletVoltageCurrent.FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 16
  • BrickletVoltageCurrent.FUNCTION_SET_POWER_CALLBACK_THRESHOLD = 18
  • BrickletVoltageCurrent.FUNCTION_SET_DEBOUNCE_PERIOD = 20
void BrickletVoltageCurrent.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:

  • BrickletVoltageCurrent.FUNCTION_SET_CONFIGURATION = 4
  • BrickletVoltageCurrent.FUNCTION_SET_CALIBRATION = 6
  • BrickletVoltageCurrent.FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 8
  • BrickletVoltageCurrent.FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 10
  • BrickletVoltageCurrent.FUNCTION_SET_POWER_CALLBACK_PERIOD = 12
  • BrickletVoltageCurrent.FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 14
  • BrickletVoltageCurrent.FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 16
  • BrickletVoltageCurrent.FUNCTION_SET_POWER_CALLBACK_THRESHOLD = 18
  • BrickletVoltageCurrent.FUNCTION_SET_DEBOUNCE_PERIOD = 20
void BrickletVoltageCurrent.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 BrickletVoltageCurrent.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Voltage/Current 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 BrickletVoltageCurrent.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Voltage/Current Bricklet dar.