Skip to content
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

Fix SSD1803A I2C LCD adapter cursor positioning and renderer #284

Merged
merged 1 commit into from
Jan 3, 2025

Conversation

forntoh
Copy link
Owner

@forntoh forntoh commented Jan 3, 2025

Fixes #282

Summary by CodeRabbit

  • New Features
    • Updated LCD display configuration with new initialization parameters
    • Modified cursor positioning logic for LCD display

- Updated the character display renderer to include new parameters.
- Swapped row and column arguments in the cursor positioning method.
@forntoh forntoh added the bugfix I have fixed a bug label Jan 3, 2025
Copy link
Contributor

coderabbitai bot commented Jan 3, 2025

Walkthrough

The pull request addresses an issue with the SSD1803A I2C LCD adapter and character display renderer. The changes involve correcting the cursor positioning method in the SSD1803A_I2CAdapter class by swapping the row and column parameters when calling lcd->locate(). Additionally, the CharacterDisplayRenderer constructor in the example sketch is updated to include custom cursor icons specific to the DOGM204 display.

Changes

File Change Summary
examples/SSD1803A_I2C/SSD1803A_I2C.ino Updated CharacterDisplayRenderer constructor to include custom cursor icons 0xDF and 0xE1
src/display/SSD1803A_I2CAdapter.h Modified setCursor method to swap row and column parameters when calling lcd->locate()

Assessment against linked issues

Objective Addressed Explanation
Fix row & col swap in setCursor [#282]
Override default cursor icons for DOGM204 display [#282]

Poem

🐰 A rabbit's tale of LCD delight,
Rows and columns now aligned just right,
Cursors dancing with icons so bright,
From swapped to perfect, a coder's might!
Display magic, no more coding plight! 🖥️


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8e76a22 and e9be26f.

📒 Files selected for processing (2)
  • examples/SSD1803A_I2C/SSD1803A_I2C.ino (1 hunks)
  • src/display/SSD1803A_I2CAdapter.h (1 hunks)
🔇 Additional comments (2)
examples/SSD1803A_I2C/SSD1803A_I2C.ino (1)

18-18: Ensure correct usage of custom characters (0xDF, 0xE1).
The new parameters appear to define custom LCD glyphs/icons. Verify that these character codes (0xDF, 0xE1) are valid for your display and do not conflict with other custom glyphs. Also confirm their usage aligns with the rest of the rendering logic so as to avoid unexpected character overlaps or corrupt display behavior.

src/display/SSD1803A_I2CAdapter.h (1)

39-39: Confirm parameter order with the underlying SSD1803A_I2C library.
Swapping the parameters to lcd->locate(row, col) assumes the library expects (row, col) in that order. Verify in the library documentation that (row, col) is correct—otherwise, you might be exposing a visual mismatch between actual and expected cursor positioning.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@coderabbitai coderabbitai bot changed the title @coderabbitai Fix SSD1803A I2C LCD adapter cursor positioning and renderer Jan 3, 2025
@forntoh forntoh merged commit 097a5b6 into master Jan 3, 2025
22 checks passed
@forntoh forntoh deleted the bf/282-bug-ssd1803a_i2cadapterh-row--col-ar branch January 3, 2025 21:46
@coderabbitai coderabbitai bot mentioned this pull request Feb 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bugfix I have fixed a bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG]: SSD1803A_I2CAdapter.h row & col are swapped in setCursor function.
1 participant