Merge pull request #16 from talbotmcinnis/SyncingSwitch

Syncing switches and RotarySyncingPotentiometer

Author: talbotmcinnis

examples/Synchronization/Synchronization.ino

@@ -70,3 +70,6 @@ void onModTimeChange(char* newValue) {
   }
 }
 DcsBios::StringBuffer<5> modTimeBuffer(0x043e, onModTimeChange);
+
+// Yet another option, some controls can be synced to DCS by combining a switch control with a Syncing version of that control.
+DcsBios::SyncingSwitch3Pos ahcpMasterArm("AHCP_MASTER_ARM", 2, 3, 0x10e8, 0x000c, 2);

releasenotes.md

@@ -1,8 +1,10 @@
-## v0.3.6 (VNext)
+## v0.3.6
 - Replaced InvertedPotentiometer class with a reverse bool constructor option for the existing potentiometer.
 - Added Synchronization example to layout different strategies for physical control <=> DCS synchronization on startup, periodic or on aircraft entry.
-  - Created new synchronization option via ResettableInput/resetThisState()
-- Added RotarySwitch for cockpits with a rotary encoder in place of N-Position switches
+- Created new single control reset/synchronization option via ResettableInput::resetThisState()
+- Created new RotarySyncingPotentiometer for simpits with a potentiometer in place of a rotary control, and an example to document usage.
+- Added RotarySwitch for cockpits with a rotary encoder in place of N-Position switches.
+- Created new Syncing Switches which are both an output to DCS, but also an input from DCS and will automatically re-send their state to DCS if DCS reports a different value.  Checkout Synchronization example for sample usage of SyncingSwitch3Pos.
 
 ## v0.3.5
 - Switched all examples to DCSBIOS_DEFAULTSERIAL for compatibility.

src/DcsBios.h

@@ -118,8 +118,10 @@ do not come with their own build system, we are just putting everything into the
 
 #include "internal/Buttons.h"
 #include "internal/Switches.h"
+#include "internal/SyncingSwitches.h"
 #include "internal/Encoders.h"
 #include "internal/Potentiometers.h"
+#include "internal/RotarySyncingPotentiometer.h"
 #include "internal/Leds.h"
 #include "internal/Servos.h"
 #include "internal/Dimmer.h"

src/internal/Potentiometers.h

