Dies ist die Beschreibung der C# API Bindings für das Color Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Color Bricklet sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die C# API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
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 | 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 Color Bricklet
static void Main()
{
IPConnection ipcon = new IPConnection(); // Create IP connection
BrickletColor c = new BrickletColor(UID, ipcon); // Create device object
ipcon.Connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Get current color
int r, g, b, c_;
c.GetColor(out r, out g, out b, out c_);
Console.WriteLine("Color [R]: " + r);
Console.WriteLine("Color [G]: " + g);
Console.WriteLine("Color [B]: " + b);
Console.WriteLine("Color [C]: " + c_);
Console.WriteLine("Press enter to exit");
Console.ReadLine();
ipcon.Disconnect();
}
}
|
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 39 40 | 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 Color Bricklet
// Callback function for color callback
static void ColorCB(BrickletColor sender, int r, int g, int b, int c)
{
Console.WriteLine("Color [R]: " + r);
Console.WriteLine("Color [G]: " + g);
Console.WriteLine("Color [B]: " + b);
Console.WriteLine("Color [C]: " + c);
Console.WriteLine("");
}
static void Main()
{
IPConnection ipcon = new IPConnection(); // Create IP connection
BrickletColor c = new BrickletColor(UID, ipcon); // Create device object
ipcon.Connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Register color callback to function ColorCB
c.ColorCallback += ColorCB;
// Set period for color callback to 1s (1000ms)
// Note: The color callback is only called every second
// if the color has changed since the last call!
c.SetColorCallbackPeriod(1000);
Console.WriteLine("Press enter to exit");
Console.ReadLine();
ipcon.Disconnect();
}
}
|
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 39 40 41 | 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 Color Bricklet
// Callback function for color reached callback
static void ColorReachedCB(BrickletColor sender, int r, int g, int b, int c)
{
Console.WriteLine("Color [R]: " + r);
Console.WriteLine("Color [G]: " + g);
Console.WriteLine("Color [B]: " + b);
Console.WriteLine("Color [C]: " + c);
Console.WriteLine("");
}
static void Main()
{
IPConnection ipcon = new IPConnection(); // Create IP connection
BrickletColor c = new BrickletColor(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 color reached callback to function ColorReachedCB
c.ColorReachedCallback += ColorReachedCB;
// Configure threshold for color "greater than 100, 200, 300, 400"
c.SetColorCallbackThreshold('>', 100, 0, 200, 0, 300, 0, 400, 0);
Console.WriteLine("Press enter to exit");
Console.ReadLine();
ipcon.Disconnect();
}
}
|
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.
BrickletColor
(string uid, IPConnection ipcon)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
BrickletColor color = new BrickletColor("YOUR_DEVICE_UID", ipcon);
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletColor.
GetColor
(out int r, out int g, out int b, out int c)¶Ausgabeparameter: |
|
---|
Gibt die gemessene Farbe des Sensors zurück.
Die rot (r), grün (g), blau (b) und clear (c) werden mit vier unterschiedlichen Fotodioden gemessen. Diese sind Empfindlich in unterschiedlichen Wellenlängen:
Wenn die Farbe periodisch abgefragt werden soll, wird empfohlen
den ColorCallback
Callback zu nutzen und die Periode mit
SetColorCallbackPeriod()
vorzugeben.
BrickletColor.
LightOn
()¶Aktiviert die LED.
BrickletColor.
LightOff
()¶Deaktiviert die LED.
BrickletColor.
IsLightOn
()¶Rückgabe: |
|
---|
Gibt den Zustand der LED zurück. Mögliche Werte sind:
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für light:
BrickletColor.
SetConfig
(byte gain, byte integrationTime)¶Parameter: |
|
---|
Setzt die Konfiguration des Sensors. Verstärkung und Integrationszeit können eingestellt werden.
Für die Konfiguration der Verstärkung:
Für die Konfiguration der Integrationszeit:
Eine Erhöhung der Verstärkung ermöglicht es dem Sensor Farben aus größeren Entfernungen zu erkennen.
Die Integrationszeit ist ein Trade-off zwischen Konvertierungszeit und Genauigkeit. Mit einer höheren Integrationszeit werden die Werte genauer, es dauert allerdings länger bis ein Resultat bereitsteht.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für gain:
Für integrationTime:
BrickletColor.
GetConfig
(out byte gain, out byte integrationTime)¶Ausgabeparameter: |
|
---|
Gibt die Einstellungen zurück, wie von SetConfig()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für gain:
Für integrationTime:
BrickletColor.
GetIlluminance
()¶Rückgabe: |
|
---|
Gibt die Beleuchtungsstärke beeinflusst durch die Verstärkung und die
Integrationszeit zurück. Verstärkung und Integrationszeit können mit
SetConfig()
eingestellt werden. Um die Beleuchtungsstärke in Lux zu
ermitteln muss folgende Formel angewendet werden:
lux = illuminance * 700 / gain / integration_time
Für eine korrekte Messung der Beleuchtungsstärke muss sichergestellt
sein, dass die Farbwerte (R, G oder B) nicht saturiert sind. Ein
Farbwert ist saturiert wenn der Wert 65535 beträgt. In diesem Fall
kann die Verstärkung per SetConfig()
reduziert werden.
BrickletColor.
GetColorTemperature
()¶Rückgabe: |
|
---|
Gibt die Farbtemperatur zurück.
Für eine korrekte Messung der Farbtemperatur muss sichergestellt
sein das die Farbwerte (R, G oder B) nicht saturiert sind. Ein
Farbwert ist saturiert wenn der Wert 65535 beträgt. In diesem Fall
kann die Verstärkung per SetConfig()
reduziert werden.
BrickletColor.
GetIdentity
(out string uid, out string connectedUid, out char position, out byte[] hardwareVersion, out byte[] firmwareVersion, out int deviceIdentifier)¶Ausgabeparameter: |
|
---|
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.
BrickletColor.
SetColorCallbackPeriod
(long period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der ColorCallback
Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
Der ColorCallback
Callback wird nur ausgelöst, wenn sich die Color seit der
letzten Auslösung geändert hat.
BrickletColor.
GetColorCallbackPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetColorCallbackPeriod()
gesetzt.
BrickletColor.
SetColorCallbackThreshold
(char option, int minR, int maxR, int minG, int maxG, int minB, int maxB, int minC, int maxC)¶Parameter: |
|
---|
Setzt den Schwellwert für den ColorReachedCallback
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:
BrickletColor.
GetColorCallbackThreshold
(out char option, out int minR, out int maxR, out int minG, out int maxG, out int minB, out int maxB, out int minC, out int maxC)¶Ausgabeparameter: |
|
---|
Gibt den Schwellwert zurück, wie von SetColorCallbackThreshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletColor.
SetDebouncePeriod
(long debounce)¶Parameter: |
|
---|
Setzt die Periode mit welcher die Schwellwert Callback
ausgelöst wird, wenn der Schwellwert
weiterhin erreicht bleibt.
BrickletColor.
GetDebouncePeriod
()¶Rückgabe: |
|
---|
Gibt die Entprellperiode zurück, wie von SetDebouncePeriod()
gesetzt.
BrickletColor.
SetIlluminanceCallbackPeriod
(long period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der IlluminanceCallback
Callback ausgelöst
wird. Ein Wert von 0 deaktiviert den Callback.
Der IlluminanceCallback
Callback wird nur ausgelöst, wenn sich die
Beleuchtungsstärke seit der letzten Auslösung geändert hat.
BrickletColor.
GetIlluminanceCallbackPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetIlluminanceCallbackPeriod()
gesetzt.
BrickletColor.
SetColorTemperatureCallbackPeriod
(long period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der ColorTemperatureCallback
Callback
ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.
Der ColorTemperatureCallback
Callback wird nur ausgelöst, wenn sich die
Farbtemperatur seit der letzten Auslösung geändert hat.
BrickletColor.
GetColorTemperatureCallbackPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetColorTemperatureCallbackPeriod()
gesetzt.
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(BrickletColor sender, int value)
{
System.Console.WriteLine("Value: " + value);
}
color.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.
BrickletColor.
ColorCallback
(BrickletColor sender, int r, int g, int b, int c)¶Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit SetColorCallbackPeriod()
,
ausgelöst. Der Parameter ist die Farbe des Sensors als RGBC.
Der ColorCallback
Callback wird nur ausgelöst, wenn sich die Farbe seit der
letzten Auslösung geändert hat.
BrickletColor.
ColorReachedCallback
(BrickletColor sender, int r, int g, int b, int c)¶Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
SetColorCallbackThreshold()
gesetzt, erreicht wird.
Der Parameter ist die Farbe des Sensors als RGBC.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit SetDebouncePeriod()
gesetzt, ausgelöst.
BrickletColor.
IlluminanceCallback
(BrickletColor sender, long illuminance)¶Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit SetIlluminanceCallbackPeriod()
,
ausgelöst. Der Parameter ist die Beleuchtungsstärke des Sensors.
Siehe GetIlluminance()
für eine Erklärung wie dieser zu interpretieren ist.
Der IlluminanceCallback
Callback wird nur ausgelöst, wenn sich die
Beleuchtungsstärke seit der letzten Auslösung geändert hat.
BrickletColor.
ColorTemperatureCallback
(BrickletColor sender, int colorTemperature)¶Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
SetColorTemperatureCallbackPeriod()
, ausgelöst. Der Parameter
ist die Farbtemperatur des Sensors.
Der ColorTemperatureCallback
Callback wird nur ausgelöst, wenn sich die
Farbtemperatur seit der letzten Auslösung geändert hat.
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.
BrickletColor.
GetAPIVersion
()¶Ausgabeparameter: |
|
---|
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.
BrickletColor.
GetResponseExpected
(byte functionId)¶Parameter: |
|
---|---|
Rückgabe: |
|
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:
BrickletColor.
SetResponseExpected
(byte functionId, bool responseExpected)¶Parameter: |
|
---|
Ä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:
BrickletColor.
SetResponseExpectedAll
(bool responseExpected)¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
BrickletColor.
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein Color 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.
BrickletColor.
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Color Bricklet dar.