Skip to content

WIP: feat: Partial update #68

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Conversation

kienvo
Copy link
Member

@kienvo kienvo commented Jun 20, 2025

Resolves #58

Summary by Sourcery

Implement partial update capability by adding protocol commands for setting a partial window and toggling partial mode, and integrate these into the display update sequence

New Features:

  • Add methods to configure a partial display window and to enter/exit partial update mode for the e-paper display
  • Integrate partial update setup into the image rendering and refresh workflow

Enhancements:

  • Validate partial window parameters with bounds checks before sending commands

Copy link
Contributor

sourcery-ai bot commented Jun 20, 2025

Reviewer's Guide

This PR adds support for partial updates on the E-Paper display by introducing new private methods to configure and control a partial window (_setPartialWindow, _partialIn, _partialOut) with input validation and bit-level command packing, and integrates these calls into the existing frame transmission and refresh sequence.

Sequence diagram for partial update integration in E-Paper refresh

sequenceDiagram
    participant App
    participant Protocol
    participant EPDController
    participant FlutterNfcKit

    App->>Protocol: refresh(id, image, epd)
    Protocol->>Protocol: _setPartialWindow(id, 0, epd.width/8-1, 0, epd.height-1, true)
    Protocol->>EPDController: epd.extractEpaperColorFrames(image)
    loop for each color frame
        Protocol->>EPDController: transmissionLines.current
        Protocol->>Protocol: writeFrame(id, color, transmissionLine)
    end
    Protocol->>Protocol: _setPartialWindow(id, 0, 15, 0, 200, true)
    Protocol->>Protocol: _partialIn(id)
    Protocol->>Protocol: _writeMsg([fw.epdCmd, epd.controller.refresh])
    Protocol->>FlutterNfcKit: finish()
Loading

Class diagram for Protocol class with partial update methods

classDiagram
    class Protocol {
        +Future<Uint8List> enableEnergyHarvesting(Uint8List tagId)
        +Future<void> _sleep()
        +Future refresh(Uint8List id, Image image, EPD epd)
        -Future<Uint8List> _setPartialWindow(Uint8List tagId, int xsbank, int xebank, int ys, int ye, bool pt_scan)
        -void _partialIn(Uint8List tagId)
        -void _partialOut(Uint8List tagId)
    }
Loading

File-Level Changes

Change Details Files
Implemented partial window configuration and control commands
  • Defined _setPartialWindow with parameter validation and bitwise assembly of window bytes
  • Created _partialIn and _partialOut to send enter/exit partial mode commands
  • Leveraged _writeMsg to dispatch EPD command and data sequences
lib/util/protocol.dart
Integrated partial update into the image transmission flow
  • Added initial _setPartialWindow call after power-on delay
  • Inserted a second _setPartialWindow and _partialIn before issuing the refresh command
  • Ensured the partial window parameters match display width/height and scanning flag
lib/util/protocol.dart

Assessment against linked issues

Issue Objective Addressed Explanation
#58 Implement partial updates to the e-paper display, allowing specific regions to be refreshed without affecting the entire screen.

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@kienvo
Copy link
Member Author

kienvo commented Jun 20, 2025

Partial refreshing won't fix the blurred pixels issue:

image

Hopefully #59 will fix this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Partial update
1 participant