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

Driver for Pervasive Display's Aurora based E-ink display #9488

Merged
merged 21 commits into from
Aug 12, 2024

Conversation

wyrdsec
Copy link

@wyrdsec wyrdsec commented Aug 8, 2024

A driver for Pervasive Displays Aurora CoG chipsets:
https://www.mouser.com/new/pervasive-displays/pervasive-displays-aurora-mb-displays/

My group used these displays for a Circuitpython badge we created, and this driver came from that effort.

The driver uses framebufferio.FramebufferDisplay (very similar to the sharpdisplay module) to interact with displayio. I has support for the 1.44", 2", 2.7", 1.9", and 2.6" sized Aurora EPD products, however I only have the 2" sized EPD so that is all I can test at this time.

This module will not be included in compilation by default, as I set the CIRCUITPY_AURORA_EPAPER define to 0. No other boards use this display AFAIK so I have just been setting that def in mpconfigboard.mk.

Copy link
Member

@tannewt tannewt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Looks like you'll need to format via pre-commit and then it'll be good to go. https://learn.adafruit.com/improve-your-code-with-pylint/check-your-code-with-pre-commit

@wyrdsec
Copy link
Author

wyrdsec commented Aug 9, 2024

I'm sorry but I can't seem to wrangle sphinx to do what I need. For some reason the second line of the docs comment is being included in the title of the page.

//| class AuroraMemoryFramebuffer:
//|     """A framebuffer for Pervasive Displays Aurora E-paper displays.
//|
//|     These displays are 2 color only.

Do I need another line break or special character to stop it from doing this?

@tannewt
Copy link
Member

tannewt commented Aug 9, 2024

That looks right to me. Can you share a screenshot of what it is doing? There should be a matching .pyi file somewhere with the Python stub version. That may make it clearer.

@wyrdsec
Copy link
Author

wyrdsec commented Aug 9, 2024

I was looking at the latest github build actions version here: https://circuitpython--9488.org.readthedocs.build/en/9488/shared-bindings/aurora_epaper/index.html

However, it seems like its working the way I expect now. I must have been seeing an old cached page on my browser.

Copy link
Member

@tannewt tannewt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great! Thank you!

@tannewt tannewt merged commit d9fcaa0 into adafruit:main Aug 12, 2024
536 checks passed
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.

2 participants