Go - OLED 128x64 Bricklet¶

Hello World¶

Download (example_hello_world.go)

 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

package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
    "github.com/Tinkerforge/go-api-bindings/oled_128x64_bricklet"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your OLED 128x64 Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    oled, _ := oled_128x64_bricklet.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // 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")

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
}

Pixel Matrix¶

Download (example_pixel_matrix.go)

 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

package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
    "github.com/Tinkerforge/go-api-bindings/oled_128x64_bricklet"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your OLED 128x64 Bricklet.

const WIDTH = 128
const HEIGHT = 64

func drawMatrix(oled oled_128x64_bricklet.OLED128x64Bricklet, pixels [HEIGHT][WIDTH]bool) {
    var pages [HEIGHT / 8][WIDTH]uint8
    for colIdx, col := range pages {
        for rowIdx := range col {
            for bit := 0; bit < 8; bit++ {
                if pixels[colIdx*8+bit][rowIdx] {
                    pages[colIdx][rowIdx] |= 1 << uint(bit)
                }
            }
        }
    }

    oled.NewWindow(0, WIDTH-1, 0, (HEIGHT/8)-1)

    for row := 0; row < HEIGHT/8; row++ {
        for col := 0; col < WIDTH; col += 64 {
            var arr [64]uint8
            copy(arr[:], pages[row][col:col+64])
            oled.Write(arr)
        }
    }
}

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    oled, _ := oled_128x64_bricklet.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    // Clear display
    oled.ClearDisplay()

    // Draw checkerboard pattern
    var pixels [HEIGHT][WIDTH]bool
    for rowIdx, row := range pixels {
        for colIdx := range row {
            pixels[rowIdx][colIdx] = (rowIdx/8)%2 == (colIdx/8)%2
        }
    }

    drawMatrix(oled, pixels)

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
}

Basic Functions¶

func oled_128x64_bricklet.New(uid string, ipcon *IPConnection) (device OLED128x64Bricklet, err error)¶

Parameters:	uid – Type: string ipcon – Type: *IPConnection
Returns:	device – Type: OLED128x64Bricklet err – Type: error

Creates a new OLED128x64Bricklet object with the unique device ID uid and adds it to the IPConnection ipcon:

device, err := oled_128x64_bricklet.New("YOUR_DEVICE_UID", &ipcon)

This device object can be used after the IPConnection has been connected.

func (*OLED128x64Bricklet) Write(data [64]uint8) (err error)¶

Parameters:	data – Type: [64]uint8, Range: [0 to 255]
Returns:	err – Type: error

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.

func (*OLED128x64Bricklet) NewWindow(columnFrom uint8, columnTo uint8, rowFrom uint8, rowTo uint8) (err error)¶

Parameters:	columnFrom – Type: uint8, Range: [0 to 127] columnTo – Type: uint8, Range: [0 to 127] rowFrom – Type: uint8, Range: [0 to 7] rowTo – Type: uint8, Range: [0 to 7]
Returns:	err – Type: error

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

func (*OLED128x64Bricklet) ClearDisplay() (err error)¶

Returns:	err – Type: error

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

func (*OLED128x64Bricklet) WriteLine(line uint8, position uint8, text string) (err error)¶

Parameters:	line – Type: uint8, Range: [0 to 7] position – Type: uint8, Range: [0 to 25] text – Type: string, Length: up to 26
Returns:	err – Type: error

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¶

func (*OLED128x64Bricklet) SetDisplayConfiguration(contrast uint8, invert bool) (err error)¶

Parameters:	contrast – Type: uint8, Range: [0 to 255], Default: 143 invert – Type: bool, Default: false
Returns:	err – Type: error

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.

func (*OLED128x64Bricklet) GetDisplayConfiguration() (contrast uint8, invert bool, err error)¶

Returns:	contrast – Type: uint8, Range: [0 to 255], Default: 143 invert – Type: bool, Default: false err – Type: error

Returns the configuration as set by SetDisplayConfiguration().

func (*OLED128x64Bricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)¶

Returns:

uid – Type: string, Length: up to 8 connectedUid – Type: string, Length: up to 8 position – Type: rune, Range: ['a' to 'h', 'z'] hardwareVersion – Type: [3]uint8 0: major – Type: uint8, Range: [0 to 255] 1: minor – Type: uint8, Range: [0 to 255] 2: revision – Type: uint8, Range: [0 to 255] firmwareVersion – Type: [3]uint8 0: major – Type: uint8, Range: [0 to 255] 1: minor – Type: uint8, Range: [0 to 255] 2: revision – Type: uint8, Range: [0 to 255] deviceIdentifier – Type: uint16, Range: [0 to 216 - 1] err – Type: error

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.

func (*OLED128x64Bricklet) GetAPIVersion() (apiVersion [3]uint8, err error)¶

Returns:	apiVersion – Type: [3]uint8 0: major – Type: uint8, Range: [0 to 255] 1: minor – Type: uint8, Range: [0 to 255] 2: revision – Type: uint8, Range: [0 to 255] err – Type: error

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.

func (*OLED128x64Bricklet) GetResponseExpected(functionId uint8) (responseExpected bool, err error)¶

Parameters:	functionId – Type: uint8, Range: See constants
Returns:	responseExpected – Type: bool err – Type: error

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:

• oled_128x64_bricklet.FunctionWrite = 1
• oled_128x64_bricklet.FunctionNewWindow = 2
• oled_128x64_bricklet.FunctionClearDisplay = 3
• oled_128x64_bricklet.FunctionSetDisplayConfiguration = 4
• oled_128x64_bricklet.FunctionWriteLine = 6

func (*OLED128x64Bricklet) SetResponseExpected(functionId uint8, responseExpected bool) (err error)¶

Parameters:	functionId – Type: uint8, Range: See constants responseExpected – Type: bool
Returns:	err – Type: error

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:

• oled_128x64_bricklet.FunctionWrite = 1
• oled_128x64_bricklet.FunctionNewWindow = 2
• oled_128x64_bricklet.FunctionClearDisplay = 3
• oled_128x64_bricklet.FunctionSetDisplayConfiguration = 4
• oled_128x64_bricklet.FunctionWriteLine = 6

func (*OLED128x64Bricklet) SetResponseExpectedAll(responseExpected bool) (err error)¶

Parameters:	responseExpected – Type: bool
Returns:	err – Type: error

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

Constants¶

oled_128x64_bricklet.DeviceIdentifier¶

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

The GetIdentity() function and the (*IPConnection) RegisterEnumerateCallback callback of the IPConnection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

oled_128x64_bricklet.DeviceDisplayName¶

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