Cleanup (#25)

* Cleanup

* Update development time

Author: AstaRom

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020,2021,2022 awawa-dev
+Copyright (c) 2020,2021,2022,2023 awawa-dev
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

include/base.h

@@ -2,7 +2,7 @@
 *
 *  MIT License
 *
-*  Copyright (c) 2022 awawa-dev
+*  Copyright (c) 2023 awawa-dev
 *
 *  https://github.com/awawa-dev/HyperSerialEsp8266
 *
@@ -69,17 +69,17 @@ class Base
 			{
 				ledStrip1 = new LED_DRIVER(ledsNumber);
 				ledStrip1->Begin();
-			}			
+			}
 		}
 
 		/**
 		 * @brief Check if there is already prepared frame to display
-		 * 
-		 * @return true 
-		 * @return false 
+		 *
+		 * @return true
+		 * @return false
 		 */
 		inline bool hasLateFrameToRender()
-		{			
+		{
 			return readyToRender;
 		}
 
@@ -88,26 +88,26 @@ class Base
 			if (newFrame)
 				readyToRender = true;
 
-			if (readyToRender && 
+			if (readyToRender &&
 				(ledStrip1 != nullptr && ledStrip1->CanShow()))
-			{			
+			{
 				statistics.increaseShow();
 				readyToRender = false;
 
 				// display segments
-				ledStrip1->Show(false);				
+				ledStrip1->Show(false);
 			}
 		}
 
 		inline bool setStripPixel(uint16_t pix, ColorDefinition &inputColor)
 		{
 			if (pix < ledsNumber)
-			{				
-				ledStrip1->SetPixelColor(pix, inputColor);			
+			{
+				ledStrip1->SetPixelColor(pix, inputColor);
 			}
 
 			return (pix + 1 < ledsNumber);
-		}		
+		}
 } base;
 
 #endif

include/calibration.h

@@ -2,7 +2,7 @@
 *
 *  MIT License
 *
-*  Copyright (c) 2022 awawa-dev
+*  Copyright (c) 2023 awawa-dev
 *
 *  https://github.com/awawa-dev/HyperSerialEsp8266
 *
@@ -51,17 +51,17 @@ struct
 class CalibrationConfig
 {
 	// calibration parameters
-	uint8_t gain = 0xFF;	
+	uint8_t gain = 0xFF;
 	uint8_t red = 0xA0;
 	uint8_t green = 0xA0;
 	uint8_t blue = 0xA0;
 
 	/**
 	 * @brief Build the LUT table using provided parameters
-	 * 
+	 *
 	 */
 	void prepareCalibration()
-	{	
+	{
 		// prepare LUT calibration table, cold white is much better than "neutral" white
 		for (uint32_t i = 0; i < 256; i++)
 		{
@@ -77,7 +77,7 @@ class CalibrationConfig
 			channelCorrection.blue[i]  = (uint8_t)std::min(ROUND_DIVIDE(_blue, 0xFF), (uint32_t)0xFF);
 		}
 	}
-	
+
 	public:
 		CalibrationConfig()
 		{
@@ -86,7 +86,7 @@ class CalibrationConfig
 
 		/**
 		 * @brief Compare base calibration settings
-		 * 
+		 *
 		 */
 		bool compareCalibrationSettings(uint8_t _gain, uint8_t _red, uint8_t _green, uint8_t _blue)
 		{
@@ -95,11 +95,11 @@ class CalibrationConfig
 
 		/**
 		 * @brief Set the parameters that define RGB to RGBW transformation
-		 * 
-		 * @param _gain 
-		 * @param _red 
-		 * @param _green 
-		 * @param _blue 
+		 *
+		 * @param _gain
+		 * @param _red
+		 * @param _green
+		 * @param _blue
 		 */
 		void setParamsAndPrepareCalibration(uint8_t _gain, uint8_t _red, uint8_t _green, uint8_t _blue)
 		{
@@ -110,16 +110,16 @@ class CalibrationConfig
 				green = _green;
 				blue = _blue;
 				prepareCalibration();
-			}			
-		}		
+			}
+		}
 
 		/**
 		 * @brief print RGBW calibration parameters when no data is received
-		 * 
+		 *
 		 */
 		void printCalibration()
 		{
-			#ifdef SerialPort			
+			#ifdef SerialPort
 				SerialPort.write("\r\nRGBW => Gain: ");
 				SerialPort.print(gain);
 				SerialPort.write("/255, red: ");

include/framestate.h

@@ -2,7 +2,7 @@
 *
 *  MIT License
 *
-*  Copyright (c) 2022 awawa-dev
+*  Copyright (c) 2023 awawa-dev
 *
 *  https://github.com/awawa-dev/HyperSerialEsp8266
 *
@@ -30,7 +30,7 @@
 
 /**
  * @brief my AWA frame protocol definition
- * 
+ *
  */
 enum class AwaProtocol
 {
@@ -53,7 +53,7 @@ enum class AwaProtocol
 
 /**
  * @brief Contains current state of the incoming frame
- * 
+ *
  */
 class
 {
@@ -65,13 +65,13 @@ class
 	uint16_t fletcher1 = 0;
 	uint16_t fletcher2 = 0;
 
-	public:			
+	public:
 		ColorDefinition color;
 
 		/**
 		 * @brief Reset statistics for new frame
-		 * 
-		 * @param input 
+		 *
+		 * @param input
 		 */
 		inline void init(byte input)
 		{
@@ -84,8 +84,8 @@ class
 
 		/**
 		 * @brief get computed CRC
-		 * 
-		 * @return uint8_t 
+		 *
+		 * @return uint8_t
 		 */
 		inline uint8_t getCRC()
 		{
@@ -94,8 +94,8 @@ class
 
 		/**
 		 * @brief Get the color count reported by the frame
-		 * 
-		 * @return uint16_t 
+		 *
+		 * @return uint16_t
 		 */
 		inline uint16_t getCount()
 		{
@@ -104,8 +104,8 @@ class
 
 		/**
 		 * @brief Get the Fletcher1 total sum
-		 * 
-		 * @return uint16_t 
+		 *
+		 * @return uint16_t
 		 */
 		inline uint16_t getFletcher1()
 		{
@@ -114,8 +114,8 @@ class
 
 		/**
 		 * @brief Get the Fletcher2 total sum
-		 * 
-		 * @return uint16_t 
+		 *
+		 * @return uint16_t
 		 */
 		inline uint16_t getFletcher2()
 		{
@@ -124,8 +124,8 @@ class
 
 		/**
 		 * @brief Get and increase the current Led index
-		 * 
-		 * @return uint16_t 
+		 *
+		 * @return uint16_t
 		 */
 		inline uint16_t getCurrentLedIndex()
 		{
@@ -134,8 +134,8 @@ class
 
 		/**
 		 * @brief Set if frame protocol version 2 (contains calibration data)
-		 * 
-		 * @param newVer 
+		 *
+		 * @param newVer
 		 */
 		inline void setProtocolVersion2(bool newVer)
 		{
@@ -144,9 +144,9 @@ class
 
 		/**
 		 * @brief Verify if frame protocol version 2 (contains calibration data)
-		 * 
-		 * @return true 
-		 * @return false 
+		 *
+		 * @return true
+		 * @return false
 		 */
 		inline bool isProtocolVersion2()
 		{
@@ -155,8 +155,8 @@ class
 
 		/**
 		 * @brief  Set new AWA frame state
-		 * 
-		 * @param newState 
+		 *
+		 * @param newState
 		 */
 		inline void setState(AwaProtocol newState)
 		{
@@ -165,18 +165,18 @@ class
 
 		/**
 		 * @brief Get current AWA frame state
-		 * 
-		 * @return AwaProtocol 
+		 *
+		 * @return AwaProtocol
 		 */
 		inline AwaProtocol getState()
 		{
 			return state;
-		}		
+		}
 
 		/**
 		 * @brief Update CRC based on current and previuos input
-		 * 
-		 * @param input 
+		 *
+		 * @param input
 		 */
 		inline void computeCRC(byte input)
 		{
@@ -186,8 +186,8 @@ class
 
 		/**
 		 * @brief Update Fletcher checksumn for incoming input
-		 * 
-		 * @param input 
+		 *
+		 * @param input
 		 */
 		inline void addFletcher(byte input)
 		{
@@ -197,23 +197,23 @@ class
 
 		/**
 		 * @brief Check if the calibration data was updated and calculate new one
-		 * 
-		 */			
+		 *
+		 */
 		inline void updateIncomingCalibration()
 		{
 			#ifdef NEOPIXEL_RGBW
 				if (protocolVersion2)
 				{
-					calibrationConfig.setParamsAndPrepareCalibration(calibration.gain, calibration.red, calibration.green, calibration.blue);					
+					calibrationConfig.setParamsAndPrepareCalibration(calibration.gain, calibration.red, calibration.green, calibration.blue);
 				}
 			#endif
-		}		
+		}
+
 
-		
 		#ifdef NEOPIXEL_RGBW
 			/**
 			* @brief Compute && correct the white channel
-			* 
+			*
 			*/
 			inline void rgb2rgbw()
 			{
@@ -229,7 +229,7 @@ class
 
 		/**
 		 * @brief Incoming calibration data
-		 * 
+		 *
 		 */
 		struct
 		{
@@ -238,7 +238,7 @@ class
 			uint8_t green = 0;
 			uint8_t blue = 0;
 		} calibration;
-		
+
 } frameState;
 
 #endif