Mathematica - LCD 128x64 Bricklet

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

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

Examples

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

Hello World

Download (ExampleHelloWorld.nb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your LCD 128x64 Bricklet*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
lcd=NETNew["Tinkerforge.BrickletLCD128x64",uid,ipcon]
ipcon@Connect[host,port]

(*Clear display*)
lcd@ClearDisplay[]

(*Write "Hello World" starting from upper left corner of the screen*)
lcd@WriteLine[0,0,"Hello World"]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[lcd]
ReleaseNETObject[ipcon]

Big Font

Download (ExampleBigFont.nb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your LCD 128x64 Bricklet*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
lcd=NETNew["Tinkerforge.BrickletLCD128x64",uid,ipcon]
ipcon@Connect[host,port]

(*Clear display*)
lcd@ClearDisplay[]

(*Write "Hello World" with big 24x32 font*)
lcd@DrawText[0,0,Tinkerforge`BrickletLCD128x64`FONTU24X32,
             Tinkerforge`BrickletLCD128x64`COLORUBLACK,"24x32"]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[lcd]
ReleaseNETObject[ipcon]

Touch

Download (ExampleTouch.nb)

 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
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your LCD 128x64 Bricklet*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
lcd=NETNew["Tinkerforge.BrickletLCD128x64",uid,ipcon]
ipcon@Connect[host,port]

(*Callback function for touch position callback*)
TouchPositionCB[sender_,pressure_,x_,y_,age_]:=
 Module[{},
  Print["Pressure: "<>ToString[pressure]];
  Print["X: "<>ToString[x]];
  Print["Y: "<>ToString[y]];
  Print["Age: "<>ToString[age]]
 ]

AddEventHandler[lcd@TouchPositionCallback,TouchPositionCB]

(*Callback function for touch gesture callback*)
TouchGestureCB[sender_,gesture_,duration_,pressureMax_,xStart_,xEnd_,yStart_,yEnd_,age_]:=
 Module[{},
  Print["Gesture: "<>ToString[gesture]];
  Print["Duration: "<>ToString[duration]];
  Print["Pressure Max: "<>ToString[pressureMax]];
  Print["X Start: "<>ToString[xStart]];
  Print["X End: "<>ToString[xEnd]];
  Print["Y Start: "<>ToString[yStart]];
  Print["Y End: "<>ToString[yEnd]];
  Print["Age: "<>ToString[age]]
 ]

AddEventHandler[lcd@TouchGestureCallback,TouchGestureCB]

(*Set period for touch position callback to 0.1s (100ms)*)
lcd@SetTouchPositionCallbackConfiguration[100,True]

(*Set period for touch gesture callback to 0.1s (100ms)*)
lcd@SetTouchGestureCallbackConfiguration[100,True]

Input["Click OK to exit"]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[lcd]
ReleaseNETObject[ipcon]

GUI

Download (ExampleGUI.nb)

 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
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your LCD 128x64 Bricklet*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
lcd=NETNew["Tinkerforge.BrickletLCD128x64",uid,ipcon]
ipcon@Connect[host,port]

(*Callback function for gui button pressed callback*)
GUIButtonPressedCB[sender_,index_,pressed_]:=
 Module[{},
  Print["Index: "<>ToString[index]];
  Print["Pressed: "<>ToString[pressed]]
 ]

AddEventHandler[lcd@GUIButtonPressedCallback,GUIButtonPressedCB]

(*Callback function for gui slider value callback*)
GUISliderValueCB[sender_,index_,value_]:=
 Module[{},
  Print["Index: "<>ToString[index]];
  Print["Value: "<>ToString[value]]
 ]

AddEventHandler[lcd@GUISliderValueCallback,GUISliderValueCB]

(*Callback function for gui tab selected callback*)
GUITabSelectedCB[sender_,index_]:=
 Print["Index: "<>ToString[index]]
AddEventHandler[lcd@GUITabSelectedCallback,GUITabSelectedCB]

(*Clear display*)
lcd@ClearDisplay[]
lcd@RemoveAllGUI[]

(*Add GUI elements: Button, Slider and Graph with 60 data points*)
lcd@SetGUIButton[0,0,0,60,20,"button"]
lcd@SetGUISlider[0,0,30,60,Tinkerforge`BrickletLCD128x64`DIRECTIONUHORIZONTAL,50]
lcd@SetGUIGraphConfiguration[0,Tinkerforge`BrickletLCD128x64`GRAPHUTYPEULINE,62,0,60,52,
                             "X","Y"]

(*Add a few data points (the remaining points will be 0)*)
lcd@SetGUIGraphData[0,{20,40,60,80,100,120,140,160,180,200,220,240}]

(*Add 5 text tabs without and configure it for click and swipe without auto-redraw*)
lcd@SetGUITabConfiguration[Tinkerforge`BrickletLCD128x64`CHANGEUTABUONUCLICKUANDUSWIPE,
                           False]
lcd@SetGUITabText[0,"Tab A"]
lcd@SetGUITabText[1,"Tab B"]
lcd@SetGUITabText[2,"Tab C"]
lcd@SetGUITabText[3,"Tab D"]
lcd@SetGUITabText[4,"Tab E"]

(*Set period for gui button pressed callback to 0.1s (100ms)*)
lcd@SetGUIButtonPressedCallbackConfiguration[100,True]

(*Set period for gui slider value callback to 0.1s (100ms)*)
lcd@SetGUISliderValueCallbackConfiguration[100,True]

(*Set period for gui tab selected callback to 0.1s (100ms)*)
lcd@SetGUITabSelectedCallbackConfiguration[100,True]

Input["Click OK to exit"]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[lcd]
ReleaseNETObject[ipcon]

API

Generally, every method of the Mathematica bindings that returns a value can throw a Tinkerforge.TimeoutException. This exception gets thrown if the device did not respond. If a cable based connection is used, it is unlikely that this exception gets thrown (assuming nobody plugs the device out). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

Since .NET/Link does not support multiple return values directly, we use the out keyword to return multiple values from a method. For further information about the out keyword in .NET/Link see the corresponding Mathematica .NET/Link documentation.

The namespace for all Brick/Bricklet bindings and the IPConnection is Tinkerforge.*.

Basic Functions

BrickletLCD128x64[uid, ipcon] → lcd128x64
Parameters:
  • uid -- String
  • ipcon -- NETObject[IPConnection]
Returns:
  • lcd128x64 -- NETObject[BrickletLCD128x64]

Creates an object with the unique device ID uid:

lcd128x64=NETNew["Tinkerforge.BrickletLCD128x64","YOUR_DEVICE_UID",ipcon]

This object can then be used after the IP Connection is connected (see examples above).

The .NET runtime has built-in garbage collection that frees objects that are no longer in use by a program. But because Mathematica can not automatically tell when a Mathematica "program" doesn't use a .NET object anymore, this has to be done by the program. For this the ReleaseNETObject[] function is used in the examples.

For further information about object management in .NET/Link see the corresponding Mathematica .NET/Link documentation.

BrickletLCD128x64@WritePixels[xStart, yStart, xEnd, yEnd, {pixels1, pixels2, ...}] → Null
Parameters:
  • xStart -- Integer
  • yStart -- Integer
  • xEnd -- Integer
  • yEnd -- Integer
  • pixelsi -- True/False

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 DrawBufferedFrame[] is called. This can be used to avoid flicker when drawing a complex frame in multiple steps.

Automatic draw can be configured with the SetDisplayConfiguration[] function.

BrickletLCD128x64@ReadPixels[xStart, yStart, xEnd, yEnd] → {pixels1, pixels2, ...}
Parameters:
  • xStart -- Integer
  • yStart -- Integer
  • xEnd -- Integer
  • yEnd -- Integer
Returns:
  • pixelsi -- True/False

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 DrawBufferedFrame[]).

Automatic draw can be configured with the SetDisplayConfiguration[] function.

BrickletLCD128x64@ClearDisplay[] → Null

Clears the complete content of the display.

BrickletLCD128x64@WriteLine[line, position, text] → Null
Parameters:
  • line -- Integer
  • position -- Integer
  • text -- String

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.

This function is a 1:1 replacement for the function with the same name in the LCD 20x4 Bricklet. You can draw text at a specific pixel position and with different font sizes with the DrawText[] function.

BrickletLCD128x64@DrawBufferedFrame[forceCompleteRedraw] → Null
Parameters:
  • forceCompleteRedraw -- True/False

Draws the currently buffered frame. Normally each call of WritePixels[] and WriteLine[] draws directly onto the display. If you turn automatic draw off (SetDisplayConfiguration[]), 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.

BrickletLCD128x64@GetTouchPosition[out pressure, out x, out y, out age] → Null
Parameters:
  • pressure -- Integer
  • x -- Integer
  • y -- Integer
  • age -- Integer

Returns the last valid touch position:

  • Pressure: Amount of pressure applied by the user (0-300)
  • X: Touch position on x-axis (0-127)
  • Y: Touch position on y-axis (0-63)
  • Age: Age of touch press in ms (how long ago it was)
BrickletLCD128x64@GetTouchGesture[out gesture, out duration, out pressureMax, out xStart, out yStart, out xEnd, out yEnd, out age] → Null
Parameters:
  • gesture -- Integer
  • duration -- Integer
  • pressureMax -- Integer
  • xStart -- Integer
  • yStart -- Integer
  • xEnd -- Integer
  • yEnd -- Integer
  • age -- Integer

Returns one of four touch gestures that can be automatically detected by the Bricklet.

The gestures are swipes from left to right, right to left, top to bottom and bottom to top.

Additionally to the gestures a vector with a start and end position of the gesture is provided. You can use this vector do determine a more exact location of the gesture (e.g. the swipe from top to bottom was on the left or right part of the screen).

The age parameter corresponds to the age of gesture in ms (how long ago it was).

The following constants are available for this function:

  • BrickletLCD128x64`GESTUREULEFTUTOURIGHT = 0
  • BrickletLCD128x64`GESTUREURIGHTUTOULEFT = 1
  • BrickletLCD128x64`GESTUREUTOPUTOUBOTTOM = 2
  • BrickletLCD128x64`GESTUREUBOTTOMUTOUTOP = 3
BrickletLCD128x64@DrawLine[positionXStart, positionYStart, positionXEnd, positionYEnd, color] → Null
Parameters:
  • positionXStart -- Integer
  • positionYStart -- Integer
  • positionXEnd -- Integer
  • positionYEnd -- Integer
  • color -- True/False

Draws a white or black line from (x, y)-start to (x, y)-end. The x values have to be within the range of 0 to 127 and the y values have t be within the range of 0 to 63.

The following constants are available for this function:

  • BrickletLCD128x64`COLORUWHITE = False
  • BrickletLCD128x64`COLORUBLACK = True

New in version 2.0.2 (Plugin).

BrickletLCD128x64@DrawBox[positionXStart, positionYStart, positionXEnd, positionYEnd, fill, color] → Null
Parameters:
  • positionXStart -- Integer
  • positionYStart -- Integer
  • positionXEnd -- Integer
  • positionYEnd -- Integer
  • fill -- True/False
  • color -- True/False

Draws a white or black box from (x, y)-start to (x, y)-end. The x values have to be within the range of 0 to 127 and the y values have to be within the range of 0 to 63.

If you set fill to true, the box will be filled with the color. Otherwise only the outline will be drawn.

The following constants are available for this function:

  • BrickletLCD128x64`COLORUWHITE = False
  • BrickletLCD128x64`COLORUBLACK = True

New in version 2.0.2 (Plugin).

BrickletLCD128x64@DrawText[positionX, positionY, font, color, text] → Null
Parameters:
  • positionX -- Integer
  • positionY -- Integer
  • font -- Integer
  • color -- True/False
  • text -- String

Draws a text with up to 22 characters at the pixel position (x, y).

The x values have to be within the range of 0 to 127 and the y values have to be within the range of 0 to 63.

You can use one of 9 different font sizes and draw the text in white or black.

The following constants are available for this function:

  • BrickletLCD128x64`FONTU6X8 = 0
  • BrickletLCD128x64`FONTU6X16 = 1
  • BrickletLCD128x64`FONTU6X24 = 2
  • BrickletLCD128x64`FONTU6X32 = 3
  • BrickletLCD128x64`FONTU12X16 = 4
  • BrickletLCD128x64`FONTU12X24 = 5
  • BrickletLCD128x64`FONTU12X32 = 6
  • BrickletLCD128x64`FONTU18X24 = 7
  • BrickletLCD128x64`FONTU18X32 = 8
  • BrickletLCD128x64`FONTU24X32 = 9
  • BrickletLCD128x64`COLORUWHITE = False
  • BrickletLCD128x64`COLORUBLACK = True

New in version 2.0.2 (Plugin).

BrickletLCD128x64@SetGUIButton[index, positionX, positionY, width, height, text] → Null
Parameters:
  • index -- Integer
  • positionX -- Integer
  • positionY -- Integer
  • width -- Integer
  • height -- Integer
  • text -- String

Draws a clickable button at position (x, y) with the given text of up to 16 characters.

You can use up to 12 buttons (index 0-11).

The x position + width has to be within the range of 1 to 128 and the y position + height has to be within the range of 1 to 64.

The minimum useful width/height of a button is 3.

You can enable a callback for a button press with SetGUIButtonPressedCallbackConfiguration[]. The callback will be triggered for press and release-events.

The button is drawn in a separate GUI buffer and the button-frame will always stay on top of the graphics drawn with WritePixels[]. To remove the button use RemoveGUIButton[].

If you want an icon instead of text, you can draw the icon inside of the button with WritePixels[].

New in version 2.0.2 (Plugin).

BrickletLCD128x64@GetGUIButton[index, out active, out positionX, out positionY, out width, out height, out text] → Null
Parameters:
  • index -- Integer
  • active -- True/False
  • positionX -- Integer
  • positionY -- Integer
  • width -- Integer
  • height -- Integer
  • text -- String

Returns the button properties for a given Index as set by SetGUIButton[].

Additionally the Active parameter shows if a button is currently active/visible or not.

New in version 2.0.2 (Plugin).

BrickletLCD128x64@RemoveGUIButton[index] → Null
Parameters:
  • index -- Integer

Removes the button with the given index.

You can use index 255 to remove all buttons.

New in version 2.0.2 (Plugin).

BrickletLCD128x64@GetGUIButtonPressed[index] → pressed
Parameters:
  • index -- Integer
Returns:
  • pressed -- True/False

Returns the state of the button for the given index.

The state can either be pressed (true) or released (false).

New in version 2.0.2 (Plugin).

BrickletLCD128x64@SetGUISlider[index, positionX, positionY, length, direction, value] → Null
Parameters:
  • index -- Integer
  • positionX -- Integer
  • positionY -- Integer
  • length -- Integer
  • direction -- Integer
  • value -- Integer

Draws a slider at position (x, y) with the given length.

You can use up to 6 sliders (index 0-5).

If you use the horizontal direction, the x position + length has to be within the range of 1 to 128 and the y position has to be within the range of 0 to 46.

If you use the vertical direction, the y position + length has to be within the range of 1 to 64 and the x position has to be within the range of 0 to 110.

The minimum length of a slider is 8.

The parameter value is the start-position of the slider, it can be between 0 and length-8.

You can enable a callback for the slider value with SetGUISliderValueCallbackConfiguration[].

The slider is drawn in a separate GUI buffer and it will always stay on top of the graphics drawn with WritePixels[]. To remove the button use RemoveGUISlider[].

The following constants are available for this function:

  • BrickletLCD128x64`DIRECTIONUHORIZONTAL = 0
  • BrickletLCD128x64`DIRECTIONUVERTICAL = 1

New in version 2.0.2 (Plugin).

BrickletLCD128x64@GetGUISlider[index, out active, out positionX, out positionY, out length, out direction, out value] → Null
Parameters:
  • index -- Integer
  • active -- True/False
  • positionX -- Integer
  • positionY -- Integer
  • length -- Integer
  • direction -- Integer
  • value -- Integer

Returns the slider properties for a given Index as set by SetGUISlider[].

Additionally the Active parameter shows if a button is currently active/visible or not.

The following constants are available for this function:

  • BrickletLCD128x64`DIRECTIONUHORIZONTAL = 0
  • BrickletLCD128x64`DIRECTIONUVERTICAL = 1

New in version 2.0.2 (Plugin).

BrickletLCD128x64@RemoveGUISlider[index] → Null
Parameters:
  • index -- Integer

Removes the slider with the given index.

You can use index 255 to remove all slider.

New in version 2.0.2 (Plugin).

BrickletLCD128x64@GetGUISliderValue[index] → value
Parameters:
  • index -- Integer
Returns:
  • value -- Integer

Returns the current slider value for the given index.

New in version 2.0.2 (Plugin).

BrickletLCD128x64@SetGUITabConfiguration[changeTabConfig, clearGUI] → Null
Parameters:
  • changeTabConfig -- Integer
  • clearGUI -- True/False

Sets the general configuration for tabs. You can configure the tabs to only accept clicks or only swipes (gesture left/right and right/left) or both.

Additionally, if you set Clear GUI to true, all of the GUI elements (buttons, slider, graphs) will automatically be removed on every tab change.

By default click and swipe as well as automatic GUI clear is enabled.

The following constants are available for this function:

  • BrickletLCD128x64`CHANGEUTABUONUCLICK = 1
  • BrickletLCD128x64`CHANGEUTABUONUSWIPE = 2
  • BrickletLCD128x64`CHANGEUTABUONUCLICKUANDUSWIPE = 3

New in version 2.0.2 (Plugin).

BrickletLCD128x64@GetGUITabConfiguration[out changeTabConfig, out clearGUI] → Null
Parameters:
  • changeTabConfig -- Integer
  • clearGUI -- True/False

Returns the tab configuration as set by SetGUITabConfiguration[].

The following constants are available for this function:

  • BrickletLCD128x64`CHANGEUTABUONUCLICK = 1
  • BrickletLCD128x64`CHANGEUTABUONUSWIPE = 2
  • BrickletLCD128x64`CHANGEUTABUONUCLICKUANDUSWIPE = 3

New in version 2.0.2 (Plugin).

BrickletLCD128x64@SetGUITabText[index, text] → Null
Parameters:
  • index -- Integer
  • text -- String

Adds a text-tab with the given index. The text can have a length of up to 5 characters.

You can use up to 10 tabs (index 0-9).

A text-tab with the same index as a icon-tab will overwrite the icon-tab.

New in version 2.0.2 (Plugin).

BrickletLCD128x64@GetGUITabText[index, out active, out text] → Null
Parameters:
  • index -- Integer
  • active -- True/False
  • text -- String

Returns the text for a given index as set by SetGUITabText[].

Additionally the Active parameter shows if the tab is currently active/visible or not.

New in version 2.0.2 (Plugin).

BrickletLCD128x64@SetGUITabIcon[index, {icon1, icon2, ..., icon168}] → Null
Parameters:
  • index -- Integer
  • iconi -- True/False

Adds a icon-tab with the given index. The icon can have a width of 28 pixels with a height of 6 pixels. It is drawn line-by-line from left to right.

You can use up to 10 tabs (index 0-9).

A icon-tab with the same index as a text-tab will overwrite the text-tab.

New in version 2.0.2 (Plugin).

BrickletLCD128x64@GetGUITabIcon[index, out active, out {icon1, icon2, ..., icon168}] → Null
Parameters:
  • index -- Integer
  • active -- True/False
  • iconi -- True/False

Returns the icon for a given index as set by SetGUITabIcon[].

Additionally the Active parameter shows if the tab is currently active/visible or not.

New in version 2.0.2 (Plugin).

BrickletLCD128x64@RemoveGUITab[index] → Null
Parameters:
  • index -- Integer

Removes the tab with the given index.

You can use index 255 to remove all tabs.

New in version 2.0.2 (Plugin).

BrickletLCD128x64@SetGUITabSelected[index] → Null
Parameters:
  • index -- Integer

Sets the tab with the given index as selected (drawn as selected on the display).

New in version 2.0.2 (Plugin).

BrickletLCD128x64@GetGUITabSelected[] → index
Returns:
  • index -- Integer

Returns the index of the currently selected tab.

New in version 2.0.2 (Plugin).

BrickletLCD128x64@SetGUIGraphConfiguration[index, graphType, positionX, positionY, width, height, textX, textY] → Null
Parameters:
  • index -- Integer
  • graphType -- Integer
  • positionX -- Integer
  • positionY -- Integer
  • width -- Integer
  • height -- Integer
  • textX -- String
  • textY -- String

Sets the configuration for up to four graphs (index 0-3).

The graph type can be dot-, line- or bar-graph.

The x and y position are pixel positions. They have to be within the range of (0, 0) to (127, 63). The maximum width is 118 and the maximum height is 63.

You can add a text for the x and y axis with at most 4 characters each. The text is drawn at the inside of the graph and it can overwrite some of the graph data. If you need the text outside of the graph you can leave this text here empty and use DrawText[] to draw the caption outside of the graph.

The data of the graph can be set and updated with SetGUIGraphData[].

The graph is drawn in a separate GUI buffer and the graph-frame and data will always stay on top of the graphics drawn with WritePixels[]. To remove the graph use RemoveGUIGraph[].

The following constants are available for this function:

  • BrickletLCD128x64`GRAPHUTYPEUDOT = 0
  • BrickletLCD128x64`GRAPHUTYPEULINE = 1
  • BrickletLCD128x64`GRAPHUTYPEUBAR = 2

New in version 2.0.2 (Plugin).

BrickletLCD128x64@GetGUIGraphConfiguration[index, out active, out graphType, out positionX, out positionY, out width, out height, out textX, out textY] → Null
Parameters:
  • index -- Integer
  • active -- True/False
  • graphType -- Integer
  • positionX -- Integer
  • positionY -- Integer
  • width -- Integer
  • height -- Integer
  • textX -- String
  • textY -- String

Returns the graph properties for a given Index as set by SetGUIGraphConfiguration[].

Additionally the Active parameter shows if a graph is currently active/visible or not.

The following constants are available for this function:

  • BrickletLCD128x64`GRAPHUTYPEUDOT = 0
  • BrickletLCD128x64`GRAPHUTYPEULINE = 1
  • BrickletLCD128x64`GRAPHUTYPEUBAR = 2

New in version 2.0.2 (Plugin).

BrickletLCD128x64@SetGUIGraphData[index, {data1, data2, ...}] → Null
Parameters:
  • index -- Integer
  • datai -- Integer

Sets the data for a graph with the given index. You have to configure the graph with SetGUIGraphConfiguration[] before you can set the first data.

The graph will show the first n values of the data that you set, where n is the width set with SetGUIGraphConfiguration[]. If you set less then n values it will show the rest of the values as zero.

The maximum number of data-points you can set is 118 (which also corresponds to the maximum width of the graph).

You have to scale your values to be between 0 and 255. 0 will be shown at the bottom of the graph and 255 at the top.

New in version 2.0.2 (Plugin).

BrickletLCD128x64@GetGUIGraphData[index] → {data1, data2, ...}
Parameters:
  • index -- Integer
Returns:
  • datai -- Integer

Returns the graph data for a given index as set by SetGUIGraphData[].

New in version 2.0.2 (Plugin).

BrickletLCD128x64@RemoveGUIGraph[index] → Null
Parameters:
  • index -- Integer

Removes the graph with the given index.

You can use index 255 to remove all graphs.

New in version 2.0.2 (Plugin).

BrickletLCD128x64@RemoveAllGUI[] → Null

Removes all GUI elements (buttons, slider, graphs, tabs).

New in version 2.0.2 (Plugin).

Advanced Functions

BrickletLCD128x64@SetDisplayConfiguration[contrast, backlight, invert, automaticDraw] → Null
Parameters:
  • contrast -- Integer
  • backlight -- Integer
  • invert -- True/False
  • automaticDraw -- True/False

Sets the configuration of the display.

You can set a contrast value from 0 to 63, a backlight intensity value from 0 to 100 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 WritePixels[] and WriteLine[]. If it is set to false, the changes are written into an internal buffer and only shown on the display after a call of DrawBufferedFrame[].

The default values are contrast 14, backlight intensity 100, inverting off and automatic draw on.

BrickletLCD128x64@GetDisplayConfiguration[out contrast, out backlight, out invert, out automaticDraw] → Null
Parameters:
  • contrast -- Integer
  • backlight -- Integer
  • invert -- True/False
  • automaticDraw -- True/False

Returns the configuration as set by SetDisplayConfiguration[].

BrickletLCD128x64@SetTouchLEDConfig[config] → Null
Parameters:
  • config -- Integer

Sets the touch LED configuration. By default the LED is on if the LCD is touched.

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

If the Bricklet is in bootloader mode, the LED is off.

The following constants are available for this function:

  • BrickletLCD128x64`TOUCHULEDUCONFIGUOFF = 0
  • BrickletLCD128x64`TOUCHULEDUCONFIGUON = 1
  • BrickletLCD128x64`TOUCHULEDUCONFIGUSHOWUHEARTBEAT = 2
  • BrickletLCD128x64`TOUCHULEDUCONFIGUSHOWUTOUCH = 3

New in version 2.0.2 (Plugin).

BrickletLCD128x64@GetTouchLEDConfig[] → config
Returns:
  • config -- Integer

Returns the configuration as set by SetTouchLEDConfig[]

The following constants are available for this function:

  • BrickletLCD128x64`TOUCHULEDUCONFIGUOFF = 0
  • BrickletLCD128x64`TOUCHULEDUCONFIGUON = 1
  • BrickletLCD128x64`TOUCHULEDUCONFIGUSHOWUHEARTBEAT = 2
  • BrickletLCD128x64`TOUCHULEDUCONFIGUSHOWUTOUCH = 3

New in version 2.0.2 (Plugin).

BrickletLCD128x64@GetAPIVersion[] → {apiVersion1, apiVersion2, apiVersion3}
Returns:
  • apiVersioni -- Integer

Returns the version of the API definition (major, minor, revision) 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.

BrickletLCD128x64@GetResponseExpected[functionId] → responseExpected
Parameters:
  • functionId -- Integer
Returns:
  • responseExpected -- True/False

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 send and errors are silently ignored, because they cannot be detected.

See SetResponseExpected[] for the list of function ID constants available for this function.

BrickletLCD128x64@SetResponseExpected[functionId, responseExpected] → Null
Parameters:
  • functionId -- Integer
  • responseExpected -- True/False

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 send and errors are silently ignored, because they cannot be detected.

The following function ID constants are available for this function:

  • BrickletLCD128x64`FUNCTIONUWRITEUPIXELS = 1
  • BrickletLCD128x64`FUNCTIONUCLEARUDISPLAY = 3
  • BrickletLCD128x64`FUNCTIONUSETUDISPLAYUCONFIGURATION = 4
  • BrickletLCD128x64`FUNCTIONUWRITEULINE = 6
  • BrickletLCD128x64`FUNCTIONUDRAWUBUFFEREDUFRAME = 7
  • BrickletLCD128x64`FUNCTIONUSETUTOUCHUPOSITIONUCALLBACKUCONFIGURATION = 9
  • BrickletLCD128x64`FUNCTIONUSETUTOUCHUGESTUREUCALLBACKUCONFIGURATION = 13
  • BrickletLCD128x64`FUNCTIONUDRAWULINE = 16
  • BrickletLCD128x64`FUNCTIONUDRAWUBOX = 17
  • BrickletLCD128x64`FUNCTIONUDRAWUTEXT = 18
  • BrickletLCD128x64`FUNCTIONUSETUGUIUBUTTON = 19
  • BrickletLCD128x64`FUNCTIONUREMOVEUGUIUBUTTON = 21
  • BrickletLCD128x64`FUNCTIONUSETUGUIUBUTTONUPRESSEDUCALLBACKUCONFIGURATION = 22
  • BrickletLCD128x64`FUNCTIONUSETUGUIUSLIDER = 26
  • BrickletLCD128x64`FUNCTIONUREMOVEUGUIUSLIDER = 28
  • BrickletLCD128x64`FUNCTIONUSETUGUIUSLIDERUVALUEUCALLBACKUCONFIGURATION = 29
  • BrickletLCD128x64`FUNCTIONUSETUGUIUTABUCONFIGURATION = 33
  • BrickletLCD128x64`FUNCTIONUSETUGUIUTABUTEXT = 35
  • BrickletLCD128x64`FUNCTIONUSETUGUIUTABUICON = 37
  • BrickletLCD128x64`FUNCTIONUREMOVEUGUIUTAB = 39
  • BrickletLCD128x64`FUNCTIONUSETUGUIUTABUSELECTED = 40
  • BrickletLCD128x64`FUNCTIONUSETUGUIUTABUSELECTEDUCALLBACKUCONFIGURATION = 41
  • BrickletLCD128x64`FUNCTIONUSETUGUIUGRAPHUCONFIGURATION = 45
  • BrickletLCD128x64`FUNCTIONUSETUGUIUGRAPHUDATA = 47
  • BrickletLCD128x64`FUNCTIONUREMOVEUGUIUGRAPH = 49
  • BrickletLCD128x64`FUNCTIONUREMOVEUALLUGUI = 50
  • BrickletLCD128x64`FUNCTIONUSETUTOUCHULEDUCONFIG = 51
  • BrickletLCD128x64`FUNCTIONUSETUWRITEUFIRMWAREUPOINTER = 237
  • BrickletLCD128x64`FUNCTIONUSETUSTATUSULEDUCONFIG = 239
  • BrickletLCD128x64`FUNCTIONURESET = 243
  • BrickletLCD128x64`FUNCTIONUWRITEUUID = 248
BrickletLCD128x64@SetResponseExpectedAll[responseExpected] → Null
Parameters:
  • responseExpected -- True/False

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

BrickletLCD128x64@GetSPITFPErrorCount[out errorCountAckChecksum, out errorCountMessageChecksum, out errorCountFrame, out errorCountOverflow] → Null
Parameters:
  • errorCountAckChecksum -- Integer
  • errorCountMessageChecksum -- Integer
  • errorCountFrame -- Integer
  • errorCountOverflow -- Integer

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.

BrickletLCD128x64@SetBootloaderMode[mode] → status
Parameters:
  • mode -- Integer
Returns:
  • status -- Integer

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 constants are available for this function:

  • BrickletLCD128x64`BOOTLOADERUMODEUBOOTLOADER = 0
  • BrickletLCD128x64`BOOTLOADERUMODEUFIRMWARE = 1
  • BrickletLCD128x64`BOOTLOADERUMODEUBOOTLOADERUWAITUFORUREBOOT = 2
  • BrickletLCD128x64`BOOTLOADERUMODEUFIRMWAREUWAITUFORUREBOOT = 3
  • BrickletLCD128x64`BOOTLOADERUMODEUFIRMWAREUWAITUFORUERASEUANDUREBOOT = 4
  • BrickletLCD128x64`BOOTLOADERUSTATUSUOK = 0
  • BrickletLCD128x64`BOOTLOADERUSTATUSUINVALIDUMODE = 1
  • BrickletLCD128x64`BOOTLOADERUSTATUSUNOUCHANGE = 2
  • BrickletLCD128x64`BOOTLOADERUSTATUSUENTRYUFUNCTIONUNOTUPRESENT = 3
  • BrickletLCD128x64`BOOTLOADERUSTATUSUDEVICEUIDENTIFIERUINCORRECT = 4
  • BrickletLCD128x64`BOOTLOADERUSTATUSUCRCUMISMATCH = 5
BrickletLCD128x64@GetBootloaderMode[] → mode
Returns:
  • mode -- Integer

Returns the current bootloader mode, see SetBootloaderMode[].

The following constants are available for this function:

  • BrickletLCD128x64`BOOTLOADERUMODEUBOOTLOADER = 0
  • BrickletLCD128x64`BOOTLOADERUMODEUFIRMWARE = 1
  • BrickletLCD128x64`BOOTLOADERUMODEUBOOTLOADERUWAITUFORUREBOOT = 2
  • BrickletLCD128x64`BOOTLOADERUMODEUFIRMWAREUWAITUFORUREBOOT = 3
  • BrickletLCD128x64`BOOTLOADERUMODEUFIRMWAREUWAITUFORUERASEUANDUREBOOT = 4
BrickletLCD128x64@SetWriteFirmwarePointer[pointer] → Null
Parameters:
  • pointer -- Integer

Sets the firmware pointer for WriteFirmware[]. 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.

BrickletLCD128x64@WriteFirmware[{data1, data2, ..., data64}] → status
Parameters:
  • datai -- Integer
Returns:
  • status -- Integer

Writes 64 Bytes of firmware at the position as written by SetWriteFirmwarePointer[] 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.

BrickletLCD128x64@SetStatusLEDConfig[config] → Null
Parameters:
  • config -- Integer

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 constants are available for this function:

  • BrickletLCD128x64`STATUSULEDUCONFIGUOFF = 0
  • BrickletLCD128x64`STATUSULEDUCONFIGUON = 1
  • BrickletLCD128x64`STATUSULEDUCONFIGUSHOWUHEARTBEAT = 2
  • BrickletLCD128x64`STATUSULEDUCONFIGUSHOWUSTATUS = 3
BrickletLCD128x64@GetStatusLEDConfig[] → config
Returns:
  • config -- Integer

Returns the configuration as set by SetStatusLEDConfig[]

The following constants are available for this function:

  • BrickletLCD128x64`STATUSULEDUCONFIGUOFF = 0
  • BrickletLCD128x64`STATUSULEDUCONFIGUON = 1
  • BrickletLCD128x64`STATUSULEDUCONFIGUSHOWUHEARTBEAT = 2
  • BrickletLCD128x64`STATUSULEDUCONFIGUSHOWUSTATUS = 3
BrickletLCD128x64@GetChipTemperature[] → temperature
Returns:
  • temperature -- Integer

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.

BrickletLCD128x64@Reset[] → Null

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!

BrickletLCD128x64@WriteUID[uid] → Null
Parameters:
  • uid -- Integer

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.

BrickletLCD128x64@ReadUID[] → uid
Returns:
  • uid -- Integer

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

BrickletLCD128x64@GetIdentity[out uid, out connectedUid, out position, out {hardwareVersion1, hardwareVersion2, hardwareVersion3}, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out deviceIdentifier] → Null
Parameters:
  • uid -- String
  • connectedUid -- String
  • position -- Integer
  • hardwareVersioni -- Integer
  • firmwareVersioni -- Integer
  • deviceIdentifier -- Integer

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. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions

BrickletLCD128x64@SetTouchPositionCallbackConfiguration[period, valueHasToChange] → Null
Parameters:
  • period -- Integer
  • valueHasToChange -- True/False

The period in ms is the period with which the TouchPositionCallback callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

The default value is (0, false).

BrickletLCD128x64@GetTouchPositionCallbackConfiguration[out period, out valueHasToChange] → Null
Parameters:
  • period -- Integer
  • valueHasToChange -- True/False

Returns the callback configuration as set by SetTouchPositionCallbackConfiguration[].

BrickletLCD128x64@SetTouchGestureCallbackConfiguration[period, valueHasToChange] → Null
Parameters:
  • period -- Integer
  • valueHasToChange -- True/False

The period in ms is the period with which the TouchGestureCallback callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

The default value is (0, false).

BrickletLCD128x64@GetTouchGestureCallbackConfiguration[out period, out valueHasToChange] → Null
Parameters:
  • period -- Integer
  • valueHasToChange -- True/False

Returns the callback configuration as set by SetTouchGestureCallbackConfiguration[].

BrickletLCD128x64@SetGUIButtonPressedCallbackConfiguration[period, valueHasToChange] → Null
Parameters:
  • period -- Integer
  • valueHasToChange -- True/False

The period in ms is the period with which the GUIButtonPressedCallback callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

The default value is (0, false).

New in version 2.0.2 (Plugin).

BrickletLCD128x64@GetGUIButtonPressedCallbackConfiguration[out period, out valueHasToChange] → Null
Parameters:
  • period -- Integer
  • valueHasToChange -- True/False

Returns the callback configuration as set by SetGUIButtonPressedCallbackConfiguration[].

New in version 2.0.2 (Plugin).

BrickletLCD128x64@SetGUISliderValueCallbackConfiguration[period, valueHasToChange] → Null
Parameters:
  • period -- Integer
  • valueHasToChange -- True/False

The period in ms is the period with which the GUISliderValueCallback callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

The default value is (0, false).

New in version 2.0.2 (Plugin).

BrickletLCD128x64@GetGUISliderValueCallbackConfiguration[out period, out valueHasToChange] → Null
Parameters:
  • period -- Integer
  • valueHasToChange -- True/False

Returns the callback configuration as set by SetGUISliderValueCallbackConfiguration[].

New in version 2.0.2 (Plugin).

BrickletLCD128x64@SetGUITabSelectedCallbackConfiguration[period, valueHasToChange] → Null
Parameters:
  • period -- Integer
  • valueHasToChange -- True/False

The period in ms is the period with which the GUITabSelectedCallback callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

The default value is (0, false).

New in version 2.0.2 (Plugin).

BrickletLCD128x64@GetGUITabSelectedCallbackConfiguration[out period, out valueHasToChange] → Null
Parameters:
  • period -- Integer
  • valueHasToChange -- True/False

Returns the callback configuration as set by SetGUITabSelectedCallbackConfiguration[].

New in version 2.0.2 (Plugin).

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done by assigning a function to a callback property of the device object:

MyCallback[sender_,value_]:=Print["Value: "<>ToString[value]]

AddEventHandler[lcd128x64@ExampleCallback,MyCallback]

For further information about event handling using .NET/Link see the corresponding Mathematica .NET/Link documentation.

The available callback property and their type of parameters are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

event BrickletLCD128x64@TouchPositionCallback[sender, pressure, x, y, age]
Parameters:
  • sender -- NETObject[BrickletLCD128x64]
  • pressure -- Integer
  • x -- Integer
  • y -- Integer
  • age -- Integer

This callback is triggered periodically with the period that is set by SetTouchPositionCallbackConfiguration[]. The parameters are the same as for GetTouchPosition[].

event BrickletLCD128x64@TouchGestureCallback[sender, gesture, duration, pressureMax, xStart, yStart, xEnd, yEnd, age]
Parameters:
  • sender -- NETObject[BrickletLCD128x64]
  • gesture -- Integer
  • duration -- Integer
  • pressureMax -- Integer
  • xStart -- Integer
  • yStart -- Integer
  • xEnd -- Integer
  • yEnd -- Integer
  • age -- Integer

This callback is triggered periodically with the period that is set by SetTouchGestureCallbackConfiguration[]. The parameters are the same as for GetTouchGesture[].

The following constants are available for this function:

  • BrickletLCD128x64`GESTUREULEFTUTOURIGHT = 0
  • BrickletLCD128x64`GESTUREURIGHTUTOULEFT = 1
  • BrickletLCD128x64`GESTUREUTOPUTOUBOTTOM = 2
  • BrickletLCD128x64`GESTUREUBOTTOMUTOUTOP = 3
event BrickletLCD128x64@GUIButtonPressedCallback[sender, index, pressed]
Parameters:
  • sender -- NETObject[BrickletLCD128x64]
  • index -- Integer
  • pressed -- True/False

This callback is triggered periodically with the period that is set by SetGUIButtonPressedCallbackConfiguration[]. The parameters are the same as for GetGUIButtonPressed[].

New in version 2.0.2 (Plugin).

event BrickletLCD128x64@GUISliderValueCallback[sender, index, value]
Parameters:
  • sender -- NETObject[BrickletLCD128x64]
  • index -- Integer
  • value -- Integer

This callback is triggered periodically with the period that is set by SetGUISliderValueCallbackConfiguration[]. The parameters are the same as for GetGUISliderValue[].

New in version 2.0.2 (Plugin).

event BrickletLCD128x64@GUITabSelectedCallback[sender, index]
Parameters:
  • sender -- NETObject[BrickletLCD128x64]
  • index -- Integer

This callback is triggered periodically with the period that is set by SetGUITabSelectedCallbackConfiguration[]. The parameters are the same as for GetGUITabSelected[].

New in version 2.0.2 (Plugin).

Constants

BrickletLCD128x64`DEVICEUIDENTIFIER

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

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

BrickletLCD128x64`DEVICEDISPLAYNAME

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