Skip to content

Rename Protomatter to RGBMatrix #2775

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

Merged
merged 15 commits into from
Apr 20, 2020
Merged

Rename Protomatter to RGBMatrix #2775

merged 15 commits into from
Apr 20, 2020

Conversation

jepler
Copy link

@jepler jepler commented Apr 15, 2020

In the interest of time, this only renames the user facing parts, a cleanup PR to rename internally will come later on.
This renames the user-facing parts as well as the identifiers that are internal to CircuitPython.

Closes: #2776

@jepler
Copy link
Author

jepler commented Apr 15, 2020

This also has the changes from #2774

@jepler
Copy link
Author

jepler commented Apr 15, 2020

User facing names:

>>> import rgbmatrix
>>> rgbmatrix
<module 'rgbmatrix'>
>>> rgbmatrix.RGBMatrix
<class 'RGBMatrix'>

Constructing and using:

matrix = rgbmatrix.RGBMatrix(
    width=64, height=32, bit_depth=3,
    rgb_pins=[board.D6, board.D5, board.D9, board.D11, board.D10, board.D12],
    addr_pins=[board.A5, board.A4, board.A3, board.A2],
    clock_pin=board.D13, latch_pin=board.D0, output_enable_pin=board.D1)
display = framebufferio.FramebufferDisplay(matrix, auto_refresh=False)

@tannewt tannewt requested a review from dhalbert April 15, 2020 17:04
@jepler jepler changed the title Rename Protomatter to RGBMatrix, as far as users are concerned Rename Protomatter to RGBMatrix Apr 15, 2020
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.

One question. Good otherwise!

//|
//| .. class:: Protomatter(width, bit_depth, rgb_pins, addr_pins, clock_pin, latch_pin, output_enable_pin, *, doublebuffer=True, framebuffer=None)
//| .. class:: RGBMatrix(width, bit_depth, rgb_pins, addr_pins, clock_pin, latch_pin, output_enable_pin, *, doublebuffer=True, framebuffer=None)
Copy link
Member

Choose a reason for hiding this comment

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

I thought we added height here. Did it get lost in the PR shuffle?

Copy link
Author

Choose a reason for hiding this comment

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

Docs got out of date. Fixed now?

tannewt
tannewt previously approved these changes Apr 16, 2020
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!

@jepler
Copy link
Author

jepler commented Apr 17, 2020

At this point, Actions reports '80 successful, 43 queued, and 1 in progress checks'. build-arm (circuitplayground_bluefruit) started 19h 17m 4s ago and has been running the step 'build' for 19h 15m 35s. The log for the build step can't be viewed.

I'm going to cancel and re-run, and if that doesn't break it loose, I'll push a nonessential change. Hopefully one of those will get this on the road again.

jepler added 14 commits April 17, 2020 18:43
I originally believed that there would be a wrapper library around it,
like with _pixelbuf; but this proves not to be the case, as there's
too little for the library to do.
This is a quick rename, it changes the user-facing names but not the
internal names of things.
This gets all the purely internal references.  Some uses of
protomatter/Protomatter/PROTOMATTER remain, as they are references
to symbols in the Protomatter C library itself.
... allocate_display_bus_or_raise() uses fixed storage, not heap storage.
@jepler
Copy link
Author

jepler commented Apr 17, 2020

Rebased and "make translate"d again.

@jepler
Copy link
Author

jepler commented Apr 18, 2020

In my own fork's actions, 9bfe6b7 (framebufferio: update copyright information) succeeded instead of hanging: https://github.com/jepler/circuitpython/actions/runs/80760861 -- however, for circuitpython it was hung and I cancelled it.

@jepler
Copy link
Author

jepler commented Apr 19, 2020

@tannewt Again, this PR build hung. I've made another non-essential change.

Copy link
Member

@ladyada ladyada left a comment

Choose a reason for hiding this comment

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

tested with feather m4 + 32x64 matrix!

@jepler jepler requested a review from tannewt April 19, 2020 18:34
@jepler
Copy link
Author

jepler commented Apr 19, 2020

@tannewt actions finally finished this time!

@jepler jepler merged commit 276241b into adafruit:master Apr 20, 2020
@jepler jepler deleted the rgbmatrix branch November 3, 2021 21:10
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.

Rename remaining protomatter mentions to rgbmatrix
3 participants