MATLAB/Octave - OLED 128x64 Bricklet¶

Hello World (MATLAB)¶

Download (matlab_example_hello_world.m)

 1function matlab_example_hello_world()
 2    import com.tinkerforge.IPConnection;
 3    import com.tinkerforge.BrickletOLED128x64;
 4
 5    HOST = 'localhost';
 6    PORT = 4223;
 7    UID = 'XYZ'; % Change XYZ to the UID of your OLED 128x64 Bricklet
 8
 9    ipcon = IPConnection(); % Create IP connection
10    oled = handle(BrickletOLED128x64(UID, ipcon), 'CallbackProperties'); % Create device object
11
12    ipcon.connect(HOST, PORT); % Connect to brickd
13    % Don't use device before ipcon is connected
14
15    % Clear display
16    oled.clearDisplay();
17
18    % Write "Hello World" starting from upper left corner of the screen
19    oled.writeLine(0, 0, 'Hello World');
20
21    input('Press key to exit\n', 's');
22    ipcon.disconnect();
23end

Pixel Matrix (MATLAB)¶

Download (matlab_example_pixel_matrix.m)

 1function matlab_example_pixel_matrix()
 2    import com.tinkerforge.IPConnection;
 3    import com.tinkerforge.BrickletOLED128x64;
 4
 5    HOST = 'localhost';
 6    PORT = 4223;
 7    UID = 'XYZ'; % Change XYZ to the UID of your OLED 128x64 Bricklet
 8    SCREEN_WIDTH = 128;
 9    SCREEN_HEIGHT = 64;
10
11    function draw_matrix(oled, pixels)
12        column = cell(1, SCREEN_HEIGHT/8);
13        column_write = [];
14
15        for i = 1:(SCREEN_HEIGHT/8) - 1
16            column{i} = zeros(1, 64);
17
18            for j = 1:SCREEN_WIDTH
19                page = 0;
20
21                for k = 0:7
22                    if pixels(i*8 + k, j) == true
23                        page = bitor(page, bitshift(1, k));
24                    end
25                end
26
27                column{i}(j) = page;
28            end
29        end
30
31        oled.newWindow(0, SCREEN_WIDTH-1, 0, 7);
32
33        for i = 1:(SCREEN_HEIGHT/8) - 1
34            l = 1;
35            for j = 1:SCREEN_WIDTH/2
36                column_write(l) = column{i}(j);
37                l = l + 1;
38            end
39
40            oled.write(column_write);
41
42            l = 1;
43            for k = (SCREEN_WIDTH/2) + 1:SCREEN_WIDTH
44                column_write(l) = column{i}(k);
45                l = l + 1;
46            end
47
48            oled.write(column_write);
49        end
50    end
51
52    ipcon = IPConnection(); % Create IP connection
53    oled = handle(BrickletOLED128x64(UID, ipcon), 'CallbackProperties'); % Create device object
54
55    ipcon.connect(HOST, PORT); % Connect to brickd
56    % Don't use device before ipcon is connected
57
58    % Clear display
59    oled.clearDisplay();
60
61    % Draw checkerboard pattern
62    pixel_matrix = false(SCREEN_HEIGHT, SCREEN_WIDTH);
63
64    for h = 1:SCREEN_HEIGHT
65        for w = 1:SCREEN_WIDTH
66            pixel_matrix(h, w) = mod(floor(h / 8), 2) == mod(floor(w / 8), 2);
67        end
68    end
69
70    draw_matrix(oled, pixel_matrix);
71
72    input('Press key to exit\n', 's');
73    ipcon.disconnect();
74end

Hello World (Octave)¶

Download (octave_example_hello_world.m)

 1function octave_example_hello_world()
 2    more off;
 3
 4    HOST = "localhost";
 5    PORT = 4223;
 6    UID = "XYZ"; % Change XYZ to the UID of your OLED 128x64 Bricklet
 7
 8    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
 9    oled = javaObject("com.tinkerforge.BrickletOLED128x64", UID, ipcon); % Create device object
10
11    ipcon.connect(HOST, PORT); % Connect to brickd
12    % Don't use device before ipcon is connected
13
14    % Clear display
15    oled.clearDisplay();
16
17    % Write "Hello World" starting from upper left corner of the screen
18    oled.writeLine(0, 0, "Hello World");
19
20    input("Press key to exit\n", "s");
21    ipcon.disconnect();
22end

Pixel Matrix (Octave)¶

Download (octave_example_pixel_matrix.m)

 1function octave_example_pixel_matrix()
 2    more off;
 3
 4    HOST = "localhost";
 5    PORT = 4223;
 6    UID = "XYZ"; % Change XYZ to the UID of your OLED 128x64 Bricklet
 7    SCREEN_WIDTH = 128;
 8    SCREEN_HEIGHT = 64;
 9
