Skip to content

Implementing WS2812b signal transmission in SPI plugin. #1382

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.

Sign up for GitHub

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

Open
wants to merge 22 commits into
base: master
Choose a base branch
from
Open

Implementing WS2812b signal transmission in SPI plugin. #1382

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
05e72b1
Added encoding for WS2812b.
Ph0N37Ic5 Feb 24, 2018
fdfdeb9
Update SPIOutput.h
Ph0N37Ic5 Feb 24, 2018
7a7b040
Merge pull request #2 from Ph0N37Ic5/Ph0N37Ic5-patch-WS2812b-1-1
Ph0N37Ic5 Feb 24, 2018
c17d0d0
Merge pull request #1 from Ph0N37Ic5/Ph0N37Ic5-patch-WS2812b-1
Ph0N37Ic5 Feb 24, 2018
960ee4b
Changes to be committed:
Ph0N37Ic5 Feb 24, 2018
8e3ccf9
Sync to upstream master.
Ph0N37Ic5 Feb 24, 2018
c94f8f1
Sync to upstream master.
Ph0N37Ic5 Feb 24, 2018
58f0ed4
Sync to upstream master, and updated code.
Ph0N37Ic5 Feb 24, 2018
9205b56
Minor bugfixes, should compile now.
Ph0N37Ic5 Feb 24, 2018
791c585
Merge branch 'master' into master
Ph0N37Ic5 Feb 24, 2018
9c22386
Added some tests of WS2812b.
Ph0N37Ic5 Feb 24, 2018
585d41f
Lint
Ph0N37Ic5 Feb 24, 2018
826061f
Merge branch 'master' of https://github.com/Ph0N37Ic5/ola
Ph0N37Ic5 Feb 24, 2018
7e3f8af
Fished out a small copy bug, and added a comment.
Ph0N37Ic5 Feb 24, 2018
9f0f5be
Scriptkiddied in some tests, hopefully they work.
Ph0N37Ic5 Feb 24, 2018
c511698
Beautification, and adding 2 calls to InternalWriteDMX
Ph0N37Ic5 Feb 24, 2018
0c99492
The output and the test now agrees.
Ph0N37Ic5 Feb 24, 2018
c17ef87
Lint
Ph0N37Ic5 Feb 25, 2018
2629090
Lint lint.
Ph0N37Ic5 Feb 25, 2018
d510fec
The lint that lint didn't find.
Ph0N37Ic5 Feb 25, 2018
7d0a5f2
Merge branch 'master' into master
Ph0N37Ic5 Feb 25, 2018
d90feca
Added a bit of debugging to the SPIOutput.cpp constructor. Incremente…
Ph0N37Ic5 Feb 27, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 93 additions & 0 deletions plugins/spi/SPIOutput.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,11 +87,13 @@ const uint16_t SPIOutput::WS2801_SLOTS_PER_PIXEL = 3;
const uint16_t SPIOutput::LPD8806_SLOTS_PER_PIXEL = 3;
const uint16_t SPIOutput::P9813_SLOTS_PER_PIXEL = 3;
const uint16_t SPIOutput::APA102_SLOTS_PER_PIXEL = 3;
const uint16_t SPIOutput::WS2812b_SLOTS_PER_PIXEL = 3;

// Number of bytes that each pixel uses on the SPI wires
// (if it differs from 1:1 with colors)
const uint16_t SPIOutput::P9813_SPI_BYTES_PER_PIXEL = 4;
const uint16_t SPIOutput::APA102_SPI_BYTES_PER_PIXEL = 4;
const uint16_t SPIOutput::WS2812b_SPI_BYTES_PER_PIXEL = 9;

const uint16_t SPIOutput::APA102_START_FRAME_BYTES = 4;

Expand Down Expand Up @@ -316,6 +318,12 @@ bool SPIOutput::InternalWriteDMX(const DmxBuffer &buffer) {
case 8:
CombinedAPA102Control(buffer);
break;
case 9:
IndividualWS2812bControl(buffer);
break;
case 10:
CombinedWS2812bControl(buffer);
break;
default:
break;
}
Expand Down Expand Up @@ -653,6 +661,91 @@ uint8_t SPIOutput::CalculateAPA102LatchBytes(uint16_t pixel_count) {
return latch_bytes;
}

