add definition WS2812_BYTE_ORDER to fix RGB LED issues #10184

hineybush · 2020-08-27T14:48:18Z

Description

While flashing and repairing some hbcp PCBs, I realized that the LEDs were not showing the correct color - specifically that the red and green channels were reversed. The LEDs on the board are WS2812B-2020 from WorldSemi. I replaced one LED with a WS2812C-2020, and it was the correct colors, according to the VIA output (and QMK). After examining the datasheets for each LED, I found that even though the software is the same (G, R then B, 1 byte each) the hardware is not - the red and green LEDs are reversed physically!

https://i.imgur.com/kB3mPyI.jpg

https://i.imgur.com/dmB1aY1.png

I created a definition, WS2812_BYTE_ORDER in color.h to define the byte order for the LED. The RGB definition swaps the R and G bytes and corrects the color issue.

https://i.imgur.com/sLcRLYU.jpg

If WS2812B-2020 LEDs are used, #define WS2812_BYTE_ORDER WS2812_BYTE_ORDER_RGB should be placed in the config.h file. I tested this successfully with the hbcp code.

This added definition should not affect any other existing PCBs without it, due to defaulting to the "standard" GRB structure. I tested this with a few PCBs I had on hand, namely h88, h87a and some prototypes.

Thanks to @Xelus22 for the assistance.

Types of Changes

Issues Fixed or Closed by This PR

Incorrect RGB coloring with WS2812B-2020 LEDs due to byte structure difference

Checklist

My code follows the code style of this project: C, Python
I have read the PR Checklist document and have made the appropriate changes.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
I have tested the changes and verified that they work and don't break anything (as well as I can manage).

fauxpark · 2020-08-27T14:59:34Z

This should probably be made more generic just in case there are other WS2812 parts with this/other byte orders.

eg. WS2812_ORDER_RGB etc.

hineybush · 2020-08-27T15:15:33Z

making this more generic, will update

hineybush · 2020-08-27T15:45:45Z

@fauxpark updated!

quantum/color.h

docs/ws2812_driver.md

fauxpark · 2020-08-27T15:56:53Z

This PR will also need to be retargeted and rebased onto develop.

quantum/color.h

docs/ws2812_driver.md

tzarc · 2020-08-27T21:58:58Z

This won't work for any of the ChibiOS drivers, as they have to manipulate the data as it goes out.

tzarc · 2020-08-27T22:35:29Z

I've actually got some WS2812C-2020's already, will see if I can get something breadboardable for testing purposes.

EDIT: Never mind, was the B's that have the reversed order.

tzarc · 2020-08-27T22:49:24Z

For ChibiOS, we'd need to give these a similar treatment:
https://github.com/qmk/qmk_firmware/blob/master/drivers/chibios/ws2812.c#L90...L98
https://github.com/qmk/qmk_firmware/blob/master/drivers/chibios/ws2812_pwm.c#L107...L141
https://github.com/qmk/qmk_firmware/blob/master/drivers/chibios/ws2812_spi.c#L65...L67

docs/ws2812_driver.md

zvecr

Aligning docs to match tz's suggested changes.

docs/ws2812_driver.md

hineybush · 2020-08-28T00:47:44Z

@tzarc I would definitely appreciate help with the ChibiOS side as I don't have any development platforms currently, nor do I plan to have any in the near future.

tzarc · 2020-08-28T01:03:05Z

Should be relatively straightforward, based on the #define you added:

Bitbang (ws2812.c) can just have the lines I linked to reordered
PWM (ws2812_pwm.c) can have the 0, 1, and 2 modified
SPI (ws2812_spi.c) can have the color.r, color.g, color.b reordered

hineybush · 2020-08-28T14:45:25Z

@tzarc for testing, you can still use the WS2812C's - the code will do the opposite however. when #define WS2812_BYTE_ORDER WS2812_BYTE_ORDER_RGB is used it will reverse the green and red channels.

stale · 2020-10-21T02:03:08Z

Thank you for your contribution!
This pull request has been automatically marked as stale because it has not had activity in the last 45 days. It will be closed in 30 days if no further activity occurs. Please feel free to give a status update now, or re-open when it's ready.
For maintainers: Please label with awaiting review, breaking_change, in progress, or on hold to prevent the issue from being re-flagged.

Ws2812 byte order 2

hineybush · 2020-10-27T05:07:04Z

@tzarc my man @Xelus22 just added the PR to my repo, which I just merged into here.

tzarc · 2020-10-27T05:18:59Z

@tzarc my man @Xelus22 just added the PR to my repo, which I just merged into here.

Awesome, cheers for that. I believe there was a request to get RGBW sorted, but I'm okay with leaving that for a separate PR... @qmk/collaborators thoughts?

docs/ws2812_driver.md

Co-authored-by: Ryan <fauxpark@gmail.com>

noroadsleft

Slight __attribute__ ((weak)) ✔️

* add define for WS2812B-2020 to fix RGB issues * update driver doc * add WS2812_BYTE_ORDER definition to correct RGB byte issues * add definition variable thing * update per PR request * update per PR reqs * update per PR request * inital changes * move defines to color.h and add rgbw incase * Update docs/ws2812_driver.md Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: hineybush <hineybushkeyboards@gmail.com> Co-authored-by: Xelus22 <preyas22@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>

