Skip to content

Conversation

@microbit-mark
Copy link
Contributor

@microbit-mark microbit-mark commented Dec 15, 2020

Doc update to include support for RGBW Neopixels. I haven't tested this on hardware, so making an assumption that the values are in the order written eg np[0]= (R, G, B, W) as opposed to GRBW which I think is the default for NeoPixelsand we order them here https://github.com/microbit-foundation/micropython-microbit-v2/blob/6a4b97ffce97a41a593e77553a82e24e59b7107c/src/codal_port/modules/neopixel.py#L19

Copy link
Collaborator

@microbit-carlos microbit-carlos left a comment

Choose a reason for hiding this comment

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

Co-authored-by: Carlos Pereira Atencio <[email protected]>
@microbit-mark
Copy link
Contributor Author

V1 has clear and show. V2 has clear, write, fill, show

@microbit-mark
Copy link
Contributor Author

I've updated to add the V2 methods in 9641853

Not sure on how best to present write() as I think it is equivalent to show().

Also not sure on how to present arguments for fill(). Is fill((r,g,b)) okay or should it be n,n,n or better to show the format in the description?

@microbit-carlos
Copy link
Collaborator

Not sure on how best to present write() as I think it is equivalent to show().

Yeah, they are equivalent. The current text is good, although if you need to edit the file anyway I might remove is available as part of the RGBW implementation and, just mentioning that they are equivalent is good enough.

Also not sure on how to present arguments for fill(). Is fill((r,g,b)) okay or should it be n,n,n or better to show the format in the description?

Showing the tuple would be difficult, as the length depends on how many bytes per pixel. I think it's fine to just name the argument color, as done in the python source code, and then in the description mention that it has to be a tuple of the same length as the number of colours per pixel, as configured in the constructor.

@microbit-carlos
Copy link
Collaborator

Perfect, thanks Mark!
Ready for merge 🎉

@microbit-carlos microbit-carlos merged commit 3253ecb into bbcmicrobit:v2-docs Dec 18, 2020
microbit-carlos added a commit to microbit-carlos/micropython that referenced this pull request Apr 12, 2022
* Docs: update for RGBW neopixel

* Docs: RGBW neopixels

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* change to bpp

* change to bpp

* add image attribution

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Add V2 methods

* Docs: Update neopixel

Co-authored-by: Carlos Pereira Atencio <[email protected]>
microbit-carlos added a commit to microbit-carlos/micropython that referenced this pull request Apr 12, 2022
Based on the changes added to the V2 documentation from PR
bbcmicrobit#694

Co-authored-by: Carlos Pereira Atencio <[email protected]>
microbit-carlos added a commit to microbit-carlos/micropython that referenced this pull request Apr 12, 2022
Based on the changes added to the V2 documentation from PR
bbcmicrobit#694

Co-authored-by: Carlos Pereira Atencio <[email protected]>
microbit-carlos added a commit to microbit-carlos/micropython that referenced this pull request Apr 12, 2022
Based on the changes added to the V2 documentation from PR
bbcmicrobit#694

Co-authored-by: Carlos Pereira Atencio <[email protected]>
microbit-carlos added a commit to microbit-carlos/micropython that referenced this pull request Apr 19, 2022
* Docs: update for RGBW neopixel

* Docs: RGBW neopixels

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* change to bpp

* change to bpp

* add image attribution

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Add V2 methods

* Docs: Update neopixel

Co-authored-by: Carlos Pereira Atencio <[email protected]>
microbit-carlos added a commit that referenced this pull request Apr 21, 2022
* docs: Update V1 neopixel module support for RGBW.

Based on the changes added to the V2 documentation from PR
#694

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* docs: Fix typo in NeoPixel module.

Co-authored-by: Mark <[email protected]>

Co-authored-by: Mark <[email protected]>
microbit-carlos added a commit to microbit-carlos/micropython that referenced this pull request Apr 21, 2022
* Docs: update for RGBW neopixel

* Docs: RGBW neopixels

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* change to bpp

* change to bpp

* add image attribution

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Add V2 methods

* Docs: Update neopixel

Co-authored-by: Carlos Pereira Atencio <[email protected]>
microbit-carlos added a commit to microbit-carlos/micropython that referenced this pull request Apr 21, 2022
* Docs: update for RGBW neopixel

