Shell - OLED 128x64 Bricklet 2.0

This is the description of the Shell API bindings for the OLED 128x64 Bricklet 2.0. General information and technical specifications for the OLED 128x64 Bricklet 2.0 are summarized in its hardware description.

An installation guide for the Shell API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

Hello World

Download (example-hello-world.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your OLED 128x64 Bricklet 2.0

# Clear display
tinkerforge call oled-128x64-v2-bricklet $uid clear-display

# Write "Hello World" starting from upper left corner of the screen
tinkerforge call oled-128x64-v2-bricklet $uid write-line 0 0 "Hello World"

Pixel Matrix

Download (example-pixel-matrix.sh)

 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
#!/bin/bash
# Connects to localhost:4223 by default, use --host and --port to change this

# This example requires Bash 4

uid=XYZ # Change XYZ to the UID of your OLED 128x64 Bricklet 2.0

SCREEN_WIDTH=128
SCREEN_HEIGHT=64

# Clear display
tinkerforge call oled-128x64-v2-bricklet $uid clear-display

# Draw checkerboard pattern
pixels=""

for ((h=0;h<${SCREEN_HEIGHT};h++))
do
    for ((w=0;w<${SCREEN_WIDTH};w++))
    do
        if [ $((((${h}/8))%2==((${w}/8))%2)) -gt 0  ]; then
            pixels+="true,"
        else
            pixels+="false,"
        fi  
    done
done
    
w=`expr $SCREEN_WIDTH - 1`
h=`expr $SCREEN_HEIGHT - 1`
tinkerforge call oled-128x64-v2-bricklet ${uid} write-pixels 0 0 $w $h ${pixels::-1}

API

Possible exit codes for all tinkerforge commands are:

  • 1: interrupted (ctrl+c)
  • 2: syntax error
  • 21: Python 2.5 or newer is required
  • 22: Python argparse module is missing
  • 23: socket error
  • 24: other exception
  • 25: invalid placeholder in format string
  • 26: authentication error
  • 201: timeout occurred
  • 209: invalid argument value
  • 210: function is not supported
  • 211: unknown error

Command Structure

The common options of the call and dispatch commands are documented here. The specific command structure is shown below.

tinkerforge call oled-128x64-v2-bricklet [<option>..] <uid> <function> [<argument>..]
Parameters:
  • <uid> -- string
  • <function> -- string

The call command is used to call a function of the OLED 128x64 Bricklet 2.0. It can take several options:

  • --help shows help for the specific call command and exits
  • --list-functions shows a list of known functions of the OLED 128x64 Bricklet 2.0 and exits
tinkerforge dispatch oled-128x64-v2-bricklet [<option>..] <uid> <callback>
Parameters:
  • <uid> -- string
  • <callback> -- string

The dispatch command is used to dispatch a callback of the OLED 128x64 Bricklet 2.0. It can take several options:

  • --help shows help for the specific dispatch command and exits
  • --list-callbacks shows a list of known callbacks of the OLED 128x64 Bricklet 2.0 and exits
tinkerforge call oled-128x64-v2-bricklet <uid> <function> [<option>..] [<argument>..]
Parameters:
  • <uid> -- string
  • <function> -- string

The <function> to be called can take different options depending of its kind. All functions can take the following options:

  • --help shows help for the specific function and exits

Getter functions can take the following options:

  • --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Setter functions can take the following options:

  • --expect-response requests response and waits for it

The --expect-response option for setter functions allows to detect timeouts and other error conditions calls of setters as well. The device will then send a response for this purpose. If this option is not given for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

tinkerforge dispatch oled-128x64-v2-bricklet <uid> <callback> [<option>..]
Parameters:
  • <uid> -- string
  • <callback> -- string

The <callback> to be dispatched can take several options:

  • --help shows help for the specific callback and exits
  • --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Basic Functions

tinkerforge call oled-128x64-v2-bricklet <uid> write-pixels-low-level <x-start> <y-start> <x-end> <y-end> <pixels-length> <pixels-chunk-offset> <pixels-chunk-data>
Parameters:
  • <x-start> -- int
  • <y-start> -- int
  • <x-end> -- int
  • <y-end> -- int
  • <pixels-length> -- int
  • <pixels-chunk-offset> -- int
  • <pixels-chunk-data> -- bool,bool,..445x..,bool
Output:

no output

Writes pixels to the specified window.

The x-axis goes from 0 to 127 and the y-axis from 0 to 63. The pixels are written into the window line by line top to bottom and each line is written from left to right.

If automatic draw is enabled (default) the pixels are directly written to the screen. Only pixels that have actually changed are updated on the screen, the rest stays the same.

If automatic draw is disabled the pixels are written to an internal buffer and the buffer is transferred to the display only after draw-buffered-frame is called. This can be used to avoid flicker when drawing a complex frame in multiple steps.

Automatic draw can be configured with the set-display-configuration function.

tinkerforge call oled-128x64-v2-bricklet <uid> read-pixels-low-level <x-start> <y-start> <x-end> <y-end>
Parameters:
  • <x-start> -- int
  • <y-start> -- int
  • <x-end> -- int
  • <y-end> -- int
Output:
  • pixels-length -- int
  • pixels-chunk-offset -- int
  • pixels-chunk-data -- bool,bool,..477x..,bool

Reads pixels from the specified window.

The x-axis goes from 0 to 127 and the y-axis from 0 to 63. The pixels are read from the window line by line top to bottom and each line is read from left to right.

If automatic draw is enabled (default) the pixels that are read are always the same that are shown on the display.

If automatic draw is disabled the pixels are read from the internal buffer (see draw-buffered-frame).

Automatic draw can be configured with the set-display-configuration function.

tinkerforge call oled-128x64-v2-bricklet <uid> clear-display
Output:no output

Clears the complete content of the display.

tinkerforge call oled-128x64-v2-bricklet <uid> write-line <line> <position> <text>
Parameters:
  • <line> -- int
  • <position> -- int
  • <text> -- string
Output:

no output

Writes text to a specific line (0 to 7) with a specific position (0 to 21). The text can have a maximum of 22 characters.

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

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

tinkerforge call oled-128x64-v2-bricklet <uid> draw-buffered-frame <force-complete-redraw>
Parameters:
  • <force-complete-redraw> -- bool
Output:

no output

Draws the currently buffered frame. Normally each call of write-pixels and write-line draws directly onto the display. If you turn automatic draw off (set-display-configuration), the data is written in an internal buffer and only transferred to the display by calling this function. This can be used to avoid flicker when drawing a complex frame in multiple steps.

Set the force complete redraw to true to redraw the whole display instead of only the changed parts. Normally it should not be necessary to set this to true. It may only become necessary in case of stuck pixels because of errors.

Advanced Functions

tinkerforge call oled-128x64-v2-bricklet <uid> set-display-configuration <contrast> <invert> <automatic-draw>
Parameters:
  • <contrast> -- int
  • <invert> -- bool
  • <automatic-draw> -- bool
Output:

no output

Sets the configuration of the display.

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

If automatic draw is set to true, the display is automatically updated with every call of write-pixels or write-line. If it is set to false, the changes are written into an internal buffer and only shown on the display after a call of draw-buffered-frame.

The default values are contrast 143, inverting off and automatic draw on.

tinkerforge call oled-128x64-v2-bricklet <uid> get-display-configuration
Output:
  • contrast -- int
  • invert -- bool
  • automatic-draw -- bool

Returns the configuration as set by set-display-configuration.

tinkerforge call oled-128x64-v2-bricklet <uid> get-spitfp-error-count
Output:
  • error-count-ack-checksum -- int
  • error-count-message-checksum -- int
  • error-count-frame -- int
  • error-count-overflow -- int

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

  • ACK checksum errors,
  • message checksum errors,
  • framing errors and
  • overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

tinkerforge call oled-128x64-v2-bricklet <uid> set-bootloader-mode <mode>
Parameters:
  • <mode> -- int (has symbols)
Output:
  • status -- int (has symbols)

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following symbols are available for this function:

  • bootloader-mode-bootloader = 0, for <mode>
  • bootloader-mode-firmware = 1, for <mode>
  • bootloader-mode-bootloader-wait-for-reboot = 2, for <mode>
  • bootloader-mode-firmware-wait-for-reboot = 3, for <mode>
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4, for <mode>
  • bootloader-status-ok = 0, for status
  • bootloader-status-invalid-mode = 1, for status
  • bootloader-status-no-change = 2, for status
  • bootloader-status-entry-function-not-present = 3, for status
  • bootloader-status-device-identifier-incorrect = 4, for status
  • bootloader-status-crc-mismatch = 5, for status
tinkerforge call oled-128x64-v2-bricklet <uid> get-bootloader-mode
Output:
  • mode -- int (has symbols)

Returns the current bootloader mode, see set-bootloader-mode.

The following symbols are available for this function:

  • bootloader-mode-bootloader = 0, for mode
  • bootloader-mode-firmware = 1, for mode
  • bootloader-mode-bootloader-wait-for-reboot = 2, for mode
  • bootloader-mode-firmware-wait-for-reboot = 3, for mode
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4, for mode
tinkerforge call oled-128x64-v2-bricklet <uid> set-write-firmware-pointer <pointer>
Parameters:
  • <pointer> -- int
Output:

no output

Sets the firmware pointer for write-firmware. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

tinkerforge call oled-128x64-v2-bricklet <uid> write-firmware <data>
Parameters:
  • <data> -- int,int,..61x..,int
Output:
  • status -- int

Writes 64 Bytes of firmware at the position as written by set-write-firmware-pointer before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

tinkerforge call oled-128x64-v2-bricklet <uid> set-status-led-config <config>
Parameters:
  • <config> -- int (has symbols)
Output:

no output

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following symbols are available for this function:

  • status-led-config-off = 0, for <config>
  • status-led-config-on = 1, for <config>
  • status-led-config-show-heartbeat = 2, for <config>
  • status-led-config-show-status = 3, for <config>
tinkerforge call oled-128x64-v2-bricklet <uid> get-status-led-config
Output:
  • config -- int (has symbols)

Returns the configuration as set by set-status-led-config

The following symbols are available for this function:

  • status-led-config-off = 0, for config
  • status-led-config-on = 1, for config
  • status-led-config-show-heartbeat = 2, for config
  • status-led-config-show-status = 3, for config
tinkerforge call oled-128x64-v2-bricklet <uid> get-chip-temperature
Output:
  • temperature -- int

Returns the temperature in °C as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

tinkerforge call oled-128x64-v2-bricklet <uid> reset
Output:no output

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

tinkerforge call oled-128x64-v2-bricklet <uid> write-uid <uid>
Parameters:
  • <uid> -- int
Output:

no output

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

tinkerforge call oled-128x64-v2-bricklet <uid> read-uid
Output:
  • uid -- int

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

tinkerforge call oled-128x64-v2-bricklet <uid> get-identity
Output:
  • uid -- string
  • connected-uid -- string
  • position -- char
  • hardware-version -- int,int,int
  • firmware-version -- int,int,int
  • device-identifier -- int (has symbols)

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' or 'd'.

The device identifier numbers can be found here