feat: Onyx2 support

It turns out the protocol for the Onyx2 is identical to the
Fleshlight Launch, with the exception that the handshake
byte is written to the Cmd handle instead of the Tx.

This adds the characteristic set to the existing Launch
protocol class rather than duplicating it.

Fixes #320

Author: blackspherefollower

Buttplug.Server.Test/Bluetooth/Devices/KiirooOnyx2Tests.cs

@@ -0,0 +1,109 @@
+using System.Collections.Generic;
+using Buttplug.Core.Messages;
+using Buttplug.Server.Bluetooth.Devices;
+using Buttplug.Server.Test.Util;
+using JetBrains.Annotations;
+using NUnit.Framework;
+
+namespace Buttplug.Server.Test.Bluetooth.Devices
+{
+    [TestFixture]
+    public class KiirooOnyx2Tests
+    {
+        [NotNull]
+        private BluetoothDeviceTestUtils<KiirooOnyx2BluetoothInfo> testUtil;
+
+        [SetUp]
+        public void Init()
+        {
+            testUtil = new BluetoothDeviceTestUtils<KiirooOnyx2BluetoothInfo>();
+            testUtil.SetupTest("Onyx2");
+        }
+
+        [Test]
+        public void TestAllowedMessages()
+        {
+            testUtil.TestDeviceAllowedMessages(new Dictionary<System.Type, uint>()
+            {
+                { typeof(StopDeviceCmd), 0 },
+                { typeof(FleshlightLaunchFW12Cmd), 0 },
+                { typeof(LinearCmd), 1 },
+            });
+        }
+
+        [Test]
+        public void TestInitialize()
+        {
+            testUtil.TestDeviceInitialize(new List<(byte[], uint)>()
+            {
+                (new byte[1] { 0x0 }, (uint)KiirooOnyx2BluetoothInfo.Chrs.Cmd),
+            }, true);
+        }
+
+        // StopDeviceCmd test handled in GeneralDeviceTests
+
+        // In all device message tests, expect WriteWithResponse to be false.
+        [Test]
+        public void TestFleshlightLaunchFW12Cmd()
+        {
+            testUtil.TestDeviceMessage(new FleshlightLaunchFW12Cmd(4, 50, 50),
+                new List<(byte[], uint)>()
+                {
+                    (new byte[2] { 50, 50 }, (uint)KiirooOnyx2BluetoothInfo.Chrs.Tx),
+                }, false);
+        }
+
+        // TODO Test currently fails because we will send repeated packets to the launch. See #402.
+        /*
+        [Test]
+        public void TestRepeatedFleshlightLaunchFW12Cmd()
+        {
+            testUtil.TestDeviceMessage(new FleshlightLaunchFW12Cmd(4, 50, 50),
+                new List<byte[]>()
+                {
+                    new byte[2] { 50, 50 },
+                }, (uint)FleshlightLaunchBluetoothInfo.Chrs.Tx, false);
+            testUtil.TestDeviceMessageNoop(new FleshlightLaunchFW12Cmd(4, 50, 50));
+        }
+        */
+
+        [Test]
+        public void TestVectorCmd()
+        {
+            var msg = new LinearCmd(4, new List<LinearCmd.VectorSubcommand>
+            {
+                new LinearCmd.VectorSubcommand(0, 500, 0.5),
+            });
+            testUtil.TestDeviceMessage(msg,
+                new List<(byte[], uint)>()
+                {
+                    (new byte[2] { 50, 20 }, (uint)KiirooOnyx2BluetoothInfo.Chrs.Tx),
+                }, false);
+        }
+
+        [Test]
+        public void TestInvalidVectorCmdTooManyFeatures()
+        {
+            var msg = LinearCmd.Create(4, 0, 500, 0.75, 2);
+            testUtil.TestInvalidDeviceMessage(msg);
+        }
+
+        [Test]
+        public void TestInvalidVectorCmdWrongFeatures()
+        {
+            var msg = new LinearCmd(4,
+                new List<LinearCmd.VectorSubcommand>
+                {
+                    new LinearCmd.VectorSubcommand(0xffffffff, 500, 0.75),
+                });
+            testUtil.TestInvalidDeviceMessage(msg);
+        }
+
+        [Test]
+        public void TestInvalidVectorNotEnoughFeatures()
+        {
+            var msg = LinearCmd.Create(4, 0, 500, 0.75, 0);
+            testUtil.TestInvalidDeviceMessage(msg);
+        }
+    }
+}

Buttplug.Server.Test/Buttplug.Server.Test.csproj

