public class BrickletOLED128x64V2 extends Device
Modifier and Type | Class and Description |
---|---|
class |
BrickletOLED128x64V2.DisplayConfiguration |
class |
BrickletOLED128x64V2.ReadPixelsLowLevel |
class |
BrickletOLED128x64V2.SPITFPErrorCount |
Device.Identity
Constructor and Description |
---|
BrickletOLED128x64V2(String uid,
IPConnection ipcon)
Creates an object with the unique device ID \c uid.
|
Modifier and Type | Method and Description |
---|---|
void |
clearDisplay()
Clears the complete content of the display.
|
void |
drawBufferedFrame(boolean forceCompleteRedraw)
Draws the currently buffered frame.
|
int |
getBootloaderMode()
Returns the current bootloader mode, see
setBootloaderMode(int) . |
int |
getChipTemperature()
Returns the temperature as measured inside the microcontroller.
|
BrickletOLED128x64V2.DisplayConfiguration |
getDisplayConfiguration()
Returns the configuration as set by
setDisplayConfiguration(int, boolean, boolean) . |
Device.Identity |
getIdentity()
Returns the UID, the UID where the Bricklet is connected to,
the position, the hardware and firmware version as well as the
device identifier.
|
BrickletOLED128x64V2.SPITFPErrorCount |
getSPITFPErrorCount()
Returns the error count for the communication between Brick and Bricklet.
|
int |
getStatusLEDConfig()
Returns the configuration as set by
setStatusLEDConfig(int) |
boolean[] |
readPixels(int xStart,
int yStart,
int xEnd,
int yEnd)
Reads pixels from the specified window.
|
BrickletOLED128x64V2.ReadPixelsLowLevel |
readPixelsLowLevel(int xStart,
int yStart,
int xEnd,
int yEnd)
Reads pixels from the specified window.
|
long |
readUID()
Returns the current UID as an integer.
|
void |
reset()
Calling this function will reset the Bricklet.
|
int |
setBootloaderMode(int mode)
Sets the bootloader mode and returns the status after the requested
mode change was instigated.
|
void |
setDisplayConfiguration(int contrast,
boolean invert,
boolean automaticDraw)
Sets the configuration of the display.
|
void |
setStatusLEDConfig(int config)
Sets the status LED configuration.
|
void |
setWriteFirmwarePointer(long pointer)
Sets the firmware pointer for
writeFirmware(int[]) . |
int |
writeFirmware(int[] data)
Writes 64 Bytes of firmware at the position as written by
setWriteFirmwarePointer(long) before. |
void |
writeLine(int line,
int position,
String text)
Writes text to a specific line with a specific position.
|
void |
writePixels(int xStart,
int yStart,
int xEnd,
int yEnd,
boolean[] pixels)
Writes pixels to the specified window.
|
void |
writePixelsLowLevel(int xStart,
int yStart,
int xEnd,
int yEnd,
int pixelsLength,
int pixelsChunkOffset,
boolean[] pixelsChunkData)
Writes pixels to the specified window.
|
void |
writeUID(long uid)
Writes a new UID into flash.
|
getAPIVersion, getResponseExpected, setResponseExpected, setResponseExpectedAll
public static final int DEVICE_IDENTIFIER
public static final String DEVICE_DISPLAY_NAME
public static final byte FUNCTION_WRITE_PIXELS_LOW_LEVEL
public static final byte FUNCTION_READ_PIXELS_LOW_LEVEL
public static final byte FUNCTION_CLEAR_DISPLAY
public static final byte FUNCTION_SET_DISPLAY_CONFIGURATION
public static final byte FUNCTION_GET_DISPLAY_CONFIGURATION
public static final byte FUNCTION_WRITE_LINE
public static final byte FUNCTION_DRAW_BUFFERED_FRAME
public static final byte FUNCTION_GET_SPITFP_ERROR_COUNT
public static final byte FUNCTION_SET_BOOTLOADER_MODE
public static final byte FUNCTION_GET_BOOTLOADER_MODE
public static final byte FUNCTION_SET_WRITE_FIRMWARE_POINTER
public static final byte FUNCTION_WRITE_FIRMWARE
public static final byte FUNCTION_SET_STATUS_LED_CONFIG
public static final byte FUNCTION_GET_STATUS_LED_CONFIG
public static final byte FUNCTION_GET_CHIP_TEMPERATURE
public static final byte FUNCTION_RESET
public static final byte FUNCTION_WRITE_UID
public static final byte FUNCTION_READ_UID
public static final byte FUNCTION_GET_IDENTITY
public static final int BOOTLOADER_MODE_BOOTLOADER
public static final int BOOTLOADER_MODE_FIRMWARE
public static final int BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
public static final int BOOTLOADER_STATUS_OK
public static final int BOOTLOADER_STATUS_INVALID_MODE
public static final int BOOTLOADER_STATUS_NO_CHANGE
public static final int BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
public static final int BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
public static final int BOOTLOADER_STATUS_CRC_MISMATCH
public static final int STATUS_LED_CONFIG_OFF
public static final int STATUS_LED_CONFIG_ON
public static final int STATUS_LED_CONFIG_SHOW_HEARTBEAT
public static final int STATUS_LED_CONFIG_SHOW_STATUS
public BrickletOLED128x64V2(String uid, IPConnection ipcon)
public void writePixelsLowLevel(int xStart, int yStart, int xEnd, int yEnd, int pixelsLength, int pixelsChunkOffset, boolean[] pixelsChunkData) throws TinkerforgeException
drawBufferedFrame(boolean)
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(int, boolean, boolean)
function.TinkerforgeException
public BrickletOLED128x64V2.ReadPixelsLowLevel readPixelsLowLevel(int xStart, int yStart, int xEnd, int yEnd) throws TinkerforgeException
drawBufferedFrame(boolean)
).
Automatic draw can be configured with the setDisplayConfiguration(int, boolean, boolean)
function.TinkerforgeException
public void clearDisplay() throws TinkerforgeException
drawBufferedFrame(boolean)
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(int, boolean, boolean)
function.TinkerforgeException
public void setDisplayConfiguration(int contrast, boolean invert, boolean automaticDraw) throws TinkerforgeException
writePixels(int, int, int, int, boolean[])
or writeLine(int, int, String)
. 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(boolean)
.TinkerforgeException
public BrickletOLED128x64V2.DisplayConfiguration getDisplayConfiguration() throws TinkerforgeException
setDisplayConfiguration(int, boolean, boolean)
.TinkerforgeException
public void writeLine(int line, int position, String text) throws TinkerforgeException
drawBufferedFrame(boolean)
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(int, boolean, boolean)
function.
The font conforms to code page 437.TinkerforgeException
public void drawBufferedFrame(boolean forceCompleteRedraw) throws TinkerforgeException
writePixels(int, int, int, int, boolean[])
and
writeLine(int, int, String)
draws directly onto the display. If you turn automatic draw off
(setDisplayConfiguration(int, boolean, boolean)
), 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.TinkerforgeException
public BrickletOLED128x64V2.SPITFPErrorCount getSPITFPErrorCount() throws TinkerforgeException
TinkerforgeException
public int setBootloaderMode(int mode) throws TinkerforgeException
TinkerforgeException
public int getBootloaderMode() throws TinkerforgeException
setBootloaderMode(int)
.TinkerforgeException
public void setWriteFirmwarePointer(long pointer) throws TinkerforgeException
writeFirmware(int[])
. 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.TinkerforgeException
public int writeFirmware(int[] data) throws TinkerforgeException
setWriteFirmwarePointer(long)
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.TinkerforgeException
public void setStatusLEDConfig(int config) throws TinkerforgeException
TinkerforgeException
public int getStatusLEDConfig() throws TinkerforgeException
setStatusLEDConfig(int)
TinkerforgeException
public int getChipTemperature() throws TinkerforgeException
TinkerforgeException
public void reset() throws TinkerforgeException
TinkerforgeException
public void writeUID(long uid) throws TinkerforgeException
TinkerforgeException
public long readUID() throws TinkerforgeException
TinkerforgeException
public Device.Identity getIdentity() throws TinkerforgeException
getIdentity
in class Device
TinkerforgeException
public void writePixels(int xStart, int yStart, int xEnd, int yEnd, boolean[] pixels) throws TinkerforgeException
drawBufferedFrame(boolean)
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(int, boolean, boolean)
function.TinkerforgeException
public boolean[] readPixels(int xStart, int yStart, int xEnd, int yEnd) throws TinkerforgeException
drawBufferedFrame(boolean)
).
Automatic draw can be configured with the setDisplayConfiguration(int, boolean, boolean)
function.TinkerforgeException
Copyright © 2022 Tinkerforge GmbH. All rights reserved.