C# - Current12 Bricklet¶

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

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 Current12 Bricklet

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

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

        // Get current current
        short current = c.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 Current12 Bricklet

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

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletCurrent12 c = new BrickletCurrent12(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
        c.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!
        c.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 Current12 Bricklet

    // Callback function for current reached callback
    static void CurrentReachedCB(BrickletCurrent12 sender, short current)
    {
        Console.WriteLine("Current: " + current/1000.0 + " A");
    }

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletCurrent12 c = new BrickletCurrent12(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)
        c.SetDebouncePeriod(10000);

        // Register current reached callback to function CurrentReachedCB
        c.CurrentReachedCallback += CurrentReachedCB;

        // Configure threshold for current "greater than 5 A"
        c.SetCurrentCallbackThreshold('>', 5*1000, 0);

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

Grundfunktionen¶

class BrickletCurrent12(string uid, IPConnection ipcon)¶

Parameter:	uid – Typ: string ipcon – Typ: IPConnection
Rückgabe:	current12 – Typ: BrickletCurrent12

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

BrickletCurrent12 current12 = new BrickletCurrent12("YOUR_DEVICE_UID", ipcon);

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

short BrickletCurrent12.GetCurrent()¶

Rückgabe:	current – Typ: short, Einheit: 1 mA, Wertebereich: [-12500 bis 12500]

Gibt die gemessenen Stromstärke des Sensors zurück.

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

Fortgeschrittene Funktionen¶

void BrickletCurrent12.Calibrate()¶

Kalibriert den Nullwert des Sensors. Diese Funktion muss aufgerufen werden, wenn kein Strom fließt.

Der Nullwert des Stromsensors ist abhängig von den exakten Eigenschaften des Analog-Digital-Wandlers, der Länge des Bricklet Kabels und der Temperatur. Daher ist es, bei Wechsel des Brick oder bei Veränderung der Umgebung in welcher das Bricklet genutzt wird, ratsam erneut zu kalibrieren.

Die resultierende Kalibrierung wird in den EEPROM des Current Bricklet gespeichert.

bool BrickletCurrent12.IsOverCurrent()¶

Rückgabe:	over – Typ: bool

Gibt true zurück wenn mehr als 12,5A gemessen wurden.

Bemerkung

Um diesen Wert zurückzusetzen ist ein Aus- und Wiedereinschalten des Bricklet notwendig.

int BrickletCurrent12.GetAnalogValue()¶

Rückgabe:	value – Typ: int, Wertebereich: [0 bis 212 - 1]

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück.

Bemerkung

Der von GetCurrent() zurückgegebene Wert ist über mehrere Messwerte gemittelt um das Rauschen zu vermindern, während GetAnalogValue() unverarbeitete Analogwerte zurück gibt. Der einzige Grund GetAnalogValue() zu nutzen, ist die volle Auflösung des Analog-Digital-Wandlers zu erhalten.

Wenn der Analogwert periodisch abgefragt werden soll, wird empfohlen den AnalogValueCallback Callback zu nutzen und die Periode mit SetAnalogValueCallbackPeriod() vorzugeben.

void BrickletCurrent12.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 BrickletCurrent12.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 BrickletCurrent12.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 BrickletCurrent12.SetAnalogValueCallbackPeriod(long period)¶

Parameter:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

long BrickletCurrent12.GetAnalogValueCallbackPeriod()¶

Rückgabe:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

void BrickletCurrent12.SetCurrentCallbackThreshold(char option, short min, short max)¶

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: short, Einheit: 1 mA, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 max – Typ: short, Einheit: 1 mA, Wertebereich: [-215 bis 215 - 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:

• BrickletCurrent12.THRESHOLD_OPTION_OFF = 'x'
• BrickletCurrent12.THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletCurrent12.THRESHOLD_OPTION_INSIDE = 'i'
• BrickletCurrent12.THRESHOLD_OPTION_SMALLER = '<'
• BrickletCurrent12.THRESHOLD_OPTION_GREATER = '>'

void BrickletCurrent12.GetCurrentCallbackThreshold(out char option, out short min, out short max)¶

Ausgabeparameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: short, Einheit: 1 mA, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 max – Typ: short, Einheit: 1 mA, Wertebereich: [-215 bis 215 - 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:

• BrickletCurrent12.THRESHOLD_OPTION_OFF = 'x'
• BrickletCurrent12.THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletCurrent12.THRESHOLD_OPTION_INSIDE = 'i'
• BrickletCurrent12.THRESHOLD_OPTION_SMALLER = '<'
• BrickletCurrent12.THRESHOLD_OPTION_GREATER = '>'

void BrickletCurrent12.SetAnalogValueCallbackThreshold(char option, int min, int max)¶

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Setzt den Schwellwert für den AnalogValueReachedCallback Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

• BrickletCurrent12.THRESHOLD_OPTION_OFF = 'x'
• BrickletCurrent12.THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletCurrent12.THRESHOLD_OPTION_INSIDE = 'i'
• BrickletCurrent12.THRESHOLD_OPTION_SMALLER = '<'
• BrickletCurrent12.THRESHOLD_OPTION_GREATER = '>'

void BrickletCurrent12.GetAnalogValueCallbackThreshold(out char option, out int min, out int max)¶

Ausgabeparameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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

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

Für option:

• BrickletCurrent12.THRESHOLD_OPTION_OFF = 'x'
• BrickletCurrent12.THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletCurrent12.THRESHOLD_OPTION_INSIDE = 'i'
• BrickletCurrent12.THRESHOLD_OPTION_SMALLER = '<'
• BrickletCurrent12.THRESHOLD_OPTION_GREATER = '>'

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

• CurrentReachedCallback,
• AnalogValueReachedCallback

ausgelöst werden, wenn die Schwellwerte

• SetCurrentCallbackThreshold(),
• SetAnalogValueCallbackThreshold()

weiterhin erreicht bleiben.

long BrickletCurrent12.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(BrickletCurrent12 sender, int value)
{
    System.Console.WriteLine("Value: " + value);
}

current12.ExampleCallback += MyCallback;

Die verfügbaren Events werden weiter unten beschrieben.

event BrickletCurrent12.CurrentCallback(BrickletCurrent12 sender, short current)¶

Callback-Parameter:	sender – Typ: BrickletCurrent12 current – Typ: short, Einheit: 1 mA, Wertebereich: [-12500 bis 12500]

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 BrickletCurrent12.AnalogValueCallback(BrickletCurrent12 sender, int value)¶

Callback-Parameter:	sender – Typ: BrickletCurrent12 value – Typ: int, Wertebereich: [0 bis 212 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit SetAnalogValueCallbackPeriod(), ausgelöst. Der Parameter ist der Analogwert des Umgebungslichtsensors.

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

event BrickletCurrent12.CurrentReachedCallback(BrickletCurrent12 sender, short current)¶

Callback-Parameter:	sender – Typ: BrickletCurrent12 current – Typ: short, Einheit: 1 mA, Wertebereich: [-12500 bis 12500]

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 BrickletCurrent12.AnalogValueReachedCallback(BrickletCurrent12 sender, int value)¶

Callback-Parameter:	sender – Typ: BrickletCurrent12 value – Typ: int, Wertebereich: [0 bis 212 - 1]

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

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

event BrickletCurrent12.OverCurrentCallback(BrickletCurrent12 sender)¶

Callback-Parameter:	sender – Typ: BrickletCurrent12

Dieser Callback wird ausgelöst, wenn ein Überstrom gemessen wurde (siehe IsOverCurrent()).

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

• BrickletCurrent12.FUNCTION_CALIBRATE = 2
• BrickletCurrent12.FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 5
• BrickletCurrent12.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
• BrickletCurrent12.FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 9
• BrickletCurrent12.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
• BrickletCurrent12.FUNCTION_SET_DEBOUNCE_PERIOD = 13

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

• BrickletCurrent12.FUNCTION_CALIBRATE = 2
• BrickletCurrent12.FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 5
• BrickletCurrent12.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
• BrickletCurrent12.FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 9
• BrickletCurrent12.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
• BrickletCurrent12.FUNCTION_SET_DEBOUNCE_PERIOD = 13

void BrickletCurrent12.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 BrickletCurrent12.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Current12 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 BrickletCurrent12.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Current12 Bricklet dar.