Skip to content

Commit 0db567b

Browse files
cibomahtoCalcProgrammer1
cibomahto
authored and
CalcProgrammer1
committed
Add support for BlinkyTape LED controllers
This adds support for the Blinkinlabs BlinkyTape controller, a USB-powered digital LED strip controller. Devices are detected automatically by scanning for their VID/PID, and connected to using serial. This code was tested in Windows. Commit squashed and amended for code style and to fix Linux build by Adam Honse <calcprogrammer1@gmail.com>
1 parent dc19fad commit 0db567b

7 files changed

+362
-1
lines changed

‎Controllers/BlinkyTapeController/BlinkyTapeController.cpp

+105
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
/*---------------------------------------------------------*\
2+
| BlinkyTapeController.cpp |
3+
| |
4+
| BlinkyTape controller interface |
5+
| |
6+
| Matt Mets (matt@blinkinlabs.com), 07/01/2021 |
7+
\*---------------------------------------------------------*/
8+
9+
#include "BlinkyTapeController.h"
10+
11+
#include <algorithm>
12+
#include <fstream>
13+
#include <iostream>
14+
#include <string>
15+
16+
#ifndef WIN32
17+
#define LPSTR char *
18+
#define strtok_s strtok_r
19+
#endif
20+
21+
BlinkyTapeController::BlinkyTapeController()
22+
{
23+
}
24+
25+
BlinkyTapeController::~BlinkyTapeController()
26+
{
27+
if(serialport != nullptr)
28+
{
29+
serialport->serial_close();
30+
delete serialport;
31+
}
32+
}
33+
34+
void BlinkyTapeController::Initialize(const std::string &portname, int led_count)
35+
{
36+
num_leds = led_count;
37+
port_name = portname;
38+
39+
serialport = new serial_port();
40+
41+
if(!serialport->serial_open(port_name.c_str(), 115200))
42+
{
43+
delete serialport;
44+
serialport = nullptr;
45+
}
46+
}
47+
48+
std::string BlinkyTapeController::GetLocation()
49+
{
50+
if(serialport == nullptr)
51+
{
52+
return("");
53+
}
54+
55+
return("COM: " + port_name);
56+
}
57+
58+
char* BlinkyTapeController::GetLEDString()
59+
{
60+
return(led_string);
61+
}
62+
63+
void BlinkyTapeController::SetLEDs(std::vector<RGBColor> colors)
64+
{
65+
if(serialport == nullptr)
66+
{
67+
return;
68+
}
69+
70+
/*-------------------------------------------------------------*\
71+
| BlinkyTape Protocol |
72+
| |
73+
| Packet size: Number of data bytes + 1 |
74+
| |
75+
| 0-n: Data Byte (0-254) |
76+
| n+1: Packet End Byte (0xFF) |
77+
\*-------------------------------------------------------------*/
78+
const unsigned int payload_size = (colors.size() * 3);
79+
const unsigned int packet_size = payload_size + 1;
80+
81+
std::vector<unsigned char> serial_buf(packet_size);
82+
83+
/*-------------------------------------------------------------*\
84+
| Set up end byte |
85+
\*-------------------------------------------------------------*/
86+
serial_buf[packet_size - 1] = 0xFF;
87+
88+
/*-------------------------------------------------------------*\
89+
| Copy in color data in RGB order |
90+
\*-------------------------------------------------------------*/
91+
for(unsigned int color_idx = 0; color_idx < colors.size(); color_idx++)
92+
{
93+
const unsigned int color_offset = color_idx * 3;
94+
95+
serial_buf[0x00 + color_offset] = std::min((unsigned int)254, RGBGetRValue(colors[color_idx]));
96+
serial_buf[0x01 + color_offset] = std::min((unsigned int)254, RGBGetGValue(colors[color_idx]));
97+
serial_buf[0x02 + color_offset] = std::min((unsigned int)254, RGBGetBValue(colors[color_idx]));
98+
}
99+
100+
/*-------------------------------------------------------------*\
101+
| Send the packet |
102+
\*-------------------------------------------------------------*/
103+
serialport->serial_write((char *)serial_buf.data(), packet_size);
104+
}
105+

‎Controllers/BlinkyTapeController/BlinkyTapeController.h

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
/*---------------------------------------------------------*\
2+
| Definitions for BlinkyTape Interface |
3+
| |
4+
| Matt Mets (matt@blinkinlabs.com), 07/01/2021 |
5+
\*---------------------------------------------------------*/
6+
7+
#ifndef BLINKYTAPE_H
8+
#define BLINKYTAPE_H
9+
10+
#include "RGBController.h"
11+
#include "serial_port.h"
12+
13+
struct BlinkyTapeDevice
14+
{
15+
std::string port;
16+
unsigned int num_leds;
17+
};
18+
19+
class BlinkyTapeController
20+
{
21+
public:
22+
BlinkyTapeController();
23+
~BlinkyTapeController();
24+
25+
void Initialize(const std::string &portname, int led_count);
26+
27+
char* GetLEDString();
28+
std::string GetLocation();
29+
30+
void SetLEDs(std::vector<RGBColor> colors);
31+
32+
int num_leds;
33+
34+
private:
35+
char led_string[1024];
36+
std::string port_name;
37+
serial_port *serialport = nullptr;
38+
};
39+
40+
#endif

