Merge pull request #123 from Legion2/timeout

Added timeout to SoftwarePlayback

Author: Legion2

src/FastLEDController.cpp

@@ -87,6 +87,9 @@ int FastLEDController::animation_step_count(int duration, int steps) {
 bool FastLEDController::updateLEDs() {
 	lastUpdate = currentUpdate;
 	currentUpdate = millis();
+	if (currentUpdate - lastCommand > LED_CONTROLLER_TIMEOUT) {
+		timeoutAction();
+	}
 
 	bool anyUpdate = false;
 
@@ -436,3 +439,10 @@ void FastLEDController::setLEDColorValues(uint8_t channel, uint8_t color, uint8_
 void FastLEDController::clearLEDColorValues(uint8_t channel) {
 	memset(channelData[channel].valuesBuffer[0], 0, channelData[channel].ledCount);
 }
+
+void FastLEDController::timeoutAction() {
+	for (int channelId = 0; channelId < CHANNEL_NUM; channelId++) {
+		triggerSave |= setLEDMode(channelId, ChannelMode::HardwarePlayback);
+	}
+	saveIfNeeded();
+}

src/FastLEDController.h

@@ -25,6 +25,10 @@
 #define EEPROM_ADDRESS 4
 #endif
 
+#ifndef LED_CONTROLLER_TIMEOUT
+#define LED_CONTROLLER_TIMEOUT 30000
+#endif
+
 /**
  * The default LEDController. This controller uses the FastLED library to implement the Hardware Lighting effects. Also
  * all RGB values of the LEDs are stored into CRGB arrays which can be used by the FastLED library to show them on the
@@ -154,4 +158,8 @@ class FastLEDController : public LEDController {
 	virtual void setLEDColorValues(uint8_t channel, uint8_t color, uint8_t offset, const uint8_t* values,
 								   size_t len) override;
 	virtual void clearLEDColorValues(uint8_t channel) override;
+	/**
+	 * This function is called when a timeout occurs.
+	 */
+	virtual void timeoutAction();
 };

src/LEDController.cpp

@@ -18,13 +18,11 @@
 #include "TemperatureController.h"
 
 void LEDController::handleLEDControl(const Command& command, const CorsairLightingProtocolResponse* response) {
+	lastCommand = millis();
 	auto& data = command.data;
 	if (command.command == WRITE_LED_TRIGGER) {
 		triggerLEDUpdate();
-		if (triggerSave) {
-			triggerSave = false;
-			save();
-		}
+		saveIfNeeded();
 	} else {
 		if (data[0] >= CHANNEL_NUM) {
 			response->sendError();
@@ -232,4 +230,11 @@ bool LEDController::setLEDPortType(uint8_t channel, PortType ledPortType) {
 		return true;
 	}
 	return false;
-}
+}
+
+bool LEDController::saveIfNeeded() {
+	if (triggerSave) {
+		triggerSave = false;
+		save();
+	}
+}

src/LEDController.h

@@ -195,6 +195,10 @@ class LEDController : public ILEDController {
 	 * Indicates that the configuration of the channels has been changed and should be saved.
 	 */
 	bool triggerSave = false;
+	/**
+	 * Stores the time at which the last command was received by the LEDController.
+	 */
+	long lastCommand = 0;
 
 	/**
 	 * Trigger update of the LEDs
@@ -246,4 +250,8 @@ class LEDController : public ILEDController {
 	virtual bool clearLEDGroups(uint8_t channel);
 	virtual bool save() = 0;
 	virtual bool load() = 0;
+	/**
+	 * Save if triggerSave is true and then reset triggerSave.
+	 */
+	bool saveIfNeeded();
 };