* Docs: RGBW neopixels

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* change to bpp

* change to bpp

* add image attribution

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Add V2 methods

* Docs: Update neopixel

Co-authored-by: Carlos Pereira Atencio <[email protected]>
microbit-carlos added a commit to microbit-carlos/micropython that referenced this pull request Apr 25, 2022
* Docs: update for RGBW neopixel

* Docs: RGBW neopixels

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* change to bpp

* change to bpp

* add image attribution

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Add V2 methods

* Docs: Update neopixel

Co-authored-by: Carlos Pereira Atencio <[email protected]>
microbit-carlos added a commit to microbit-carlos/micropython that referenced this pull request Apr 28, 2022
* Docs: update for RGBW neopixel

* Docs: RGBW neopixels

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* change to bpp

* change to bpp

* add image attribution

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Add V2 methods

* Docs: Update neopixel

Co-authored-by: Carlos Pereira Atencio <[email protected]>
microbit-carlos added a commit that referenced this pull request Apr 29, 2022
* Docs: update for RGBW neopixel

* Docs: RGBW neopixels

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* change to bpp

* change to bpp

* add image attribution

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Add V2 methods

* Docs: Update neopixel

Co-authored-by: Carlos Pereira Atencio <[email protected]>
microbit-carlos added a commit that referenced this pull request Jun 17, 2022
* Docs: update for RGBW neopixel

* Docs: RGBW neopixels

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* change to bpp

* change to bpp

* add image attribution

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Add V2 methods

* Docs: Update neopixel

Co-authored-by: Carlos Pereira Atencio <[email protected]>
microbit-carlos added a commit to microbit-carlos/micropython that referenced this pull request Sep 6, 2022
* Docs: update for RGBW neopixel

* Docs: RGBW neopixels

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* change to bpp

* change to bpp

* add image attribution

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Add V2 methods

* Docs: Update neopixel

Co-authored-by: Carlos Pereira Atencio <[email protected]>
microbit-carlos added a commit that referenced this pull request Nov 15, 2022
* Docs: update for RGBW neopixel

* Docs: RGBW neopixels

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* change to bpp

* change to bpp

* add image attribution

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Add V2 methods

* Docs: Update neopixel

Co-authored-by: Carlos Pereira Atencio <[email protected]>
microbit-carlos added a commit that referenced this pull request Nov 15, 2022
* Docs: update for RGBW neopixel

* Docs: RGBW neopixels

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* change to bpp

* change to bpp

* add image attribution

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Add V2 methods

* Docs: Update neopixel

Co-authored-by: Carlos Pereira Atencio <[email protected]>
microbit-carlos added a commit to microbit-carlos/micropython that referenced this pull request Feb 26, 2024
* Docs: update for RGBW neopixel

* Docs: RGBW neopixels

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* change to bpp

* change to bpp

* add image attribution

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Add V2 methods

* Docs: Update neopixel

Co-authored-by: Carlos Pereira Atencio <[email protected]>
microbit-carlos added a commit that referenced this pull request Feb 26, 2024
* Docs: update for RGBW neopixel

* Docs: RGBW neopixels

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* change to bpp

* change to bpp

* add image attribution

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Add V2 methods

* Docs: Update neopixel

Co-authored-by: Carlos Pereira Atencio <[email protected]>
microbit-carlos added a commit that referenced this pull request May 7, 2024
* Docs: update for RGBW neopixel

* Docs: RGBW neopixels

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* change to bpp

* change to bpp

* add image attribution

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Add V2 methods

* Docs: Update neopixel

Co-authored-by: Carlos Pereira Atencio <[email protected]>
microbit-carlos added a commit that referenced this pull request Jul 18, 2024
* Docs: update for RGBW neopixel

* Docs: RGBW neopixels

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* change to bpp

* change to bpp

* add image attribution

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Add V2 methods

* Docs: Update neopixel

Co-authored-by: Carlos Pereira Atencio <[email protected]>
microbit-carlos added a commit that referenced this pull request Sep 16, 2024
* Docs: update for RGBW neopixel

* Docs: RGBW neopixels

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* change to bpp

* change to bpp

* add image attribution

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Add V2 methods

* Docs: Update neopixel

Co-authored-by: Carlos Pereira Atencio <[email protected]>
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