Skip to content

Commit 68510f9

Browse files
Legion2Legion2
authored
Merge pull request #77 from Legion2/dev
Version 0.8.0
2 parents 5e1c015 + 74e4c4a commit 68510f9

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+2950
-110
lines changed

‎.github/workflows/documentation.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Create Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- dev
7+
8+
jobs:
9+
doxygen:
10+
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- uses: actions/checkout@v1
15+
- name: Install doxygen
16+
run: sudo apt install doxygen graphviz
17+
- name: Run doxygen
18+
run: doxygen extra/doxygen.conf
19+
- name: Deploy to gh-pages
20+
uses: peaceiris/[email protected]
21+
env:
22+
ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
23+
PUBLISH_BRANCH: gh-pages
24+
PUBLISH_DIR: doxygen/html

‎.github/workflows/push.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ jobs:
66
runs-on: ubuntu-latest
77
strategy:
88
matrix:
9-
sketch: [LightingNodePRO, SingleStripLightingNodePRO, CommanderPRO, DeviceIDTool, RepeatAndScale, TransformLLFansFormatToStrip]
9+
sketch: [LightingNodePRO, SingleStripLightingNodePRO, CommanderPRO, DeviceIDTool, RepeatAndScale, TransformLLFansFormatToStrip, LS100]
1010
board: ["arduino:avr:leonardo", "arduino:avr:micro", "SparkFun:avr:promicro:cpu=16MHzatmega32U4"]
1111
steps:
1212
- uses: actions/checkout@master

‎.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -267,3 +267,5 @@ __vm/
267267
*.vcxproj
268268
*.vcxproj.filters
269269
*.vcxitems
270+
271+
/doxygen

‎README.md

