Delphi/Lazarus - Color Bricklet

Dies ist die Beschreibung der Delphi/Lazarus 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 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
53
54
55
56
program ExampleSimple;

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

uses
  SysUtils, IPConnection, BrickletColor;

type
  TExample = class
  private
    ipcon: TIPConnection;
    c: TBrickletColor;
  public
    procedure Execute;
  end;

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

var
  e: TExample;

procedure TExample.Execute;
var r, g, b, c_: word;
begin
  { Create IP connection }
  ipcon := TIPConnection.Create;

  { Create device object }
  c := TBrickletColor.Create(UID, ipcon);

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

  { Get current color }
  c.GetColor(r, g, b, c_);

  WriteLn(Format('Color [R]: %d', [r]));
  WriteLn(Format('Color [G]: %d', [g]));
  WriteLn(Format('Color [B]: %d', [b]));
  WriteLn(Format('Color [C]: %d', [c_]));

  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
63
64
65
66
67
68
program ExampleCallback;

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

uses
  SysUtils, IPConnection, BrickletColor;

type
  TExample = class
  private
    ipcon: TIPConnection;
    c: TBrickletColor;
  public
    procedure ColorCB(sender: TBrickletColor; const r: word; const g: word; const b: word;
                      const c_: word);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for color callback }
procedure TExample.ColorCB(sender: TBrickletColor; const r: word; const g: word;
                           const b: word; const c_: word);
begin
  WriteLn(Format('Color [R]: %d', [r]));
  WriteLn(Format('Color [G]: %d', [g]));
  WriteLn(Format('Color [B]: %d', [b]));
  WriteLn(Format('Color [C]: %d', [c_]));
  WriteLn('');
end;

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

  { Create device object }
  c := TBrickletColor.Create(UID, ipcon);

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

  { Register color callback to procedure ColorCB }
  c.OnColor := {$ifdef FPC}@{$endif}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);

  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
67
68
69
program ExampleThreshold;

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

uses
  SysUtils, IPConnection, BrickletColor;

type
  TExample = class
  private
    ipcon: TIPConnection;
    c: TBrickletColor;
  public
    procedure ColorReachedCB(sender: TBrickletColor; const r: word; const g: word;
                             const b: word; const c_: word);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for color reached callback }
procedure TExample.ColorReachedCB(sender: TBrickletColor; const r: word; const g: word;
                                  const b: word; const c_: word);
begin
  WriteLn(Format('Color [R]: %d', [r]));
  WriteLn(Format('Color [G]: %d', [g]));
  WriteLn(Format('Color [B]: %d', [b]));
  WriteLn(Format('Color [C]: %d', [c_]));
  WriteLn('');
