Delphi/Lazarus - Ambient Light Bricklet

Dies ist die Beschreibung der Delphi/Lazarus 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 Delphi/Lazarus API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (ExampleSimple.pas)

 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
42
43
44
45
46
47
48
49
50
51
52
program ExampleSimple;

{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}

uses
  SysUtils, IPConnection, BrickletAmbientLight;

type
  TExample = class
  private
    ipcon: TIPConnection;
    al: TBrickletAmbientLight;
  public
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your Ambient Light Bricklet }

var
  e: TExample;

procedure TExample.Execute;
var illuminance: word;
begin
  { Create IP connection }
  ipcon := TIPConnection.Create;

  { Create device object }
  al := TBrickletAmbientLight.Create(UID, ipcon);

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

  { Get current illuminance }
  illuminance := al.GetIlluminance;
  WriteLn(Format('Illuminance: %f lx', [illuminance/10.0]));

  WriteLn('Press key to exit');
  ReadLn;
  ipcon.Destroy; { Calls ipcon.Disconnect internally }
end;

begin
  e := TExample.Create;
  e.Execute;
  e.Destroy;
end.

Callback

Download (ExampleCallback.pas)

 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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
program ExampleCallback;

{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}

uses
  SysUtils, IPConnection, BrickletAmbientLight;

type
  TExample = class
  private
    ipcon: TIPConnection;
    al: TBrickletAmbientLight;
  public
    procedure IlluminanceCB(sender: TBrickletAmbientLight; const illuminance: word);
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your Ambient Light Bricklet }

var
  e: TExample;

{ Callback procedure for illuminance callback }
procedure TExample.IlluminanceCB(sender: TBrickletAmbientLight; const illuminance: word);
begin
  WriteLn(Format('Illuminance: %f lx', [illuminance/10.0]));
end;

procedure TExample.Execute;
begin
  { Create IP connection }
  ipcon := TIPConnection.Create;

  { Create device object }
  al := TBrickletAmbientLight.Create(UID, ipcon);

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

  { Register illuminance callback to procedure IlluminanceCB }
  al.OnIlluminance := {$ifdef FPC}@{$endif}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);

  WriteLn('Press key to exit');
  ReadLn;
  ipcon.Destroy; { Calls ipcon.Disconnect internally }
end;

begin
  e := TExample.Create;
  e.Execute;
  e.Destroy;
end.

Threshold

Download (ExampleThreshold.pas)

 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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
program ExampleThreshold;

{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}

uses
  SysUtils, IPConnection, BrickletAmbientLight;

type
  TExample = class
  private
    ipcon: TIPConnection;
    al: TBrickletAmbientLight;
  public
    procedure IlluminanceReachedCB(sender: TBrickletAmbientLight;
                                   const illuminance: word);
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your Ambient Light Bricklet }

var
  e: TExample;

{ Callback procedure for illuminance reached callback }
procedure TExample.IlluminanceReachedCB(sender: TBrickletAmbientLight;
                                        const illuminance: word);
begin
  WriteLn(Format('Illuminance: %f lx', [illuminance/10.0]));
  WriteLn('Too bright, close the curtains!');
end;

procedure TExample.Execute;
begin
  { Create IP connection }
  ipcon := TIPConnection.Create;

  { Create device object }
  al := TBrickletAmbientLight.Create(UID, ipcon);

  { Connect to brickd }
  ipcon.Connect(HOST, PORT);
  { 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 procedure IlluminanceReachedCB }
  al.OnIlluminanceReached := {$ifdef FPC}@{$endif}IlluminanceReachedCB;

  { Configure threshold for illuminance "greater than 200 lx" }
  al.SetIlluminanceCallbackThreshold('>', 200*10, 0);

  WriteLn('Press key to exit');
  ReadLn;
  ipcon.Destroy; { Calls ipcon.Disconnect internally }
end;

begin
  e := TExample.Create;
  e.Execute;
  e.Destroy;
end.

API

Da Delphi nicht mehrere Rückgabewerte direkt unterstützt, wird das out Schlüsselwort genutzt um mehrere Werte von einer Funktion zurückzugeben.

Alle folgend aufgelisteten Funktionen und Prozeduren sind Thread-sicher.

Grundfunktionen

constructor TBrickletAmbientLight.Create(const uid: string; ipcon: TIPConnection)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: TIPConnection
Rückgabe:
  • ambientLight – Typ: TBrickletAmbientLight

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

ambientLight := TBrickletAmbientLight.Create('YOUR_DEVICE_UID', ipcon);

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

function TBrickletAmbientLight.GetIlluminance: word
Rückgabe:
  • illuminance – Typ: word, 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 OnIlluminance Callback zu nutzen und die Periode mit SetIlluminanceCallbackPeriod vorzugeben.

Fortgeschrittene Funktionen

function TBrickletAmbientLight.GetAnalogValue: word
Rückgabe:
  • value – Typ: word, 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 OnAnalogValue Callback zu nutzen und die Periode mit SetAnalogValueCallbackPeriod vorzugeben.

procedure TBrickletAmbientLight.GetIdentity(out uid: string; out connectedUid: string; out position: char; out hardwareVersion: array [0..2] of byte; out firmwareVersion: array [0..2] of byte; out deviceIdentifier: word)
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: array [0..2] of byte
    • 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: array [0..2] of byte
    • 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: word, 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

