Delphi/Lazarus - OLED 64x48 Bricklet¶

Hello World¶

Download (ExampleHelloWorld.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

program ExampleHelloWorld;

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

uses
  SysUtils, IPConnection, BrickletOLED64x48;

type
  TExample = class
  private
    ipcon: TIPConnection;
    oled: TBrickletOLED64x48;
  public
    procedure Execute;
  end;

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

var
  e: TExample;

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

  { Create device object }
  oled := TBrickletOLED64x48.Create(UID, ipcon);

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

  { Clear display }
  oled.ClearDisplay;

  { Write "Hello World" starting from upper left corner of the screen }
  oled.WriteLine(0, 0, 'Hello World');

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

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

Pixel Matrix¶

Download (ExamplePixelMatrix.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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

program ExamplePixelMatrix;

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

uses
  Math, SysUtils, IPConnection, BrickletOLED64x48;

const
  WIDTH = 64;
  HEIGHT = 48;

type
  TPixels = array [0..(HEIGHT - 1), 0..(WIDTH - 1)] of boolean;
  TExample = class
  private
    ipcon: TIPConnection;
    oled: TBrickletOLED64x48;
  public
    procedure DrawMatrix(pixels: TPixels);
    procedure Execute;
  end;

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

var
  e: TExample;

procedure TExample.DrawMatrix(pixels: TPixels);
var row, column, bit: integer; pages: array [0..(HEIGHT div 8 - 1), 0..(WIDTH - 1)] of byte;
begin
  for row := 0 to HEIGHT div 8 - 1 do begin
    for column := 0 to WIDTH - 1 do begin
      pages[row][column] := 0;
      for bit := 0 to 7 do begin
        if (pixels[(row * 8) + bit, column]) then begin
          pages[row][column] := pages[row][column] or (1 << bit);
        end;
      end;
    end;
  end;
  oled.NewWindow(0, WIDTH - 1, 0, HEIGHT div 8 - 1);
  for row := 0 to HEIGHT div 8 - 1 do begin
    oled.write(pages[row]);
  end;
end;

procedure TExample.Execute;
var row, column: integer; pixels: TPixels;
begin
  { Create IP connection }
  ipcon := TIPConnection.Create;

  { Create device object }
  oled := TBrickletOLED64x48.Create(UID, ipcon);

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

  { Clear display }
  oled.ClearDisplay;

  { Draw checkerboard pattern }
  for row := 0 to HEIGHT - 1 do begin
    for column := 0 to WIDTH - 1 do begin
      pixels[row, column] := (row div 8) mod 2 = (column div 8) mod 2;
    end;
  end;

  e.DrawMatrix(pixels);

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

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

Grundfunktionen¶

constructor TBrickletOLED64x48.Create(const uid: string; ipcon: TIPConnection)¶

Parameter:	uid – Typ: string ipcon – Typ: TIPConnection
Rückgabe:	oled64x48 – Typ: TBrickletOLED64x48

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

oled64x48 := TBrickletOLED64x48.Create('YOUR_DEVICE_UID', ipcon);

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

procedure TBrickletOLED64x48.Write(const data: array [0..63] of byte)¶

Parameter:	data – Typ: array [0..63] of byte, Wertebereich: [0 bis 255]

Fügt 64 Byte Daten zu dem mit NewWindow gesetztem Fenster hinzu.

Jede Zeile hat eine Höhe von 8 Pixeln welche einem Byte Daten entsprechen.

Beispiel: Wenn NewWindow mit Spalte (Column) von 0 bis 63 und Zeile (Row) von 0 bis 5 (das ganze Display) aufgerufen wird, schreibt jedes Write (roter Pfeil) eine Zeile.

Das LSB (D0) von jedem Daten-Byte ist in der Zeile oben und das MSB (D7) ist in der Zeile unten.

Der nächste Aufruf von Write schreibt die zweite Zeile usw. Um das ganze Display zu füllen muss Write 6 mal aufgerufen werden.

procedure TBrickletOLED64x48.NewWindow(const columnFrom: byte; const columnTo: byte; const rowFrom: byte; const rowTo: byte)¶

Parameter:	columnFrom – Typ: byte, Wertebereich: [0 bis 63] columnTo – Typ: byte, Wertebereich: [0 bis 63] rowFrom – Typ: byte, Wertebereich: [0 bis 5] rowTo – Typ: byte, Wertebereich: [0 bis 5]

Setzt das Fenster in welches mit Write geschrieben werden kann. Eine Zeile (Row) hat eine Höhe von 8 Pixel.

procedure TBrickletOLED64x48.ClearDisplay¶

Löscht den aktuellen Inhalt des mit NewWindow gesetztem Fensters.

procedure TBrickletOLED64x48.WriteLine(const line: byte; const position: byte; const text: string)¶

Parameter:	line – Typ: byte, Wertebereich: [0 bis 5] position – Typ: byte, Wertebereich: [0 bis 12] text – Typ: string, Länge: bis zu 13

Schreibt einen Text in die angegebene Zeile (0 bis 5) mit einer vorgegebenen Position (0 bis 12). Der Text kann maximal 13 Zeichen lang sein.

Beispiel: (1, 4, "Hallo") schreibt Hallo in die Mitte der zweiten Zeile des Displays.

Es ist möglich zuerst auf das Display mit Write zu malen und danach Text hinzuzufügen.

Das Display nutzt einen speziellen 5x7 Pixel Zeichensatz. Der Zeichensatz kann mit Hilfe von Brick Viewer angezeigt werden.

Der der Zeichensatz entspricht Codepage 437.

Fortgeschrittene Funktionen¶

procedure TBrickletOLED64x48.SetDisplayConfiguration(const contrast: byte; const invert: boolean)¶

Parameter:	contrast – Typ: byte, Wertebereich: [0 bis 255], Standardwert: 143 invert – Typ: boolean, Standardwert: false

Setzt die Konfiguration des Displays

Es können der Kontrast mit einem Wertebereich von 0 bis 255 gesetzt, sowie die Farben (schwarz/weiß) des Displays invertiert werden.

procedure TBrickletOLED64x48.GetDisplayConfiguration(out contrast: byte; out invert: boolean)¶

Ausgabeparameter:	contrast – Typ: byte, Wertebereich: [0 bis 255], Standardwert: 143 invert – Typ: boolean, Standardwert: false

Gibt die Konfiguration zurück, wie von SetDisplayConfiguration gesetzt.

procedure TBrickletOLED64x48.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.

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 TBrickletOLED64x48.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 TBrickletOLED64x48.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_OLED_64X48_FUNCTION_WRITE = 1
• BRICKLET_OLED_64X48_FUNCTION_NEW_WINDOW = 2
• BRICKLET_OLED_64X48_FUNCTION_CLEAR_DISPLAY = 3
• BRICKLET_OLED_64X48_FUNCTION_SET_DISPLAY_CONFIGURATION = 4
• BRICKLET_OLED_64X48_FUNCTION_WRITE_LINE = 6

procedure TBrickletOLED64x48.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_OLED_64X48_FUNCTION_WRITE = 1
• BRICKLET_OLED_64X48_FUNCTION_NEW_WINDOW = 2
• BRICKLET_OLED_64X48_FUNCTION_CLEAR_DISPLAY = 3
• BRICKLET_OLED_64X48_FUNCTION_SET_DISPLAY_CONFIGURATION = 4
• BRICKLET_OLED_64X48_FUNCTION_WRITE_LINE = 6

procedure TBrickletOLED64x48.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_OLED_64X48_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein OLED 64x48 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_OLED_64X48_DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines OLED 64x48 Bricklet dar.