chore: Add motion-first-sent status to all protocols

Protocols all start with "last device state variables" that use primitive, non-nullable types. This means if the first command we send to a vibration device is 0, then the device thinks it's already at zero and doesn't sent it. Added boolean values that protocols can change in order to start skipping repeated commands after the first one is sent. Fixes #564
buttplugio · Feb 12, 2019 · bff181a · bff181a
1 parent 1a5b78b
commit bff181a
Show file tree

Hide file tree

Showing 14 changed files with 42 additions and 14 deletions.
diff --git a/Buttplug/Devices/ButtplugDeviceProtocol.cs b/Buttplug/Devices/ButtplugDeviceProtocol.cs
@@ -36,6 +36,10 @@ public abstract class ButtplugDeviceProtocol : IButtplugDeviceProtocol
         [NotNull]
         protected IButtplugDeviceImpl Interface;
 
+        protected bool SentVibration = false;
+        protected bool SentLinear = false;
+        protected bool SentRotation = false;
+
         /// <inheritdoc />
         public IEnumerable<Type> AllowedMessageTypes => MsgFuncs.Keys;
 

diff --git a/Buttplug/Devices/Protocols/CuemeProtocol.cs b/Buttplug/Devices/Protocols/CuemeProtocol.cs
@@ -169,7 +169,7 @@ private Task<ButtplugMessage> HandleVibrateCmd(ButtplugDeviceMessage aMsg, Cance
                 newVibratorSpeeds[v.Index] = v.Speed;
             }
 
-            if (newVibratorSpeeds.SequenceEqual(_vibratorSpeeds))
+            if (newVibratorSpeeds.SequenceEqual(_vibratorSpeeds) && SentVibration)
             {
                 return Task.FromResult(new Ok(aMsg.Id) as ButtplugMessage);
             }
@@ -183,6 +183,7 @@ private Task<ButtplugMessage> HandleVibrateCmd(ButtplugDeviceMessage aMsg, Cance
                 _updateValueTimer.Enabled = true;
             }
 
+            SentVibration = true;
             return Task.FromResult(new Ok(aMsg.Id) as ButtplugMessage);
         }
     }

diff --git a/Buttplug/Devices/Protocols/CycloneX10Protocol.cs b/Buttplug/Devices/Protocols/CycloneX10Protocol.cs
@@ -61,11 +61,12 @@ private async Task<ButtplugMessage> HandleRotateCmd(ButtplugDeviceMessage aMsg,
                 _speed = i.Speed;
             }
 
-            if (!changed)
+            if (!changed && SentRotation)
             {
                 return new Ok(cmdMsg.Id);
             }
 
+            SentRotation = true;
             // todo These comments don't match the actual settings below?!?!?!
             // [6] pause 0x30 + 0-1
             // [7] speed 0x30 + 0-10

diff --git a/Buttplug/Devices/Protocols/KiirooGen1Protocol.cs b/Buttplug/Devices/Protocols/KiirooGen1Protocol.cs
@@ -179,11 +179,12 @@ private async Task<ButtplugMessage> HandleVibrateCmd([NotNull] ButtplugDeviceMes
                         cmdMsg.Id);
                 }
 
-                if (Math.Abs(_deviceSpeed - v.Speed) < 0.001)
+                if (Math.Abs(_deviceSpeed - v.Speed) < 0.001 && SentVibration)
                 {
                     return new Ok(cmdMsg.Id);
                 }
 
+                SentVibration = true;
                 _deviceSpeed = v.Speed;
             }
 

diff --git a/Buttplug/Devices/Protocols/KiirooGen2VibeProtocol.cs b/Buttplug/Devices/Protocols/KiirooGen2VibeProtocol.cs
@@ -121,11 +121,14 @@ private async Task<ButtplugMessage> HandleVibrateCmd([NotNull] ButtplugDeviceMes
                 changed = true;
             }
 
-            if (!changed)
+
+            if (!changed && SentVibration)
             {
                 return new Ok(cmdMsg.Id);
             }
 
