Merge pull request #34 from DCSFlightpanels/document-EmulatedConcentricRotaryEncoder

Documentation and some cleanup of the code.  No functional changes.

Author: talbotmcinnis

examples/OneOfEverything/OneOfEverything.ino

@@ -7,72 +7,86 @@
  *#2 - Provide a very basic testing suite that developers can use to ensure that changes do not break existing sketches
  */
 
+// Some made-up pin assignments just to make the examples more readable
+const int PIN_A = 1;
+const int PIN_B = 2;
+const int ANALOG_PIN_A = 6;
+
 // Buttons
 ///////////
 // The simplest push button, a single momentary button on a single pin, which sends ARG_0 to MSG_0
-DcsBios::ActionButton iffDec("IFF_CODE", "INC", 1);
+DcsBios::ActionButton iffDec("IFF_CODE", "INC", PIN_A);
 
 // Used when a physical switch is a momentary button, but needs to sent alternating arguments each time it is pressed
-DcsBios::ToggleButton toggleButtonExample("MSG_0", "ARG_0", "ARG_1", 1);
+DcsBios::ToggleButton toggleButtonExample("MSG_0", "ARG_0", "ARG_1", PIN_A);
 
 // A dual mode button with a master switch which toggles the function of a physical pit button between two different DCS functions.  Think multi-seat aircraft.
-DcsBios::DualModeButton dualModeButtonExample(0, 1, "MSG_INMODE0", "MSG_INMODE1");
+DcsBios::DualModeButton dualModeButtonExample(PIN_A, PIN_B, "MSG_INMODE0", "MSG_INMODE1");
 
 // Switches
 ////////////
 // A standard two position on/off
-DcsBios::Switch2Pos switch2PosExample("MSG_0", 1);
+DcsBios::Switch2Pos switch2PosExample("MSG_0", PIN_A);
 // A three position on/off/on switch
-DcsBios::Switch3Pos switch3PosExample("MSG_0", 1, 2);
+DcsBios::Switch3Pos switch3PosExample("MSG_0", PIN_A, PIN_B);
 // A multiple position switch, often a rotary switch
 const byte multiPosPins[4] = {1,2,3,4};
 DcsBios::SwitchMultiPos switchMulitPosExample("MSG_0", multiPosPins, 4);
 // A switch that has a cover in DCS that must be opened before the switch itself can be activated
-DcsBios::SwitchWithCover2Pos pltLaunchbarAbort("PLT_LAUNCHBAR_ABORT", "PLT_LAUNCHBAR_ABORT_COVER", 6);
+DcsBios::SwitchWithCover2Pos pltLaunchbarAbort("PLT_LAUNCHBAR_ABORT", "PLT_LAUNCHBAR_ABORT_COVER", PIN_A);
 
 // Analogs
 ///////////
-// Use an analog input, divided into discrete steps
-DcsBios::AnalogMultiPos analogMultiPosExample("MSG_0", 1, 10);
+// Use an analog input, divided into (10) discrete steps
+DcsBios::AnalogMultiPos analogMultiPosExample("MSG_0", ANALOG_PIN_A, 10);
 
 // Other stuff
 // A Binary Coded Decimal wheel usually displaying digits for numeric entry, i.e. IFF code wheels.
-DcsBios::BcdWheel bcdWheelExample("MSG_0", 1, 2);
+DcsBios::BcdWheel bcdWheelExample("MSG_0", PIN_A, PIN_B);
 // A special case of bcdWheel that will send a radio frequency instead of raw digit
 DcsBios::RadioPreset radioPresetExample("MSG_0", 1, 2, 3, 4, 5);
 
 // Spinning things
 ///////////////////
+const int DATAPIN = 1;
+const int CLKPIN = 2;
+const int SWPIN = 3;
+
 // Rotary encoder on two pins to send INC/DEC arguments when rotated
-DcsBios::RotaryEncoder rotaryEncoderExample("MSG_0", "ARG_DEC", "ARG_INC", 1, 2);
+DcsBios::RotaryEncoder rotaryEncoderExample("MSG_0", "ARG_DEC", "ARG_INC", PIN_A, PIN_B);
 // A rotary encoder which will send larger increments when used continuously.  Originally written for faster gross adjustments to HSI.