Lines changed: 50 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
[![arduino-library-badge](https://www.ardu-badge.com/badge/Corsair%20Lighting%20Protocol.svg?)](https://www.ardu-badge.com/Corsair%20Lighting%20Protocol)
32
![Test Status](https://github.com/Legion2/CorsairLightingProtocol/workflows/Test/badge.svg)
43

@@ -13,14 +12,20 @@
1312
* Use multiple devices at the same time.
1413
* Repeat or scale LED channels to arbitrary size.
1514

16-
![Overview](docs/Overview.png)
15+
### Supported Devices
16+
* Lighting Node PRO
17+
* Commander PRO
18+
* Lighting Node CORE
19+
* LS100 Smart Lighting Controller
20+
21+
![Overview](extra/images/overview.png)
1722

1823
# Getting started
1924

2025
- [Requirements](#requirements)
2126
- [Install the library](#install-the-library)
2227
- [Create a Lighting Node PRO](#create-a-lighting-node-pro)
23-
- [Use the library](#use-the-library)
28+
- [Use the Lighting Node PRO](#use-the-lighting-node-pro)
2429

2530
## Requirements
2631
The library is compatible with all boards using the MCU ATmega32U4.
@@ -29,44 +34,44 @@ It also supports the Arduino Uno and Arduino Mega, **but** this requires the [Ho
2934
It is **not** compatible with Arduino Nano.
3035
In the rest of the documentation "Arduino" is used as a synonym for all supported boards regardless of the manufacturer.
3136

32-
As an IDE [Visual Studio](https://visualstudio.microsoft.com/downloads/) with the extension [Visual Micro](https://marketplace.visualstudio.com/items?itemName=VisualMicro.ArduinoIDEforVisualStudio) is recommended.
33-
Visual Micro provides the required functionality for free, but sometimes ask you to buy the full version.
34-
Using the Arduino IDE is difficult, but you can find a tutorial in the [wiki](https://github.com/Legion2/CorsairLightingProtocol/wiki/How-to-use-Arduino-IDE).
35-
3637
You have problems with a board not listed here, please open an [Issue](https://github.com/Legion2/CorsairLightingProtocol/issues).
3738

3839
## Install the library
39-
Use the [Library-Manager](https://www.visualmicro.com/page/User-Guide.aspx?doc=Library-Manager.html#) to install this library or download a [release](https://github.com/Legion2/CorsairLightingProtocol/releases).
40+
Use the [Library-Manager](https://www.ardu-badge.com/Corsair%20Lighting%20Protocol/ide) to install this library (Corsair Lighting Protocol).
4041
Additionally, the [FastLED](http://fastled.io/) library must be installed.
4142

4243
## Create a Lighting Node PRO
43-
Open the example "LightingNodePRO", you can find it in the Visual Micro Explorer or the [examples directory](examples).
44-
The library [FastLED](http://fastled.io/) is used to control the LEDs. For more information on [how to wire the leds](https://github.com/FastLED/FastLED/wiki/Wiring-leds) and [how to set up the LEDs in the code](https://github.com/FastLED/FastLED/wiki/Basic-usage#setting-up-the-leds) see the links.
45-
After you have done the wiring or at least know which pin is the data pin, you can set this pin in the example sketch and upload it to the Arduino.
46-
In Visual Studio use the "Release" [configuration](https://github.com/MicrosoftDocs/visualstudio-docs/blob/master/docs/debugger/how-to-set-debug-and-release-configurations.md#change-the-build-configuration).
44+
This guide will teach you how to create a Lighting Node PRO with an Arduino Leonardo compatible board.
45+
If you have an Arduino Uno or Mega, see the [other guide](https://github.com/Legion2/CorsairLightingProtocol/wiki/How-to-use-on-Arduino-Uno-and-Arduino-Mega).
46+
47+
1. Open the example "LightingNodePRO", you can find it in Arduino IDE in the File menu->Examples->Corsair Lighting Protocol->LightingNodePRO or in the [examples directory](examples) if you download this project.
48+
49+
![open example sketch](extra/images/open-example.png)
50+
1. Follow [these steps](https://github.com/Legion2/CorsairLightingProtocolBoards#how-to-use-these-boards-in-arduino) to install the CLP Boards and upload the sketch to your Arduino.
51+
1. Do the wiring.
52+
For more information on [how to wire the leds](https://github.com/FastLED/FastLED/wiki/Wiring-leds) and [how to set up the LEDs in the code](https://github.com/FastLED/FastLED/wiki/Basic-usage#setting-up-the-leds) see the links.
53+
54+
![the wiring](extra/images/board-wiring.jpg)
55+
1. Verify that your device works as expected.
56+
Open the Windows settings->devices->Other devices.
57+
Somewhere in the list of devices, there should be a device called "Lighting Node PRO".
58+
1. Now open [iCUE](https://www.corsair.com/icue) there should be the "Lighting Node PRO".
4759

48-
To verify that the library works as expected, open the Windows settings -> devices -> connected devices. Somewhere in the list of devices, there should be a device called "Lighting Node PRO". (If not, please open an [Issue](https://github.com/Legion2/CorsairLightingProtocol/issues))
49-
Open [iCUE](https://www.corsair.com/icue) there should also be the "Lighting Node PRO".
60+
## Use the Lighting Node PRO
5061

51-
![iCUE RGB Strip example](docs/iCUE.jpg)
62+
![iCUE RGB Strip example](extra/images/iCUE.jpg)
5263

5364
In iCUE open the "Lighting Setup" tab of the Lighting Node PRO(LNP) and set for both Lighting Channels the device to "RGB Light Strip" and the amount to a tenth of the LEDs you have.
5465
iCUE groups the LEDs into groups of ten.
5566
So if you have 20 LEDs, set the amount to 2.
5667
Now you can create lighting effects in the "Lighting Channel #" tabs.
5768

58-
The example "SingleStripLightingNodePRO" only requires one LED strip connected to the Arduino.
59-
Because the "SingleStripLightingNodePRO" concatenate the two channels, a total of 120 LEDs can be controlled on a single LED Strip.
60-
61-
## Use the library
62-
If you want to use this library in your own sketch don't forget to use Visual Studio as IDE and include the [board.txt](examples/LightingNodePRO/board.txt) in the root directory of your sketch.
63-
6469
# Misc
6570

71+
- [API Documentation](https://legion2.github.io/CorsairLightingProtocol/)
6672
- [How it works](#how-it-works)
6773
- [Use multiple Devices](#use-multiple-devices)
6874
- [Repeat or scale LED channel](#repeat-or-scale-led-channel)
69-
- [Debugging](#debugging)
7075

7176
## How it works
7277
This library uses the USB HID interface of the Arduino Micro or Leonardo.
@@ -75,26 +80,41 @@ After uploading a sketch with the library and these IDs, iCUE recognizes the Ard
7580
In iCUE you can then select the "Lighting Node PRO" and set some lighting effects.
7681
iCUE sends these via the CorsairLightingProtocol to the Arduino.
7782
These commands are understood by the library and converted into lighting effects on the RGB strips connected to the Arduino.
83+
The [FastLED](http://fastled.io/) library is used to control the LEDs.
7884

7985
## Use multiple Devices
8086
Each device has two unique IDs, that is, they should be unique.
8187
You must give each device a unique ID.
82-
There are two IDs that must be changed `SERIAL_NUMBER` and `DeviceID`.
83-
84-
The `SERIAL_NUMBER` can be changed in the board.txt file.
85-
Uncomment the line with `SERIAL_NUMBER` and change some characters at the end, don't change the length and only use HEX characters(0-9 and A-F).
86-
The `DeviceID` can be changed with the [tool](examples/DeviceIDTool/DeviceIDTool.ino)
88+
There are two IDs that must be changed `Serial Number` and `DeviceID`.
89+
90+
The Serial Number can be set in the constructor of `CorsairLightingProtocolHID` and `CLPUSBSerialBridge` as shown in the [example](examples/AdditionalFeatures/AdditionalFeatures.ino).
91+
```C++
92+
const char mySerialNumber[] PROGMEM = "202B6949A967";
93+
CorsairLightingProtocolHID cHID(&cLP, mySerialNumber);
94+
```
95+
The Serial Number MAY only consist of HEX characters (0-9 and A-F).
96+
97+
The DeviceID can be set with the `setDeviceID` function of `CorsairLightingFirmware`.
98+
```C++
99+
void setup() {
100+
byte deviceId[4] = { 0x9A, 0xDA, 0xA7, 0x8E };
101+
firmware.setDeviceID(deviceId);
102+
...
103+
}
104+
```
105+
106+
### Alternative
107+
The `DeviceID` can be changed with the [DeviceIDTool](examples/DeviceIDTool/DeviceIDTool.ino).
87108
Upload the DeviceIDTool sketch and then open the Serial monitor with baudrate 115200.
88109
The tool displays the current DeviceID, you can type in a new DeviceID that is saved on the Arduino.
89110
After that, you can upload another sketch.
90111

91112
## Repeat or scale LED channel
92113
You can repeat or scale LED channel controlled by iCUE onto physical LED strips.
93-
This is very useful if you have very long LED strips that are longer than 60/96 LEDs.
114+
This is very useful if you have very long LED strips that are longer than 60/96/135 LEDs.
94115
This is the maximum number iCUE supports.
95116

96117
To repeat or scale a LED channel you must apply the `CLP::repeat` or the `CLP:scale` function in the update hook of the FastLEDController.
97-
The functions must be included from `FastLEDControllerUtils.h`.
98118
See the [RepeatAndScale](examples/RepeatAndScale/RepeatAndScale.ino) example for the complete code.
99119
Both functions take the FastLEDController pointer and the channel index as arguments.
100120
Additionally, the `repeat` function takes as an argument how often the LED channel should be repeated.
@@ -106,16 +126,6 @@ Then the third argument of the `scale` function is `144`.
106126
For both functions it's **important**, that the CRGB arrays have at least the length of the physical LED strip.
107127
This means if your LED channel from iCUE has 50 LEDs and you use the `repeat` function to control 100 physical LEDs you MUST declare the CRGB array at least with a length of 100.
108128

109-
## Debugging
110-
For debugging don't use the integrated debugger of Visual Studio, as it will most likely break the USB communication.
111-
Use the `DEBUG` macro and the Serial Monitor.
112-
With the `-DDEBUG` flag you can enable debugging in the whole project.
113-
Add this flag in the board.txt file to the `build.extra_flags`.
114-
115-
For advanced debugging you can use the [DebugSketch](examples/DebugSketch/DebugSketch.ino).
116-
In the board.txt file, the default values for the debugging options can be set.
117-
After uploading the sketch open the serial monitor with baud rate 115200 and set the line ending to "Line Feed"/"Newline" (`\n`).
118-
119129
# DISCLAIMERS
120130
This is a DO IT YOURSELF project, use at your own risk!
121131

@@ -126,4 +136,5 @@ This is a DO IT YOURSELF project, use at your own risk!
126136

127137
## Related projects
128138
- [CorsairArduinoController](https://github.com/TylerSeiford/CorsairArduinoController)
139+
- [CorsairLightingProtocolBoards](https://github.com/Legion2/CorsairLightingProtocolBoards)
129140
- [OpenCorsairLighting](https://github.com/McHauge/OpenCorsairLighting)

‎examples/AdditionalFeatures/AdditionalFeatures.ino

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
/*
2+
Copyright 2019 Leon Kiefer
3+
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing, software
11+
distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
15+
*/
16+
#include <CorsairLightingProtocol.h>
17+
#include <FastLED.h>
18+
19+
#define DATA_PIN_CHANNEL_1 2
20+
#define DATA_PIN_CHANNEL_2 3
21+
22+
CRGB ledsChannel1[60];
23+
CRGB ledsChannel2[60];
24+
25+
const char mySerialNumber[] PROGMEM = "202B6949A967";
26+
27+
CorsairLightingFirmware firmware = corsairLightingNodePROFirmware();
28+
FastLEDController ledController(true);
29+
CorsairLightingProtocolController cLP(&ledController, &firmware);
30+
CorsairLightingProtocolHID cHID(&cLP, mySerialNumber);
31+
32+
void setup() {
33+
CLP::disableBuildInLEDs();
34+
if (CLP::shouldReset(&firmware)) {
35+
CLP::reset(&firmware);
36+
ledController.reset();
37+
}
38+
FastLED.addLeds<NEOPIXEL, DATA_PIN_CHANNEL_1>(ledsChannel1, 60);
39+
FastLED.addLeds<NEOPIXEL, DATA_PIN_CHANNEL_2>(ledsChannel2, 60);
40+
ledController.addLEDs(0, ledsChannel1, 60);
41+
ledController.addLEDs(1, ledsChannel2, 60);
42+
}
43+
44+
void loop() {
45+
cHID.update();
46+
47+
if (ledController.updateLEDs()) {
48+
FastLED.show();
49+
}
50+
}

‎examples/AdditionalFeatures/board.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# CorsairLightingProtocol build property overrides
2+
3+
build.vid=0x1b1c
4+
build.pid=0x0c0b
5+
build.usb_product="Lighting Node PRO"
6+
build.usb_manufacturer="Corsair"

‎examples/CommanderPRO/board.txt

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,6 @@
11
# build properties for Commander PRO
2-
#
3-
4-
##############################################################
52

63
build.vid=0x1b1c
74
build.pid=0x0c10
85
build.usb_product="Commander PRO"
96
build.usb_manufacturer="Corsair"
10-
11-
#build.extra_flags={build.usb_flags} '-DSERIAL_NUMBER="FB66DF55421900F5"'

‎examples/DebugSketch/DebugSketch.ino

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
*/
1616
#include <CorsairLightingProtocol.h>
1717
#include <FastLED.h>
18-
#include <EEPROM.h>
1918

2019
#define CHANNEL_LED_COUNT 96
2120

@@ -60,9 +59,9 @@ void loop() {
6059

6160
void processCommand(String& cmd) {
6261
if (cmd == F("print DeviceID")) {
63-
byte DeviceId[4];
64-
EEPROM.get(EEPROM_ADDRESS_DEVICE_ID, DeviceId);
65-
CLP::printDeviceID(DeviceId);
62+
byte deviceId[4];
63+
firmware.getDeviceID(deviceId);
64+
CLP::printDeviceID(deviceId);
6665
Serial.println();
6766
}
6867
#ifdef VERBOSE

‎examples/DebugSketch/board.txt

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
11
# CorsairLightingProtocol build property overrides
2-
#
3-
4-
##############################################################
52

63
build.vid=0x1b1c
74
build.pid=0x0c0b
85
build.usb_product="Lighting Node PRO"
96
build.usb_manufacturer="Corsair"
107

11-
build.extra_flags={build.usb_flags} '-DSERIAL_NUMBER="FB66DF55421900F5"' -DDEBUG -DVERBOSE -DPRINT_COMMAND=true -DPRINT_RESPONSE=true -DPRINT_LOOP=true -DPRINT_UPDATE=true
8+
build.extra_flags={build.usb_flags} -DDEBUG -DVERBOSE -DPRINT_COMMAND=true -DPRINT_RESPONSE=true -DPRINT_LOOP=true -DPRINT_UPDATE=true

‎examples/DeviceIDTool/DeviceIDTool.ino

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,6 @@
2121

2222
#define EEPROM_ADDRESS_DEVICE_ID 0
2323

24-
bool isNullID(uint8_t* deviceId) {
25-
return !(deviceId[0] | deviceId[1] | deviceId[2] | deviceId[3]);
26-
}
27-
2824
void setup() {
2925
Serial.begin(115200);
3026
Serial.setTimeout(100);
@@ -60,9 +56,12 @@ void loop() {
6056
Serial.println(F("Set DeviceID to: "));
6157
CLP::printDeviceID(newDeviceID);
6258
Serial.println();
63-
if (isNullID(newDeviceID)) {
59+
if (CLP::isNullID(newDeviceID)) {
6460
Serial.println(F("This is a special DeviceID, it will generate a new random DeviceID next time iCUE controls the device!"));
6561
}
62+
if (CLP::isResetID(newDeviceID)) {
63+
Serial.println(F("This is a special DeviceID, it will reset the device and then generate a new DeviceID!"));
64+
}
6665
Serial.println();
6766
EEPROM.put(EEPROM_ADDRESS_DEVICE_ID, newDeviceID);
6867
}

‎examples/HoodLoader2CLPBridge/CLPUSBSerialBridge.cpp

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,11 @@ void resetIOMCU() {
2727
#endif // DEBUG
2828
}
2929

30+
CLPUSBSerialBridge::CLPUSBSerialBridge(const char* serialNumber)
31+
{
32+
RawHID.setSerialNumber(serialNumber);
33+
}
34+
3035
void CLPUSBSerialBridge::begin()
3136
{
3237
Serial1.begin(SERIAL_BAUD);

‎examples/HoodLoader2CLPBridge/CLPUSBSerialBridge.h

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,25 @@
3030

3131
class CLPUSBSerialBridge {
3232
public:
33+
/**
34+
* Create a new CLPUSBSerialBridge with the default Serial Number.
35+
*/
36+
CLPUSBSerialBridge() {};
37+
/**
38+
* Create a new CLPUSBSerialBridge and set a Serial Number.
39+
*
40+
* @param serialNumber the Serial Number of the USB device
41+
*/
42+
CLPUSBSerialBridge(const char* serialNumber);
43+
/**
44+
* Setup the bridge connections.
45+
* Must be called in the Arduino setup function.
46+
*/
3347
virtual void begin();
48+
/**
49+
* Reads data from USB and sents it via Serial to the main MCU. Wait for the response and set it back to the USB host.
50+
* MUST be called in the Arduino loop function.
51+
*/
3452
virtual void handleHID();
3553
private:
3654
byte rawHIDAndSerialBuffer[RAWHID_AND_SERIAL_BUFFER_SIZE];

‎examples/HoodLoader2CLPBridge/board.txt

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,6 @@
11
# CorsairLightingProtocol build property overrides
2-
#
3-
4-
##############################################################
52

63
build.vid=0x1b1c
74
build.pid=0x0c0b
85
build.usb_product="Lighting Node PRO"
96
build.usb_manufacturer="Corsair"
10-
11-
#build.extra_flags={build.usb_flags} '-DSERIAL_NUMBER="FB66DF55421900F5"'

‎examples/HoodLoader2UnoMegaController/HoodLoader2UnoMegaController.ino

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@
1616
#include <CorsairLightingProtocol.h>
1717
#include <FastLED.h>
1818

19-
#define CHANNEL_LED_COUNT 96
19+
// Hint: The Arduino Uno does not have as much memory as the Arduino Mega, it may be that problems occur when a higher value is set here.
20+
#define CHANNEL_LED_COUNT 60
2021

2122
#define DATA_PIN_CHANNEL_1 2
2223
#define DATA_PIN_CHANNEL_2 3

‎examples/HoodLoader2UnoMegaController/board.txt

Lines changed: 0 additions & 6 deletions
This file was deleted.

0 commit comments

Comments
 (0)