+            SentVibration = true;
+
             var data = new[]
             {
                 (byte)Convert.ToUInt16(_vibratorSpeeds[_devInfo.VibeOrder[0]] * 100),

diff --git a/Buttplug/Devices/Protocols/LiBoProtocol.cs b/Buttplug/Devices/Protocols/LiBoProtocol.cs
@@ -58,11 +58,13 @@ private async Task<ButtplugMessage> HandleVibrateCmd(ButtplugDeviceMessage aMsg,
                 _vibratorSpeed[v.Index] = v.Speed;
             }
 
-            if (!changed)
+            if (!changed && SentVibration)
             {
                 return new Ok(cmdMsg.Id);
             }
 
+            SentVibration = true;
+
             // Map a 0 - 100% value to a 0 - 3 value since 0 * x == 0 this will turn off the vibe if
             // speed is 0.00
             var mode = (int)Math.Ceiling(_vibratorSpeed[0] * 3);

diff --git a/Buttplug/Devices/Protocols/LovenseProtocol.cs b/Buttplug/Devices/Protocols/LovenseProtocol.cs
@@ -223,11 +223,12 @@ await Interface.WriteValueAsync(
                     Encoding.ASCII.GetBytes("RotateChange;"), false, aToken).ConfigureAwait(false);
             }
 
-            if (Math.Abs(_rotateSpeed - vi.Speed) < 0.0001)
+            if (Math.Abs(_rotateSpeed - vi.Speed) < 0.0001 && SentRotation)
             {
                 return new Ok(cmdMsg.Id);
             }
 