10    function draw_matrix(oled, pixels)
11        column = cell(1, SCREEN_HEIGHT/8);
12
13        for i = 1:(SCREEN_HEIGHT/8) - 1
14            column{i} = zeros(1, 64);
15
16            for j = 1:SCREEN_WIDTH
17                page = 0;
18
19                for k = 0:7
20                    if pixels(i*8 + k, j) == true
21                        page = bitor(page, bitshift(1, k));
22                    end
23                end
24
25                column{i}(j) = page;
26            end
27        end
28
29        oled.newWindow(0, SCREEN_WIDTH-1, 0, 7);
30
31        for i = 1:(SCREEN_HEIGHT/8) - 1
32            l = 1;
33            for j = 1:SCREEN_WIDTH/2
34                column_write(l) = column{i}(j);
35                l = l + 1;
36            end
37
38            oled.write(column_write);
39
40            l = 1;
41            for k = (SCREEN_WIDTH/2) + 1:SCREEN_WIDTH
42                column_write(l) = column{i}(k);
43                l = l + 1;
44            end
45
46            oled.write(column_write);
47        end
48    end
49
50    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
51    oled = javaObject("com.tinkerforge.BrickletOLED128x64", UID, ipcon); % Create device object
52
53    ipcon.connect(HOST, PORT); % Connect to brickd
54    % Don't use device before ipcon is connected
55
56    % Clear display
57    oled.clearDisplay();
58
59    % Draw checkerboard pattern
60    pixel_matrix = false(SCREEN_HEIGHT, SCREEN_WIDTH);
61
62    for h = 1:SCREEN_HEIGHT
63        for w = 1:SCREEN_WIDTH
64            pixel_matrix(h, w) = mod(floor(h / 8), 2) == mod(floor(w / 8), 2);
65        end
66    end
67
68    draw_matrix(oled, pixel_matrix);
69
70    input("Press key to exit\n", "s");
71    ipcon.disconnect();
72end

Basic Functions¶

class BrickletOLED128x64(String uid, IPConnection ipcon)¶

Parameters:	uid – Type: String ipcon – Type: IPConnection
Returns:	oled128x64 – Type: BrickletOLED128x64

Creates an object with the unique device ID uid.

In MATLAB:

import com.tinkerforge.BrickletOLED128x64;

oled128x64 = BrickletOLED128x64('YOUR_DEVICE_UID', ipcon);

In Octave:

oled128x64 = java_new("com.tinkerforge.BrickletOLED128x64", "YOUR_DEVICE_UID", ipcon);

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

void BrickletOLED128x64.write(short[] data)¶

Parameters:	data – Type: short[], Length: 64, 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.

void BrickletOLED128x64.newWindow(short columnFrom, short columnTo, short rowFrom, short rowTo)¶

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

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

void BrickletOLED128x64.clearDisplay()¶

Clears the current content of the window as set by newWindow().

void BrickletOLED128x64.writeLine(short line, short position, String text)¶

Parameters:	line – Type: short, Range: [0 to 7] position – Type: short, 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¶

void BrickletOLED128x64.setDisplayConfiguration(short contrast, boolean invert)¶

Parameters:	contrast – Type: short, 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.

BrickletOLED128x64.DisplayConfiguration BrickletOLED128x64.getDisplayConfiguration()¶

Return Object:	contrast – Type: short, Range: [0 to 255], Default: 143 invert – Type: boolean, Default: false

Returns the configuration as set by setDisplayConfiguration().

BrickletOLED128x64.Identity BrickletOLED128x64.getIdentity()¶

Return Object:

uid – Type: String, Length: up to 8 connectedUid – Type: String, Length: up to 8 position – Type: char, Range: ['a' to 'h', 'z'] hardwareVersion – Type: short[], Length: 3 1: major – Type: short, Range: [0 to 255] 2: minor – Type: short, Range: [0 to 255] 3: revision – Type: short, Range: [0 to 255] firmwareVersion – Type: short[], Length: 3 1: major – Type: short, Range: [0 to 255] 2: minor – Type: short, Range: [0 to 255] 3: revision – Type: short, Range: [0 to 255] deviceIdentifier – Type: int, 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.

short[] BrickletOLED128x64.getAPIVersion()¶

Return Object:	apiVersion – Type: short[], Length: 3 1: major – Type: short, Range: [0 to 255] 2: minor – Type: short, Range: [0 to 255] 3: revision – Type: short, 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.

boolean BrickletOLED128x64.getResponseExpected(byte functionId)¶

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:

• BrickletOLED128x64.FUNCTION_WRITE = 1

• BrickletOLED128x64.FUNCTION_NEW_WINDOW = 2

• BrickletOLED128x64.FUNCTION_CLEAR_DISPLAY = 3

• BrickletOLED128x64.FUNCTION_SET_DISPLAY_CONFIGURATION = 4

• BrickletOLED128x64.FUNCTION_WRITE_LINE = 6

void BrickletOLED128x64.setResponseExpected(byte functionId, boolean responseExpected)¶

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:

• BrickletOLED128x64.FUNCTION_WRITE = 1

• BrickletOLED128x64.FUNCTION_NEW_WINDOW = 2

• BrickletOLED128x64.FUNCTION_CLEAR_DISPLAY = 3

• BrickletOLED128x64.FUNCTION_SET_DISPLAY_CONFIGURATION = 4

• BrickletOLED128x64.FUNCTION_WRITE_LINE = 6

void BrickletOLED128x64.setResponseExpectedAll(boolean responseExpected)¶

Parameters:	responseExpected – Type: boolean

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

Constants¶

int BrickletOLED128x64.DEVICE_IDENTIFIER¶

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

The getIdentity() function and the IPConnection.EnumerateCallback callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

String BrickletOLED128x64.DEVICE_DISPLAY_NAME¶

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