@@ -61,6 +61,7 @@
   <ItemGroup>
     <Compile Include="ArgsTests.cs" />
     <Compile Include="AssemblyGitVersionTests.cs" />
+    <Compile Include="Bluetooth\Devices\KiirooOnyx2Tests.cs" />
     <Compile Include="Bluetooth\Devices\FleshlightLaunchTests.cs" />
     <Compile Include="Bluetooth\Devices\GeneralDeviceTests.cs" />
     <Compile Include="Bluetooth\Devices\KiirooGen2VibeTests.cs" />

Buttplug.Server/Bluetooth/BluetoothSubtypeManager.cs

@@ -22,6 +22,7 @@ protected BluetoothSubtypeManager([NotNull] IButtplugLogManager aLogManager)
                 new FleshlightLaunchBluetoothInfo(),
                 new KiirooBluetoothInfo(),
                 new KiirooGen2VibeBluetoothInfo(),
+                new KiirooOnyx2BluetoothInfo(),
                 new YoucupsBluetoothInfo(),
                 new LovenseBluetoothInfo(),
                 new MagicMotionBluetoothInfo(),

Buttplug.Server/Bluetooth/Devices/FleshlightLaunch.cs

@@ -43,18 +43,63 @@ public IButtplugDevice CreateDevice(
         }
     }
 
+    internal class KiirooOnyx2BluetoothInfo : IBluetoothDeviceInfo
+    {
+        public enum Chrs : uint
+        {
+            Tx = 0,
+            Rx,
+            Cmd,
+        }
+
+        public string[] Names { get; } = { "Onyx2" };
+
+        public string[] NamePrefixes { get; } = { };
+
+        public Guid[] Services { get; } = { new Guid("f60402a6-0293-4bdb-9f20-6758133f7090") };
+
+        public Dictionary<uint, Guid> Characteristics { get; } = new Dictionary<uint, Guid>
+        {
+            // Tx
+            { (uint)Chrs.Tx, new Guid("02962ac9-e86f-4094-989d-231d69995fc2") },
+
+            // Rx
+            { (uint)Chrs.Rx, new Guid("d44d0393-0731-43b3-a373-8fc70b1f3323") },
+
+            // Cmd
+            { (uint)Chrs.Cmd, new Guid("c7b7a04b-2cc4-40ff-8b10-5d531d1161db") },
+        };
+
+        public IButtplugDevice CreateDevice(IButtplugLogManager aLogManager,
+            IBluetoothDeviceInterface aInterface)
+        {
+            return new FleshlightLaunch(aLogManager, aInterface, this);
+        }
+    }
+
     internal class FleshlightLaunch : ButtplugBluetoothDevice
     {
+        private static Dictionary<string, string> _brandNames = new Dictionary<string, string>
+        {
+            { "Launch", "Fleshlight" },
+            { "Onyx2", "Kiiroo" },
+        };
+
         private double _lastPosition;
 
         public FleshlightLaunch([NotNull] IButtplugLogManager aLogManager,
                                 [NotNull] IBluetoothDeviceInterface aInterface,
                                 [NotNull] IBluetoothDeviceInfo aInfo)
             : base(aLogManager,
-                   "Fleshlight Launch",
+                   aInterface.Name,
                    aInterface,
                    aInfo)
         {
+            if (_brandNames.ContainsKey(aInterface.Name))
+            {
+                Name = $"{_brandNames[aInterface.Name]} {aInterface.Name}";
+            }
+
             // Setup message function array
             MsgFuncs.Add(typeof(FleshlightLaunchFW12Cmd), new ButtplugDeviceWrapper(HandleFleshlightLaunchRawCmd));
             MsgFuncs.Add(typeof(LinearCmd), new ButtplugDeviceWrapper(HandleLinearCmd, new MessageAttributes() { FeatureCount = 1 }));
@@ -64,8 +109,15 @@ public FleshlightLaunch([NotNull] IButtplugLogManager aLogManager,
         public override async Task<ButtplugMessage> Initialize()
         {
             BpLogger.Trace($"Initializing {Name}");
+            var chr = (uint)FleshlightLaunchBluetoothInfo.Chrs.Tx;
+
+            if (Name == "Kiiroo Onyx2")
+            {
+                chr = (uint)KiirooOnyx2BluetoothInfo.Chrs.Cmd;
+            }
+
             return await Interface.WriteValue(ButtplugConsts.SystemMsgId,
-                (int)FleshlightLaunchBluetoothInfo.Chrs.Tx,
+                chr,
                 new byte[] { 0 },
                 true);
         }