+            SentRotation = true;
             _rotateSpeed = vi.Speed;
 
             await Interface.WriteValueAsync(

diff --git a/Buttplug/Devices/Protocols/MagicMotionProtocol.cs b/Buttplug/Devices/Protocols/MagicMotionProtocol.cs
@@ -173,11 +173,12 @@ private async Task<ButtplugMessage> HandleVibrateCmd(ButtplugDeviceMessage aMsg,
                 _vibratorSpeeds[v.Index] = v.Speed;
             }
 
-            if (!changed)
+            if (!changed && SentVibration)
             {
                 return new Ok(cmdMsg.Id);
             }
 
+            SentVibration = true;
             byte[] data;
             switch (_devInfo.Protocol)
             {

diff --git a/Buttplug/Devices/Protocols/MysteryVibeProtocol.cs b/Buttplug/Devices/Protocols/MysteryVibeProtocol.cs
@@ -113,11 +113,13 @@ private Task<ButtplugMessage> HandleVibrateCmd(ButtplugDeviceMessage aMsg, Cance
                 newVibratorSpeeds[v.Index] = (byte)(v.Speed * MaxSpeed);
             }
 
-            if (newVibratorSpeeds.SequenceEqual(_vibratorSpeeds))
+            if (newVibratorSpeeds.SequenceEqual(_vibratorSpeeds) && SentVibration)
             {
                 return Task.FromResult(new Ok(aMsg.Id) as ButtplugMessage);
             }
 
+            SentVibration = true;
+
             _vibratorSpeeds = newVibratorSpeeds;
 
             if (!_updateValueTimer.Enabled)

diff --git a/Buttplug/Devices/Protocols/PicobongProtocol.cs b/Buttplug/Devices/Protocols/PicobongProtocol.cs
@@ -75,11 +75,13 @@ private async Task<ButtplugMessage> HandleVibrateCmd(ButtplugDeviceMessage aMsg,
                 _vibratorSpeed = v.Speed;
             }
 
-            if (!changed)
+            if (!changed && SentVibration)
             {
                 return new Ok(cmdMsg.Id);
             }
 
+            SentVibration = true;
+
             var speedInt = Convert.ToUInt16(_vibratorSpeed * 10);
 
             var data = new byte[] { 0x01, speedInt > 0 ? (byte)0x01 : (byte)0xff, Convert.ToByte(speedInt) };

diff --git a/Buttplug/Devices/Protocols/VibratissimoProtocol.cs b/Buttplug/Devices/Protocols/VibratissimoProtocol.cs
@@ -45,11 +45,13 @@ private async Task<ButtplugMessage> HandleVibrateCmd(ButtplugDeviceMessage aMsg,
             var cmdMsg = CheckGenericMessageHandler<VibrateCmd>(aMsg, 1);
             var v = cmdMsg.Speeds[0];
 
-            if (Math.Abs(v.Speed - _vibratorSpeed) < 0.001)
+            if (Math.Abs(v.Speed - _vibratorSpeed) < 0.001 && SentVibration)
             {
                 return new Ok(cmdMsg.Id);
             }
 
+            SentVibration = true;
+
             _vibratorSpeed = v.Speed;
 
             var data = new byte[] { 0x03, 0xff };

diff --git a/Buttplug/Devices/Protocols/VorzeSAProtocol.cs b/Buttplug/Devices/Protocols/VorzeSAProtocol.cs
@@ -108,11 +108,13 @@ private async Task<ButtplugMessage> HandleVorzeA10CycloneCmd(ButtplugDeviceMessa
         {
             var cmdMsg = CheckMessageHandler<VorzeA10CycloneCmd>(aMsg);
 
-            if (_clockwise == cmdMsg.Clockwise && _speed == cmdMsg.Speed)
+            if (_clockwise == cmdMsg.Clockwise && _speed == cmdMsg.Speed && SentRotation)
             {
                 return new Ok(cmdMsg.Id);
             }
 
+            SentRotation = true;
+
             _clockwise = cmdMsg.Clockwise;
             _speed = cmdMsg.Speed;
 
@@ -146,11 +148,13 @@ private async Task<ButtplugMessage> HandleVibrateCmd(ButtplugDeviceMessage aMsg,
                 _speed = tmpSpeed;
             }
 
-            if (!changed)
+            if (!changed && SentVibration)
             {
                 return new Ok(cmdMsg.Id);
             }
 
+            SentVibration = true;
+
             await Interface.WriteValueAsync(Endpoints.Tx,
                 new[] { (byte)_deviceType, (byte)_commandType, (byte)_speed }, false, aToken).ConfigureAwait(false);
             return new Ok(aMsg.Id);

diff --git a/Buttplug/Devices/Protocols/WeVibeProtocol.cs b/Buttplug/Devices/Protocols/WeVibeProtocol.cs
@@ -75,11 +75,13 @@ private async Task<ButtplugMessage> HandleVibrateCmd(ButtplugDeviceMessage aMsg,
                 _vibratorSpeed[v.Index] = v.Speed;
             }
 
-            if (!changed)
+            if (!changed && SentVibration)
             {
                 return new Ok(cmdMsg.Id);
             }
 
+            SentVibration = true;
+
             var rSpeedInt = Convert.ToUInt16(_vibratorSpeed[0] * 15);
             var rSpeedExt = Convert.ToUInt16(_vibratorSpeed[_vibratorCount - 1] * 15);
 

diff --git a/Buttplug/Devices/Protocols/YoucupsProtocol.cs b/Buttplug/Devices/Protocols/YoucupsProtocol.cs
@@ -57,11 +57,13 @@ private async Task<ButtplugMessage> HandleVibrateCmd(ButtplugDeviceMessage aMsg,
             var cmdMsg = CheckGenericMessageHandler<VibrateCmd>(aMsg, 1);
             var v = cmdMsg.Speeds[0];
 
-            if (Math.Abs(v.Speed - _vibratorSpeed) < 0.001)
+            if (Math.Abs(v.Speed - _vibratorSpeed) < 0.001 && SentVibration)
             {
                 return new Ok(cmdMsg.Id);
             }
 
+            SentVibration = true;
+
             _vibratorSpeed = v.Speed;
 
             await Interface.WriteValueAsync(