@@ -58,7 +58,7 @@ namespace DcsBios {
 			{
 				msg_ = msg;
 			}
-        
+
 			void resetThisState()
 			{
 				this->resetState();

src/internal/RotarySyncingPotentiometer.h

@@ -0,0 +1,94 @@
+#ifndef __DCSBIOS_ROTARYPOTS_H
+#define __DCSBIOS_ROTARYPOTS_H
+
+#include <math.h>
+#include "Arduino.h"
+#include "PollingInput.h"
+
+namespace DcsBios {
+	template <unsigned long pollIntervalMs = POLL_EVERY_TIME, bool invert = false>
+	class RotarySyncingPotentiometerEWMA : PollingInput, Int16Buffer, public ResettableInput {
+		private:
+			void resetState()
+			{
+				lastState_ = (lastState_==0)?-1:0;
+			}
+			void pollInput() {
+				lastState_ = readState();
+			}
+
+			inline unsigned int readState()
+			{
+				return map(analogRead(pin_), invert?1023:0, invert?0:1023, 0, 65535);
+			}
+
+			const char* msg_;
+			char pin_;
+			unsigned int lastState_;
+
+			unsigned int mask;
+			unsigned char shift;
+
+			unsigned long lastSendTime;
+
+			int (*mapperCallback)(unsigned int, unsigned int);
+			
+		public:
+			RotarySyncingPotentiometerEWMA(const char* msg, char pin,
+				unsigned int syncToAddress, unsigned int syncToMask, unsigned char syncToShift,
+				int (*mapperCallback)(unsigned int, unsigned int)) :
+				PollingInput(pollIntervalMs), Int16Buffer(syncToAddress) {
+				msg_ = msg;
+				pin_ = pin;
+				pinMode(pin_, INPUT);
+				lastState_ = (float)readState();
+
+				this->mask = syncToMask;
+				this->shift = syncToShift;
+				lastSendTime = millis();
+
+				this->mapperCallback = mapperCallback;
+			}
+
+			void SetControl( const char* msg )
+			{
+				msg_ = msg;
+			}
+        
+			void resetThisState()
+			{
+				this->resetState();
+			}
+
+			unsigned int getData() {
+				return ((this->Int16Buffer::getData()) & mask) >> shift;
+			}
+
+			virtual void loop() {
+				unsigned int dcsData = getData();
+
+				int requiredAdjustment = mapperCallback(lastState_, dcsData);
+				
+				//Serial.println("**************");
+				//Serial.write("lastState_:");Serial.println(lastState_);
+				//Serial.write("dcsData:");Serial.println(dcsData);
+				//Serial.write("requiredAdjustment:");Serial.println(requiredAdjustment);
+				
+				// Send the adjustment to DCS
+				if( requiredAdjustment != 0 )
+				{
+					if( millis() - lastSendTime > 100)
+					{
+						char buff[7];
+						sprintf(buff, "%+d", requiredAdjustment);
+						tryToSendDcsBiosMessage(msg_, buff);
+						lastSendTime = millis();
+					}
+				}
+			}
+	};
+	typedef RotarySyncingPotentiometerEWMA<> RotarySyncingPotentiometer;
+	typedef RotarySyncingPotentiometerEWMA<POLL_EVERY_TIME, true> InvertedRotarySyncingPotentiometer;
+}
+
+#endif

src/internal/SyncingSwitches.h

@@ -0,0 +1,107 @@
+#ifndef __DCSBIOS_SYNCING_SWITCHES_H
+#define __DCSBIOS_SYNCING_SWITCHES_H
+
+#include <math.h>
+#include "Arduino.h"
+
+namespace DcsBios {
+	template <unsigned long pollIntervalMs = POLL_EVERY_TIME>
+	class SyncingSwitch3PosT : PollingInput, public ResettableInput, Int16Buffer
+	{
+	private:
+		const char* msg_;
+		char pinA_;
+		char pinB_;
+		char lastState_;
+		char steadyState_;
+		unsigned long debounceDelay_;
+		unsigned long lastDebounceTime = 0;
+
+		unsigned int mask;
+		unsigned char shift;
+
+		char readState() {
+			if (digitalRead(pinA_) == LOW) return 0;
+			if (digitalRead(pinB_) == LOW) return 2;
+			return 1;
+		}
+		void resetState()
+		{
+			lastState_ = (lastState_==0)?-1:0;
+			steadyState_ = lastState_;
+		}
+		void pollInput() {
+			char state = readState();
+			if (state != lastState_) {
+				lastDebounceTime = millis();
+			}
+
+			if ((millis() - lastDebounceTime) > debounceDelay_)
+			{
+				if (state != steadyState_) {
+					if (state == 0)
+					{
+						if (tryToSendDcsBiosMessage(msg_, "0"))
+							steadyState_ = state;
+					}
+					else if (state == 1)
+					{
+						if (tryToSendDcsBiosMessage(msg_, "1"))
+							steadyState_ = state;
+					}
+					else if (state == 2)
+					{
+						if(tryToSendDcsBiosMessage(msg_, "2"))
+							steadyState_ = state;
+					}
+				}
+			}
+
+			lastState_ = state;
+		}
+	public:
+		SyncingSwitch3PosT(const char* msg, char pinA, char pinB, 
+			unsigned int syncToAddress, unsigned int syncToMask, unsigned char syncToShift,
+			unsigned long debounceDelay = 50) :
+			PollingInput(pollIntervalMs), Int16Buffer(syncToAddress)
+		{
+			msg_ = msg;
+			pinA_ = pinA;
+			pinB_ = pinB;
+			pinMode(pinA_, INPUT_PULLUP);
+			pinMode(pinB_, INPUT_PULLUP);
+			lastState_ = readState();
+			steadyState_ = lastState_;
+			debounceDelay_ = debounceDelay;
+
+			this->mask = syncToMask;
+			this->shift = syncToShift;
+		}
+		
+		void SetControl( const char* msg )
+		{
+			msg_ = msg;
+		}
+
+		void resetThisState()
+		{
+			this->resetState();
+		}
+
+		unsigned int getData() {
+			return ((this->Int16Buffer::getData()) & mask) >> shift;
+		}
+
+		virtual void loop() {
+			if (hasUpdatedData()) {
+				unsigned int dcsData = getData();
+				// What DCS says is most important, so latch it as our last known state.  If the switch differs,
+				// it will be caught on the next pollInput
+				lastState_ = dcsData;
+			}
+		}
+	};
+	typedef SyncingSwitch3PosT<> SyncingSwitch3Pos;
+}
+
+#endif