Delphi/Lazarus - OLED 128x64 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, BrickletOLED128x64;

type
  TExample = class
  private
    ipcon: TIPConnection;
    oled: TBrickletOLED128x64;
  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;
begin
  { Create IP connection }
  ipcon := TIPConnection.Create;

  { Create device object }
  oled := TBrickletOLED128x64.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
86
87
88
89
90
91
92
93
94

program ExamplePixelMatrix;

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

uses
  Math, SysUtils, IPConnection, BrickletOLED128x64;

const
  WIDTH = 128;
  HEIGHT = 64;

type
  TPixels = array [0..(HEIGHT - 1), 0..(WIDTH - 1)] of boolean;
  TExample = class
  private
    ipcon: TIPConnection;
    oled: TBrickletOLED128x64;
  public
    procedure DrawMatrix(pixels: TPixels);
    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.DrawMatrix(pixels: TPixels);
var row, column, bit, i: integer;
    pages: array [0..(HEIGHT div 8 - 1), 0..(WIDTH - 1)] of byte;
    section: array [0..63] 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
    column := 0;
    while column < WIDTH - 1 do begin
      for i := 0 to 63 do begin
        section[i] := pages[row][column + i];
      end;
      oled.write(section);
      column := column + 64;
    end;
  end;
end;

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

  { Create device object }
  oled := TBrickletOLED128x64.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.

Basic Functions¶

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

Parameters:	uid – Type: string ipcon – Type: TIPConnection
Returns:	oled128x64 – Type: TBrickletOLED128x64

Creates an object with the unique device ID uid:

oled128x64 := TBrickletOLED128x64.Create('YOUR_DEVICE_UID', ipcon);

This object can then be used after the IP Connection is connected.

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

Parameters:	data – Type: array [0..63] of byte, Range: [0 to 255]

Appends 64 byte of data to the window as set by NewWindow.

Each row has a height of 8 pixels which corresponds to one byte of data.

Example: if you call NewWindow with column from 0 to 127 and row from 0 to 7 (the whole display) each call of Write (red arrow) will write half of a row.

The LSB (D0) of each data byte is at the top and the MSB (D7) is at the bottom of the row.

The next call of Write will write the second half of the row and the next two the second row and so on. To fill the whole display you need to call Write 16 times.

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

Parameters:	columnFrom – Type: byte, Range: [0 to 127] columnTo – Type: byte, Range: [0 to 127] rowFrom – Type: byte, Range: [0 to 7] rowTo – Type: byte, Range: [0 to 7]

Sets the window in which you can write with Write. One row has a height of 8 pixels.

procedure TBrickletOLED128x64.ClearDisplay¶

Clears the current content of the window as set by NewWindow.

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

Parameters:	line – Type: byte, Range: [0 to 7] position – Type: byte, Range: [0 to 25] text – Type: string, Length: up to 26

Writes text to a specific line with a specific position. The text can have a maximum of 26 characters.

For example: (1, 10, "Hello") will write Hello in the middle of the second line of the display.

You can draw to the display with Write and then add text to it afterwards.

The display uses a special 5x7 pixel charset. You can view the characters of the charset in Brick Viewer.

The font conforms to code page 437.

Advanced Functions¶

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

Parameters:	contrast – Type: byte, Range: [0 to 255], Default: 143 invert – Type: boolean, Default: false

Sets the configuration of the display.

You can set a contrast value from 0 to 255 and you can invert the color (black/white) of the display.

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

Output Parameters:	contrast – Type: byte, Range: [0 to 255], Default: 143 invert – Type: boolean, Default: false

Returns the configuration as set by SetDisplayConfiguration.

procedure TBrickletOLED128x64.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)¶

Output Parameters:

uid – Type: string, Length: up to 8 connectedUid – Type: string, Length: up to 8 position – Type: char, Range: ['a' to 'h', 'z'] hardwareVersion – Type: array [0..2] of byte 0: major – Type: byte, Range: [0 to 255] 1: minor – Type: byte, Range: [0 to 255] 2: revision – Type: byte, Range: [0 to 255] firmwareVersion – Type: array [0..2] of byte 0: major – Type: byte, Range: [0 to 255] 1: minor – Type: byte, Range: [0 to 255] 2: revision – Type: byte, Range: [0 to 255] deviceIdentifier – Type: word, Range: [0 to 216 - 1]

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

function TBrickletOLED128x64.GetAPIVersion: array [0..2] of byte¶

Output Parameters:	apiVersion – Type: array [0..2] of byte 0: major – Type: byte, Range: [0 to 255] 1: minor – Type: byte, Range: [0 to 255] 2: revision – Type: byte, Range: [0 to 255]

Returns the version of the API definition implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

function TBrickletOLED128x64.GetResponseExpected(const functionId: byte): boolean¶

Parameters:	functionId – Type: byte, Range: See constants
Returns:	responseExpected – Type: boolean

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by SetResponseExpected. For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

• BRICKLET_OLED_128X64_FUNCTION_WRITE = 1
• BRICKLET_OLED_128X64_FUNCTION_NEW_WINDOW = 2
• BRICKLET_OLED_128X64_FUNCTION_CLEAR_DISPLAY = 3
• BRICKLET_OLED_128X64_FUNCTION_SET_DISPLAY_CONFIGURATION = 4
• BRICKLET_OLED_128X64_FUNCTION_WRITE_LINE = 6

procedure TBrickletOLED128x64.SetResponseExpected(const functionId: byte; const responseExpected: boolean)¶

Parameters:	functionId – Type: byte, Range: See constants responseExpected – Type: boolean

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

• BRICKLET_OLED_128X64_FUNCTION_WRITE = 1
• BRICKLET_OLED_128X64_FUNCTION_NEW_WINDOW = 2
• BRICKLET_OLED_128X64_FUNCTION_CLEAR_DISPLAY = 3
• BRICKLET_OLED_128X64_FUNCTION_SET_DISPLAY_CONFIGURATION = 4
• BRICKLET_OLED_128X64_FUNCTION_WRITE_LINE = 6

procedure TBrickletOLED128x64.SetResponseExpectedAll(const responseExpected: boolean)¶

Parameters:	responseExpected – Type: boolean

Changes the response expected flag for all setter and callback configuration functions of this device at once.

Constants¶

const BRICKLET_OLED_128X64_DEVICE_IDENTIFIER¶

This constant is used to identify a OLED 128x64 Bricklet.

The GetIdentity function and the TIPConnection.OnEnumerate callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

const BRICKLET_OLED_128X64_DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a OLED 128x64 Bricklet.