‎Controllers/BlinkyTapeController/BlinkyTapeControllerDetect.cpp

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
#include "Detector.h"
2+
#include "BlinkyTapeController.h"
3+
#include "RGBController.h"
4+
#include "RGBController_BlinkyTape.h"
5+
#include "SettingsManager.h"
6+
#include "find_usb_serial_port.h"
7+
#include <vector>
8+
#include <stdio.h>
9+
#include <stdlib.h>
10+
11+
#define BLINKINLABS_VID 0x1D50
12+
#define BLINKYTAPE_PID 0x605E
13+
14+
/******************************************************************************************\
15+
* *
16+
* DetectBlinkyTapeControllers *
17+
* *
18+
* Detect BlinkyTape devices *
19+
* *
20+
\******************************************************************************************/
21+
22+
void DetectBlinkyTapeControllers(std::vector<RGBController*> &rgb_controllers)
23+
{
24+
std::vector<std::string *> device_locations = find_usb_serial_port(BLINKINLABS_VID, BLINKYTAPE_PID);
25+
26+
for(unsigned int device_idx = 0; device_idx < device_locations.size(); device_idx++)
27+
{
28+
int led_count = 64;
29+
30+
BlinkyTapeController* controller = new BlinkyTapeController();
31+
controller->Initialize(*device_locations[device_idx], led_count);
32+
33+
RGBController_BlinkyTape* rgb_controller = new RGBController_BlinkyTape(controller);
34+
rgb_controllers.push_back(rgb_controller);
35+
}
36+
}
37+
38+
REGISTER_DETECTOR("BlinkyTape", DetectBlinkyTapeControllers);

‎Controllers/BlinkyTapeController/RGBController_BlinkyTape.cpp

+137
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
/*---------------------------------------------------------*\
2+
| RGBController_BlinkyTape.cpp |
3+
| |
4+
| Generic RGB Interface for BlinkyTape Led controller |
5+
| |
6+
| Matt Mets (matt@blinkinlabs.com), 07/01/2021 |
7+
\*---------------------------------------------------------*/
8+
9+
#include "RGBController_BlinkyTape.h"
10+
11+
RGBController_BlinkyTape::RGBController_BlinkyTape(BlinkyTapeController* controller_ptr)
12+
{
13+
controller = controller_ptr;
14+
15+
name = "BlinkyTape";
16+
vendor = "Blinkinlabs";
17+
type = DEVICE_TYPE_LEDSTRIP;
18+
description = "BlinkyTape Controller Device";
19+
location = controller->GetLocation();
20+
21+
mode Direct;
22+
Direct.name = "Direct";
23+
Direct.value = 0;
24+
Direct.flags = MODE_FLAG_HAS_PER_LED_COLOR;
25+
Direct.color_mode = MODE_COLORS_PER_LED;
26+
modes.push_back(Direct);
27+
28+
SetupZones();
29+
}
30+
31+
RGBController_BlinkyTape::~RGBController_BlinkyTape()
32+
{
33+
delete controller;
34+
}
35+
36+
void RGBController_BlinkyTape::SetupZones()
37+
{
38+
zones.clear();
39+
leds.clear();
40+
41+
zone led_zone;
42+
led_zone.name = "LED Strip";
43+
led_zone.type = ZONE_TYPE_LINEAR;
44+
led_zone.leds_min = 1;
45+
led_zone.leds_max = 512;
46+
led_zone.leds_count = 0;
47+
led_zone.matrix_map = NULL;
48+
zones.push_back(led_zone);
49+
50+
ResizeZone(0, controller->num_leds);
51+
}
52+
53+
void RGBController_BlinkyTape::ResizeZone(int zone, int new_size)
54+
{
55+
/*-------------------------------------------------*\
56+
| Explicitly cast these to avoid compiler warnings |
57+
\*-------------------------------------------------*/
58+
const unsigned int zone_u = static_cast<unsigned int>(zone);
59+
const unsigned int new_size_u = static_cast<unsigned int>(new_size);
60+
61+
/*-------------------------------------------------*\
62+
| Check that the zone is in bounds |
63+
\*-------------------------------------------------*/
64+
if((zone_u > zones.size()) || (zone < 0))
65+
{
66+
return;
67+
}
68+
69+
/*-------------------------------------------------*\
70+
| And that the new size is in bounds |
71+
\*-------------------------------------------------*/
72+
if((new_size_u > zones.at(zone).leds_max) || (new_size_u < zones.at(zone).leds_min))
73+
{
74+
return;
75+
}
76+
77+
/*-------------------------------------------------*\
78+
| And that there's actually a change |
79+
\*-------------------------------------------------*/
80+
if(zones.at(zone).leds_count == new_size_u)
81+
{
82+
return;
83+
}
84+
85+
/*-------------------------------------------------*\
86+
| If the new size is less than the current size, |
87+
| just chop off the end |
88+
\*-------------------------------------------------*/
89+
if(leds.size() > new_size_u)
90+
{
91+
leds.resize(new_size);
92+
}
93+
94+
/*-------------------------------------------------*\
95+
| Otherwise, add new LEDs to the end |
96+
\*-------------------------------------------------*/
97+
if(leds.size() < new_size_u)
98+
{
99+
for(size_t led_idx = leds.size(); led_idx < new_size_u; led_idx++)
100+
{
101+
led new_led;
102+
new_led.name = "LED ";
103+
new_led.name.append(std::to_string(led_idx));
104+
105+
leds.push_back(new_led);
106+
}
107+
}
108+
109+
zones.at(zone).leds_count = new_size;
110+
111+
SetupColors();
112+
}
113+
114+
void RGBController_BlinkyTape::DeviceUpdateLEDs()
115+
{
116+
controller->SetLEDs(colors);
117+
}
118+
119+
void RGBController_BlinkyTape::UpdateZoneLEDs(int /*zone*/)
120+
{
121+
controller->SetLEDs(colors);
122+
}
123+
124+
void RGBController_BlinkyTape::UpdateSingleLED(int /*led*/)
125+
{
126+
controller->SetLEDs(colors);
127+
}
128+
129+
void RGBController_BlinkyTape::SetCustomMode()
130+
{
131+
132+
}
133+
134+
void RGBController_BlinkyTape::DeviceUpdateMode()
135+
{
136+
137+
}