end;

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

  { Create device object }
  c := TBrickletColor.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) }
  c.SetDebouncePeriod(10000);

  { Register color reached callback to procedure ColorReachedCB }
  c.OnColorReached := {$ifdef FPC}@{$endif}ColorReachedCB;

  { Configure threshold for color "greater than 100, 200, 300, 400" }
  c.SetColorCallbackThreshold('>', 100, 0, 200, 0, 300, 0, 400, 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 TBrickletColor.Create(const uid: string; ipcon: TIPConnection)

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

color := TBrickletColor.Create('YOUR_DEVICE_UID', ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

procedure TBrickletColor.GetColor(out r: word; out g: word; out b: word; out c: word)

Gibt die gemessene Farbe des Sensors zurück. Der Wertebereich ist von 0 bis 65535.

Die rot (r), grün (g), blau (b) und clear (c) werden mit vier unterschiedlichen Fotodioden gemessen. Diese sind Empfindlich in unterschiedlichen Wellenlängen:

Chart Responsivity / Wavelength

Wenn die Farbe periodisch abgefragt werden soll, wird empfohlen den OnColor Callback zu nutzen und die Periode mit SetColorCallbackPeriod vorzugeben.

procedure TBrickletColor.LightOn

Aktiviert die LED.

procedure TBrickletColor.LightOff

Deaktiviert die LED.

function TBrickletColor.IsLightOn: byte

Gibt den Zustand der LED zurück. Mögliche Werte sind:

  • 0: On
  • 1: Off

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

  • BRICKLET_COLOR_LIGHT_ON = 0
  • BRICKLET_COLOR_LIGHT_OFF = 1
procedure TBrickletColor.SetConfig(const gain: byte; const integrationTime: byte)

Setzt die Konfiguration des Sensors. Verstärkung und Integrationszeit können eingestellt werden.

Für die Konfiguration der Verstärkung:

  • 0: 1x Gain
  • 1: 4x Gain
  • 2: 16x Gain
  • 3: 60x Gain

Für die Konfiguration der Integrationszeit:

  • 0: 2,4ms
  • 1: 24ms
  • 2: 101ms
  • 3: 154ms
  • 4: 700ms

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 Standardwerte sind 60x Verstärkung und 154ms Integrationszeit.

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

  • BRICKLET_COLOR_GAIN_1X = 0
  • BRICKLET_COLOR_GAIN_4X = 1
  • BRICKLET_COLOR_GAIN_16X = 2
  • BRICKLET_COLOR_GAIN_60X = 3
  • BRICKLET_COLOR_INTEGRATION_TIME_2MS = 0
  • BRICKLET_COLOR_INTEGRATION_TIME_24MS = 1
  • BRICKLET_COLOR_INTEGRATION_TIME_101MS = 2
  • BRICKLET_COLOR_INTEGRATION_TIME_154MS = 3
  • BRICKLET_COLOR_INTEGRATION_TIME_700MS = 4
procedure TBrickletColor.GetConfig(out gain: byte; out integrationTime: byte)

Gibt die Einstellungen zurück, wie von SetConfig gesetzt.

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

  • BRICKLET_COLOR_GAIN_1X = 0
  • BRICKLET_COLOR_GAIN_4X = 1
  • BRICKLET_COLOR_GAIN_16X = 2
  • BRICKLET_COLOR_GAIN_60X = 3
  • BRICKLET_COLOR_INTEGRATION_TIME_2MS = 0
  • BRICKLET_COLOR_INTEGRATION_TIME_24MS = 1
  • BRICKLET_COLOR_INTEGRATION_TIME_101MS = 2
  • BRICKLET_COLOR_INTEGRATION_TIME_154MS = 3
  • BRICKLET_COLOR_INTEGRATION_TIME_700MS = 4
function TBrickletColor.GetIlluminance: longword

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.

function TBrickletColor.GetColorTemperature: word

Gibt die Farbtemperatur in Kelvin 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.

Fortgeschrittene Funktionen

function TBrickletColor.GetAPIVersion: array [0..2] of byte

Gibt die Version der API Definition (Major, Minor, Revision) 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 TBrickletColor.GetResponseExpected(const functionId: byte): 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:

  • BRICKLET_COLOR_FUNCTION_SET_COLOR_CALLBACK_PERIOD = 2
  • BRICKLET_COLOR_FUNCTION_SET_COLOR_CALLBACK_THRESHOLD = 4
  • BRICKLET_COLOR_FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BRICKLET_COLOR_FUNCTION_LIGHT_ON = 10
  • BRICKLET_COLOR_FUNCTION_LIGHT_OFF = 11
  • BRICKLET_COLOR_FUNCTION_SET_CONFIG = 13
  • BRICKLET_COLOR_FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 17
  • BRICKLET_COLOR_FUNCTION_SET_COLOR_TEMPERATURE_CALLBACK_PERIOD = 19
procedure TBrickletColor.SetResponseExpected(const functionId: byte; const responseExpected: 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:

  • BRICKLET_COLOR_FUNCTION_SET_COLOR_CALLBACK_PERIOD = 2
  • BRICKLET_COLOR_FUNCTION_SET_COLOR_CALLBACK_THRESHOLD = 4
  • BRICKLET_COLOR_FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BRICKLET_COLOR_FUNCTION_LIGHT_ON = 10
  • BRICKLET_COLOR_FUNCTION_LIGHT_OFF = 11
  • BRICKLET_COLOR_FUNCTION_SET_CONFIG = 13
  • BRICKLET_COLOR_FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 17
  • BRICKLET_COLOR_FUNCTION_SET_COLOR_TEMPERATURE_CALLBACK_PERIOD = 19
procedure TBrickletColor.SetResponseExpectedAll(const responseExpected: boolean)

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

procedure TBrickletColor.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)

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 kann 'a', 'b', 'c' oder 'd' sein.

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 TBrickletColor.SetColorCallbackPeriod(const period: longword)

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

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

Der Standardwert ist 0.

function TBrickletColor.GetColorCallbackPeriod: longword

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

procedure TBrickletColor.SetColorCallbackThreshold(const option: char; const minR: word; const maxR: word; const minG: word; const maxG: word; const minB: word; const maxB: word; const minC: word; const maxC: word)

Setzt den Schwellwert für den OnColorReached 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)

Der Standardwert ist ('x', 0, 0, 0, 0, 0, 0, 0, 0).

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

  • BRICKLET_COLOR_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_COLOR_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_COLOR_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_COLOR_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_COLOR_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletColor.GetColorCallbackThreshold(out option: char; out minR: word; out maxR: word; out minG: word; out maxG: word; out minB: word; out maxB: word; out minC: word; out maxC: word)

Gibt den Schwellwert zurück, wie von SetColorCallbackThreshold gesetzt.

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

  • BRICKLET_COLOR_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_COLOR_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_COLOR_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_COLOR_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_COLOR_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletColor.SetDebouncePeriod(const debounce: longword)

Setzt die Periode in ms mit welcher die Schwellwert Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

Der Standardwert ist 100.

function TBrickletColor.GetDebouncePeriod: longword

Gibt die Entprellperiode zurück, wie von SetDebouncePeriod gesetzt.

procedure TBrickletColor.SetIlluminanceCallbackPeriod(const period: longword)

Setzt die Periode in ms 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.

Der Standardwert ist 0.

function TBrickletColor.GetIlluminanceCallbackPeriod: longword

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

procedure TBrickletColor.SetColorTemperatureCallbackPeriod(const period: longword)

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

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

Der Standardwert ist 0.

function TBrickletColor.GetColorTemperatureCallbackPeriod: longword

Gibt die Periode zurück, wie von SetColorTemperatureCallbackPeriod 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: TBrickletColor; const param: word);
begin
  WriteLn(param);
end;

color.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 TBrickletColor.OnColor
procedure(sender: TBrickletColor; const r: word; const g: word; const b: word; const c: word) of object;

Dieser Callback wird mit der Periode, wie gesetzt mit SetColorCallbackPeriod, ausgelöst. Der Parameter ist die Farbe des Sensors als RGBC.

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

property TBrickletColor.OnColorReached
procedure(sender: TBrickletColor; const r: word; const g: word; const b: word; const c: word) of object;

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.

property TBrickletColor.OnIlluminance
procedure(sender: TBrickletColor; const illuminance: longword) of object;

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 OnIlluminance Callback wird nur ausgelöst, wenn sich die Beleuchtungsstärke seit der letzten Auslösung geändert hat.

property TBrickletColor.OnColorTemperature
procedure(sender: TBrickletColor; const colorTemperature: word) of object;

Dieser Callback wird mit der Periode, wie gesetzt mit SetColorTemperatureCallbackPeriod, ausgelöst. Der Parameter ist die Farbtemperatur des Sensors in Kelvin.

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

Konstanten

const BRICKLET_COLOR_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Color 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_COLOR_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Color Bricklet dar.