Documentation ¶
Overview ¶
Three color 296x128 e-paper display.
See also the documentation here: https://www.tinkerforge.com/en/doc/Software/Bricklets/EPaper296x128_Bricklet_Go.html.
Index ¶
- Constants
- type BootloaderMode
- type BootloaderStatus
- type Color
- type DisplayDriver
- type DisplayType
- type DrawStatus
- type EPaper296x128Bricklet
- func (device *EPaper296x128Bricklet) DeregisterDrawStatusCallback(registrationId uint64)
- func (device *EPaper296x128Bricklet) Draw() (err error)
- func (device *EPaper296x128Bricklet) DrawBox(positionXStart uint16, positionYStart uint8, positionXEnd uint16, ...) (err error)
- func (device *EPaper296x128Bricklet) DrawLine(positionXStart uint16, positionYStart uint8, positionXEnd uint16, ...) (err error)
- func (device *EPaper296x128Bricklet) DrawText(positionX uint16, positionY uint8, font Font, color Color, ...) (err error)
- func (device *EPaper296x128Bricklet) FillDisplay(color Color) (err error)
- func (device *EPaper296x128Bricklet) GetAPIVersion() [3]uint8
- func (device *EPaper296x128Bricklet) GetBootloaderMode() (mode BootloaderMode, err error)
- func (device *EPaper296x128Bricklet) GetChipTemperature() (temperature int16, err error)
- func (device *EPaper296x128Bricklet) GetDisplayDriver() (displayDriver DisplayDriver, err error)
- func (device *EPaper296x128Bricklet) GetDisplayType() (displayType DisplayType, err error)
- func (device *EPaper296x128Bricklet) GetDrawStatus() (drawStatus DrawStatus, err error)
- func (device *EPaper296x128Bricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, ...)
- func (device *EPaper296x128Bricklet) GetResponseExpected(functionID Function) (bool, error)
- func (device *EPaper296x128Bricklet) GetSPITFPErrorCount() (errorCountAckChecksum uint32, errorCountMessageChecksum uint32, ...)
- func (device *EPaper296x128Bricklet) GetStatusLEDConfig() (config StatusLEDConfig, err error)
- func (device *EPaper296x128Bricklet) GetUpdateMode() (updateMode UpdateMode, err error)
- func (device *EPaper296x128Bricklet) ReadBlackWhite(xStart uint16, yStart uint8, xEnd uint16, yEnd uint8) (pixels []bool, err error)
- func (device *EPaper296x128Bricklet) ReadBlackWhiteLowLevel(xStart uint16, yStart uint8, xEnd uint16, yEnd uint8) (pixelsLength uint16, pixelsChunkOffset uint16, pixelsChunkData [464]bool, ...)
- func (device *EPaper296x128Bricklet) ReadColor(xStart uint16, yStart uint8, xEnd uint16, yEnd uint8) (pixels []bool, err error)
- func (device *EPaper296x128Bricklet) ReadColorLowLevel(xStart uint16, yStart uint8, xEnd uint16, yEnd uint8) (pixelsLength uint16, pixelsChunkOffset uint16, pixelsChunkData [464]bool, ...)
- func (device *EPaper296x128Bricklet) ReadUID() (uid uint32, err error)
- func (device *EPaper296x128Bricklet) RegisterDrawStatusCallback(fn func(DrawStatus)) uint64
- func (device *EPaper296x128Bricklet) Reset() (err error)
- func (device *EPaper296x128Bricklet) SetBootloaderMode(mode BootloaderMode) (status BootloaderStatus, err error)
- func (device *EPaper296x128Bricklet) SetDisplayDriver(displayDriver DisplayDriver) (err error)
- func (device *EPaper296x128Bricklet) SetDisplayType(displayType DisplayType) (err error)
- func (device *EPaper296x128Bricklet) SetResponseExpected(functionID Function, responseExpected bool) error
- func (device *EPaper296x128Bricklet) SetResponseExpectedAll(responseExpected bool)
- func (device *EPaper296x128Bricklet) SetStatusLEDConfig(config StatusLEDConfig) (err error)
- func (device *EPaper296x128Bricklet) SetUpdateMode(updateMode UpdateMode) (err error)
- func (device *EPaper296x128Bricklet) SetWriteFirmwarePointer(pointer uint32) (err error)
- func (device *EPaper296x128Bricklet) WriteBlackWhite(xStart uint16, yStart uint8, xEnd uint16, yEnd uint8, pixels []bool) (err error)
- func (device *EPaper296x128Bricklet) WriteBlackWhiteLowLevel(xStart uint16, yStart uint8, xEnd uint16, yEnd uint8, pixelsLength uint16, ...) (err error)
- func (device *EPaper296x128Bricklet) WriteColor(xStart uint16, yStart uint8, xEnd uint16, yEnd uint8, pixels []bool) (err error)
- func (device *EPaper296x128Bricklet) WriteColorLowLevel(xStart uint16, yStart uint8, xEnd uint16, yEnd uint8, pixelsLength uint16, ...) (err error)
- func (device *EPaper296x128Bricklet) WriteFirmware(data [64]uint8) (status uint8, err error)
- func (device *EPaper296x128Bricklet) WriteUID(uid uint32) (err error)
- type Font
- type Function
- type Orientation
- type StatusLEDConfig
- type UpdateMode
Constants ¶
const DeviceDisplayName = "E-Paper 296x128 Bricklet"
const DeviceIdentifier = 2146
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BootloaderMode ¶
type BootloaderMode = uint8
const ( BootloaderModeBootloader BootloaderMode = 0 BootloaderModeFirmware BootloaderMode = 1 BootloaderModeBootloaderWaitForReboot BootloaderMode = 2 BootloaderModeFirmwareWaitForReboot BootloaderMode = 3 BootloaderModeFirmwareWaitForEraseAndReboot BootloaderMode = 4 )
type BootloaderStatus ¶
type BootloaderStatus = uint8
const ( BootloaderStatusOK BootloaderStatus = 0 BootloaderStatusInvalidMode BootloaderStatus = 1 BootloaderStatusNoChange BootloaderStatus = 2 BootloaderStatusEntryFunctionNotPresent BootloaderStatus = 3 BootloaderStatusDeviceIdentifierIncorrect BootloaderStatus = 4 BootloaderStatusCRCMismatch BootloaderStatus = 5 )
type DisplayDriver ¶
type DisplayDriver = uint8
const ( DisplayDriverSSD1675A DisplayDriver = 0 DisplayDriverSSD1680 DisplayDriver = 1 )
type DisplayType ¶
type DisplayType = uint8
const ( DisplayTypeBlackWhiteRed DisplayType = 0 DisplayTypeBlackWhiteGray DisplayType = 1 )
type DrawStatus ¶
type DrawStatus = uint8
const ( DrawStatusIdle DrawStatus = 0 DrawStatusCopying DrawStatus = 1 DrawStatusDrawing DrawStatus = 2 )
type EPaper296x128Bricklet ¶
type EPaper296x128Bricklet struct {
// contains filtered or unexported fields
}
func New ¶
func New(uid string, ipcon *ipconnection.IPConnection) (EPaper296x128Bricklet, error)
Creates an object with the unique device ID `uid`. This object can then be used after the IP Connection `ipcon` is connected.
func (*EPaper296x128Bricklet) DeregisterDrawStatusCallback ¶
func (device *EPaper296x128Bricklet) DeregisterDrawStatusCallback(registrationId uint64)
Remove a registered Draw Status callback.
func (*EPaper296x128Bricklet) Draw ¶
func (device *EPaper296x128Bricklet) Draw() (err error)
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.
func (*EPaper296x128Bricklet) DrawBox ¶
func (device *EPaper296x128Bricklet) DrawBox(positionXStart uint16, positionYStart uint8, positionXEnd uint16, positionYEnd uint8, fill bool, color Color) (err error)
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.
Associated constants:
- ColorBlack
- ColorWhite
- ColorRed
- ColorGray
func (*EPaper296x128Bricklet) DrawLine ¶
func (device *EPaper296x128Bricklet) DrawLine(positionXStart uint16, positionYStart uint8, positionXEnd uint16, positionYEnd uint8, color Color) (err error)
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.
Associated constants:
- ColorBlack
- ColorWhite
- ColorRed
- ColorGray
func (*EPaper296x128Bricklet) DrawText ¶
func (device *EPaper296x128Bricklet) DrawText(positionX uint16, positionY uint8, font Font, color Color, orientation Orientation, text string) (err error)
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.
Associated constants:
- Font6x8
- Font6x16
- Font6x24
- Font6x32
- Font12x16
- Font12x24
- Font12x32
- Font18x24
- Font18x32
- Font24x32
- ColorBlack
- ColorWhite
- ColorRed
- ColorGray
- OrientationHorizontal
- OrientationVertical
func (*EPaper296x128Bricklet) FillDisplay ¶
func (device *EPaper296x128Bricklet) FillDisplay(color Color) (err error)
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.
Associated constants:
- ColorBlack
- ColorWhite
- ColorRed
- ColorGray
func (*EPaper296x128Bricklet) GetAPIVersion ¶
func (device *EPaper296x128Bricklet) GetAPIVersion() [3]uint8
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.
func (*EPaper296x128Bricklet) GetBootloaderMode ¶
func (device *EPaper296x128Bricklet) GetBootloaderMode() (mode BootloaderMode, err error)
Returns the current bootloader mode, see SetBootloaderMode.
Associated constants:
- BootloaderModeBootloader
- BootloaderModeFirmware
- BootloaderModeBootloaderWaitForReboot
- BootloaderModeFirmwareWaitForReboot
- BootloaderModeFirmwareWaitForEraseAndReboot
func (*EPaper296x128Bricklet) GetChipTemperature ¶
func (device *EPaper296x128Bricklet) GetChipTemperature() (temperature int16, err error)
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.
func (*EPaper296x128Bricklet) GetDisplayDriver ¶
func (device *EPaper296x128Bricklet) GetDisplayDriver() (displayDriver DisplayDriver, err error)
Returns the e-paper display driver.
.. versionadded:: 2.0.3$nbsp;(Plugin)
Associated constants:
- DisplayDriverSSD1675A
- DisplayDriverSSD1680
func (*EPaper296x128Bricklet) GetDisplayType ¶
func (device *EPaper296x128Bricklet) GetDisplayType() (displayType DisplayType, err error)
Returns the type of the e-paper display. It can either be black/white/red or black/white/gray.
Associated constants:
- DisplayTypeBlackWhiteRed
- DisplayTypeBlackWhiteGray
func (*EPaper296x128Bricklet) GetDrawStatus ¶
func (device *EPaper296x128Bricklet) GetDrawStatus() (drawStatus DrawStatus, err error)
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.
Associated constants:
- DrawStatusIdle
- DrawStatusCopying
- DrawStatusDrawing
func (*EPaper296x128Bricklet) GetIdentity ¶
func (device *EPaper296x128Bricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)
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 <isolator_bricklet>` is always at position 'z'.
The device identifier numbers can be found `here <device_identifier>`. |device_identifier_constant|
func (*EPaper296x128Bricklet) GetResponseExpected ¶
func (device *EPaper296x128Bricklet) GetResponseExpected(functionID Function) (bool, error)
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.
See SetResponseExpected for the list of function ID constants available for this function.
func (*EPaper296x128Bricklet) GetSPITFPErrorCount ¶
func (device *EPaper296x128Bricklet) GetSPITFPErrorCount() (errorCountAckChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)
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.
func (*EPaper296x128Bricklet) GetStatusLEDConfig ¶
func (device *EPaper296x128Bricklet) GetStatusLEDConfig() (config StatusLEDConfig, err error)
Returns the configuration as set by SetStatusLEDConfig
Associated constants:
- StatusLEDConfigOff
- StatusLEDConfigOn
- StatusLEDConfigShowHeartbeat
- StatusLEDConfigShowStatus
func (*EPaper296x128Bricklet) GetUpdateMode ¶
func (device *EPaper296x128Bricklet) GetUpdateMode() (updateMode UpdateMode, err error)
Returns the update mode as set by SetUpdateMode.
Associated constants:
- UpdateModeDefault
- UpdateModeBlackWhite
- UpdateModeDelta
func (*EPaper296x128Bricklet) ReadBlackWhite ¶
func (device *EPaper296x128Bricklet) ReadBlackWhite(xStart uint16, yStart uint8, xEnd uint16, yEnd uint8) (pixels []bool, err error)
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.
func (*EPaper296x128Bricklet) ReadBlackWhiteLowLevel ¶
func (device *EPaper296x128Bricklet) ReadBlackWhiteLowLevel(xStart uint16, yStart uint8, xEnd uint16, yEnd uint8) (pixelsLength uint16, pixelsChunkOffset uint16, pixelsChunkData [464]bool, err error)
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.
func (*EPaper296x128Bricklet) ReadColor ¶
func (device *EPaper296x128Bricklet) ReadColor(xStart uint16, yStart uint8, xEnd uint16, yEnd uint8) (pixels []bool, err error)
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.
func (*EPaper296x128Bricklet) ReadColorLowLevel ¶
func (device *EPaper296x128Bricklet) ReadColorLowLevel(xStart uint16, yStart uint8, xEnd uint16, yEnd uint8) (pixelsLength uint16, pixelsChunkOffset uint16, pixelsChunkData [464]bool, err error)
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.
func (*EPaper296x128Bricklet) ReadUID ¶
func (device *EPaper296x128Bricklet) ReadUID() (uid uint32, err error)
Returns the current UID as an integer. Encode as Base58 to get the usual string version.
func (*EPaper296x128Bricklet) RegisterDrawStatusCallback ¶
func (device *EPaper296x128Bricklet) RegisterDrawStatusCallback(fn func(DrawStatus)) uint64
Callback for the current draw status. Will be called every time the draw status changes (see GetDrawStatus).
func (*EPaper296x128Bricklet) Reset ¶
func (device *EPaper296x128Bricklet) Reset() (err error)
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!
func (*EPaper296x128Bricklet) SetBootloaderMode ¶
func (device *EPaper296x128Bricklet) SetBootloaderMode(mode BootloaderMode) (status BootloaderStatus, err error)
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.
Associated constants:
- BootloaderModeBootloader
- BootloaderModeFirmware
- BootloaderModeBootloaderWaitForReboot
- BootloaderModeFirmwareWaitForReboot
- BootloaderModeFirmwareWaitForEraseAndReboot
- BootloaderStatusOK
- BootloaderStatusInvalidMode
- BootloaderStatusNoChange
- BootloaderStatusEntryFunctionNotPresent
- BootloaderStatusDeviceIdentifierIncorrect
- BootloaderStatusCRCMismatch
func (*EPaper296x128Bricklet) SetDisplayDriver ¶
func (device *EPaper296x128Bricklet) SetDisplayDriver(displayDriver DisplayDriver) (err error)
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)
Associated constants:
- DisplayDriverSSD1675A
- DisplayDriverSSD1680
func (*EPaper296x128Bricklet) SetDisplayType ¶
func (device *EPaper296x128Bricklet) SetDisplayType(displayType DisplayType) (err error)
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.
Associated constants:
- DisplayTypeBlackWhiteRed
- DisplayTypeBlackWhiteGray
func (*EPaper296x128Bricklet) SetResponseExpected ¶
func (device *EPaper296x128Bricklet) SetResponseExpected(functionID Function, responseExpected bool) error
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.
func (*EPaper296x128Bricklet) SetResponseExpectedAll ¶
func (device *EPaper296x128Bricklet) SetResponseExpectedAll(responseExpected bool)
Changes the response expected flag for all setter and callback configuration functions of this device at once.
func (*EPaper296x128Bricklet) SetStatusLEDConfig ¶
func (device *EPaper296x128Bricklet) SetStatusLEDConfig(config StatusLEDConfig) (err error)
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.
Associated constants:
- StatusLEDConfigOff
- StatusLEDConfigOn
- StatusLEDConfigShowHeartbeat
- StatusLEDConfigShowStatus
func (*EPaper296x128Bricklet) SetUpdateMode ¶
func (device *EPaper296x128Bricklet) SetUpdateMode(updateMode UpdateMode) (err error)
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.
Associated constants:
- UpdateModeDefault
- UpdateModeBlackWhite
- UpdateModeDelta
func (*EPaper296x128Bricklet) SetWriteFirmwarePointer ¶
func (device *EPaper296x128Bricklet) SetWriteFirmwarePointer(pointer uint32) (err error)
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.
func (*EPaper296x128Bricklet) WriteBlackWhite ¶
func (device *EPaper296x128Bricklet) WriteBlackWhite(xStart uint16, yStart uint8, xEnd uint16, yEnd uint8, pixels []bool) (err error)
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.
func (*EPaper296x128Bricklet) WriteBlackWhiteLowLevel ¶
func (device *EPaper296x128Bricklet) WriteBlackWhiteLowLevel(xStart uint16, yStart uint8, xEnd uint16, yEnd uint8, pixelsLength uint16, pixelsChunkOffset uint16, pixelsChunkData [432]bool) (err error)
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.
func (*EPaper296x128Bricklet) WriteColor ¶
func (device *EPaper296x128Bricklet) WriteColor(xStart uint16, yStart uint8, xEnd uint16, yEnd uint8, pixels []bool) (err error)
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.
func (*EPaper296x128Bricklet) WriteColorLowLevel ¶
func (device *EPaper296x128Bricklet) WriteColorLowLevel(xStart uint16, yStart uint8, xEnd uint16, yEnd uint8, pixelsLength uint16, pixelsChunkOffset uint16, pixelsChunkData [432]bool) (err error)
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.
func (*EPaper296x128Bricklet) WriteFirmware ¶
func (device *EPaper296x128Bricklet) WriteFirmware(data [64]uint8) (status uint8, err error)
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.
func (*EPaper296x128Bricklet) WriteUID ¶
func (device *EPaper296x128Bricklet) WriteUID(uid uint32) (err error)
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.
type Function ¶
type Function = uint8
const ( FunctionDraw Function = 1 FunctionGetDrawStatus Function = 2 FunctionWriteBlackWhiteLowLevel Function = 3 FunctionReadBlackWhiteLowLevel Function = 4 FunctionWriteColorLowLevel Function = 5 FunctionReadColorLowLevel Function = 6 FunctionFillDisplay Function = 7 FunctionDrawText Function = 8 FunctionDrawLine Function = 9 FunctionDrawBox Function = 10 FunctionSetUpdateMode Function = 12 FunctionGetUpdateMode Function = 13 FunctionSetDisplayType Function = 14 FunctionGetDisplayType Function = 15 FunctionSetDisplayDriver Function = 16 FunctionGetDisplayDriver Function = 17 FunctionGetSPITFPErrorCount Function = 234 FunctionSetBootloaderMode Function = 235 FunctionGetBootloaderMode Function = 236 FunctionSetWriteFirmwarePointer Function = 237 FunctionWriteFirmware Function = 238 FunctionSetStatusLEDConfig Function = 239 FunctionGetStatusLEDConfig Function = 240 FunctionGetChipTemperature Function = 242 FunctionReset Function = 243 FunctionWriteUID Function = 248 FunctionReadUID Function = 249 FunctionGetIdentity Function = 255 FunctionCallbackDrawStatus Function = 11 )
type Orientation ¶
type Orientation = uint8
const ( OrientationHorizontal Orientation = 0 OrientationVertical Orientation = 1 )
type StatusLEDConfig ¶
type StatusLEDConfig = uint8
const ( StatusLEDConfigOff StatusLEDConfig = 0 StatusLEDConfigOn StatusLEDConfig = 1 StatusLEDConfigShowHeartbeat StatusLEDConfig = 2 StatusLEDConfigShowStatus StatusLEDConfig = 3 )
type UpdateMode ¶
type UpdateMode = uint8
const ( UpdateModeDefault UpdateMode = 0 UpdateModeBlackWhite UpdateMode = 1 UpdateModeDelta UpdateMode = 2 )