Merge pull request #99 from Legion2/road-to-stable

Improvements for stable release

Author: Legion2

.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)](https://github.com/Legion2/CorsairLightingProtocol/actions?query=workflow%3ATest+branch%3Adev+event%3Apush)
+# 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.**
 
@@ -88,11 +87,10 @@ Now you can create lighting effects in the "Lighting Channel #" tabs.
 - [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.
 

examples/AdditionalFeatures/board.txt

@@ -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

@@ -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/HoodLoader2CLPBridge/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/LS100/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/LightingNodeCORE/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/LightingNodePRO/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/NonAddressable/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/RepeatAndScale/board.txt

@@ -255,6 +255,8 @@ bool FastLEDController::updateLEDs()
 					}
 					else if (tempGroup < TEMPERATURE_NUM && temperatureController != nullptr) {
 						currentTemperature = temperatureController->getTemperature(tempGroup);
+					} else {
+						break;
 					}
 
 					CRGB color;

examples/SingleStripLightingNodePRO/board.txt

@@ -21,12 +21,9 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 */
-
 #include "RawHID.h"
-#if defined(USBCON)
-#ifndef HID_REPORTID_RAWHID
-#define HID_REPORTID_RAWHID 0x00
-#endif
+
+#if defined(ARDUINO_ARCH_AVR) && defined(USBCON)
 
 #ifndef HID_ENDPOINT_INTERVAL_RAWHID
 #define HID_ENDPOINT_INTERVAL_RAWHID 0x01

examples/TransformLLFansFormatToStrip/board.txt

@@ -26,18 +26,14 @@ THE SOFTWARE.
 #include <Arduino.h>
 
 #if defined(ARDUINO_ARCH_AVR)
+#include <HID.h>
+#endif
 
-#include "HID.h"
-#if defined(USBCON)
-
-#define EPTYPE_DESCRIPTOR_SIZE uint8_t
-// HID Functional Characteristics HID1.11 Page 10 4.4 Interfaces
-// Interrupt Out Endpoint is optional, contoll endpoint is used by default
-#define ENDPOINT_COUNT 1
-
-#define HID_ENDPOINT_IN	pluggedEndpoint
-#define HID_TX HID_ENDPOINT_IN
+#if defined(ARDUINO_ARCH_AVR) && defined(USBCON)
+#define SUPPORT_RAW_HID
+#endif
 
+#if defined(SUPPORT_RAW_HID)
 // RawHID might never work with multireports, because of OS problems
 // therefore we have to make it a single report with no idea. No other HID device will be supported then.
 #undef RAWHID_USAGE_PAGE
@@ -49,6 +45,18 @@ THE SOFTWARE.
 #define RAWHID_TX_SIZE 64
 #define RAWHID_RX_SIZE 64
 
+#endif
+
+#if defined(ARDUINO_ARCH_AVR) && defined(USBCON) // Arduino Core
+
+#define EPTYPE_DESCRIPTOR_SIZE uint8_t
+// HID Functional Characteristics HID1.11 Page 10 4.4 Interfaces
+// Interrupt Out Endpoint is optional, contoll endpoint is used by default
+#define ENDPOINT_COUNT 1
+
+#define HID_ENDPOINT_IN	pluggedEndpoint
+#define HID_TX HID_ENDPOINT_IN
+
 class RawHID_ : public PluggableUSBModule, public Stream
 {
 public:
@@ -167,4 +175,3 @@ class RawHID_ : public PluggableUSBModule, public Stream
 };
 extern RawHID_ RawHID;
 #endif
-#endif