Merge pull request #59 from Legion2/documentation-and-renaming

Refactorings

Author: Legion2

examples/CommanderPRO/CommanderPRO.ino

@@ -15,10 +15,7 @@
 */
 #include "SimpleFanController.h"
 #include "ThermistorTemperatureController.h"
-#include <CorsairLightingFirmware.h>
 #include <CorsairLightingProtocol.h>
-#include <CorsairLightingProtocolHID.h>
-#include <FastLEDController.h>
 #include <FastLED.h>
 
 #define DATA_PIN_CHANNEL_1 2
@@ -39,7 +36,7 @@ CorsairLightingFirmware firmware = corsairCommanderPROFirmware();
 ThermistorTemperatureController temperatureController;
 FastLEDController ledController(&temperatureController, true);
 SimpleFanController fanController(&temperatureController, FAN_UPDATE_RATE, EEPROM_ADDRESS + ledController.getEEPROMSize());
-CorsairLightingProtocol cLP(&ledController, &temperatureController, &fanController, &firmware);
+CorsairLightingProtocolController cLP(&ledController, &temperatureController, &fanController, &firmware);
 CorsairLightingProtocolHID cHID(&cLP);
 
 CRGB ledsChannel1[CHANNEL_LED_COUNT];

examples/DebugSketch/DebugSketch.ino

@@ -13,10 +13,7 @@
    See the License for the specific language governing permissions and
    limitations under the License.
 */
-#include <CorsairLightingFirmware.h>
-#include <FastLEDController.h>
 #include <CorsairLightingProtocol.h>
-#include <CorsairLightingProtocolHID.h>
 #include <FastLED.h>
 #include <EEPROM.h>
 
@@ -27,7 +24,7 @@
 
 CorsairLightingFirmware firmware = corsairLightingNodePROFirmware();
 FastLEDController ledController(true);
-CorsairLightingProtocol cLP(&ledController, &firmware);
+CorsairLightingProtocolController cLP(&ledController, &firmware);
 CorsairLightingProtocolHID cLPS(&cLP);
 
 CRGB ledsChannel1[CHANNEL_LED_COUNT];
