Visual Basic .NET - E-Paper 296x128 Bricklet¶

Hello World¶

Download (ExampleHelloWorld.vb)

 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

Imports System
Imports Tinkerforge

Module ExampleHelloWorld
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your E-Paper 296x128 Bricklet

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim ep As New BrickletEPaper296x128(UID, ipcon) ' Create device object

        ipcon.Connect(HOST, PORT) ' Connect to brickd
        ' Don't use device before ipcon is connected

        ' Use black background
        ep.FillDisplay(BrickletEPaper296x128.COLOR_BLACK)

        ' Write big white "Hello World" in the middle of the screen
        ep.DrawText(16, 48, BrickletEPaper296x128.FONT_24X32, _
                    BrickletEPaper296x128.COLOR_WHITE, _
                    BrickletEPaper296x128.ORIENTATION_HORIZONTAL, "Hello World")
        ep.Draw()

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

Load Image¶

Download (ExampleLoadImage.vb)

 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

Imports System
Imports System.Drawing
Imports System.Threading
Imports Tinkerforge

' Tested with 
' > vbnc /reference:System.Drawing.dll /target:exe /out:Example.exe /reference:Tinkerforge.dll ExampleLoadImage.vb

Module ExampleScribble
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your E-Paper 296x128 Bricklet
    Const WIDTH As Integer = 296
    Const HEIGHT As Integer = 128

    ' Convert VB.NET Bitmap to matching color boolean array
    Function BoolArrayFromImage(ByVal bitmap As Bitmap, ByVal color As Color) As Boolean()
        Dim pixels() As Boolean = New Boolean(HEIGHT*WIDTH) {}

        For row As Integer = 0 To HEIGHT - 1
            For column As Integer = 0 To WIDTH - 1
                Dim c As Color =  bitmap.GetPixel(column, row)
                pixels(row*WIDTH + column) = ((c.R = color.R) And (c.G = color.G) And (c.B = color.B))
            Next column
        Next row

        Return pixels
    End Function

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim epaper As New BrickletEPaper296x128(UID, ipcon) ' Create device object

        ipcon.Connect(HOST, PORT) ' Connect to brickd
        ' Don't use device before ipcon is connected

        ' Download example image here:
        ' https://raw.githubusercontent.com/Tinkerforge/e-paper-296x128-bricklet/master/software/examples/tf_red.png
        Dim bitmap As New Bitmap("tf_red.png")

        ' Get black/white pixels from image and write them to the Bricklet buffer
        Dim pixelsBW() As Boolean = BoolArrayFromImage(bitmap, Color.White)
        epaper.WriteBlackWhite(0, 0, WIDTH-1, HEIGHT-1, pixelsBW)

        ' Get red pixels from image and write them to the Bricklet buffer
        Dim pixelsRed() As Boolean = BoolArrayFromImage(bitmap, Color.Red)
        epaper.WriteColor(0, 0, WIDTH-1, HEIGHT-1, pixelsRed)

        ' Draw buffered values to the display
        epaper.Draw()


        Console.WriteLine("Press enter to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

Basic Functions¶

Class BrickletEPaper296x128(ByVal uid As String, ByVal ipcon As IPConnection)¶

Creates an object with the unique device ID uid:

Dim ePaper296x128 As New BrickletEPaper296x128("YOUR_DEVICE_UID", ipcon)

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

Sub BrickletEPaper296x128.Draw()¶

Draws the current black/white and red or gray buffer to the e-paper display.

The Bricklet does not have any double-buffering. You should not call this function while writing to the buffer. See GetDrawStatus().

Function BrickletEPaper296x128.GetDrawStatus() As Byte¶

Returns:	drawStatus – Type: Byte, Range: See constants

Returns one of three draw statuses:

• Idle
• Copying: Data is being copied from the buffer of the Bricklet to the buffer of the display.
• Drawing: The display is updating its content (during this phase the flickering etc happens).

You can write to the buffer (through one of the write or draw functions) when the status is either idle or drawing. You should not write to the buffer while it is being copied to the display. There is no double-buffering.

The following constants are available for this function:

For drawStatus:

• BrickletEPaper296x128.DRAW_STATUS_IDLE = 0
• BrickletEPaper296x128.DRAW_STATUS_COPYING = 1
• BrickletEPaper296x128.DRAW_STATUS_DRAWING = 2

Sub BrickletEPaper296x128.WriteBlackWhite(ByVal xStart As Integer, ByVal yStart As Byte, ByVal xEnd As Integer, ByVal yEnd As Byte, ByVal pixels() As Boolean)¶

Parameters:	xStart – Type: Integer, Range: [0 to 295] yStart – Type: Byte, Range: [0 to 127] xEnd – Type: Integer, Range: [0 to 295] yEnd – Type: Byte, Range: [0 to 127] pixels – Type: Boolean Array, Length: variable

Writes black/white pixels to the specified window into the buffer.

The pixels are written into the window line by line top to bottom and each line is written from left to right.

The value 0 (false) corresponds to a black pixel and the value 1 (true) to a white pixel.

This function writes the pixels into the black/white pixel buffer, to draw the buffer to the display use Draw().

Use WriteColor() to write red or gray pixels.

Function BrickletEPaper296x128.ReadBlackWhite(ByVal xStart As Integer, ByVal yStart As Byte, ByVal xEnd As Integer, ByVal yEnd As Byte) As Boolean()¶

Parameters:	xStart – Type: Integer, Range: [0 to 295] yStart – Type: Byte, Range: [0 to 127] xEnd – Type: Integer, Range: [0 to 295] yEnd – Type: Byte, Range: [0 to 127]
Returns:	pixels – Type: Boolean Array, Length: variable

Returns the current content of the black/white pixel buffer for the specified window.

The pixels are read into the window line by line top to bottom and each line is read from left to right.

The current content of the buffer does not have to be the current content of the display. It is possible that the data was not drawn to the display yet and after a restart of the Bricklet the buffer will be reset to black, while the display retains its content.

Sub BrickletEPaper296x128.WriteColor(ByVal xStart As Integer, ByVal yStart As Byte, ByVal xEnd As Integer, ByVal yEnd As Byte, ByVal pixels() As Boolean)¶

Parameters:	xStart – Type: Integer, Range: [0 to 295] yStart – Type: Byte, Range: [0 to 127] xEnd – Type: Integer, Range: [0 to 295] yEnd – Type: Byte, Range: [0 to 127] pixels – Type: Boolean Array, Length: variable

The E-Paper 296x128 Bricklet is available with the colors black/white/red and black/white/gray. Depending on the model this function writes either red or gray pixels to the specified window into the buffer.

The pixels are written into the window line by line top to bottom and each line is written from left to right.

The value 0 (false) means that this pixel does not have color. It will be either black or white (see WriteBlackWhite()). The value 1 (true) corresponds to a red or gray pixel, depending on the Bricklet model.

This function writes the pixels into the red or gray pixel buffer, to draw the buffer to the display use Draw().

Use WriteBlackWhite() to write black/white pixels.

Function BrickletEPaper296x128.ReadColor(ByVal xStart As Integer, ByVal yStart As Byte, ByVal xEnd As Integer, ByVal yEnd As Byte) As Boolean()¶

Parameters:	xStart – Type: Integer, Range: [0 to 295] yStart – Type: Byte, Range: [0 to 127] xEnd – Type: Integer, Range: [0 to 295] yEnd – Type: Byte, Range: [0 to 127]
Returns:	pixels – Type: Boolean Array, Length: variable

Returns the current content of the red or gray pixel buffer for the specified window.

The pixels are written into the window line by line top to bottom and each line is written from left to right.

The current content of the buffer does not have to be the current content of the display. It is possible that the data was not drawn to the display yet and after a restart of the Bricklet the buffer will be reset to black, while the display retains its content.

Sub BrickletEPaper296x128.FillDisplay(ByVal color As Byte)¶

Parameters:	color – Type: Byte, Range: See constants

Fills the complete content of the display with the given color.

This function writes the pixels into the black/white/red|gray pixel buffer, to draw the buffer to the display use Draw().

The following constants are available for this function:

For color:

• BrickletEPaper296x128.COLOR_BLACK = 0
• BrickletEPaper296x128.COLOR_WHITE = 1
• BrickletEPaper296x128.COLOR_RED = 2
• BrickletEPaper296x128.COLOR_GRAY = 2

Sub BrickletEPaper296x128.DrawText(ByVal positionX As Integer, ByVal positionY As Byte, ByVal font As Byte, ByVal color As Byte, ByVal orientation As Byte, ByVal text As String)¶

Parameters:	positionX – Type: Integer, Range: [0 to 295] positionY – Type: Byte, Range: [0 to 127] font – Type: Byte, Range: See constants color – Type: Byte, Range: See constants orientation – Type: Byte, Range: See constants text – Type: String, Length: up to 50

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

You can use one of 9 different font sizes and draw the text in black/white/red|gray. The text can be drawn horizontal or vertical.

This function writes the pixels into the black/white/red|gray pixel buffer, to draw the buffer to the display use Draw().

The font conforms to code page 437.

The following constants are available for this function:

For font:

• BrickletEPaper296x128.FONT_6X8 = 0
• BrickletEPaper296x128.FONT_6X16 = 1
• BrickletEPaper296x128.FONT_6X24 = 2
• BrickletEPaper296x128.FONT_6X32 = 3
• BrickletEPaper296x128.FONT_12X16 = 4
• BrickletEPaper296x128.FONT_12X24 = 5
• BrickletEPaper296x128.FONT_12X32 = 6
• BrickletEPaper296x128.FONT_18X24 = 7
• BrickletEPaper296x128.FONT_18X32 = 8
• BrickletEPaper296x128.FONT_24X32 = 9

For color:

• BrickletEPaper296x128.COLOR_BLACK = 0
• BrickletEPaper296x128.COLOR_WHITE = 1
• BrickletEPaper296x128.COLOR_RED = 2
• BrickletEPaper296x128.COLOR_GRAY = 2

For orientation:

• BrickletEPaper296x128.ORIENTATION_HORIZONTAL = 0
• BrickletEPaper296x128.ORIENTATION_VERTICAL = 1

Sub BrickletEPaper296x128.DrawLine(ByVal positionXStart As Integer, ByVal positionYStart As Byte, ByVal positionXEnd As Integer, ByVal positionYEnd As Byte, ByVal color As Byte)¶

Parameters:	positionXStart – Type: Integer, Range: [0 to 295] positionYStart – Type: Byte, Range: [0 to 127] positionXEnd – Type: Integer, Range: [0 to 295] positionYEnd – Type: Byte, Range: [0 to 127] color – Type: Byte, Range: See constants

Draws a line from (x, y)-start to (x, y)-end in the given color.

This function writes the pixels into the black/white/red|gray pixel buffer, to draw the buffer to the display use Draw().

The following constants are available for this function:

For color:

• BrickletEPaper296x128.COLOR_BLACK = 0
• BrickletEPaper296x128.COLOR_WHITE = 1
• BrickletEPaper296x128.COLOR_RED = 2
• BrickletEPaper296x128.COLOR_GRAY = 2

Sub BrickletEPaper296x128.DrawBox(ByVal positionXStart As Integer, ByVal positionYStart As Byte, ByVal positionXEnd As Integer, ByVal positionYEnd As Byte, ByVal fill As Boolean, ByVal color As Byte)¶

Parameters:	positionXStart – Type: Integer, Range: [0 to 295] positionYStart – Type: Byte, Range: [0 to 127] positionXEnd – Type: Integer, Range: [0 to 295] positionYEnd – Type: Byte, Range: [0 to 127] fill – Type: Boolean color – Type: Byte, Range: See constants

Draws a box from (x, y)-start to (x, y)-end in the given color.

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

This function writes the pixels into the black/white/red|gray pixel buffer, to draw the buffer to the display use Draw().

The following constants are available for this function:

For color:

• BrickletEPaper296x128.COLOR_BLACK = 0
• BrickletEPaper296x128.COLOR_WHITE = 1
• BrickletEPaper296x128.COLOR_RED = 2
• BrickletEPaper296x128.COLOR_GRAY = 2

Advanced Functions¶

Sub BrickletEPaper296x128.SetUpdateMode(ByVal updateMode As Byte)¶

Parameters:	updateMode – Type: Byte, Range: See constants, Default: 0

Note

The default update mode corresponds to the default e-paper display manufacturer settings. All of the other modes are experimental and will result in increased ghosting and possibly other long-term side effects.

If you want to know more about the inner workings of an e-paper display take a look at this excellent video from Ben Krasnow: https://www.youtube.com/watch?v=MsbiO8EAsGw.

If you are not sure about this option, leave the update mode at default.

Currently there are three update modes available:

• Default: Settings as given by the manufacturer. An update will take about 7.5 seconds and during the update the screen will flicker several times.
• Black/White: This will only update the black/white pixel. It uses the manufacturer settings for black/white and ignores the red or gray pixel buffer. With this mode the display will flicker once and it takes about 2.5 seconds. Compared to the default settings there is more ghosting.
• Delta: This will only update the black/white pixel. It uses an aggressive method where the changes are not applied for a whole buffer but only for the delta between the last and the next buffer. With this mode the display will not flicker during an update and it takes about 900-950ms. Compared to the other two settings there is more ghosting. This mode can be used for something like a flicker-free live update of a text.

With the black/white/red display if you use either the black/white or the delta mode, after a while of going back and forth between black and white the white color will start to appear red-ish or pink-ish.

If you use the aggressive delta mode and rapidly change the content, we recommend that you change back to the default mode every few hours and in the default mode cycle between the three available colors a few times. This will get rid of the ghosting and after that you can go back to the delta mode with flicker-free updates.

The following constants are available for this function:

For updateMode:

• BrickletEPaper296x128.UPDATE_MODE_DEFAULT = 0
• BrickletEPaper296x128.UPDATE_MODE_BLACK_WHITE = 1
• BrickletEPaper296x128.UPDATE_MODE_DELTA = 2

Function BrickletEPaper296x128.GetUpdateMode() As Byte¶

Returns:	updateMode – Type: Byte, Range: See constants, Default: 0

Returns the update mode as set by SetUpdateMode().

The following constants are available for this function:

For updateMode:

• BrickletEPaper296x128.UPDATE_MODE_DEFAULT = 0
• BrickletEPaper296x128.UPDATE_MODE_BLACK_WHITE = 1
• BrickletEPaper296x128.UPDATE_MODE_DELTA = 2

Sub BrickletEPaper296x128.SetDisplayType(ByVal displayType As Byte)¶

Parameters:	displayType – Type: Byte, Range: See constants

Sets the type of the display. The e-paper display is available in black/white/red and black/white/gray. This will be factory set during the flashing and testing phase. The value is saved in non-volatile memory and will stay after a power cycle.

The following constants are available for this function:

For displayType:

• BrickletEPaper296x128.DISPLAY_TYPE_BLACK_WHITE_RED = 0
• BrickletEPaper296x128.DISPLAY_TYPE_BLACK_WHITE_GRAY = 1

Function BrickletEPaper296x128.GetDisplayType() As Byte¶

Returns:	displayType – Type: Byte, Range: See constants

Returns the type of the e-paper display. It can either be black/white/red or black/white/gray.

The following constants are available for this function:

For displayType:

• BrickletEPaper296x128.DISPLAY_TYPE_BLACK_WHITE_RED = 0
• BrickletEPaper296x128.DISPLAY_TYPE_BLACK_WHITE_GRAY = 1

Sub BrickletEPaper296x128.SetDisplayDriver(ByVal displayDriver As Byte)¶

Parameters:	displayDriver – Type: Byte, Range: See constants

Sets the type of display driver. The Bricklet can currently support SSD1675A and SSD1680. This will be factory set during the flashing and testing phase. The value is saved in non-volatile memory and will stay after a power cycle.

The following constants are available for this function:

For displayDriver:

• BrickletEPaper296x128.DISPLAY_DRIVER_SSD1675A = 0
• BrickletEPaper296x128.DISPLAY_DRIVER_SSD1680 = 1

New in version 2.0.3 (Plugin).

Function BrickletEPaper296x128.GetDisplayDriver() As Byte¶

Returns:	displayDriver – Type: Byte, Range: See constants

Returns the e-paper display driver.

The following constants are available for this function:

For displayDriver:

• BrickletEPaper296x128.DISPLAY_DRIVER_SSD1675A = 0
• BrickletEPaper296x128.DISPLAY_DRIVER_SSD1680 = 1

New in version 2.0.3 (Plugin).

Sub BrickletEPaper296x128.GetSPITFPErrorCount(ByRef errorCountAckChecksum As Long, ByRef errorCountMessageChecksum As Long, ByRef errorCountFrame As Long, ByRef errorCountOverflow As Long)¶

Output Parameters:	errorCountAckChecksum – Type: Long, Range: [0 to 232 - 1] errorCountMessageChecksum – Type: Long, Range: [0 to 232 - 1] errorCountFrame – Type: Long, Range: [0 to 232 - 1] errorCountOverflow – Type: Long, Range: [0 to 232 - 1]

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.

Sub BrickletEPaper296x128.SetStatusLEDConfig(ByVal config As Byte)¶

Parameters:	config – Type: Byte, Range: See constants, Default: 3

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:

For config:

• BrickletEPaper296x128.STATUS_LED_CONFIG_OFF = 0
• BrickletEPaper296x128.STATUS_LED_CONFIG_ON = 1
• BrickletEPaper296x128.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletEPaper296x128.STATUS_LED_CONFIG_SHOW_STATUS = 3

Function BrickletEPaper296x128.GetStatusLEDConfig() As Byte¶

Returns:	config – Type: Byte, Range: See constants, Default: 3

Returns the configuration as set by SetStatusLEDConfig()

The following constants are available for this function:

For config:

• BrickletEPaper296x128.STATUS_LED_CONFIG_OFF = 0
• BrickletEPaper296x128.STATUS_LED_CONFIG_ON = 1
• BrickletEPaper296x128.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletEPaper296x128.STATUS_LED_CONFIG_SHOW_STATUS = 3

Function BrickletEPaper296x128.GetChipTemperature() As Short¶

Returns:	temperature – Type: Short, Unit: 1 °C, Range: [-215 to 215 - 1]

Returns the temperature 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.

Sub BrickletEPaper296x128.Reset()¶

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!

Sub BrickletEPaper296x128.GetIdentity(ByRef uid As String, ByRef connectedUid As String, ByRef position As Char, ByRef hardwareVersion() As Byte, ByRef firmwareVersion() As Byte, ByRef deviceIdentifier As Integer)¶

Output Parameters:

uid – Type: String, Length: up to 8 connectedUid – Type: String, Length: up to 8 position – Type: Char, Range: ["a"C to "h"C, "z"C] hardwareVersion – Type: Byte Array, Length: 3 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: Byte Array, Length: 3 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: Integer, 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.

Callbacks¶

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

Sub MyCallback(ByVal sender As BrickletEPaper296x128, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler ePaper296x128.ExampleCallback, AddressOf MyCallback

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

Event BrickletEPaper296x128.DrawStatusCallback(ByVal sender As BrickletEPaper296x128, ByVal drawStatus As Byte)¶

Callback Parameters:	sender – Type: BrickletEPaper296x128 drawStatus – Type: Byte, Range: See constants

Callback for the current draw status. Will be called every time the draw status changes (see GetDrawStatus()).

The following constants are available for this function:

For drawStatus:

• BrickletEPaper296x128.DRAW_STATUS_IDLE = 0
• BrickletEPaper296x128.DRAW_STATUS_COPYING = 1
• BrickletEPaper296x128.DRAW_STATUS_DRAWING = 2

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 BrickletEPaper296x128.GetAPIVersion() As Byte()¶

Output Parameters:	apiVersion – Type: Byte Array, Length: 3 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 BrickletEPaper296x128.GetResponseExpected(ByVal functionId As Byte) As 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:

• BrickletEPaper296x128.FUNCTION_DRAW = 1
• BrickletEPaper296x128.FUNCTION_WRITE_BLACK_WHITE = 3
• BrickletEPaper296x128.FUNCTION_WRITE_COLOR = 5
• BrickletEPaper296x128.FUNCTION_FILL_DISPLAY = 7
• BrickletEPaper296x128.FUNCTION_DRAW_TEXT = 8
• BrickletEPaper296x128.FUNCTION_DRAW_LINE = 9
• BrickletEPaper296x128.FUNCTION_DRAW_BOX = 10
• BrickletEPaper296x128.FUNCTION_SET_UPDATE_MODE = 12
• BrickletEPaper296x128.FUNCTION_SET_DISPLAY_TYPE = 14
• BrickletEPaper296x128.FUNCTION_SET_DISPLAY_DRIVER = 16
• BrickletEPaper296x128.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletEPaper296x128.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletEPaper296x128.FUNCTION_RESET = 243
• BrickletEPaper296x128.FUNCTION_WRITE_UID = 248

Sub BrickletEPaper296x128.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As 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:

• BrickletEPaper296x128.FUNCTION_DRAW = 1
• BrickletEPaper296x128.FUNCTION_WRITE_BLACK_WHITE = 3
• BrickletEPaper296x128.FUNCTION_WRITE_COLOR = 5
• BrickletEPaper296x128.FUNCTION_FILL_DISPLAY = 7
• BrickletEPaper296x128.FUNCTION_DRAW_TEXT = 8
• BrickletEPaper296x128.FUNCTION_DRAW_LINE = 9
• BrickletEPaper296x128.FUNCTION_DRAW_BOX = 10
• BrickletEPaper296x128.FUNCTION_SET_UPDATE_MODE = 12
• BrickletEPaper296x128.FUNCTION_SET_DISPLAY_TYPE = 14
• BrickletEPaper296x128.FUNCTION_SET_DISPLAY_DRIVER = 16
• BrickletEPaper296x128.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletEPaper296x128.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletEPaper296x128.FUNCTION_RESET = 243
• BrickletEPaper296x128.FUNCTION_WRITE_UID = 248

Sub BrickletEPaper296x128.SetResponseExpectedAll(ByVal responseExpected As Boolean)¶

Parameters:	responseExpected – Type: Boolean

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

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

Function BrickletEPaper296x128.SetBootloaderMode(ByVal mode As Byte) As Byte¶

Parameters:	mode – Type: Byte, Range: See constants
Returns:	status – Type: Byte, Range: See constants

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:

For mode:

• BrickletEPaper296x128.BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletEPaper296x128.BOOTLOADER_MODE_FIRMWARE = 1
• BrickletEPaper296x128.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletEPaper296x128.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletEPaper296x128.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

• BrickletEPaper296x128.BOOTLOADER_STATUS_OK = 0
• BrickletEPaper296x128.BOOTLOADER_STATUS_INVALID_MODE = 1
• BrickletEPaper296x128.BOOTLOADER_STATUS_NO_CHANGE = 2
• BrickletEPaper296x128.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• BrickletEPaper296x128.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• BrickletEPaper296x128.BOOTLOADER_STATUS_CRC_MISMATCH = 5

Function BrickletEPaper296x128.GetBootloaderMode() As Byte¶

Returns:	mode – Type: Byte, Range: See constants

Returns the current bootloader mode, see SetBootloaderMode().

The following constants are available for this function:

For mode:

• BrickletEPaper296x128.BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletEPaper296x128.BOOTLOADER_MODE_FIRMWARE = 1
• BrickletEPaper296x128.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletEPaper296x128.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletEPaper296x128.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Sub BrickletEPaper296x128.SetWriteFirmwarePointer(ByVal pointer As Long)¶

Parameters:	pointer – Type: Long, Unit: 1 B, Range: [0 to 232 - 1]

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.

Function BrickletEPaper296x128.WriteFirmware(ByVal data() As Byte) As Byte¶

Parameters:	data – Type: Byte Array, Length: 64, Range: [0 to 255]
Returns:	status – Type: Byte, Range: [0 to 255]

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.

Sub BrickletEPaper296x128.WriteUID(ByVal uid As Long)¶

Parameters:	uid – Type: Long, Range: [0 to 232 - 1]

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.

Function BrickletEPaper296x128.ReadUID() As Long¶

Returns:	uid – Type: Long, Range: [0 to 232 - 1]

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

Constants¶

Const BrickletEPaper296x128.DEVICE_IDENTIFIER¶

This constant is used to identify a E-Paper 296x128 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.

Const BrickletEPaper296x128.DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a E-Paper 296x128 Bricklet.