C# - Ambient Light Bricklet

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

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

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

        // Get current illuminance
        int illuminance = al.GetIlluminance();
        Console.WriteLine("Illuminance: " + illuminance/10.0 + " lx");

        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 Ambient Light Bricklet

    // Callback function for illuminance callback
    static void IlluminanceCB(BrickletAmbientLight sender, int illuminance)
    {
        Console.WriteLine("Illuminance: " + illuminance/10.0 + " lx");
    }

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

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

        // Register illuminance callback to function IlluminanceCB
        al.IlluminanceCallback += IlluminanceCB;

        // Set period for illuminance callback to 1s (1000ms)
        // Note: The illuminance callback is only called every second
        //       if the illuminance has changed since the last call!
        al.SetIlluminanceCallbackPeriod(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 Ambient Light Bricklet

    // Callback function for illuminance reached callback
    static void IlluminanceReachedCB(BrickletAmbientLight sender, int illuminance)
    {
        Console.WriteLine("Illuminance: " + illuminance/10.0 + " lx");
        Console.WriteLine("Too bright, close the curtains!");
    }

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

        // Register illuminance reached callback to function IlluminanceReachedCB
        al.IlluminanceReachedCallback += IlluminanceReachedCB;

        // Configure threshold for illuminance "greater than 200 lx"
        al.SetIlluminanceCallbackThreshold('>', 200*10, 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 BrickletAmbientLight(string uid, IPConnection ipcon)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: IPConnection
Rückgabe:
  • ambientLight – Typ: BrickletAmbientLight

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

BrickletAmbientLight ambientLight = new BrickletAmbientLight("YOUR_DEVICE_UID", ipcon);

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

int BrickletAmbientLight.GetIlluminance()
Rückgabe:
  • illuminance – Typ: int, Einheit: 1/10 lx, Wertebereich: [0 bis 9000]

Gibt die Beleuchtungsstärke des Umgebungslichtsensors zurück.

Wenn die Beleuchtungsstärke periodisch abgefragt werden soll, wird empfohlen den IlluminanceCallback Callback zu nutzen und die Periode mit SetIlluminanceCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen

int BrickletAmbientLight.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 GetIlluminance() 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.

Weiterhin deckt der Analog-Digital-Wandler drei unterschiedliche Bereiche ab, welche dynamisch gewechselt werden abhängig von der Lichtintensität. Es ist nicht möglich, anhand der Analogwerte, zwischen diesen Bereichen zu unterscheiden.

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

void BrickletAmbientLight.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 BrickletAmbientLight.SetIlluminanceCallbackPeriod(long period)
Parameter:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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.

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

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

void BrickletAmbientLight.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 BrickletAmbientLight.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 BrickletAmbientLight.SetIlluminanceCallbackThreshold(char option, int min, int max)
Parameter:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Einheit: 1/10 lx, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1/10 lx, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Setzt den Schwellwert für den IlluminanceReachedCallback Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

  • BrickletAmbientLight.THRESHOLD_OPTION_OFF = 'x'
  • BrickletAmbientLight.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletAmbientLight.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletAmbientLight.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletAmbientLight.THRESHOLD_OPTION_GREATER = '>'
void BrickletAmbientLight.GetIlluminanceCallbackThreshold(out char option, out int min, out int max)
Ausgabeparameter:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Einheit: 1/10 lx, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1/10 lx, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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

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

Für option:

  • BrickletAmbientLight.THRESHOLD_OPTION_OFF = 'x'
  • BrickletAmbientLight.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletAmbientLight.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletAmbientLight.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletAmbientLight.THRESHOLD_OPTION_GREATER = '>'
void BrickletAmbientLight.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:

  • BrickletAmbientLight.THRESHOLD_OPTION_OFF = 'x'
  • BrickletAmbientLight.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletAmbientLight.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletAmbientLight.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletAmbientLight.THRESHOLD_OPTION_GREATER = '>'
void BrickletAmbientLight.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:

  • BrickletAmbientLight.THRESHOLD_OPTION_OFF = 'x'
  • BrickletAmbientLight.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletAmbientLight.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletAmbientLight.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletAmbientLight.THRESHOLD_OPTION_GREATER = '>'
void BrickletAmbientLight.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 BrickletAmbientLight.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(BrickletAmbientLight sender, int value)
{
    System.Console.WriteLine("Value: " + value);
}

ambientLight.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 BrickletAmbientLight.IlluminanceCallback(BrickletAmbientLight sender, int illuminance)
Callback-Parameter:
  • sender – Typ: BrickletAmbientLight
  • illuminance – Typ: int, Einheit: 1/10 lx, Wertebereich: [0 bis 9000]

Dieser Callback wird mit der Periode, wie gesetzt mit SetIlluminanceCallbackPeriod(), ausgelöst. Der Parameter ist die Beleuchtungsstärke des Umgebungslichtsensors.

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

event BrickletAmbientLight.AnalogValueCallback(BrickletAmbientLight sender, int value)
Callback-Parameter:
  • sender – Typ: BrickletAmbientLight
  • 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 BrickletAmbientLight.IlluminanceReachedCallback(BrickletAmbientLight sender, int illuminance)
Callback-Parameter:
  • sender – Typ: BrickletAmbientLight
  • illuminance – Typ: int, Einheit: 1/10 lx, Wertebereich: [0 bis 9000]

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

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

event BrickletAmbientLight.AnalogValueReachedCallback(BrickletAmbientLight sender, int value)
Callback-Parameter:
  • sender – Typ: BrickletAmbientLight
  • 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 Umgebungslichtsensors.

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

  • BrickletAmbientLight.FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 3
  • BrickletAmbientLight.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • BrickletAmbientLight.FUNCTION_SET_ILLUMINANCE_CALLBACK_THRESHOLD = 7
  • BrickletAmbientLight.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • BrickletAmbientLight.FUNCTION_SET_DEBOUNCE_PERIOD = 11
void BrickletAmbientLight.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:

  • BrickletAmbientLight.FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 3
  • BrickletAmbientLight.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • BrickletAmbientLight.FUNCTION_SET_ILLUMINANCE_CALLBACK_THRESHOLD = 7
  • BrickletAmbientLight.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • BrickletAmbientLight.FUNCTION_SET_DEBOUNCE_PERIOD = 11
void BrickletAmbientLight.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 BrickletAmbientLight.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Ambient Light 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 BrickletAmbientLight.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Ambient Light Bricklet dar.