hineybush added 2 commits August 27, 2020 10:41

add define for WS2812B-2020 to fix RGB issues

7e7ca72

update driver doc

533866a

add WS2812_BYTE_ORDER definition to correct RGB byte issues

278fc6b

add definition variable thing

df6c54a

hineybush changed the title ~~add definition for WS2812B-2020 to fix RGB issues~~ add definition WS2812_BYTE_ORDER to fix RGB LED issues Aug 27, 2020

fauxpark requested changes Aug 27, 2020

View reviewed changes

quantum/color.h Outdated Show resolved Hide resolved

quantum/color.h Outdated Show resolved Hide resolved

fauxpark requested changes Aug 27, 2020

View reviewed changes

docs/ws2812_driver.md Outdated Show resolved Hide resolved

fauxpark added bug core enhancement labels Aug 27, 2020

fauxpark requested a review from a team August 27, 2020 15:56

update per PR request

9e06514

fauxpark requested changes Aug 27, 2020

View reviewed changes

quantum/color.h Show resolved Hide resolved

quantum/color.h Show resolved Hide resolved

fauxpark requested changes Aug 27, 2020

View reviewed changes

docs/ws2812_driver.md Outdated Show resolved Hide resolved

docs/ws2812_driver.md Outdated Show resolved Hide resolved

fauxpark added the documentation label Aug 27, 2020

update per PR reqs

da1f557

tzarc requested changes Aug 27, 2020

View reviewed changes

docs/ws2812_driver.md Show resolved Hide resolved

zvecr reviewed Aug 27, 2020

View reviewed changes

docs/ws2812_driver.md Outdated Show resolved Hide resolved

update per PR request

8cf2a50

inital changes

de6626e

drashna requested a review from a team September 5, 2020 22:47

stale bot added awaiting changes and removed awaiting changes labels Oct 21, 2020

move defines to color.h and add rgbw incase

70b8ad8

tzarc added the in progress label Oct 27, 2020

tzarc mentioned this pull request Oct 27, 2020

[Feature Request / Bug] Arm SPI support for RGBW LEDs #9821

Closed

4 tasks

Merge pull request #3 from Xelus22/ws2812_byte_order

c670840

Ws2812 byte order 2

fauxpark approved these changes Oct 27, 2020

View reviewed changes

drashna reviewed Nov 5, 2020

View reviewed changes

docs/ws2812_driver.md Show resolved Hide resolved

fauxpark requested changes Nov 5, 2020

View reviewed changes

docs/ws2812_driver.md Outdated Show resolved Hide resolved

fauxpark mentioned this pull request Nov 11, 2020

Add support for #define WS2812_RGB to support non-standard implementa… #10916

Closed

10 tasks

Update docs/ws2812_driver.md

c957bca

Co-authored-by: Ryan <fauxpark@gmail.com>

fauxpark approved these changes Nov 22, 2020

View reviewed changes

fauxpark requested a review from a team November 22, 2020 11:17

noroadsleft approved these changes Dec 5, 2020

View reviewed changes

tzarc merged commit c59f87a into qmk:master Dec 6, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add definition WS2812_BYTE_ORDER to fix RGB LED issues #10184

add definition WS2812_BYTE_ORDER to fix RGB LED issues #10184

hineybush commented Aug 27, 2020 •

edited

Loading

fauxpark commented Aug 27, 2020 •

edited

Loading

hineybush commented Aug 27, 2020

hineybush commented Aug 27, 2020

fauxpark commented Aug 27, 2020

tzarc commented Aug 27, 2020

tzarc commented Aug 27, 2020 •

edited

Loading

tzarc commented Aug 27, 2020

zvecr left a comment

hineybush commented Aug 28, 2020

tzarc commented Aug 28, 2020

hineybush commented Aug 28, 2020

stale bot commented Oct 21, 2020

hineybush commented Oct 27, 2020

tzarc commented Oct 27, 2020

noroadsleft left a comment

add definition WS2812_BYTE_ORDER to fix RGB LED issues #10184

add definition WS2812_BYTE_ORDER to fix RGB LED issues #10184

Conversation

hineybush commented Aug 27, 2020 • edited Loading

Description

Types of Changes

Issues Fixed or Closed by This PR

Checklist

fauxpark commented Aug 27, 2020 • edited Loading

hineybush commented Aug 27, 2020

hineybush commented Aug 27, 2020

fauxpark commented Aug 27, 2020

tzarc commented Aug 27, 2020

tzarc commented Aug 27, 2020 • edited Loading

tzarc commented Aug 27, 2020

zvecr left a comment

Choose a reason for hiding this comment

hineybush commented Aug 28, 2020

tzarc commented Aug 28, 2020

hineybush commented Aug 28, 2020

stale bot commented Oct 21, 2020

hineybush commented Oct 27, 2020

tzarc commented Oct 27, 2020

noroadsleft left a comment

Choose a reason for hiding this comment

hineybush commented Aug 27, 2020 •

edited

Loading

fauxpark commented Aug 27, 2020 •

edited

Loading

tzarc commented Aug 27, 2020 •

edited

Loading