C# - Ambient Light Bricklet 2.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 2.0

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

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

        // Get current illuminance
        long illuminance = al.GetIlluminance();
        Console.WriteLine("Illuminance: " + illuminance/100.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 2.0

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

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

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

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletAmbientLightV2 al = new BrickletAmbientLightV2(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 500 lx"
        al.SetIlluminanceCallbackThreshold('>', 500*100, 0);

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

Grundfunktionen¶

class BrickletAmbientLightV2(string uid, IPConnection ipcon)¶

Parameter:	uid – Typ: string ipcon – Typ: IPConnection
Rückgabe:	ambientLightV2 – Typ: BrickletAmbientLightV2

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

BrickletAmbientLightV2 ambientLightV2 = new BrickletAmbientLightV2("YOUR_DEVICE_UID", ipcon);

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

long BrickletAmbientLightV2.GetIlluminance()¶

Rückgabe:	illuminance – Typ: long, Einheit: 1/100 lx, Wertebereich: [0 bis 232 - 1]

Gibt die Beleuchtungsstärke des Umgebungslichtsensors zurück. Der Messbereich erstreckt sich bis über 100000Lux, aber ab 64000Lux nimmt die Messgenauigkeit ab.

Geändert in Version 2.0.2 (Plugin): Eine Beleuchtungsstärke von 0Lux bedeutet eine Ausnahmesituation in der der Sensor keine sinnvolle Messung durchführen kann. Dies kann bei sehr schwacher oder sehr starker Beleuchtung auftreten. Bei starker Beleuchtung bedeutet diese möglicherweise, dass der Sensor gesättigt (saturated) ist und die Konfiguration angepasst werden sollte (SetConfiguration()), um besser der Beleuchtung zu entsprechen.

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

Fortgeschrittene Funktionen¶

void BrickletAmbientLightV2.SetConfiguration(byte illuminanceRange, byte integrationTime)¶

Parameter:	illuminanceRange – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 3 integrationTime – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 3

Setzt die Konfiguration. Es ist möglich den Helligkeitswertebereich zwischen 0-600Lux und 0-64000Lux sowie eine Integrationszeit zwischen 50ms und 400ms zu konfigurieren.

Neu in Version 2.0.2 (Plugin): Der unbeschränkt (unlimited) Helligkeitswertebereich ermöglicht es bis über 100000Lux zu messen, aber ab 64000Lux nimmt die Messgenauigkeit ab.

Ein kleinerer Helligkeitswertebereich erhöht die Auflösung der Daten. Eine längere Integrationszeit verringert das Rauschen auf den Daten.

Geändert in Version 2.0.2 (Plugin): Wenn der eigentliche Messwert außerhalb des eingestellten Helligkeitswertebereichs liegt, dann geben GetIlluminance() und der IlluminanceCallback Callback das Maximum des eingestellten Helligkeitswertebereichs +0,01Lux zurück. Also z.B. 800001 für den 0-8000Lux Bereich.

Geändert in Version 2.0.2 (Plugin): Bei einer langen Integrationszeit kann es sein, dass der Sensor gesättigt (saturated) ist bevor der Messwert das Maximum des ausgewählten Helligkeitswertebereichs erreicht hat. In diesem Fall geben GetIlluminance() und der IlluminanceCallback Callback 0Lux zurück.

Wenn der Messwert außerhalb des eingestellten Helligkeitswertebereichs liegt oder der Sensor gesättigt ist, dann sollte der nächst höhere Helligkeitswertebereich eingestellt werden. Wenn der höchste Helligkeitswertebereich schon erreicht ist, dann kann noch die Integrationszeit verringert werden.

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

Für illuminanceRange:

• BrickletAmbientLightV2.ILLUMINANCE_RANGE_UNLIMITED = 6
• BrickletAmbientLightV2.ILLUMINANCE_RANGE_64000LUX = 0
• BrickletAmbientLightV2.ILLUMINANCE_RANGE_32000LUX = 1
• BrickletAmbientLightV2.ILLUMINANCE_RANGE_16000LUX = 2
• BrickletAmbientLightV2.ILLUMINANCE_RANGE_8000LUX = 3
• BrickletAmbientLightV2.ILLUMINANCE_RANGE_1300LUX = 4
• BrickletAmbientLightV2.ILLUMINANCE_RANGE_600LUX = 5

Für integrationTime:

• BrickletAmbientLightV2.INTEGRATION_TIME_50MS = 0
• BrickletAmbientLightV2.INTEGRATION_TIME_100MS = 1
• BrickletAmbientLightV2.INTEGRATION_TIME_150MS = 2
• BrickletAmbientLightV2.INTEGRATION_TIME_200MS = 3
• BrickletAmbientLightV2.INTEGRATION_TIME_250MS = 4
• BrickletAmbientLightV2.INTEGRATION_TIME_300MS = 5
• BrickletAmbientLightV2.INTEGRATION_TIME_350MS = 6
• BrickletAmbientLightV2.INTEGRATION_TIME_400MS = 7

void BrickletAmbientLightV2.GetConfiguration(out byte illuminanceRange, out byte integrationTime)¶

Ausgabeparameter:	illuminanceRange – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 3 integrationTime – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Konfiguration zurück, wie von SetConfiguration() gesetzt.

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

Für illuminanceRange:

• BrickletAmbientLightV2.ILLUMINANCE_RANGE_UNLIMITED = 6
• BrickletAmbientLightV2.ILLUMINANCE_RANGE_64000LUX = 0
• BrickletAmbientLightV2.ILLUMINANCE_RANGE_32000LUX = 1
• BrickletAmbientLightV2.ILLUMINANCE_RANGE_16000LUX = 2
• BrickletAmbientLightV2.ILLUMINANCE_RANGE_8000LUX = 3
• BrickletAmbientLightV2.ILLUMINANCE_RANGE_1300LUX = 4
• BrickletAmbientLightV2.ILLUMINANCE_RANGE_600LUX = 5

Für integrationTime:

• BrickletAmbientLightV2.INTEGRATION_TIME_50MS = 0
• BrickletAmbientLightV2.INTEGRATION_TIME_100MS = 1
• BrickletAmbientLightV2.INTEGRATION_TIME_150MS = 2
• BrickletAmbientLightV2.INTEGRATION_TIME_200MS = 3
• BrickletAmbientLightV2.INTEGRATION_TIME_250MS = 4
• BrickletAmbientLightV2.INTEGRATION_TIME_300MS = 5
• BrickletAmbientLightV2.INTEGRATION_TIME_350MS = 6
• BrickletAmbientLightV2.INTEGRATION_TIME_400MS = 7

void BrickletAmbientLightV2.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 BrickletAmbientLightV2.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 BrickletAmbientLightV2.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 BrickletAmbientLightV2.SetIlluminanceCallbackThreshold(char option, long min, long max)¶

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: long, Einheit: 1/100 lx, Wertebereich: [0 bis 232 - 1], Standardwert: 0 max – Typ: long, Einheit: 1/100 lx, Wertebereich: [0 bis 232 - 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:

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

void BrickletAmbientLightV2.GetIlluminanceCallbackThreshold(out char option, out long min, out long max)¶

Ausgabeparameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: long, Einheit: 1/100 lx, Wertebereich: [0 bis 232 - 1], Standardwert: 0 max – Typ: long, Einheit: 1/100 lx, Wertebereich: [0 bis 232 - 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:

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

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

• IlluminanceReachedCallback,

ausgelöst werden, wenn die Schwellwerte

• SetIlluminanceCallbackThreshold(),

weiterhin erreicht bleiben.

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

ambientLightV2.ExampleCallback += MyCallback;

Die verfügbaren Events werden weiter unten beschrieben.

event BrickletAmbientLightV2.IlluminanceCallback(BrickletAmbientLightV2 sender, long illuminance)¶

Callback-Parameter:	sender – Typ: BrickletAmbientLightV2 illuminance – Typ: long, Einheit: 1/100 lx, Wertebereich: [0 bis 232 - 1]

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 BrickletAmbientLightV2.IlluminanceReachedCallback(BrickletAmbientLightV2 sender, long illuminance)¶

Callback-Parameter:	sender – Typ: BrickletAmbientLightV2 illuminance – Typ: long, Einheit: 1/100 lx, Wertebereich: [0 bis 232 - 1]

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.

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

• BrickletAmbientLightV2.FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 2
• BrickletAmbientLightV2.FUNCTION_SET_ILLUMINANCE_CALLBACK_THRESHOLD = 4
• BrickletAmbientLightV2.FUNCTION_SET_DEBOUNCE_PERIOD = 6
• BrickletAmbientLightV2.FUNCTION_SET_CONFIGURATION = 8

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

• BrickletAmbientLightV2.FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 2
• BrickletAmbientLightV2.FUNCTION_SET_ILLUMINANCE_CALLBACK_THRESHOLD = 4
• BrickletAmbientLightV2.FUNCTION_SET_DEBOUNCE_PERIOD = 6
• BrickletAmbientLightV2.FUNCTION_SET_CONFIGURATION = 8

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

Diese Konstante wird verwendet um ein Ambient Light Bricklet 2.0 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 BrickletAmbientLightV2.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Ambient Light Bricklet 2.0 dar.