void SPIOutput::IndividualWS2812bControl(const DmxBuffer &buffer) {
const unsigned int first_slot = m_start_address - 1; // 0 offset
if (buffer.Size() - first_slot < WS2812b_SLOTS_PER_PIXEL) {
OLA_INFO << "Insufficient DMX data, required " << WS2812b_SLOTS_PER_PIXEL
<< ", got " << buffer.Size() - first_slot;
return;
}

// We always check out the entire string length, even if we only have data
// for part of it
const unsigned int output_length = m_pixel_count * WS2812b_SLOTS_PER_PIXEL;
uint8_t *output = m_backend->Checkout(m_output_number, output_length);
if (!output) {
OLA_INFO << "Unable to create output buffer of required length: " << output_length;
return;
}

const unsigned int length = std::min(m_pixel_count * WS2812b_SLOTS_PER_PIXEL,
buffer.Size() - first_slot);

for (unsigned int i = 0; i < length / WS2812b_SLOTS_PER_PIXEL; i++) {
// Convert RGB to GRB
unsigned int offset = first_slot + i * WS2812b_SLOTS_PER_PIXEL;
uint8_t r = buffer.Get(offset);
uint8_t g = buffer.Get(offset + 1);
uint8_t b = buffer.Get(offset + 2);
output[i * WS2812b_SPI_BYTES_PER_PIXEL] = 0x24 | ((g & 0x1) << 1) | ((g & 0x2) << 3) | ((g & 0x4) << 5);
Copy link
Member

@peternewman peternewman Feb 24, 2018

Choose a reason for hiding this comment

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

Given this code is used twice, it would be good to have a function that does it, passing in the DMX data and a reference to the array we want to write it into.

Copy link
Author

@Ph0N37Ic5 Ph0N37Ic5 Feb 24, 2018

Choose a reason for hiding this comment

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

The conversion code is the same thing 6 times over, wouldn't it be better to convert that part to a function. I struggle with passing arrays around in C++ as I don't really know C++, could you give me a hint on doing this?

output[i * WS2812b_SPI_BYTES_PER_PIXEL + 1] = 0x49 | ((g & 0x8) >> 1) | ((g & 0x10) << 1);
output[i * WS2812b_SPI_BYTES_PER_PIXEL + 2] = 0x92 | ((g & 0x20) >> 5) | ((g & 0x40) >> 3) | ((g & 0x80) >> 1);
output[i * WS2812b_SPI_BYTES_PER_PIXEL + 3] = 0x24 | ((r & 0x1) << 1) | ((r & 0x2) << 3) | ((r & 0x4) << 5);
output[i * WS2812b_SPI_BYTES_PER_PIXEL + 4] = 0x49 | ((r & 0x8) >> 1) | ((r & 0x10) << 1);
output[i * WS2812b_SPI_BYTES_PER_PIXEL + 5] = 0x92 | ((r & 0x20) >> 5) | ((r & 0x40) >> 3) | ((r & 0x80) >> 1);
output[i * WS2812b_SPI_BYTES_PER_PIXEL + 6] = 0x24 | ((b & 0x1) << 1) | ((b & 0x2) << 3) | ((b & 0x4) << 5);
output[i * WS2812b_SPI_BYTES_PER_PIXEL + 7] = 0x49 | ((b & 0x8) >> 1) | ((b & 0x10) << 1);
output[i * WS2812b_SPI_BYTES_PER_PIXEL + 8] = 0x92 | ((b & 0x20) >> 5) | ((b & 0x40) >> 3) | ((b & 0x80) >> 1);
}

// write output back...
m_backend->Commit(m_output_number);
}

