Delphi/Lazarus - OLED 128x64 Bricklet 2.0

Dies ist die Beschreibung der Delphi/Lazarus API Bindings für das OLED 128x64 Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des OLED 128x64 Bricklet 2.0 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).

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, BrickletOLED128x64V2;

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

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your OLED 128x64 Bricklet 2.0 }

var
  e: TExample;

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

  { Create device object }
  oled := TBrickletOLED128x64V2.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
program ExamplePixelMatrix;

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

uses
  Math, SysUtils, IPConnection, BrickletOLED128x64V2;

const
  WIDTH = 128;
  HEIGHT = 64;

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

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

var
  e: TExample;

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

  { Create device object }
  oled := TBrickletOLED128x64V2.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 * WIDTH + column] := (row div 8) mod 2 = (column div 8) mod 2;
    end;
  end;

  oled.WritePixels(0, 0, WIDTH-1, HEIGHT-1, pixels);

  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 TBrickletOLED128x64V2.Create(const uid: string; ipcon: TIPConnection)

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

oled128x64V2 := TBrickletOLED128x64V2.Create('YOUR_DEVICE_UID', ipcon);

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

procedure TBrickletOLED128x64V2.WritePixels(const xStart: byte; const yStart: byte; const xEnd: byte; const yEnd: byte; const pixels: array of boolean)

Schreibt Pixel in das angegebene Fenster.

Die X-Achse läuft von 0 bis 127 und die Y-Achse von 0 bis 63. Die Pixel werden zeilenweise von oben nach unten und die Zeilen werden jeweils von links nach rechts geschrieben.

Wenn Automatic Draw aktiviert ist (Standard), dann werden die Pixel direkt auf den Display geschrieben. Nur Pixel die sich wirklich verändert haben werden auf dem Display aktualisiert.

Wenn Automatic Draw deaktiviert ist, dann werden die Pixel in einen internen Buffer geschrieben der dann durch einen Aufruf von DrawBufferedFrame auf dem Display angezeigt werden kann. Dadurch kann Flicker vermieden werden, wenn ein komplexes Bild in mehreren Schritten aufgebaut wird.

Automatic Draw kann über die SetDisplayConfiguration Funktion eingestellt werden.

function TBrickletOLED128x64V2.ReadPixels(const xStart: byte; const yStart: byte; const xEnd: byte; const yEnd: byte): array of boolean

Liest Pixel aus dem angegebenen Fenster.

Die X-Achse läuft von 0 bis 127 und die Y-Achse von 0 bis 63. Die Pixel werden zeilenweise von oben nach unten und die Zeilen werden jeweils von links nach rechts gelesen.

Wenn Automatic Draw aktiviert ist (Standard), dann werden die Pixel direkt vom Display gelesen.

Wenn Automatic Draw deaktiviert ist, dann werden die Pixel aus einen internen Buffer gelesen (siehe DrawBufferedFrame).

Automatic Draw kann über die SetDisplayConfiguration Funktion eingestellt werden.

procedure TBrickletOLED128x64V2.ClearDisplay

Löscht den kompletten aktuellen Inhalt des Displays.

Wenn Automatic Draw aktiviert ist (Standard), dann werden die Pixel direkt gelöscht.

Wenn Automatic Draw deaktiviert ist, dann werden die Pixel im internen Buffer gelöscht der dann durch einen Aufruf von DrawBufferedFrame auf dem Display angezeigt werden kann. Dadurch kann Flicker vermieden werden, wenn ein komplexes Bild in mehreren Schritten aufgebaut wird.

Automatic Draw kann über die SetDisplayConfiguration Funktion eingestellt werden.

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

Schreibt einen Text in die angegebene Zeile (0 bis 7) mit einer vorgegebenen Position (0 bis 21). Der Text kann maximal 22 Zeichen lang sein.

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

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

Wenn Automatic Draw aktiviert ist (Standard), dann wird der Text direkt auf den Display geschrieben. Nur Pixel die sich wirklich verändert haben werden auf dem Display aktualisiert.

Wenn Automatic Draw deaktiviert ist, dann wird der Text in einen internen Buffer geschrieben der dann durch einen Aufruf von DrawBufferedFrame auf dem Display angezeigt werden kann. Dadurch kann Flicker vermieden werden, wenn ein komplexes Bild in mehreren Schritten aufgebaut wird.

Automatic Draw kann über die SetDisplayConfiguration Funktion eingestellt werden.

procedure TBrickletOLED128x64V2.DrawBufferedFrame(const forceCompleteRedraw: boolean)

Stellt den aktuell Inhalt des internen Buffers auf dem Display dar. Normalerweise schreibt jeder Aufruf von WritePixels und WriteLine direkt auf den Display. Wenn jedoch Automatic Draw deaktiviert ist (SetDisplayConfiguration), dann werden Änderungen in einen internen Buffer anstatt auf den Display geschrieben. Der internen Buffer kann dann durch einen Aufruf dieser Funktion auf den Display geschrieben werden. Dadurch kann Flicker vermieden werden, wenn ein komplexes Bild in mehreren Schritten aufgebaut wird.

