feat: add framebuffer command helpers for reading and saving PNGs #4
+83
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
urish
requested changes
Aug 20, 2025
src/wokwi_client/client.py
Outdated
| @@ -233,3 +240,23 @@ async def set_control( | |||
| value: Control value to set (float). | |||
| """ | |||
| return await set_control(self._transport, part=part, control=control, value=value) | |||
|
|
|||
| async def framebuffer_read(self, id: str) -> ResponseMessage: | |||
There was a problem hiding this comment.
What's the use case for this API?
IMHO if there's no good use case, let's not expose it, since it is can be confusing when you have both framebuffer_read and framebuffer_png_bytes.
src/wokwi_client/client.py
Outdated
|
|
||
| async def compare_framebuffer_png( | ||
| self, id: str, reference: Path, save_mismatch: Optional[Path] = None | ||
| ) -> bool: |
There was a problem hiding this comment.
IMHO that doesn't belong to the API - it's better if users implement their own comparison logic as they want (and byte-by-byte comparison may break when we upgrade our PNG library, for example).
src/wokwi_client/client.py
Outdated
| """Read the current framebuffer for the given device id.""" | ||
| return await framebuffer_read(self._transport, id=id) | ||
|
|
||
| async def framebuffer_png_bytes(self, id: str) -> bytes: |
There was a problem hiding this comment.
Let's keep the naming convention consistent. If other methods are called "save_framebuffer_...", then this one should be "get_framebuffer_png_bytes" (or read_...)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request adds a new set of framebuffer utilities to the client, making it easier to interact with devices that expose a framebuffer (such as LCD modules). The main changes include introducing a new
framebuffer.pymodule with helper functions for reading, saving, and comparing framebuffer images, and exposing these helpers through the main client interface.