void SPIOutput::CombinedWS2812bControl(const DmxBuffer &buffer) {
const unsigned int first_slot = m_start_address - 1; // 0 offset
if (buffer.Size() - first_slot < WS2812b_SLOTS_PER_PIXEL) {
OLA_INFO << "Insufficient DMX data, required " << WS2812b_SLOTS_PER_PIXEL
<< ", got " << buffer.Size() - first_slot;
return;
}

// We always check out the entire string length, even if we only have data
// for part of it
const unsigned int output_length = m_pixel_count * WS2801_SLOTS_PER_PIXEL;
uint8_t *output = m_backend->Checkout(m_output_number, output_length);
if (!output) {
OLA_INFO << "Unable to create output buffer of required length: " << output_length;
return;
}

// Grab RGB data for conversion to GBR
Copy link
Member

@peternewman peternewman Aug 10, 2021

Choose a reason for hiding this comment

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

I think this is a typo based on the other use and the code.

Suggested change
// Grab RGB data for conversion to GBR
// Grab RGB data for conversion to GRB

uint8_t r = buffer.Get(first_slot);
uint8_t g = buffer.Get(first_slot + 1);
uint8_t b = buffer.Get(first_slot + 2);

// create Pixel Data
uint8_t pixel_data[WS2812b_SPI_BYTES_PER_PIXEL];
pixel_data[0] = 0x24 | ((g & 0x1) << 1) | ((g & 0x2) << 3) | ((g & 0x4) << 5);
Copy link
Member

@peternewman peternewman Feb 24, 2018

Choose a reason for hiding this comment

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

Use the new function when you've written it.

pixel_data[1] = 0x49 | ((g & 0x8) >> 1) | ((g & 0x10) << 1);
pixel_data[2] = 0x92 | ((g & 0x20) >> 5) | ((g & 0x40) >> 3) | ((g & 0x80) >> 1);
pixel_data[3] = 0x24 | ((r & 0x1) << 1) | ((r & 0x2) << 3) | ((r & 0x4) << 5);
pixel_data[4] = 0x49 | ((r & 0x8) >> 1) | ((r & 0x10) << 1);
pixel_data[5] = 0x92 | ((r & 0x20) >> 5) | ((r & 0x40) >> 3) | ((r & 0x80) >> 1);
pixel_data[6] = 0x24 | ((b & 0x1) << 1) | ((b & 0x2) << 3) | ((b & 0x4) << 5);
pixel_data[7] = 0x49 | ((b & 0x8) >> 1) | ((b & 0x10) << 1);
pixel_data[8] = 0x92 | ((b & 0x20) >> 5) | ((b & 0x40) >> 3) | ((b & 0x80) >> 1);

// set all pixel to same value
for (uint16_t i = 0; i < m_pixel_count; i++) {
uint16_t spi_offset = (i * WS2812b_SPI_BYTES_PER_PIXEL);
Copy link
Member

@peternewman peternewman Feb 24, 2018

Choose a reason for hiding this comment

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

I'd be inclined to just put this directly in the row below, rather than storing it in a variable as we're only using it once.

Copy link
Member

@peternewman peternewman Dec 2, 2020

Choose a reason for hiding this comment

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

Done, although I think we may be able to improve the memcpy possibly.

memcpy(&output[spi_offset], pixel_data,
WS2812b_SPI_BYTES_PER_PIXEL);
}

// write output back...
m_backend->Commit(m_output_number);
}

RDMResponse *SPIOutput::GetDeviceInfo(const RDMRequest *request) {
return ResponderHelper::GetDeviceInfo(
Expand Down
8 changes: 6 additions & 2 deletions plugins/spi/SPIOutput.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,9 @@ class SPIOutput: public ola::rdm::DiscoverableRDMControllerInterface {
void CombinedP9813Control(const DmxBuffer &buffer);
void IndividualAPA102Control(const DmxBuffer &buffer);
void CombinedAPA102Control(const DmxBuffer &buffer);

void IndividualWS2812bControl(const DmxBuffer &buffer);
void CombinedWS2812bControl(const DmxBuffer &buffer);

unsigned int LPD8806BufferSize() const;
void WriteSPIData(const uint8_t *data, unsigned int length);

Expand Down Expand Up @@ -186,7 +188,9 @@ class SPIOutput: public ola::rdm::DiscoverableRDMControllerInterface {
static const uint16_t APA102_SLOTS_PER_PIXEL;
static const uint16_t APA102_SPI_BYTES_PER_PIXEL;
static const uint16_t APA102_START_FRAME_BYTES;

static const uint16_t WS2812b_SLOTS_PER_PIXEL;
static const uint16_t WS2812b_SPI_BYTES_PER_PIXEL;

static const ola::rdm::ResponderOps<SPIOutput>::ParamHandler
PARAM_HANDLERS[];
};
Expand Down