procedure TBrickletAmbientLight.SetIlluminanceCallbackPeriod(const period: longword)
Parameter:
  • period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

function TBrickletAmbientLight.GetIlluminanceCallbackPeriod: longword
Rückgabe:
  • period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

procedure TBrickletAmbientLight.SetAnalogValueCallbackPeriod(const period: longword)
Parameter:
  • period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

function TBrickletAmbientLight.GetAnalogValueCallbackPeriod: longword
Rückgabe:
  • period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von SetAnalogValueCallbackPeriod gesetzt.

procedure TBrickletAmbientLight.SetIlluminanceCallbackThreshold(const option: char; const min: word; const max: word)
Parameter:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: word, Einheit: 1/10 lx, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: word, Einheit: 1/10 lx, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Setzt den Schwellwert für den OnIlluminanceReached 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:

  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletAmbientLight.GetIlluminanceCallbackThreshold(out option: char; out min: word; out max: word)
Ausgabeparameter:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: word, Einheit: 1/10 lx, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: word, 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:

  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletAmbientLight.SetAnalogValueCallbackThreshold(const option: char; const min: word; const max: word)
Parameter:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: word, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: word, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Setzt den Schwellwert für den OnAnalogValueReached 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:

  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletAmbientLight.GetAnalogValueCallbackThreshold(out option: char; out min: word; out max: word)
Ausgabeparameter:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: word, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: word, 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:

  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletAmbientLight.SetDebouncePeriod(const debounce: longword)
Parameter:
  • debounce – Typ: longword, 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.

function TBrickletAmbientLight.GetDebouncePeriod: longword
Rückgabe:
  • debounce – Typ: longword, 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 erfolgt indem eine Prozedur einem Callback Property des Geräte Objektes zugewiesen wird:

procedure TExample.MyCallback(sender: TBrickletAmbientLight; const value: longint);
begin
  WriteLn(Format('Value: %d', [value]));
end;

ambientLight.OnExample := {$ifdef FPC}@{$endif}example.MyCallback;

Die verfügbaren Callback Properties und ihre Parametertypen 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.

property TBrickletAmbientLight.OnIlluminance
procedure(sender: TBrickletAmbientLight; const illuminance: word) of object;
Callback-Parameter:
  • sender – Typ: TBrickletAmbientLight
  • illuminance – Typ: word, 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 OnIlluminance Callback wird nur ausgelöst, wenn sich die Beleuchtungsstärke seit der letzten Auslösung geändert hat.

property TBrickletAmbientLight.OnAnalogValue
procedure(sender: TBrickletAmbientLight; const value: word) of object;
Callback-Parameter:
  • sender – Typ: TBrickletAmbientLight
  • value – Typ: word, 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 OnAnalogValue Callback wird nur ausgelöst, wenn sich der Analogwert seit der letzten Auslösung geändert hat.

property TBrickletAmbientLight.OnIlluminanceReached
procedure(sender: TBrickletAmbientLight; const illuminance: word) of object;
Callback-Parameter:
  • sender – Typ: TBrickletAmbientLight
  • illuminance – Typ: word, 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.

property TBrickletAmbientLight.OnAnalogValueReached
procedure(sender: TBrickletAmbientLight; const value: word) of object;
Callback-Parameter:
  • sender – Typ: TBrickletAmbientLight
  • value – Typ: word, 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.

function TBrickletAmbientLight.GetAPIVersion: array [0..2] of byte
Ausgabeparameter:
  • apiVersion – Typ: array [0..2] of byte
    • 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.

function TBrickletAmbientLight.GetResponseExpected(const functionId: byte): boolean
Parameter:
  • functionId – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: boolean

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:

  • BRICKLET_AMBIENT_LIGHT_FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 3
  • BRICKLET_AMBIENT_LIGHT_FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • BRICKLET_AMBIENT_LIGHT_FUNCTION_SET_ILLUMINANCE_CALLBACK_THRESHOLD = 7
  • BRICKLET_AMBIENT_LIGHT_FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • BRICKLET_AMBIENT_LIGHT_FUNCTION_SET_DEBOUNCE_PERIOD = 11
procedure TBrickletAmbientLight.SetResponseExpected(const functionId: byte; const responseExpected: boolean)
Parameter:
  • functionId – Typ: byte, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: boolean

Ä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:

  • BRICKLET_AMBIENT_LIGHT_FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 3
  • BRICKLET_AMBIENT_LIGHT_FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • BRICKLET_AMBIENT_LIGHT_FUNCTION_SET_ILLUMINANCE_CALLBACK_THRESHOLD = 7
  • BRICKLET_AMBIENT_LIGHT_FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • BRICKLET_AMBIENT_LIGHT_FUNCTION_SET_DEBOUNCE_PERIOD = 11
procedure TBrickletAmbientLight.SetResponseExpectedAll(const responseExpected: boolean)
Parameter:
  • responseExpected – Typ: boolean

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Konstanten

const BRICKLET_AMBIENT_LIGHT_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Ambient Light Bricklet zu identifizieren.

Die GetIdentity Funktion und der TIPConnection.OnEnumerate Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

const BRICKLET_AMBIENT_LIGHT_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Ambient Light Bricklet dar.