Swap G25/G27 LED and detect pin order

This is arbitrary, but it's important to get this change in there before the API is locked for the major release.

Originally, I figured that resistors were required for both pins (pull-down for the detect, series for the LED). In which case, it's more likely that users would want the detect feature (disabling inputs on disconnect) over the LED feature (...blinky).

After some testing I've determined that even though the LED should probably have a 100 Ohm resistor, it will survive without it. That means it's more likely for users to set it, in which case it should take precedence over the detect pin.

In addition, the LED pin is shared by the data input of the EEPROM chip. Although the library does not currently interface with the EEPROM, if it ever does that pin will become required. In which case, again, the detect pin would end up at the end of the list so it can have a default argument.

Author: dmadison

examples/Shifter/LogitechShifterG25/LogitechShifterG25_Joystick/LogitechShifterG25_Joystick.ino

@@ -55,7 +55,7 @@ const int Pin_ShifterDetect = SimRacing::UnusedPin;  // DE-9 pin 1
 SimRacing::LogitechShifterG25 shifter(
 	Pin_ShifterX, Pin_ShifterY,
 	Pin_ShifterLatch, Pin_ShifterClock, Pin_ShifterData,
-	Pin_ShifterDetect, Pin_ShifterLED
+	Pin_ShifterLED, Pin_ShifterDetect
 );
 //SimRacing::LogitechShifterG25 shifter = SimRacing::CreateShieldObject<SimRacing::LogitechShifterG25, 2>();
 

examples/Shifter/LogitechShifterG25/LogitechShifterG25_Print/LogitechShifterG25_Print.ino

@@ -51,7 +51,7 @@ const int Pin_ShifterDetect = SimRacing::UnusedPin;  // DE-9 pin 1
 SimRacing::LogitechShifterG25 shifter(
 	Pin_ShifterX, Pin_ShifterY,
 	Pin_ShifterLatch, Pin_ShifterClock, Pin_ShifterData,
-	Pin_ShifterDetect, Pin_ShifterLED
+	Pin_ShifterLED, Pin_ShifterDetect
 );
 //SimRacing::LogitechShifterG25 shifter = SimRacing::CreateShieldObject<SimRacing::LogitechShifterG25, 2>();
 

examples/Shifter/LogitechShifterG27/LogitechShifterG27_Joystick/LogitechShifterG27_Joystick.ino

@@ -53,7 +53,7 @@ const int Pin_ShifterDetect = SimRacing::UnusedPin;  // DE-9 pin 7
 SimRacing::LogitechShifterG27 shifter(
 	Pin_ShifterX, Pin_ShifterY,
 	Pin_ShifterLatch, Pin_ShifterClock, Pin_ShifterData,
-	Pin_ShifterDetect, Pin_ShifterLED
+	Pin_ShifterLED, Pin_ShifterDetect
 );
 //SimRacing::LogitechShifterG27 shifter = SimRacing::CreateShieldObject<SimRacing::LogitechShifterG27, 2>();
 

examples/Shifter/LogitechShifterG27/LogitechShifterG27_Print/LogitechShifterG27_Print.ino

@@ -49,7 +49,7 @@ const int Pin_ShifterDetect = SimRacing::UnusedPin;  // DE-9 pin 7
 SimRacing::LogitechShifterG27 shifter(
 	Pin_ShifterX, Pin_ShifterY,
 	Pin_ShifterLatch, Pin_ShifterClock, Pin_ShifterData,
-	Pin_ShifterDetect, Pin_ShifterLED
+	Pin_ShifterLED, Pin_ShifterDetect
 );
 //SimRacing::LogitechShifterG27 shifter = SimRacing::CreateShieldObject<SimRacing::LogitechShifterG27, 2>();
 

src/SimRacing.cpp

@@ -84,10 +84,10 @@ LogitechShifterG27 CreateShieldObject<LogitechShifterG27, 2>() {
 	const PinNum Pin_Latch    = 10;  // DE-9 pin 3, aka chip select, requires 10k Ohm pull-up
 	const PinNum Pin_Clock    = 15;  // DE-9 pin 1, should have 470 Ohm resistor to prevent shorts
 
-	const PinNum Pin_Detect   = A2;  // DE-9 pin 7, requires 10k Ohm pull-down
 	const PinNum Pin_LED      = 16;  // DE-9 pin 5, has a 100-120 Ohm series resistor
+	const PinNum Pin_Detect   = A2;  // DE-9 pin 7, requires 10k Ohm pull-down
 
-	return LogitechShifterG27(Pin_X_Wiper, Pin_Y_Wiper, Pin_Latch, Pin_Clock, Pin_DataOut, Pin_Detect, Pin_LED);
+	return LogitechShifterG27(Pin_X_Wiper, Pin_Y_Wiper, Pin_Latch, Pin_Clock, Pin_DataOut, Pin_LED, Pin_Detect);
 }
 
 template<>