@@ -65,7 +62,7 @@ void processCommand(String& cmd) {
 	if (cmd == F("print DeviceID")) {
 		byte DeviceId[4];
 		EEPROM.get(EEPROM_ADDRESS_DEVICE_ID, DeviceId);
-		printDeviceID(DeviceId);
+		CLP::printDeviceID(DeviceId);
 		Serial.println();
 	}
 #ifdef VERBOSE

examples/HoodLoader2UnoMegaController/HoodLoader2UnoMegaController.ino

@@ -13,10 +13,7 @@
    See the License for the specific language governing permissions and
    limitations under the License.
 */
-#include <CorsairLightingFirmware.h>
-#include <FastLEDController.h>
 #include <CorsairLightingProtocol.h>
-#include <CorsairLightingProtocolSerial.h>
 #include <FastLED.h>
 
 #define CHANNEL_LED_COUNT 96
@@ -26,7 +23,7 @@
 
 CorsairLightingFirmware firmware = corsairLightingNodePROFirmware();
 FastLEDController ledController(true);
-CorsairLightingProtocol cLP(&ledController, &firmware);
+CorsairLightingProtocolController cLP(&ledController, &firmware);
 CorsairLightingProtocolSerial cLPS(&cLP);
 
 CRGB ledsChannel1[CHANNEL_LED_COUNT];

examples/RepeatAndScale/RepeatAndScale.ino

@@ -13,11 +13,7 @@
    See the License for the specific language governing permissions and
    limitations under the License.
 */
-#include <CorsairLightingFirmware.h>
-#include <FastLEDController.h>
 #include <CorsairLightingProtocol.h>
-#include <CorsairLightingProtocolHID.h>
-#include <FastLEDControllerUtils.h>
 #include <FastLED.h>
 
 #define DATA_PIN_CHANNEL_1 2
@@ -28,7 +24,7 @@ CRGB ledsChannel2[144];
 
 CorsairLightingFirmware firmware = corsairLightingNodePROFirmware();
 FastLEDController ledController(true);
-CorsairLightingProtocol cLP(&ledController, &firmware);
+CorsairLightingProtocolController cLP(&ledController, &firmware);
 CorsairLightingProtocolHID cHID(&cLP);
 
 void setup() {

examples/SingleStripLightingNodePRO/SingleStripLightingNodePRO.ino

@@ -13,10 +13,7 @@
    See the License for the specific language governing permissions and
    limitations under the License.
 */
-#include <CorsairLightingFirmware.h>
-#include <FastLEDController.h>
 #include <CorsairLightingProtocol.h>
-#include <CorsairLightingProtocolHID.h>
 #include <FastLED.h>
 
 // The number of LEDs per channel.
@@ -32,7 +29,7 @@
 
 CorsairLightingFirmware firmware = corsairLightingNodePROFirmware();
 FastLEDController ledController(true);
-CorsairLightingProtocol cLP(&ledController, &firmware);
+CorsairLightingProtocolController cLP(&ledController, &firmware);
 CorsairLightingProtocolHID cHID(&cLP);
 
 // This array conatins all RGB values for the LEDs of the both channels.

examples/TransformLLFansFormatToStrip/TransformLLFansFormatToStrip.ino

@@ -13,11 +13,7 @@
    See the License for the specific language governing permissions and
    limitations under the License.
 */
-#include <CorsairLightingFirmware.h>
-#include <FastLEDController.h>
 #include <CorsairLightingProtocol.h>
-#include <CorsairLightingProtocolHID.h>
-#include <FastLEDControllerUtils.h>
 #include <FastLED.h>
 
 #define DATA_PIN_CHANNEL_1 2
@@ -28,7 +24,7 @@ CRGB ledsChannel2[60];
 
 CorsairLightingFirmware firmware = corsairLightingNodePROFirmware();
 FastLEDController ledController(true);
-CorsairLightingProtocol cLP(&ledController, &firmware);
+CorsairLightingProtocolController cLP(&ledController, &firmware);
 CorsairLightingProtocolHID cHID(&cLP);
 
 void setup() {

library.properties

@@ -7,4 +7,4 @@ paragraph=The library mimics a Lighting Node PRO and can be controlled as such i
 category=Device Control
 url=https://github.com/Legion2/CorsairLightingProtocol
 architectures=*
-includes=CorsairLightingProtocol.h,LEDController.h
+includes=CorsairLightingProtocol.h

src/CorsairLightingNodePRO.h

@@ -36,7 +36,7 @@ class CorsairLightingNodePRO {
 	CRGB ledsChannel2[CHANNEL_LED_COUNT_DEFAULT];
 	CorsairLightingFirmware firmware = corsairLightingNodePROFirmware();
 	FastLEDController ledController;
-	CorsairLightingProtocol cLP;
+	CorsairLightingProtocolController cLP;
 	CorsairLightingProtocolHID connectionAdapter;
 };
 

src/CorsairLightingProtocol.h

@@ -15,24 +15,20 @@
 */
 #pragma once
 
-#include "Arduino.h"
-
+// central include file for CorsairLightingProtocolController
 #include "CorsairLightingFirmware.h"
+#include "CorsairLightingNodePRO.h"
 #include "CorsairLightingProtocolConstants.h"
+#include "CorsairLightingProtocolController.h"
+#include "CorsairLightingProtocolHID.h"
 #include "CorsairLightingProtocolResponse.h"
+#include "CorsairLightingProtocolSerial.h"
 #include "IFanController.h"
+#include "FanController.h"
 #include "ILEDController.h"
+#include "LEDController.h"
+#include "FastLEDController.h"
 #include "ITemperatureController.h"
-
-class CorsairLightingProtocol
-{
-public:
-	CorsairLightingProtocol(ILEDController* l, CorsairLightingFirmware* c);
-	CorsairLightingProtocol(ILEDController* l, ITemperatureController* t, IFanController* f, CorsairLightingFirmware* c);
-	void handleCommand(const Command& command, CorsairLightingProtocolResponse* response);
-private:
-	CorsairLightingFirmware* const corsairLightingFirmware;
-	ILEDController* const ledController;
-	ITemperatureController* const temperatureController;
-	IFanController* const fanController;
-};
+#include "TemperatureController.h"
+#include "FastLEDControllerUtils.h"
+#include "CLPUtils.h"

src/CorsairLightingProtocol.cpp renamed to src/CorsairLightingProtocolController.cpp

@@ -13,14 +13,14 @@
    See the License for the specific language governing permissions and
    limitations under the License.
 */
-#include "CorsairLightingProtocol.h"
+#include "CorsairLightingProtocolController.h"
 #include "LEDController.h"
 
-CorsairLightingProtocol::CorsairLightingProtocol(ILEDController* aLEDController, CorsairLightingFirmware* corsairLightingFirmware) : corsairLightingFirmware(corsairLightingFirmware), ledController(aLEDController), temperatureController(nullptr), fanController(nullptr) {}
+CorsairLightingProtocolController::CorsairLightingProtocolController(ILEDController* aLEDController, CorsairLightingFirmware* corsairLightingFirmware) : corsairLightingFirmware(corsairLightingFirmware), ledController(aLEDController), temperatureController(nullptr), fanController(nullptr) {}
 
-CorsairLightingProtocol::CorsairLightingProtocol(ILEDController* aLEDController, ITemperatureController* temperatureController, IFanController* fanController, CorsairLightingFirmware* corsairLightingFirmware) : corsairLightingFirmware(corsairLightingFirmware), ledController(aLEDController), temperatureController(temperatureController), fanController(fanController) {}
+CorsairLightingProtocolController::CorsairLightingProtocolController(ILEDController* aLEDController, ITemperatureController* temperatureController, IFanController* fanController, CorsairLightingFirmware* corsairLightingFirmware) : corsairLightingFirmware(corsairLightingFirmware), ledController(aLEDController), temperatureController(temperatureController), fanController(fanController) {}
 
-void CorsairLightingProtocol::handleCommand(const Command& command, CorsairLightingProtocolResponse* response)
+void CorsairLightingProtocolController::handleCommand(const Command& command, CorsairLightingProtocolResponse* response)
 {
 	if (command.command < 0x10) {
 		corsairLightingFirmware->handleFirmwareCommand(command, response);

src/CorsairLightingProtocolController.h

@@ -0,0 +1,63 @@
+/*
+   Copyright 2019 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.
+*/
+#pragma once
+
+#include "Arduino.h"
+
+#include "CorsairLightingFirmware.h"
+#include "CorsairLightingProtocolConstants.h"
+#include "CorsairLightingProtocolResponse.h"
+#include "IFanController.h"
+#include "ILEDController.h"
+#include "ITemperatureController.h"
+
+/**
+ * The central Controller which integrates all components. The main components of the CorsairLightingProtocolController are the CorsairLightingFirmware
+ * and the LEDController. There can also be an optional TemperatureController and FanController which are required if the device should be an Commander PRO.
+ */
+class CorsairLightingProtocolController
+{
+public:
+	/**
+	 * The constructor used to create a Lighting Node PRO.
+	 * 
+	 * @param l The LEDController which should be used to control the LEDs of the created Lighting Node PRO
+	 * @param c The CorsairLightingFirmware used to handle Firmware related commands
+	 */
+	CorsairLightingProtocolController(ILEDController* l, CorsairLightingFirmware* c);
+	/**
+	 * The constructor used to create an Commander PRO.
+	 * 
+	 * @param l The LEDController which should be used to control the LEDs of the created Commander PRO
+	 * @param t The TemperatureController which used to messure the temperature of the created Commander PRO
+	 * @param f The FanController used to control the fans of the created Commander PRO
+	 * @param c The CorsairLightingFirmware used to handle Firmware related commands
+	 */
+	CorsairLightingProtocolController(ILEDController* l, ITemperatureController* t, IFanController* f, CorsairLightingFirmware* c);
+	/**
+	 * The only public function of the CorsairLightingProtocolController. It must be called to process a command with was received from iCUE. This
+	 * function is normaly called by CorsairLightingProtocolHID and CorsairLightingProtocolSerial adapters.
+	 * 
+	 * @param command The command received from iCUE
+	 * @param response The response callback which can be called to response to the command
+	 */
+	void handleCommand(const Command& command, CorsairLightingProtocolResponse* response);
+private:
+	CorsairLightingFirmware* const corsairLightingFirmware;
+	ILEDController* const ledController;
+	ITemperatureController* const temperatureController;
+	IFanController* const fanController;
+};

src/CorsairLightingProtocolHID.cpp

@@ -27,7 +27,7 @@ bool printCommand = PRINT_COMMAND;
 bool printResponse = PRINT_RESPONSE;
 #endif
 
-CorsairLightingProtocolHID::CorsairLightingProtocolHID(CorsairLightingProtocol* cLP) : cLP(cLP)
+CorsairLightingProtocolHID::CorsairLightingProtocolHID(CorsairLightingProtocolController* cLP) : cLP(cLP)
 {
 	RawHID.begin(rawhidData, sizeof(rawhidData));
 }

src/CorsairLightingProtocolHID.h

@@ -17,7 +17,7 @@
 
 #include "Arduino.h"
 
-#include "CorsairLightingProtocol.h"
+#include "CorsairLightingProtocolController.h"
 #include "CorsairLightingProtocolResponse.h"
 #include "CorsairLightingProtocolConstants.h"
 
@@ -30,11 +30,11 @@ extern bool printResponse;
 
 class CorsairLightingProtocolHID : CorsairLightingProtocolResponse {
 public:
-	CorsairLightingProtocolHID(CorsairLightingProtocol* cLP);
+	CorsairLightingProtocolHID(CorsairLightingProtocolController* cLP);
 	void update();
 protected:
 	uint8_t rawhidData[COMMAND_SIZE];
-	CorsairLightingProtocol* const cLP;
+	CorsairLightingProtocolController* const cLP;
 
 	bool available() const;
 	void getCommand(Command& command);

src/CorsairLightingProtocolSerial.cpp

@@ -15,7 +15,7 @@
 */
 #include "CorsairLightingProtocolSerial.h"
 
-CorsairLightingProtocolSerial::CorsairLightingProtocolSerial(CorsairLightingProtocol* cLP) : cLP(cLP) {}
+CorsairLightingProtocolSerial::CorsairLightingProtocolSerial(CorsairLightingProtocolController* cLP) : cLP(cLP) {}
 
 void CorsairLightingProtocolSerial::setup()
 {

src/CorsairLightingProtocolSerial.h

@@ -15,7 +15,7 @@
 */
 #pragma once
 
-#include <CorsairLightingProtocol.h>
+#include <CorsairLightingProtocolController.h>
 #include <CorsairLightingProtocolConstants.h>
 #include <CorsairLightingProtocolResponse.h>
 
@@ -25,12 +25,12 @@
 
 class CorsairLightingProtocolSerial : CorsairLightingProtocolResponse {
 public:
-	CorsairLightingProtocolSerial(CorsairLightingProtocol* cLP);
+	CorsairLightingProtocolSerial(CorsairLightingProtocolController* cLP);
 	void setup();
 	void update();
 private:
 	byte rawCommand[COMMAND_SIZE];
-	CorsairLightingProtocol* const cLP;
+	CorsairLightingProtocolController* const cLP;
 
 	bool handleSerial();
 	void sendX(const uint8_t* data, const size_t x) const override;

src/FanController.h

@@ -17,7 +17,6 @@
 
 #include "Arduino.h"
 
-#include "CorsairLightingProtocol.h"
 #include "IFanController.h"
 
 #define FAN_NUM 6