C# - Moisture 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 Moisture Bricklet

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

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

        // Get current moisture value
        int moisture = m.GetMoistureValue();
        Console.WriteLine("Moisture Value: " + moisture);

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

    // Callback function for moisture value callback
    static void MoistureCB(BrickletMoisture sender, int moisture)
    {
        Console.WriteLine("Moisture Value: " + moisture);
    }

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

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

        // Register moisture value callback to function MoistureCB
        m.MoistureCallback += MoistureCB;

        // Set period for moisture value callback to 1s (1000ms)
        // Note: The moisture value callback is only called every second
        //       if the moisture value has changed since the last call!
        m.SetMoistureCallbackPeriod(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 Moisture Bricklet

    // Callback function for moisture value reached callback
    static void MoistureReachedCB(BrickletMoisture sender, int moisture)
    {
        Console.WriteLine("Moisture Value: " + moisture);
    }

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletMoisture m = new BrickletMoisture(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 1 second (1000ms)
        m.SetDebouncePeriod(1000);

        // Register moisture value reached callback to function MoistureReachedCB
        m.MoistureReachedCallback += MoistureReachedCB;

        // Configure threshold for moisture value "greater than 200"
        m.SetMoistureCallbackThreshold('>', 200, 0);

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

Grundfunktionen¶

class BrickletMoisture(string uid, IPConnection ipcon)¶

Parameter:	uid – Typ: string ipcon – Typ: IPConnection
Rückgabe:	moisture – Typ: BrickletMoisture

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

BrickletMoisture moisture = new BrickletMoisture("YOUR_DEVICE_UID", ipcon);

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

int BrickletMoisture.GetMoistureValue()¶

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

Gibt den aktuellen Feuchtigkeitswert zurück. Ein kleiner Wert entspricht einer geringen Feuchtigkeit, ein großer Wert entspricht einer hohen Feuchtigkeit.

Wenn der Feuchtigkeitswert periodisch abgefragt werden soll, wird empfohlen den MoistureCallback Callback zu nutzen und die Periode mit SetMoistureCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen¶

void BrickletMoisture.SetMovingAverage(byte average)¶

Parameter:	average – Typ: byte, Wertebereich: [0 bis 100], Standardwert: 100

Setzt die Länge eines gleitenden Mittelwerts für den Feuchtigkeitswert.

Wenn die Länge auf 0 gesetzt wird, ist das Averaging komplett aus. Desto kleiner die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

byte BrickletMoisture.GetMovingAverage()¶

Rückgabe:	average – Typ: byte, Wertebereich: [0 bis 100], Standardwert: 100

Gibt die Länge des gleitenden Mittelwerts zurück, wie von SetMovingAverage() gesetzt.

void BrickletMoisture.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 BrickletMoisture.SetMoistureCallbackPeriod(long period)¶

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

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

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

long BrickletMoisture.GetMoistureCallbackPeriod()¶

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

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

void BrickletMoisture.SetMoistureCallbackThreshold(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 MoistureReachedCallback Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

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

void BrickletMoisture.GetMoistureCallbackThreshold(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 SetMoistureCallbackThreshold() gesetzt.

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

Für option:

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

void BrickletMoisture.SetDebouncePeriod(long debounce)¶

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

Setzt die Periode mit welcher die Schwellwert Callback

• MoistureReachedCallback

ausgelöst wird, wenn der Schwellwert

• SetMoistureCallbackThreshold()

weiterhin erreicht bleibt.

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

moisture.ExampleCallback += MyCallback;

Die verfügbaren Events werden weiter unten beschrieben.

event BrickletMoisture.MoistureCallback(BrickletMoisture sender, int moisture)¶

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

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

The MoistureCallback Callback wird nur ausgelöst, wenn sich der Feuchtigkeitswert seit der letzten Auslösung geändert hat.

event BrickletMoisture.MoistureReachedCallback(BrickletMoisture sender, int moisture)¶

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetMoistureCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Feuchtigkeitswert 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[] BrickletMoisture.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 BrickletMoisture.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:

• BrickletMoisture.FUNCTION_SET_MOISTURE_CALLBACK_PERIOD = 2
• BrickletMoisture.FUNCTION_SET_MOISTURE_CALLBACK_THRESHOLD = 4
• BrickletMoisture.FUNCTION_SET_DEBOUNCE_PERIOD = 6
• BrickletMoisture.FUNCTION_SET_MOVING_AVERAGE = 10

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

• BrickletMoisture.FUNCTION_SET_MOISTURE_CALLBACK_PERIOD = 2
• BrickletMoisture.FUNCTION_SET_MOISTURE_CALLBACK_THRESHOLD = 4
• BrickletMoisture.FUNCTION_SET_DEBOUNCE_PERIOD = 6
• BrickletMoisture.FUNCTION_SET_MOVING_AVERAGE = 10

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

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

Diese Konstante stellt den Anzeigenamen eines Moisture Bricklet dar.