‎Controllers/BlinkyTapeController/RGBController_BlinkyTape.h

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
/*---------------------------------------------------------*\
2+
| RGBController_BlinkyTape.h |
3+
| |
4+
| Generic RGB Interface for BlinkyTape Led controller |
5+
| |
6+
| Matt Mets (matt@blinkinlabs.com), 07/01/2021 |
7+
\*---------------------------------------------------------*/
8+
9+
#pragma once
10+
#include "RGBController.h"
11+
#include "serial_port.h"
12+
#include "BlinkyTapeController.h"
13+
14+
class RGBController_BlinkyTape : public RGBController
15+
{
16+
public:
17+
RGBController_BlinkyTape(BlinkyTapeController* controller_ptr);
18+
~RGBController_BlinkyTape();
19+
20+
void SetupZones();
21+
22+
void ResizeZone(int zone, int new_size);
23+
24+
void DeviceUpdateLEDs();
25+
void UpdateZoneLEDs(int zone);
26+
void UpdateSingleLED(int led);
27+
28+
void SetCustomMode();
29+
void DeviceUpdateMode();
30+
31+
private:
32+
BlinkyTapeController* controller;
33+
};

‎OpenRGB.pro

+5
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,8 @@ HEADERS +=
206206
Controllers/AsusAuraUSBController/RGBController_AsusAuraMouse.h \
207207
Controllers/AsusAuraUSBController/RGBController_AsusAuraTUFKeyboard.h \
208208
Controllers/AsusAuraUSBController/RGBController_AsusAuraUSB.h \
209+
Controllers/BlinkyTapeController/BlinkyTapeController.h \
210+
Controllers/BlinkyTapeController/RGBController_BlinkyTape.h \
209211
Controllers/CoolerMasterController/CMARGBcontroller.h \
210212
Controllers/CoolerMasterController/CMMP750Controller.h \
211213
Controllers/CoolerMasterController/CMSmallARGBController.h \
@@ -513,6 +515,9 @@ SOURCES +=
513515
Controllers/AsusAuraUSBController/RGBController_AsusAuraMouse.cpp \
514516
Controllers/AsusAuraUSBController/RGBController_AsusAuraTUFKeyboard.cpp \
515517
Controllers/AsusAuraUSBController/RGBController_AsusAuraUSB.cpp \
518+
Controllers/BlinkyTapeController/BlinkyTapeController.cpp \
519+
Controllers/BlinkyTapeController/BlinkyTapeControllerDetect.cpp \
520+
Controllers/BlinkyTapeController/RGBController_BlinkyTape.cpp \
516521
Controllers/CoolerMasterController/CMARGBcontroller.cpp \
517522
Controllers/CoolerMasterController/CMMP750Controller.cpp \
518523
Controllers/CoolerMasterController/CMSmallARGBController.cpp \

‎serial_port/serial_port.h

+4-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,10 @@
1414
#include <stdio.h>
1515

1616
#ifdef _WIN32
17-
17+
/*---------------------------------------------------------*\
18+
| Windows interferes with std::max unless NOMINMAX defined |
19+
\*---------------------------------------------------------*/
20+
#define NOMINMAX
1821
#include <windows.h>
1922

2023
#endif /* _WIN32 */

0 commit comments

Comments
 (0)