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

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

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

        // Get current temperature
        short temperature = t.GetTemperature();
        Console.WriteLine("Temperature: " + temperature/100.0 + " °C");

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

    // Callback function for temperature callback
    static void TemperatureCB(BrickletTemperature sender, short temperature)
    {
        Console.WriteLine("Temperature: " + temperature/100.0 + " °C");
    }

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

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

        // Register temperature callback to function TemperatureCB
        t.TemperatureCallback += TemperatureCB;

        // Set period for temperature callback to 1s (1000ms)
        // Note: The temperature callback is only called every second
        //       if the temperature has changed since the last call!
        t.SetTemperatureCallbackPeriod(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
38

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

    // Callback function for temperature reached callback
    static void TemperatureReachedCB(BrickletTemperature sender, short temperature)
    {
        Console.WriteLine("Temperature: " + temperature/100.0 + " °C");
        Console.WriteLine("It is too hot, we need air conditioning!");
    }

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

        // Register temperature reached callback to function TemperatureReachedCB
        t.TemperatureReachedCallback += TemperatureReachedCB;

        // Configure threshold for temperature "greater than 30 °C"
        t.SetTemperatureCallbackThreshold('>', 30*100, 0);

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

Grundfunktionen¶

class BrickletTemperature(string uid, IPConnection ipcon)¶

Parameter:	uid – Typ: string ipcon – Typ: IPConnection
Rückgabe:	temperature – Typ: BrickletTemperature

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

BrickletTemperature temperature = new BrickletTemperature("YOUR_DEVICE_UID", ipcon);

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

short BrickletTemperature.GetTemperature()¶

Rückgabe:	temperature – Typ: short, Einheit: 1/100 °C, Wertebereich: [-2500 bis 8500]

Gibt die Temperatur des Sensors zurück.

Wenn die Temperatur periodisch abgefragt werden soll, wird empfohlen den TemperatureCallback Callback zu nutzen und die Periode mit SetTemperatureCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen¶

void BrickletTemperature.SetI2CMode(byte mode)¶

Parameter:	mode – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0

Setzt den I2C Modus. Mögliche Modi sind:

• 0: Fast (400kHz)
• 1: Slow (100kHz)

Wenn Probleme mit offensichtlichen Ausreißern in den Temperature Bricklet Messungen auftreten, können diese eventuell aufgrund von elektromagnetischen Störungen sein. In diesem Fall kann es helfen die I2C Geschwindigkeit zu verringern.

Falls in einem System ein hoher Durchsatz an Nachrichten erwünscht ist, sollte die I2C Geschwindigkeit allerdings nicht verringert werden.

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

Für mode:

• BrickletTemperature.I2C_MODE_FAST = 0
• BrickletTemperature.I2C_MODE_SLOW = 1

Neu in Version 2.0.1 (Plugin).

byte BrickletTemperature.GetI2CMode()¶

Rückgabe:	mode – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0

Gibt den I2C Modus zurück, wie von SetI2CMode() gesetzt.

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

Für mode:

• BrickletTemperature.I2C_MODE_FAST = 0
• BrickletTemperature.I2C_MODE_SLOW = 1

Neu in Version 2.0.1 (Plugin).

void BrickletTemperature.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 BrickletTemperature.SetTemperatureCallbackPeriod(long period)¶

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

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

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

long BrickletTemperature.GetTemperatureCallbackPeriod()¶

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

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

void BrickletTemperature.SetTemperatureCallbackThreshold(char option, short min, short max)¶

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: short, Einheit: 1/100 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 max – Typ: short, Einheit: 1/100 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

Setzt den Schwellwert für den TemperatureReachedCallback Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

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

void BrickletTemperature.GetTemperatureCallbackThreshold(out char option, out short min, out short max)¶

Ausgabeparameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: short, Einheit: 1/100 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 max – Typ: short, Einheit: 1/100 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

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

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

Für option:

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

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

• TemperatureReachedCallback

ausgelöst wird, wenn der Schwellwert

• SetTemperatureCallbackThreshold()

weiterhin erreicht bleibt.

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

temperature.ExampleCallback += MyCallback;

Die verfügbaren Events werden weiter unten beschrieben.

event BrickletTemperature.TemperatureCallback(BrickletTemperature sender, short temperature)¶

Callback-Parameter:	sender – Typ: BrickletTemperature temperature – Typ: short, Einheit: 1/100 °C, Wertebereich: [-2500 bis 8500]

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

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

event BrickletTemperature.TemperatureReachedCallback(BrickletTemperature sender, short temperature)¶

Callback-Parameter:	sender – Typ: BrickletTemperature temperature – Typ: short, Einheit: 1/100 °C, Wertebereich: [-2500 bis 8500]

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

• BrickletTemperature.FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 2
• BrickletTemperature.FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 4
• BrickletTemperature.FUNCTION_SET_DEBOUNCE_PERIOD = 6
• BrickletTemperature.FUNCTION_SET_I2C_MODE = 10

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

• BrickletTemperature.FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 2
• BrickletTemperature.FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 4
• BrickletTemperature.FUNCTION_SET_DEBOUNCE_PERIOD = 6
• BrickletTemperature.FUNCTION_SET_I2C_MODE = 10

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

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

Diese Konstante stellt den Anzeigenamen eines Temperature Bricklet dar.