-DcsBios::RotaryAcceleratedEncoder rotaryAcceleratedEncoderExample("MSG_0", "ARG_DEC", "ARG_INC", "FAST_INC", "FAST_DEC", 1, 2);
+DcsBios::RotaryAcceleratedEncoder rotaryAcceleratedEncoderExample("MSG_0", "ARG_DEC", "ARG_INC", "FAST_INC", "FAST_DEC", PIN_A, PIN_B);
+// A rotary with pushbutton, used to emulate a concentric rotary encoder.  Pushing the button toggles between two functions
+DcsBios::EmulatedConcentricRotaryEncoder ilsRightKnob("ILS_KHZ", "DEC", "INC", "ILS_VOL", "-4500", "+4500", DATAPIN, CLKPIN, SWPIN);
+
 // A linear/analog axis on a single pin
-DcsBios::Potentiometer potentiometerExample("MSG_0", 1);
+DcsBios::Potentiometer potentiometerExample("MSG_0", ANALOG_PIN_A);
 // A linear axis control where the physical or electrical range of the input does utilize the full 0 to 1023 range.
-DcsBios::Potentiometer clippedPotentiometerExample("MSG_0", false, 256, 768);
+DcsBios::Potentiometer clippedPotentiometerExample("MSG_0", ANALOG_PIN_A, false, 256, 768);
 
 // An inverted version of a linear axis control
-DcsBios::Potentiometer invertedPotentiometerExample("MSG_0", 1, true);
+DcsBios::Potentiometer invertedPotentiometerExample("MSG_0", ANALOG_PIN_A, true);
 
 // Rotary encoder being used to control something that is an N-pos switch in DCS.  3 represents the number of positions of the switch in DCS.
-DcsBios::RotarySwitch rotarySwitchExample("MSG_0", 1, 2, 3);
+DcsBios::RotarySwitch rotarySwitchExample("MSG_0", PIN_A, PIN_B, 3);
 
 // Outputs
 ///////////
+const int OUT_PIN_A = 15;
+const int ANALOG_OUT_PIN_A = 16;
 // A single LED
-DcsBios::Dimmer defaultDimmerExample(0x1012, 5);
-DcsBios::LED masterCaution(0x1012, 0x0800, 13);
+DcsBios::Dimmer defaultDimmerExample(0x1012, OUT_PIN_A);
+DcsBios::LED masterCaution(0x1012, 0x0800, OUT_PIN_A);
 // An analog output with a value that comes from a DCS address
-DcsBios::Dimmer dimmerExample(0x1012, 13);
-DcsBios::Dimmer invertedDimmerExample(0x1012, 5, 200, 0);
+DcsBios::Dimmer dimmerExample(0x1012, ANALOG_OUT_PIN_A);
+DcsBios::Dimmer invertedDimmerExample(0x1012, ANALOG_OUT_PIN_A, 200, 0);
 unsigned int myValueMapper(unsigned int dcsValue)
 {
   return dcsValue % 10;
 }
-DcsBios::Dimmer mappedDimmerExample(0x1012, 5, myValueMapper);
+DcsBios::Dimmer mappedDimmerExample(0x1012, ANALOG_OUT_PIN_A, myValueMapper);
 // A servo motor controlleed from DCS, i.e. a guage.
