Bulk of Library Work Completed

[makermelissa]

This is the initial work for Circuit Python and is based of of the Adafruit RA8875 Arduino Library, but with some structural changes so that it's even easier to use. Many of the function names and parameters are intended to coincide with the GFX library for easy of porting code over. I have also ran this through PyLint and the only things coming up are import-errors and I'm sure that has to do with my setup as it functions perfectly.

There are 2 examples. One goes through all of the hardware accelerated drawing function as well as displaying text and updating it. The other one will decode and draw a bitmap onto the screen using the fastest drawing methods available.

[kattni]

Thanks for putting this together!!

It looks like you may have missed copying the .files from the cookiecutter output. This includes, but is not limited to, .travis.yml and .readthedocs.yml. Please either copy them from your cookiecutter output, or if you've deleted it already, you can rerun cookiecutter and copy only those files into your working directory and push them to this branch. Thanks!

[makermelissa]

Good catch. They probably didn’t copy over because they were hidden. — Melissa LeBlanc-Williams Check out my YouTube Channel at https://www.youtube.com/channel/UCmDzlRL-Wkg3HCBlF58A4cw Follow me on Twitter at https://twitter.com/makermelissa

…

On Jan 19, 2019, at 1:45 PM, Kattni ***@***.***> wrote: @kattni requested changes on this pull request. Thanks for putting this together!! It looks like you may have missed copying the .files from the cookiecutter output. This includes .travis.yml and .readthedocs.yml. Please either copy them from your cookiecutter output, or if you've deleted it already, you can rerun cookiecutter and copy only those files into your working directory and push them to this branch. Thanks! — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#1 (review)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ACjqSTZLl-3wL4yxWi--n36bgpOUMJeUks5vE5HpgaJpZM4aJWN3>.

[makermelissa]

Ok, I re-added the files. to I need to create a new PR? — Melissa LeBlanc-Williams Check out my YouTube Channel at https://www.youtube.com/channel/UCmDzlRL-Wkg3HCBlF58A4cw Follow me on Twitter at https://twitter.com/makermelissa

…

On Jan 19, 2019, at 1:45 PM, Kattni ***@***.***> wrote: @kattni requested changes on this pull request. Thanks for putting this together!! It looks like you may have missed copying the .files from the cookiecutter output. This includes .travis.yml and .readthedocs.yml. Please either copy them from your cookiecutter output, or if you've deleted it already, you can rerun cookiecutter and copy only those files into your working directory and push them to this branch. Thanks! — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#1 (review)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ACjqSTZLl-3wL4yxWi--n36bgpOUMJeUks5vE5HpgaJpZM4aJWN3>.

[kattni]

Perfect, thank you! Travis is now running on it and has failed. (As it does for all of us!)

We've moved to Discord for now for more immediate discussion.

Requested changes were completed, but I'm waiting to approve until Travis passes.

[sommersoft]

Holy cow! This thing is massive! Excellent work.

I rolled through and didn't see anything glaring in the code itself. I don't have any experience with this display, so I'll leave the more technical review to others.

I do have a couple suggestions with regards to documentation though.

[makermelissa]

Thanks @sommersoft. I’ll work on that today. — Melissa LeBlanc-Williams Check out my YouTube Channel at https://youtube.com/makermelissaslab Follow me on Twitter at https://twitter.com/makermelissa

…

On Jan 20, 2019, at 10:42 PM, sommersoft ***@***.***> wrote: @sommersoft requested changes on this pull request. Holy cow! This thing is massive! Excellent work. I rolled through and didn't see anything glaring in the code itself. I don't have any experience with this display, so I'll leave the more technical review to others. I do have a couple suggestions with regards to documentation though. In adafruit_ra8875/ra8875.py <#1 (comment)>: > + +__version__ = "0.0.0-auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_RA8875.git" + +#pylint: disable-msg=invalid-name +def color565(r, g=0, b=0): + """Convert red, green and blue values (0-255) into a 16-bit 565 encoding.""" + try: + r, g, b = r # see if the first var is a tuple/list + except TypeError: + pass + return (r & 0xf8) << 8 | (g & 0xfc) << 3 | b >> 3 +#pylint: enable-msg=invalid-name + +class RA8875_Device(object): + """Set Initial Variables""" Can you add parameter descriptions for the class, so they're available in the documentation? Example: """ Writes the specified 'payload' to the sensor Returns the results of the write attempt. :param bytearray payload: The byte array to write to the sensor :param rxlen: (optional) The numbers of bytes to read back (default=0) """ Requesting this for each class, as well as each public function (private function docs aren't built by default, though can be forced). In docs/api.rst <#1 (comment)>: > @@ -0,0 +1,12 @@ + +.. If you created a package, create one automodule per module in the package. + +.. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py) +.. use this format as the module name: "adafruit_foo.foo" + +.. automodule:: adafruit_ra8875.ra8875 + :members: + +.. automodule:: adafruit_ra8875.registers + :members: registers seems to be for internal use only? If they aren't going to be exposed to the user, I don't really see a need to list them in the documentation. May add a layer of confusion. I can definitely be overruled on this, though. 😄 — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#1 (review)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ACjqSR2fVBkBru97nTFjs6wF_SmiwIviks5vFWFEgaJpZM4aJWN3>.

[makermelissa]

I've gone ahead and made the above changes. It passed on Travis just fine and I don't think there's anything left to do on my end.

[makermelissa]

I just noticed you said that private functions don't have comments built by default, so I reduced those to reduce file size. Also I just made brightness public in case somebody want's to adjust the backlight with code.

[tannewt]

This looks awesome to me! Definitely thinking about how this will fit into displayio. Are there other similar accelerated displays like this? Seems like we'll need a primitive to hold drawing commands as opposed to pixels. Thanks for the library!

[makermelissa]

@tannewt Thanks! There are most likely other hardware accelerated graphics chips like this, but I'm not aware of anything specific.

[kattni]

Thank you again!