Add CreateShieldObject template function

Convenience function for creating objects that are compatible with the Sim Racing Shields (https://github.com/dmadison/Sim-Racing-Shields) without needing to look up or remember the pinout.

Author: dmadison

examples/Pedals/PedalsJoystick/PedalsJoystick.ino

@@ -36,7 +36,7 @@ const int Pin_Brake  = A1;
 const int Pin_Clutch = A0;
 
 SimRacing::LogitechPedals pedals(Pin_Gas, Pin_Brake, Pin_Clutch);
-//SimRacing::LogitechPedals pedals(PEDAL_SHIELD_V1_PINS);
+//SimRacing::LogitechPedals pedals = SimRacing::CreateShieldObject<SimRacing::LogitechPedals, 1>();
 
 Joystick_ Joystick(
 	JOYSTICK_DEFAULT_REPORT_ID,          // default report (no additional pages)

examples/Pedals/PedalsPrint/PedalsPrint.ino

@@ -32,7 +32,7 @@ const int Pin_Brake  = A1;
 const int Pin_Clutch = A0;
 
 SimRacing::LogitechPedals pedals(Pin_Gas, Pin_Brake, Pin_Clutch);
-//SimRacing::LogitechPedals pedals(PEDAL_SHIELD_V1_PINS);
+//SimRacing::LogitechPedals pedals = SimRacing::CreateShieldObject<SimRacing::LogitechPedals, 1>();
 
 
 void setup() {

examples/Shifter/LogitechShifter/LogitechShifter_Joystick/LogitechShifter_Joystick.ino

@@ -49,7 +49,7 @@ const int Pin_ShifterY   = A2;  // DE-9 pin 8
 const int Pin_ShifterRev = 2;   // DE-9 pin 2
 
 SimRacing::LogitechShifter shifter(Pin_ShifterX, Pin_ShifterY, Pin_ShifterRev);
-//SimRacing::LogitechShifter shifter(SHIFTER_SHIELD_V1_PINS);
+//SimRacing::LogitechShifter shifter = SimRacing::CreateShieldObject<SimRacing::LogitechShifter, 2>();
 
 const int Gears[] = { 1, 2, 3, 4, 5, 6, -1 };
 const int NumGears = sizeof(Gears) / sizeof(Gears[0]);

examples/Shifter/LogitechShifter/LogitechShifter_Print/LogitechShifter_Print.ino

@@ -36,7 +36,7 @@ const int Pin_ShifterY   = A2;  // DE-9 pin 8
 const int Pin_ShifterRev = 2;   // DE-9 pin 2
 
 SimRacing::LogitechShifter shifter(Pin_ShifterX, Pin_ShifterY, Pin_ShifterRev);
-//SimRacing::LogitechShifter shifter(SHIFTER_SHIELD_V1_PINS);
+//SimRacing::LogitechShifter shifter = SimRacing::CreateShieldObject<SimRacing::LogitechShifter, 2>();
 
 const unsigned long PrintSpeed = 1500;  // ms
 unsigned long lastPrint = 0;

examples/Shifter/LogitechShifterG25/LogitechShifterG25_Joystick/LogitechShifterG25_Joystick.ino

@@ -50,6 +50,7 @@ SimRacing::LogitechShifterG25 shifter(
 	Pin_ShifterLatch, Pin_ShifterClock, Pin_ShifterData,
 	Pin_ShifterDetect, Pin_ShifterLED
 );
+//SimRacing::LogitechShifterG25 shifter = SimRacing::CreateShieldObject<SimRacing::LogitechShifterG25, 2>();
 
 // Set this option to 'true' to send the shifter's X/Y position
 // as a joystick. This is not needed for most games.

examples/Shifter/LogitechShifterG25/LogitechShifterG25_Print/LogitechShifterG25_Print.ino

@@ -46,6 +46,7 @@ SimRacing::LogitechShifterG25 shifter(
 	Pin_ShifterLatch, Pin_ShifterClock, Pin_ShifterData,
 	Pin_ShifterDetect, Pin_ShifterLED
 );
+//SimRacing::LogitechShifterG25 shifter = SimRacing::CreateShieldObject<SimRacing::LogitechShifterG25, 2>();
 
 // alias so we don't need to type so much
 using ShifterButton = SimRacing::LogitechShifterG25::Button;

examples/Shifter/LogitechShifterG27/LogitechShifterG27_Joystick/LogitechShifterG27_Joystick.ino

@@ -50,6 +50,7 @@ SimRacing::LogitechShifterG27 shifter(
 	Pin_ShifterLatch, Pin_ShifterClock, Pin_ShifterData,
 	Pin_ShifterDetect, Pin_ShifterLED
 );
+//SimRacing::LogitechShifterG27 shifter = SimRacing::CreateShieldObject<SimRacing::LogitechShifterG27, 2>();
 
 // Set this option to 'true' to send the shifter's X/Y position
 // as a joystick. This is not needed for most games.

examples/Shifter/LogitechShifterG27/LogitechShifterG27_Print/LogitechShifterG27_Print.ino

@@ -46,6 +46,7 @@ SimRacing::LogitechShifterG27 shifter(
 	Pin_ShifterLatch, Pin_ShifterClock, Pin_ShifterData,
 	Pin_ShifterDetect, Pin_ShifterLED
 );
+//SimRacing::LogitechShifterG27 shifter = SimRacing::CreateShieldObject<SimRacing::LogitechShifterG27, 2>();
 
 // alias so we don't need to type so much
 using ShifterButton = SimRacing::LogitechShifterG27::Button;

keywords.txt

@@ -44,6 +44,12 @@ LogitechShifterG25	KEYWORD1
 # Handbrake Classes
 Handbrake	KEYWORD1
 
+#######################################
+# Functions (KEYWORD2)
+#######################################
+
+CreateShieldObject	KEYWORD2
+
 #######################################
 # Peripheral Class Methods and Functions (KEYWORD2)
 #######################################

src/SimRacing.cpp

@@ -29,6 +29,83 @@
 
 namespace SimRacing {
 
+#if defined(__AVR_ATmega32U4__) || defined(SIM_RACING_DOXYGEN)
+
+template<>
+LogitechPedals CreateShieldObject<LogitechPedals, 1>() {
+	//  Power (VCC): DE-9 pin 9, bridged to DE-9 pin 6
+	// Ground (GND): DE-9 pin 1
+
+	const PinNum Pin_Gas    = A2;  // DE-9 pin 2
+	const PinNum Pin_Brake  = A1;  // DE-9 pin 3
+	const PinNum Pin_Clutch = A0;  // DE-9 pin 4
+	const PinNum Pin_Detect = 10;  // DE-9 pin 6, requires 10k Ohm pull-down
+
+	return LogitechPedals(Pin_Gas, Pin_Brake, Pin_Clutch, Pin_Detect);
+}
+
+template<>
+LogitechPedals CreateShieldObject<LogitechPedals, 2>() {
+	// version 2 of the pedals shield has the same pinout,
+	// so we can use the v1 function
+	return CreateShieldObject<LogitechPedals, 1>();
+}
+
+template<>
+LogitechShifter CreateShieldObject<LogitechShifter, 1>() {
+	//  Power (VCC): DE-9 pin 9, bridged to DE-9 pin 7
+	// Ground (GND): DE-9 pin 6
+	// DE-9 pin 3 (CS) needs to be pulled-up to VCC
+
+	const PinNum Pin_X_Wiper = A1;  // DE-9 pin 4
+	const PinNum Pin_Y_Wiper = A0;  // DE-9 pin 8
+	const PinNum Pin_DataOut = 14;  // DE-9 pin 2
+	const PinNum Pin_Detect  = A2;  // DE-9 pin 7, requires 10k Ohm pull-down
+
+	return LogitechShifter(Pin_X_Wiper, Pin_Y_Wiper, Pin_DataOut, Pin_Detect);
+}
+
+template<>
+LogitechShifter CreateShieldObject<LogitechShifter, 2>() {
+	// version 2 of the shifter shield has the same data pinout for
+	// the Driving Force shifter, so we can use the v1 function
+	return CreateShieldObject<LogitechShifter, 1>();
+}
+
+/**
+* Helper function to create either a LogitechShifterG27 or LogitechShifterG25
+* object using the v2 shifter shield pinout, as both use the same pins.
+*/
+template<class T>
+static T CreateShieldShifter() {
+	//  Power (VCC): DE-9 pin 9, bridged to DE-9 pin 1
+	// Ground (GND): DE-9 pin 6
+
+	const PinNum Pin_X_Wiper  = A1;  // DE-9 pin 4
+	const PinNum Pin_Y_Wiper  = A0;  // DE-9 pin 8
+	const PinNum Pin_DataOut  = 14;  // DE-9 pin 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, requires 100-120 Ohm series resistor
+
+	return T(Pin_X_Wiper, Pin_Y_Wiper, Pin_Latch, Pin_Clock, Pin_DataOut, Pin_Detect, Pin_LED);
+}
+
+template<>
+LogitechShifterG27 CreateShieldObject<LogitechShifterG27, 2>() {
+	return CreateShieldShifter<LogitechShifterG27>();
+}
+
+template<>
+LogitechShifterG25 CreateShieldObject<LogitechShifterG25, 2>() {
+	return CreateShieldShifter<LogitechShifterG25>();
+}
+#endif  // ATmega32U4 for shield functions
+
+
 /**
 * Take a pin number as an input and sanitize it to a known working value
 *