Merge pull request #102 from Legion2/dev

Version 0.10.0

Author: Legion2

.github/workflows/push.yml

@@ -6,7 +6,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        sketch: [LightingNodePRO, SingleStripLightingNodePRO, CommanderPRO, DeviceIDTool, RepeatAndScale, TransformLLFansFormatToStrip, LS100, LightingNodeCORE, NonAddressable]
+        sketch: [LightingNodePRO, SingleStripLightingNodePRO, CommanderPRO, DeviceIDTool, RepeatAndScale, TransformLLFansFormatToStrip, LS100, LightingNodeCORE, NonAddressable, AmbientBacklight]
         board: ["arduino:avr:leonardo", "arduino:avr:micro", "SparkFun:avr:promicro:cpu=16MHzatmega32U4"]
     steps:
     - uses: actions/checkout@master

.gitignore

@@ -269,3 +269,6 @@ __vm/
 *.vcxitems
 
 /doxygen
+
+# VS Code settings
+.vscode/

README.md

@@ -1,5 +1,4 @@
-[![arduino-library-badge](https://www.ardu-badge.com/badge/Corsair%20Lighting%20Protocol.svg?)](https://www.ardu-badge.com/Corsair%20Lighting%20Protocol)
-![Test Status](https://github.com/Legion2/CorsairLightingProtocol/workflows/Test/badge.svg)
+# Corsair Lighting Protocol [![arduino-library-badge](https://www.ardu-badge.com/badge/Corsair%20Lighting%20Protocol.svg?)](https://www.ardu-badge.com/Corsair%20Lighting%20Protocol) [![Test Status](https://github.com/Legion2/CorsairLightingProtocol/workflows/Test/badge.svg)](https://github.com/Legion2/CorsairLightingProtocol/actions?query=workflow%3ATest+branch%3Adev+event%3Apush)
 
 **This library can be used to integrate custom/unofficial RGB strips with iCUE.**
 
@@ -21,9 +20,12 @@
 ![Overview](extra/images/overview.png)
 
 # Getting started
+This project is an Arduino library called "Corsair Lighting Protocol".
+It can be used to control Arduino boards with iCUE.
+This project provides example sketches for easy use with Arduino IDE.
 
 - [Requirements](#requirements)
-- [Install the library](#install-the-library)
+- [Install the libraries](#install-the-libraries)
 - [Create a Lighting Node PRO](#create-a-lighting-node-pro)
 - [Use the Lighting Node PRO](#use-the-lighting-node-pro)
 
@@ -34,28 +36,39 @@ It also supports the Arduino Uno and Arduino Mega, **but** this requires the [Ho
 It is **not** compatible with Arduino Nano.
 In the rest of the documentation "Arduino" is used as a synonym for all supported boards regardless of the manufacturer.
 
-You have problems with a board not listed here, please open an [Issue](https://github.com/Legion2/CorsairLightingProtocol/issues).
+When you have problems with a board not listed here, please open an [Issue](https://github.com/Legion2/CorsairLightingProtocol/issues).
 
-## Install the library
-Use the [Library-Manager](https://www.ardu-badge.com/Corsair%20Lighting%20Protocol/ide) to install this library (Corsair Lighting Protocol).
-Additionally, the [FastLED](http://fastled.io/) library must be installed.
+## Install the libraries
+To use this library you must install it with the Library-Manager.
+Open the Library-Manager in Arduino IDE via Tools->Manage Libraries...
+Search for "Corsair Lighting Protocol" and install the Corsair Lighting Protocol library.
+This library also requires the [FastLED](http://fastled.io/) library.
+Search for "FastLED" in the Library-Manager and install the FastLED library.
 
 ## Create a Lighting Node PRO
 This guide will teach you how to create a Lighting Node PRO with an Arduino Leonardo compatible board.
 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).
 
-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.
+1. Open the example "LightingNodePRO", you can find it in Arduino IDE in the File menu->Examples->Corsair Lighting Protocol->LightingNodePRO.
+   If you can't open the LightingNodePRO example the Corsair Lighting Protocol library is not installed correctly.
 
    ![open example sketch](extra/images/open-example.png)
-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.
+1. Install the [CLP Boards](https://github.com/Legion2/CorsairLightingProtocolBoards).
+   They can be installed by following the [CLP Boards installation guide](https://github.com/Legion2/CorsairLightingProtocolBoards#how-to-use-these-boards-in-arduino).
+   After installation it should be possible to select the CLP Boards in the Arduino IDE as shown in the screenshot below.
+
+   ![select CLP Board](extra/images/select-board.png)
+1. Upload the "LightingNodePRO" sketch to your Arduino.
+
+   ![upload sketch](extra/images/upload-sketch.png)
 1. Do the wiring.
    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.
 
    ![the wiring](extra/images/board-wiring.jpg)
-1. Verify that your device works as expected.
+1. Verify your device works as expected.
    Open the Windows settings->devices->Other devices.
    Somewhere in the list of devices, there should be a device called "Lighting Node PRO".
-1. Now open [iCUE](https://www.corsair.com/icue) there should be the "Lighting Node PRO".
+1. Now open [iCUE](https://www.corsair.com/icue) there you should see the "Lighting Node PRO".
 
 ## Use the Lighting Node PRO
 
@@ -66,23 +79,22 @@ iCUE groups the LEDs into groups of ten.
 So if you have 20 LEDs, set the amount to 2.
 Now you can create lighting effects in the "Lighting Channel #" tabs.
 
-# Misc
+# Documentation
 
 - [API Documentation](https://legion2.github.io/CorsairLightingProtocol/)
 - [How it works](#how-it-works)
-- [Use multiple Devices](#use-multiple-devices)
+- [Use of multiple devices](#use-of-multiple-devices)
 - [Repeat or scale LED channel](#repeat-or-scale-led-channel)
 
 ## How it works
-This library uses the USB HID interface of the Arduino Micro or Leonardo.
-In the board.txt the unique VID and PID of a "Lighting Node PRO" are defined.
-After uploading a sketch with the library and these IDs, iCUE recognizes the Arduino as a Lighting Node PRO.
-In iCUE you can then select the "Lighting Node PRO" and set some lighting effects.
-iCUE sends these via the CorsairLightingProtocol to the Arduino.
+This library uses the USB HID interface of the ATmega32U4.
+After uploading a sketch with the library and selected CLP Boards, iCUE recognizes the Arduino as a Corsair device, because the CLP Boards use USB IDs of Corsair.
+In iCUE you can then select the device and set some lighting effects.
+iCUE sends these via the HID protocol to the Arduino.
 These commands are understood by the library and converted into lighting effects on the RGB strips connected to the Arduino.
 The [FastLED](http://fastled.io/) library is used to control the LEDs.
 
-## Use multiple Devices
+## Use of multiple devices
 Each device has two unique IDs, that is, they should be unique.
 You must give each device a unique ID.
 There are two IDs that must be changed `Serial Number` and `DeviceID`.

examples/AdditionalFeatures/board.txt

@@ -0,0 +1,49 @@
+/*
+   Copyright 2020 Leon Kiefer
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+	   http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+#include <CorsairLightingProtocol.h>
+#include <FastLED.h>
+
+// Hint: The channels are swapped in iCUE, so the first channel in iCUE is here channel 2
+#define DATA_PIN_CHANNEL_1 2 // For the monitor backlight
+#define DATA_PIN_CHANNEL_2 3
+
+CRGB ledsChannel1[84];
+CRGB ledsChannel2[105];
+
+CorsairLightingFirmware firmware = corsairLS100Firmware();
+FastLEDController ledController(true);
+CorsairLightingProtocolController cLP(&ledController, &firmware);
+CorsairLightingProtocolHID cHID(&cLP);
+
+void setup() {
+	FastLED.addLeds<NEOPIXEL, DATA_PIN_CHANNEL_1>(ledsChannel1, 84);
+	FastLED.addLeds<NEOPIXEL, DATA_PIN_CHANNEL_2>(ledsChannel2, 105);
+	ledController.addLEDs(0, ledsChannel1, 84);
+	ledController.addLEDs(1, ledsChannel2, 105);
+	ledController.onUpdateHook(0, []() {
+		// gamma correction with gamma value 2.0. Use napplyGamma_video for other gamma values.
+		CLP::gammaCorrection(&ledController, 0);
+		//napplyGamma_video(ledsChannel1, 84, 2.2);
+	});
+}
+
+void loop() {
+	cHID.update();
+
+	if (ledController.updateLEDs()) {
+		FastLED.show();
+	}
+}

examples/AmbientBacklight/AmbientBacklight.ino

@@ -38,7 +38,7 @@ PROJECT_NAME           = "Corsair Lighting Protocol"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 0.9.1
+PROJECT_NUMBER         = 0.10.0
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a
@@ -2099,7 +2099,7 @@ INCLUDE_FILE_PATTERNS  =
 # recursively expanded use the := operator instead of the = operator.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-PREDEFINED             = USBCON
+PREDEFINED             = USBCON ARDUINO_ARCH_AVR
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
 # tag can be used to specify a list of macro names that should be expanded. The

examples/CommanderPRO/board.txt

@@ -1,11 +1,11 @@
 name=Corsair Lighting Protocol
-version=0.9.1
+version=0.10.0
 author=Leon Kiefer
 maintainer=Leon Kiefer
 sentence=Allows iCUE to control RGB LEDs.
 paragraph=The library mimics a Lighting Node PRO and can be controlled as such in iCUE.
 category=Device Control
 url=https://github.com/Legion2/CorsairLightingProtocol
-architectures=*
+architectures=avr
 includes=CorsairLightingProtocol.h
 depends=FastLED

examples/HoodLoader2CLPBridge/board.txt

@@ -33,7 +33,7 @@ void CorsairLightingFirmware::handleFirmwareCommand(const Command& command, cons
 	{
 	case READ_STATUS:
 	{
-		uint8_t statusData[] = { PROTOCOL_STATUS_OK };
+		uint8_t statusData[] = { status };
 		response->send(statusData, sizeof(statusData));
 		break;
 	}
@@ -76,6 +76,16 @@ void CorsairLightingFirmware::setDeviceID(const uint8_t* deviceID)
 	EEPROM.put(EEPROM_ADDRESS_DEVICE_ID, deviceId);
 }
 
+uint8_t CorsairLightingFirmware::getStatus()
+{
+	return status;
+}
+
+void CorsairLightingFirmware::setStatus(uint8_t a_status)
+{
+	status = a_status;
+}
+
 CorsairLightingFirmware corsairLightingNodePROFirmware()
 {
 	return CorsairLightingFirmware(corsairLightingNodePROFirmwareVersion);

examples/LS100/board.txt

@@ -35,9 +35,13 @@ class CorsairLightingFirmware {
 	void handleFirmwareCommand(const Command& command, const CorsairLightingProtocolResponse* response);
 	void getDeviceID(uint8_t* deviceID) const;
 	void setDeviceID(const uint8_t* deviceID);
+	uint8_t getStatus();
+	void setStatus(uint8_t status);
 protected:
 	const uint8_t* firmwareVersion;
 	uint8_t deviceId[4];
+private:
+	uint8_t status = PROTOCOL_STATUS_OK;
 };
 
 CorsairLightingFirmware corsairLightingNodePROFirmware();

examples/LightingNodeCORE/board.txt

@@ -15,7 +15,7 @@
 */
 #include "CorsairLightingNodePRO.h"
 
-#if defined(USBCON)
+#if defined(SUPPORT_RAW_HID)
 
 CorsairLightingNodePRO::CorsairLightingNodePRO() : ledController(true), cLP(&ledController, &firmware), connectionAdapter(&cLP)
 {

examples/LightingNodePRO/board.txt

@@ -22,7 +22,7 @@
 #include "CorsairLightingProtocolHID.h"
 #include <FastLED.h>
 
-#if defined(USBCON)
+#if defined(SUPPORT_RAW_HID)
 
 #define CHANNEL_LED_COUNT_DEFAULT 96
 

examples/NonAddressable/board.txt

@@ -14,9 +14,8 @@
    limitations under the License.
 */
 #include "CorsairLightingProtocolHID.h"
-#include "RawHID.h"
 
-#if defined(USBCON)
+#if defined(SUPPORT_RAW_HID)
 
 #if (RAWHID_TX_SIZE != RESPONSE_SIZE)
 #error "USB endpoint must be the same size as the protocol response"

examples/RepeatAndScale/board.txt

@@ -21,7 +21,9 @@
 #include "CorsairLightingProtocolResponse.h"
 #include "CorsairLightingProtocolConstants.h"
 
-#if defined(USBCON)
+#include "RawHID.h"
+
+#if defined(SUPPORT_RAW_HID)
 
 #if defined(DEBUG) && defined(VERBOSE)
 extern bool printCommand;

examples/SingleStripLightingNodePRO/board.txt

@@ -17,8 +17,7 @@
 #include "CorsairLightingProtocolConstants.h"
 
 void CorsairLightingProtocolResponse::send(const uint8_t* data, size_t size) const {
-	uint8_t response[RESPONSE_SIZE];
-	memset(response, 0x00, sizeof(response));
+	uint8_t response[RESPONSE_SIZE] = { 0x00 };
 	if (size + 1 > sizeof(response)) {
 		return;
 	}
@@ -28,18 +27,17 @@ void CorsairLightingProtocolResponse::send(const uint8_t* data, size_t size) con
 }
 
 void CorsairLightingProtocolResponse::sendError() const {
-	uint8_t response[RESPONSE_SIZE];
-	memset(response, 0x00, sizeof(response));
+	uint8_t response[RESPONSE_SIZE] = { 0x00 };
 	response[0] = PROTOCOL_RESPONSE_ERROR;
 	sendX(response, sizeof(response));
 }
 
 void CorsairLightingProtocolResponse::send_P(const uint8_t* data, size_t size) const {
-	uint8_t response[RESPONSE_SIZE];
-	memset(response, 0x00, sizeof(response));
+	uint8_t response[RESPONSE_SIZE] = { 0x00 };
 	if (size + 1 > sizeof(response)) {
 		return;
 	}
+	response[0] = PROTOCOL_RESPONSE_OK;
 	memcpy_P(response + 1, data, size);
 	sendX(response, sizeof(response));
 }

examples/TransformLLFansFormatToStrip/board.txt

@@ -45,6 +45,7 @@ void FanController::handleFanControl(const Command& command, const CorsairLighti
 				break;
 			case FanDetectionType::Disconnected:
 				mask[i] = FanMask::Disconnected;
+				break;
 			}
 		}
 		response->send(reinterpret_cast<byte*>(mask), sizeof(mask));