Class BrickletOLED128x64V2


  • public class BrickletOLED128x64V2
    extends Device
    3.3cm (1.3") OLED display with 128x64 pixels
    • Field Detail

      • DEVICE_DISPLAY_NAME

        public static final java.lang.String DEVICE_DISPLAY_NAME
        See Also:
        Constant Field Values
      • FUNCTION_WRITE_PIXELS_LOW_LEVEL

        public static final byte FUNCTION_WRITE_PIXELS_LOW_LEVEL
        See Also:
        Constant Field Values
      • FUNCTION_READ_PIXELS_LOW_LEVEL

        public static final byte FUNCTION_READ_PIXELS_LOW_LEVEL
        See Also:
        Constant Field Values
      • FUNCTION_CLEAR_DISPLAY

        public static final byte FUNCTION_CLEAR_DISPLAY
        See Also:
        Constant Field Values
      • FUNCTION_SET_DISPLAY_CONFIGURATION

        public static final byte FUNCTION_SET_DISPLAY_CONFIGURATION
        See Also:
        Constant Field Values
      • FUNCTION_GET_DISPLAY_CONFIGURATION

        public static final byte FUNCTION_GET_DISPLAY_CONFIGURATION
        See Also:
        Constant Field Values
      • FUNCTION_DRAW_BUFFERED_FRAME

        public static final byte FUNCTION_DRAW_BUFFERED_FRAME
        See Also:
        Constant Field Values
      • FUNCTION_GET_SPITFP_ERROR_COUNT

        public static final byte FUNCTION_GET_SPITFP_ERROR_COUNT
        See Also:
        Constant Field Values
      • FUNCTION_SET_BOOTLOADER_MODE

        public static final byte FUNCTION_SET_BOOTLOADER_MODE
        See Also:
        Constant Field Values
      • FUNCTION_GET_BOOTLOADER_MODE

        public static final byte FUNCTION_GET_BOOTLOADER_MODE
        See Also:
        Constant Field Values
      • FUNCTION_SET_WRITE_FIRMWARE_POINTER

        public static final byte FUNCTION_SET_WRITE_FIRMWARE_POINTER
        See Also:
        Constant Field Values
      • FUNCTION_WRITE_FIRMWARE

        public static final byte FUNCTION_WRITE_FIRMWARE
        See Also:
        Constant Field Values
      • FUNCTION_SET_STATUS_LED_CONFIG

        public static final byte FUNCTION_SET_STATUS_LED_CONFIG
        See Also:
        Constant Field Values
      • FUNCTION_GET_STATUS_LED_CONFIG

        public static final byte FUNCTION_GET_STATUS_LED_CONFIG
        See Also:
        Constant Field Values
      • FUNCTION_GET_CHIP_TEMPERATURE

        public static final byte FUNCTION_GET_CHIP_TEMPERATURE
        See Also:
        Constant Field Values
      • BOOTLOADER_MODE_BOOTLOADER

        public static final int BOOTLOADER_MODE_BOOTLOADER
        See Also:
        Constant Field Values
      • BOOTLOADER_MODE_FIRMWARE

        public static final int BOOTLOADER_MODE_FIRMWARE
        See Also:
        Constant Field Values
      • BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT

        public static final int BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
        See Also:
        Constant Field Values
      • BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT

        public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
        See Also:
        Constant Field Values
      • BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT

        public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
        See Also:
        Constant Field Values
      • BOOTLOADER_STATUS_INVALID_MODE

        public static final int BOOTLOADER_STATUS_INVALID_MODE
        See Also:
        Constant Field Values
      • BOOTLOADER_STATUS_NO_CHANGE

        public static final int BOOTLOADER_STATUS_NO_CHANGE
        See Also:
        Constant Field Values
      • BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT

        public static final int BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
        See Also:
        Constant Field Values
      • BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT

        public static final int BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
        See Also:
        Constant Field Values
      • BOOTLOADER_STATUS_CRC_MISMATCH

        public static final int BOOTLOADER_STATUS_CRC_MISMATCH
        See Also:
        Constant Field Values
      • STATUS_LED_CONFIG_SHOW_HEARTBEAT

        public static final int STATUS_LED_CONFIG_SHOW_HEARTBEAT
        See Also:
        Constant Field Values
      • STATUS_LED_CONFIG_SHOW_STATUS

        public static final int STATUS_LED_CONFIG_SHOW_STATUS
        See Also:
        Constant Field Values
    • Constructor Detail

      • BrickletOLED128x64V2

        public BrickletOLED128x64V2​(java.lang.String uid,
                                    IPConnection ipcon)
        Creates an object with the unique device ID \c uid. and adds it to the IP Connection \c ipcon.
    • Method Detail

      • writePixelsLowLevel

        public void writePixelsLowLevel​(int xStart,
                                        int yStart,
                                        int xEnd,
                                        int yEnd,
                                        int pixelsLength,
                                        int pixelsChunkOffset,
                                        boolean[] pixelsChunkData)
                                 throws TinkerforgeException
        Writes pixels to 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. 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(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.
        Throws:
        TinkerforgeException
      • writeLine

        public void writeLine​(int line,
                              int position,
                              java.lang.String text)
                       throws TinkerforgeException
        Writes text to a specific line with a specific position. 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. If automatic draw is enabled (default) the text is 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 text is written to an internal buffer and the buffer is transferred to the display only after 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.
        Throws:
        TinkerforgeException
      • drawBufferedFrame

        public void drawBufferedFrame​(boolean forceCompleteRedraw)
                               throws TinkerforgeException
        Draws the currently buffered frame. Normally each call of 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.
        Throws:
        TinkerforgeException
      • getSPITFPErrorCount

        public BrickletOLED128x64V2.SPITFPErrorCount getSPITFPErrorCount()
                                                                  throws TinkerforgeException
        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.
        Throws:
        TinkerforgeException
      • setBootloaderMode

        public int setBootloaderMode​(int mode)
                              throws TinkerforgeException
        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.
        Throws:
        TinkerforgeException
      • setWriteFirmwarePointer

        public void setWriteFirmwarePointer​(long pointer)
                                     throws TinkerforgeException
        Sets the firmware pointer for 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.
        Throws:
        TinkerforgeException
      • writeFirmware

        public int writeFirmware​(int[] data)
                          throws TinkerforgeException
        Writes 64 Bytes of firmware at the position as written by 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.
        Throws:
        TinkerforgeException
      • setStatusLEDConfig

        public void setStatusLEDConfig​(int config)
                                throws TinkerforgeException
        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.
        Throws:
        TinkerforgeException
      • getChipTemperature

        public int getChipTemperature()
                               throws TinkerforgeException
        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.
        Throws:
        TinkerforgeException
      • reset

        public void reset()
                   throws TinkerforgeException
        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!
        Throws:
        TinkerforgeException
      • writeUID

        public void writeUID​(long uid)
                      throws TinkerforgeException
        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.
        Throws:
        TinkerforgeException
      • getIdentity

        public Device.Identity getIdentity()
                                    throws TinkerforgeException
        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 :ref:`Isolator Bricklet <isolator_bricklet>` is always at position 'z'. The device identifier numbers can be found :ref:`here <device_identifier>`. |device_identifier_constant|
        Specified by:
        getIdentity in class Device
        Throws:
        TinkerforgeException
      • writePixels

        public void writePixels​(int xStart,
                                int yStart,
                                int xEnd,
                                int yEnd,
                                boolean[] pixels)
                         throws TinkerforgeException
        Writes pixels to 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. 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(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.
        Throws:
        TinkerforgeException
      • readPixels

        public boolean[] readPixels​(int xStart,
                                    int yStart,
                                    int xEnd,
                                    int yEnd)
                             throws TinkerforgeException
        Reads pixels from the specified window. 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(boolean)). Automatic draw can be configured with the setDisplayConfiguration(int, boolean, boolean) function.
        Throws:
        TinkerforgeException