-DcsBios::ServoOutput servoExample(0x1012, 13, 544, 2400);
+DcsBios::ServoOutput servoExample(0x1012, ANALOG_OUT_PIN_A, 544, 2400);
 
 void setup() {
   DcsBios::setup();

releasenotes.md

@@ -2,6 +2,7 @@
 - Added input_min and input_max optional parameters to PotentiometerEWMA to allow a user to calibrate their analog inputs if their physical control does not utilize the full range available to the controller.
 - Fix Switch2Pos state reset logic, and improve it's internal debounce logic for a few edge cases.
 - Add DualModeButton for first multi-seat support.  Originally developed for use in Apache cockpits where one switch toggles the function of a physical button between front and back seat DCS control.
+- Included AerialElectron's Concentric Rotary Encoder Emulator.  Useful for simpits with a rotary that has a pushbutton, to emulate controlling two different dcs cockpit controls, especially if the dcs controls are dual-ring concentric rotaries.  Thanks for the contribution AerialElectron!
 
 ## v0.3.7
 - Integrate 2 and 3 position Matrix switches, thanks to Dehuman for the starting point!

src/internal/Encoders.h

@@ -294,7 +294,6 @@ namespace DcsBios {
 
   	//To emulate dual concentric rotary encoders/resolvers/potentiometers using a rotary encoder with a push button.
 	//Secondary message is used when push button or switch is enabled.
-
 	template <unsigned long pollIntervalMs = POLL_EVERY_TIME, StepsPerDetent stepsPerDetent = ONE_STEP_PER_DETENT>
 	class EmulatedConcentricRotaryEncoderT : PollingInput, public ResettableInput {
 	private:
@@ -306,29 +305,27 @@ namespace DcsBios {
 		const char* incArg2_;
 		char pinA_;
 		char pinB_;
-		char pinC_;	//Integrated button pin
+		char pinToggle_;	//Integrated button pin
 		bool msg1Mode_;
 		char prevMode_;
 		char lastState_;
 		signed char delta_;
 
 		char readState() {
-			return (digitalRead(pinA_) << 1) | digitalRead(pinB_);
-		}
-		
-		void checkPress() {
 			char currentMode;
-			msg1Mode_ = ((currentMode = digitalRead(pinC_)) != prevMode_)?!msg1Mode_:msg1Mode_;
+			msg1Mode_ = ((currentMode = digitalRead(pinToggle_)) != prevMode_)?!msg1Mode_:msg1Mode_;
 			prevMode_ = currentMode;
+
+			return (digitalRead(pinA_) << 1) | digitalRead(pinB_);
 		}
 
 		void resetState() {
+			msg1Mode_ = !msg1Mode_;
 			lastState_ = (lastState_==0)?-1:0;
 		}
 
 		void pollInput() {
 			char state = readState();
-			checkPress();
 			switch(lastState_) {
 				case 0:
 					if (state == 2) delta_--;
@@ -349,47 +346,42 @@ namespace DcsBios {
 			}
 			lastState_ = state;
 
-			if ((delta_ >= stepsPerDetent) && (msg1Mode_)) {
-				if (tryToSendDcsBiosMessage(msg1_, incArg1_))
-					delta_ -= stepsPerDetent;
-			}
-			if ((delta_ <= -stepsPerDetent) && (msg1Mode_)) {
-				if (tryToSendDcsBiosMessage(msg1_, decArg1_))
-					delta_ += stepsPerDetent;
-			}
-			if ((delta_ >= stepsPerDetent) && (!msg1Mode_)) {
-				if (tryToSendDcsBiosMessage(msg2_, incArg2_))
+			if (delta_ >= stepsPerDetent) {
+				if (tryToSendDcsBiosMessage(msg1Mode_?msg1_:msg2_, msg1Mode_?incArg1_:incArg2_))
 					delta_ -= stepsPerDetent;
 			}
-			if ((delta_ <= -stepsPerDetent) && (!msg1Mode_)) {
-				if (tryToSendDcsBiosMessage(msg2_, decArg2_))
+			if (delta_ <= -stepsPerDetent) {
+				if (tryToSendDcsBiosMessage(msg1Mode_?msg1_:msg2_, msg1Mode_?decArg1_:decArg2_))
 					delta_ += stepsPerDetent;
 			}
 		}
 	public:
 		EmulatedConcentricRotaryEncoderT(const char* msg1, const char* decArg1, const char* incArg1, const char* msg2, const char* decArg2, const char* incArg2, char pinA, char pinB, char pinC) :
-			PollingInput(pollIntervalMs) {
+			PollingInput(pollIntervalMs)
+		{
 			msg1_ = msg1;
 			decArg1_ = decArg1;
 			incArg1_ = incArg1;
 			msg2_ = msg2;
 			decArg2_ = decArg2;
 			incArg2_ = incArg2;
+			
 			pinA_ = pinA;
 			pinB_ = pinB;
-			pinC_ = pinC;
+			pinToggle_ = pinC;
 			msg1Mode_ = true;
-			prevMode_ = 1;
+			
 			pinMode(pinA_, INPUT_PULLUP);
 			pinMode(pinB_, INPUT_PULLUP);
-			pinMode(pinC_, INPUT_PULLUP);
-			prevMode_ = digitalRead(pinC_);	//Prevents defaulting to secondary action on initialization
+			pinMode(pinToggle_, INPUT_PULLUP);
+			prevMode_ = digitalRead(pinToggle_);	//Prevents defaulting to secondary action on initialization
+			
 			delta_ = 0;
 			lastState_ = readState();
 		}
 
 		void SetControl(const char* msg) {	
-			msg1_ = msg;
+			msg1_ = msg;	// Note this won't work to remap the second message
 		}