@@ -102,10 +102,10 @@ LogitechShifterG25 CreateShieldObject<LogitechShifterG25, 2>() {
 	const PinNum Pin_Latch    = 10;  // DE-9 pin 3, aka chip select, requires 10k Ohm pull-up
 	const PinNum Pin_Clock    = A2;  // DE-9 pin 7, should have 470 Ohm resistor to prevent shorts
 
-	const PinNum Pin_Detect   = 15;  // DE-9 pin 1, requires 10k Ohm pull-down
 	const PinNum Pin_LED      = 16;  // DE-9 pin 5, has a 100-120 Ohm series resistor
+	const PinNum Pin_Detect   = 15;  // DE-9 pin 1, requires 10k Ohm pull-down
 
-	return LogitechShifterG25(Pin_X_Wiper, Pin_Y_Wiper, Pin_Latch, Pin_Clock, Pin_DataOut, Pin_Detect, Pin_LED);
+	return LogitechShifterG25(Pin_X_Wiper, Pin_Y_Wiper, Pin_Latch, Pin_Clock, Pin_DataOut, Pin_LED, Pin_Detect);
 }
 #endif  // ATmega32U4 for shield functions
 
@@ -1148,8 +1148,8 @@ LogitechShifter::LogitechShifter(PinNum pinX, PinNum pinY, PinNum pinRev, PinNum
 LogitechShifterG27::LogitechShifterG27(
 	PinNum pinX, PinNum pinY,
 	PinNum pinLatch, PinNum pinClock, PinNum pinData,
-	PinNum pinDetect,
-	PinNum pinLed
+	PinNum pinLed,
+	PinNum pinDetect
 ) :
 	LogitechShifter(pinX, pinY, UnusedPin, pinDetect),
 
@@ -1397,14 +1397,14 @@ const float LogitechShifterG25::CalReleasePoint = 0.50;
 LogitechShifterG25::LogitechShifterG25(
 	PinNum pinX, PinNum pinY,
 	PinNum pinLatch, PinNum pinClock, PinNum pinData,
-	PinNum pinDetect,
-	PinNum pinLed
+	PinNum pinLed,
+	PinNum pinDetect
 ) :
 	LogitechShifterG27(
 		pinX, pinY,
 		pinLatch, pinClock, pinData,
-		pinDetect,
-		pinLed
+		pinLed,
+		pinDetect
 	),
 
 	sequentialProcess(false),  // not in sequential mode

src/SimRacing.h

@@ -973,16 +973,16 @@ namespace SimRacing {
 		* @param pinLatch  digital output pin to pulse to latch data, DE-9 pin 3
 		* @param pinClock  digital output pin to pulse as a clock, DE-9 pin 1
 		* @param pinData   digital input pin to use for reading data, DE-9 pin 2
-		* @param pinDetect the digital input pin for device detection, DE-9 pin 7.
-		*                  Requires a pull-down resistor.
 		* @param pinLed    digital output pin to light the power LED on connection,
 		*                  DE-9 pin 5
+		* @param pinDetect digital input pin for device detection, DE-9 pin 7.
+		*                  Requires a pull-down resistor.
 		*/
 		LogitechShifterG27(
 			PinNum pinX, PinNum pinY,
 			PinNum pinLatch, PinNum pinClock, PinNum pinData,
-			PinNum pinDetect = UnusedPin,
-			PinNum pinLed    = UnusedPin
+			PinNum pinLed    = UnusedPin,
+			PinNum pinDetect = UnusedPin
 		);
 
 		/**
@@ -1106,16 +1106,16 @@ namespace SimRacing {
 		* @param pinLatch  digital output pin to pulse to latch data, DE-9 pin 3
 		* @param pinClock  digital output pin to pulse as a clock, DE-9 pin 7
 		* @param pinData   digital input pin to use for reading data, DE-9 pin 2
-		* @param pinDetect the digital input pin for device detection, DE-9 pin 1.
-		*                  Requires a pull-down resistor.
 		* @param pinLed    digital output pin to light the power LED on connection,
 		*                  DE-9 pin 5
+		* @param pinDetect digital input pin for device detection, DE-9 pin 1.
+		*                  Requires a pull-down resistor.
 		*/
 		LogitechShifterG25(
 			PinNum pinX, PinNum pinY,
 			PinNum pinLatch, PinNum pinClock, PinNum pinData,
-			PinNum pinDetect = UnusedPin,
-			PinNum pinLed    = UnusedPin
+			PinNum pinLed    = UnusedPin,
+			PinNum pinDetect = UnusedPin
 		);
 
 		/** @copydoc LogitechShifterG27::begin() */