Class BrickletEPaper296x128


  • public class BrickletEPaper296x128
    extends Device
    Three color 296x128 e-paper display
    • Constructor Detail

      • BrickletEPaper296x128

        public BrickletEPaper296x128​(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

      • draw

        public void draw()
                  throws TinkerforgeException
        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().
        Throws:
        TinkerforgeException
      • getDrawStatus

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

        public void writeBlackWhiteLowLevel​(int xStart,
                                            int yStart,
                                            int xEnd,
                                            int yEnd,
                                            int pixelsLength,
                                            int pixelsChunkOffset,
                                            boolean[] pixelsChunkData)
                                     throws TinkerforgeException
        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(int, int, int, int, boolean[]) to write red or gray pixels.
        Throws:
        TinkerforgeException
      • readBlackWhiteLowLevel

        public BrickletEPaper296x128.ReadBlackWhiteLowLevel readBlackWhiteLowLevel​(int xStart,
                                                                                   int yStart,
                                                                                   int xEnd,
                                                                                   int yEnd)
                                                                            throws TinkerforgeException
        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.
        Throws:
        TinkerforgeException
      • writeColorLowLevel

        public void writeColorLowLevel​(int xStart,
                                       int yStart,
                                       int xEnd,
                                       int yEnd,
                                       int pixelsLength,
                                       int pixelsChunkOffset,
                                       boolean[] pixelsChunkData)
                                throws TinkerforgeException
        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(int, int, int, int, boolean[])). 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(int, int, int, int, boolean[]) to write black/white pixels.
        Throws:
        TinkerforgeException
      • readColorLowLevel

        public BrickletEPaper296x128.ReadColorLowLevel readColorLowLevel​(int xStart,
                                                                         int yStart,
                                                                         int xEnd,
                                                                         int yEnd)
                                                                  throws TinkerforgeException
        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.
        Throws:
        TinkerforgeException
      • fillDisplay

        public void fillDisplay​(int color)
                         throws TinkerforgeException
        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().
        Throws:
        TinkerforgeException
      • drawText

        public void drawText​(int positionX,
                             int positionY,
                             int font,
                             int color,
                             int orientation,
                             java.lang.String text)
                      throws TinkerforgeException
        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.
        Throws:
        TinkerforgeException
      • drawLine

        public void drawLine​(int positionXStart,
                             int positionYStart,
                             int positionXEnd,
                             int positionYEnd,
                             int color)
                      throws TinkerforgeException
        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().
        Throws:
        TinkerforgeException
      • drawBox

        public void drawBox​(int positionXStart,
                            int positionYStart,
                            int positionXEnd,
                            int positionYEnd,
                            boolean fill,
                            int color)
                     throws TinkerforgeException
        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().
        Throws:
        TinkerforgeException
      • setUpdateMode

        public void setUpdateMode​(int updateMode)
                           throws TinkerforgeException
        \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 <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.
        Throws:
        TinkerforgeException
      • setDisplayType

        public void setDisplayType​(int displayType)
                            throws TinkerforgeException
        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.
        Throws:
        TinkerforgeException
      • setDisplayDriver

        public void setDisplayDriver​(int displayDriver)
                              throws TinkerforgeException
        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. .. versionadded:: 2.0.3$nbsp;(Plugin)
        Throws:
        TinkerforgeException
      • getSPITFPErrorCount

        public BrickletEPaper296x128.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
      • writeBlackWhite

        public void writeBlackWhite​(int xStart,
                                    int yStart,
                                    int xEnd,
                                    int yEnd,
                                    boolean[] pixels)
                             throws TinkerforgeException
        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(int, int, int, int, boolean[]) to write red or gray pixels.
        Throws:
        TinkerforgeException
      • readBlackWhite

        public boolean[] readBlackWhite​(int xStart,
                                        int yStart,
                                        int xEnd,
                                        int yEnd)
                                 throws TinkerforgeException
        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.
        Throws:
        TinkerforgeException
      • writeColor

        public void writeColor​(int xStart,
                               int yStart,
                               int xEnd,
                               int yEnd,
                               boolean[] pixels)
                        throws TinkerforgeException
        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(int, int, int, int, boolean[])). 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(int, int, int, int, boolean[]) to write black/white pixels.
        Throws:
        TinkerforgeException
      • readColor

        public boolean[] readColor​(int xStart,
                                   int yStart,
                                   int xEnd,
                                   int yEnd)
                            throws TinkerforgeException
        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.
        Throws:
        TinkerforgeException