Wenn Force Complete Redraw auf true gesetzt ist, dann wird der gesamte Display aktualisiert, anstatt nur die Pixel die sich wirklich verändert haben. Normalerweise sollte dies nicht notwendig sein, außer bei hängenden Pixeln bedingt durch Fehler.

Fortgeschrittene Funktionen

procedure TBrickletOLED128x64V2.SetDisplayConfiguration(const contrast: byte; const invert: boolean; const automaticDraw: boolean)

Setzt die Konfiguration des Displays.

Der Kontrast kann zwischen 0 und 255 und das Farbschema invertiert (weiß/schwarz) eingestellt werden.

Wenn Automatic Draw aktiviert (true) ist dann wird das Display bei jedem Aufruf von WritePixels und WriteLine aktualisiert. Wenn Automatic Draw deaktiviert (false) ist, dann werden Änderungen in einen internen Buffer geschrieben, der dann bei bei einem Aufruf von DrawBufferedFrame auf dem Display angezeigt wird.

Standardwerte: Kontrast 143, Invertierung aus und Automatic Draw aktiviert.

procedure TBrickletOLED128x64V2.GetDisplayConfiguration(out contrast: byte; out invert: boolean; out automaticDraw: boolean)

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

function TBrickletOLED128x64V2.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 TBrickletOLED128x64V2.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.

Siehe SetResponseExpected für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

procedure TBrickletOLED128x64V2.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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • BRICKLET_OLED_128X64_V2_FUNCTION_WRITE_PIXELS = 1
  • BRICKLET_OLED_128X64_V2_FUNCTION_CLEAR_DISPLAY = 3
  • BRICKLET_OLED_128X64_V2_FUNCTION_SET_DISPLAY_CONFIGURATION = 4
  • BRICKLET_OLED_128X64_V2_FUNCTION_WRITE_LINE = 6
  • BRICKLET_OLED_128X64_V2_FUNCTION_DRAW_BUFFERED_FRAME = 7
  • BRICKLET_OLED_128X64_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BRICKLET_OLED_128X64_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BRICKLET_OLED_128X64_V2_FUNCTION_RESET = 243
  • BRICKLET_OLED_128X64_V2_FUNCTION_WRITE_UID = 248
procedure TBrickletOLED128x64V2.SetResponseExpectedAll(const responseExpected: boolean)

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

procedure TBrickletOLED128x64V2.GetSPITFPErrorCount(out errorCountAckChecksum: longword; out errorCountMessageChecksum: longword; out errorCountFrame: longword; out errorCountOverflow: longword)

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

function TBrickletOLED128x64V2.SetBootloaderMode(const mode: byte): byte

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootlodaer- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

  • BRICKLET_OLED_128X64_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_OLED_128X64_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_OLED_128X64_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_OLED_128X64_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_OLED_128X64_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BRICKLET_OLED_128X64_V2_BOOTLOADER_STATUS_OK = 0
  • BRICKLET_OLED_128X64_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
  • BRICKLET_OLED_128X64_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
  • BRICKLET_OLED_128X64_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BRICKLET_OLED_128X64_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BRICKLET_OLED_128X64_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5
function TBrickletOLED128x64V2.GetBootloaderMode: byte

Gibt den aktuellen Bootloader-Modus zurück, siehe SetBootloaderMode.

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

  • BRICKLET_OLED_128X64_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_OLED_128X64_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_OLED_128X64_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_OLED_128X64_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_OLED_128X64_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
procedure TBrickletOLED128x64V2.SetWriteFirmwarePointer(const pointer: longword)

Setzt den Firmware-Pointer für WriteFirmware. Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

function TBrickletOLED128x64V2.WriteFirmware(const data: array [0..63] of byte): byte

Schreibt 64 Bytes Firmware an die Position die vorher von SetWriteFirmwarePointer gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

procedure TBrickletOLED128x64V2.SetStatusLEDConfig(const config: byte)

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

  • BRICKLET_OLED_128X64_V2_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_OLED_128X64_V2_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_OLED_128X64_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_OLED_128X64_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletOLED128x64V2.GetStatusLEDConfig: byte

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

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

  • BRICKLET_OLED_128X64_V2_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_OLED_128X64_V2_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_OLED_128X64_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_OLED_128X64_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletOLED128x64V2.GetChipTemperature: smallint

Gibt die Temperatur in °C, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

procedure TBrickletOLED128x64V2.Reset

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

procedure TBrickletOLED128x64V2.WriteUID(const uid: longword)

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

function TBrickletOLED128x64V2.ReadUID: longword

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

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

Konstanten

const BRICKLET_OLED_128X64_V2_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein OLED 128x64 Bricklet 2.0 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_128X64_V2_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines OLED 128x64 Bricklet 2.0 dar.