Add PortInputFromat(Setup)Single|CombinedMode

tthiery · tthiery · commit 08f1ad58e8c9 · 2020-05-31T19:46:00.000+02:00
- Add Encoders for PortInputFormatCombinedMode
- Add Encoders for PortInputFormatSetupCombinedMode
diff --git a/README.md b/README.md
@@ -12,7 +12,7 @@ SharpBrick.PoweredUp is a .NET implementation of the BlueTooth Low Energy Protoc
 
 ***Note:** This is the current message driven interface. In future there will be a component model allowing a more comfortable access*
 
-## Discover Hubs
+## Discover Hubs (using raw bluetooth kernel)
 
 ````csharp
 var poweredUpBluetoothAdapter = new WinRTPoweredUpBluetoothAdapter();
@@ -35,7 +35,7 @@ Console.ReadLine();
 cts.Cancel(); // cancels the scanning process
 ````
 
-## Connect to Hub and Send a Message (and retrieving answers)
+## Connect to Hub and Send a Message and retrieving answers (using raw bluetooth kernel and messages)
 
 ````csharp
 using (var kernel = new BluetoothKernel(poweredUpBluetoothAdapter, bluetoothAddress, loggerFactory.CreateLogger<BluetoothKernel>()))
@@ -61,7 +61,7 @@ using (var kernel = new BluetoothKernel(poweredUpBluetoothAdapter, bluetoothAddr
 }
 ````
 
-## VISION: Future Hub Based Model
+## VISION: Hub Based Model
 
 ````csharp
 var host = new PoweredUpHost();
@@ -86,15 +86,23 @@ using (var hub = await host.FindHub<TechnicMediumHub>(bluetoothAddresss: 1234))
 
 - Bluetooth Adapter
   - [X] .NET Core 3.1 (on Windows 10 using WinRT)
-    - Library uses `Span<T>` therefore not supported in WinRT until arrival of .NET 5.
+    - Library uses `Span<T>` therefore not supported in .NET Framework 1.0-4.8 and UWP Apps until arrival of .NET 5 (WinForms and WPF work in .NET Core 3.1)
     - Library uses WinRT for communication therefore only Windows 10
-  - [ ] Xamarin.Essentials
-  - [ ] Blazor / WebBluetooth
+  - [ ] Xamarin (on iOS / Android using Xamarin.Essentials)
+  - [ ] Blazor (on Browser using WebBluetooth)
 - Hub Model
   - Hubs
     - [ ] Technic Medium Hub
     - .. other hubs depend on availability of hardware / contributions
   - Devices
+    - [ ] Technic Medium Hub - Rgb Light
+    - [ ] Technic Medium Hub - Current
+    - [ ] Technic Medium Hub - Voltage
+    - [ ] Technic Medium Hub - Temperature Sensor 1
+    - [ ] Technic Medium Hub - Temperature Sensor 2
+    - [ ] Technic Medium Hub - Accelerometer
+    - [ ] Technic Medium Hub - Gyro Sensor
+    - [ ] Technic Medium Hub - Tilt Sensor
     - [ ] Technic XLarge Motor
     - [ ] Technic Large Motor
 - Message Encoder
@@ -107,21 +115,21 @@ using (var hub = await host.FindHub<TechnicMediumHub>(bluetoothAddresss: 1234))
   - [X] [3.7. Hub Alerts](https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#hub-alerts)
   - [X] [3.8. Hub Attached I/O](https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#hub-attached-i-o)
   - [X] [3.9. Generic Error Messages](https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#generic-error-messages)
-  - ~~[ ] [3.10. H/W NetWork Commands](https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#h-w-network-commands)~~
-  - ~~[ ] [3.11. F/W Update - Go Into Boot Mode](https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#f-w-update-go-into-boot-mode)~~
-  - ~~[ ] [3.12. F/W Update Lock memory](https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#f-w-update-lock-memory)~~
-  - ~~[ ] [3.13. F/W Update Lock Status Request](https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#f-w-update-lock-status-request)~~
-  - ~~[ ] [3.14. F/W Lock Status](https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#f-w-lock-status)~~
+  - [ ] ~~[3.10. H/W NetWork Commands](https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#h-w-network-commands)~~
+  - [ ] ~~[3.11. F/W Update - Go Into Boot Mode](https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#f-w-update-go-into-boot-mode)~~
+  - [ ] ~~[3.12. F/W Update Lock memory](https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#f-w-update-lock-memory)~~
+  - [ ] ~~[3.13. F/W Update Lock Status Request](https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#f-w-update-lock-status-request)~~
+  - [ ] ~~[3.14. F/W Lock Status](https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#f-w-lock-status)~~
   - [X] [3.15. Port Information Request](https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#port-information-request)
   - [X] [3.16. Port Mode Information Request](https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#port-mode-information-request)
   - [X] [3.17. Port Input Format Setup (Single)](https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#port-input-format-setup-single)
-  - [ ] [3.18. Port Input Format Setup (CombinedMode)](https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#port-input-format-setup-combinedmode)
+  - [X] [3.18. Port Input Format Setup (CombinedMode)](https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#port-input-format-setup-combinedmode)
   - [X] [3.19. Port Information](https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#port-information)
   - [X] [3.20. Port Mode Information](https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#port-mode-information)
   - [ ] [3.21. Port Value (Single)](https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#port-value-single)
   - [ ] [3.22. Port Value (CombinedMode)](https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#port-value-combinedmode)
   - [X] [3.23. Port Input Format (Single)](https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#port-input-format-single)
-  - [ ] [3.24. Port Input Format (CombinedMode)](https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#port-input-format-combinedmode)
+  - [X] [3.24. Port Input Format (CombinedMode)](https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#port-input-format-combinedmode)
   - [ ] [3.25. Virtual Port Setup](https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#virtual-port-setup)
   - [ ] [3.26. Port Output Command](https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#port-output-command)
   - [ ] [3.27. Output Command 0x81 - Motor Sub Commands [0x01-0x3F]](https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#output-command-0x81-motor-sub-commands-0x01-0x3f)
diff --git a/examples/message-trace/Program.cs b/examples/message-trace/Program.cs
@@ -70,6 +70,7 @@ await kernel.ReceiveBytesAsync(async data =>
                             PortInformationForModeInfoMessage msg => $"Port Information - Port {msg.PortId} Total Modes {msg.TotalModeCount} / Capabilities Output:{msg.OutputCapability}, Input:{msg.InputCapability}, LogicalCombinable:{msg.LogicalCombinableCapability}, LogicalSynchronizable:{msg.LogicalSynchronizableCapability} / InputModes: {msg.InputModes:X}, OutputModes: {msg.InputModes:X}",
                             PortInformationForPossibleModeCombinationsMessage msg => $"Port Information (combinations) - Port {msg.PortId} Combinations: {string.Join(",", msg.ModeCombinations.Select(x => x.ToString("X")))}",
                             PortInputFormatSingleMessage msg => $"Port Input Format (Single) - Port {msg.PortId}, Mode {msg.Mode}, Threshold {msg.DeltaInterval}, Notification {msg.NotificationEnabled}",
+                            PortInputFormatCombinedModeMessage msg => $"Port Input Format (Combined Mode) - Port {msg.PortId} UsedCombinationIndex {msg.UsedCombinationIndex} Enabled {msg.MultiUpdateEnabled} Configured Modes {string.Join(",", msg.ConfiguredModeDataSetIndex)}",
                             UnknownMessage msg => $"Unknown Message Type: {(MessageType)msg.MessageType} Length: {msg.Length} Content: {BytesStringUtil.DataToString(data)}",
                             var unknown => $"{unknown.MessageType} (not yet formatted)",
                         };
@@ -86,12 +87,10 @@ await kernel.ReceiveBytesAsync(async data =>
                 // await kernel.SendBytesAsync(request);
 
                 // logger.LogInformation("Request PortInformation (ModeInfo)");
-                // request = MessageEncoder.Encode(new PortInformationRequestMessage() { PortId = 0, InformationType = PortInformationType.ModeInfo });
-                // await kernel.SendBytesAsync(request);
+                // await kernel.SendBytesAsync(MessageEncoder.Encode(new PortInformationRequestMessage() { PortId = 99, InformationType = PortInformationType.ModeInfo }));
 
                 // logger.LogInformation("Request PortInformation (ModeCombinations)");
-                // request = MessageEncoder.Encode(new PortInformationRequestMessage() { PortId = 0, InformationType = PortInformationType.PossibleModeCombinations });
-                // await kernel.SendBytesAsync(request);
+                // await kernel.SendBytesAsync(MessageEncoder.Encode(new PortInformationRequestMessage() { PortId = 99, InformationType = PortInformationType.PossibleModeCombinations }));
 
                 // logger.LogInformation("Request PortModeInformation(s)");
                 // await kernel.SendBytesAsync(MessageEncoder.Encode(new PortModeInformationRequestMessage() { PortId = 0, Mode = 0, InformationType = PortModeInformationType.ValueFormat }));
@@ -113,7 +112,9 @@ await kernel.ReceiveBytesAsync(async data =>
 
                 // await kernel.SendBytesAsync(BytesStringUtil.StringToData("09-00-81-00-11-07-64-64-00")); // 3.27.5
 
-                await kernel.SendBytesAsync(MessageEncoder.Encode(new PortInputFormatSetupSingleMessage() { PortId = 0, Mode = 0x03, DeltaInterval = 5, NotificationEnabled = true }));
+                // await kernel.SendBytesAsync(MessageEncoder.Encode(new PortInputFormatSetupSingleMessage() { PortId = 0, Mode = 0x03, DeltaInterval = 5, NotificationEnabled = true }));
+
+                await SetupPortInCombinedMode(kernel);
 
                 Console.ReadLine();
 
@@ -123,5 +124,58 @@ await kernel.ReceiveBytesAsync(async data =>
                 Console.ReadLine();
             }
         }
+
+        private static async Task SetupPortInCombinedMode(BluetoothKernel kernel)
+        {
+            await kernel.SendBytesAsync(MessageEncoder.Encode(new PortInputFormatSetupCombinedModeMessage()
+            {
+                PortId = 0,
+                SubCommand = PortInputFormatSetupCombinedSubCommand.LockDeviceForSetup,
+            }));
+
+            await kernel.SendBytesAsync(MessageEncoder.Encode(new PortInputFormatSetupCombinedModeForSetModeDataSetMessage()
+            {
+                PortId = 0,
+                SubCommand = PortInputFormatSetupCombinedSubCommand.SetModeAndDataSetCombination,
+                CombinationIndex = 0, // should refer 0b0000_0000_0000_1110 => SPEED POS APOS
+                ModeDataSets = new PortInputFormatSetupCombinedModeModeDataSet[] {
+                        new PortInputFormatSetupCombinedModeModeDataSet() { Mode = 0x01, DataSet = 0, },
+                        new PortInputFormatSetupCombinedModeModeDataSet() { Mode = 0x02, DataSet = 0, },
+                        new PortInputFormatSetupCombinedModeModeDataSet() { Mode = 0x03, DataSet = 0, },
+                    }
+            }));
+
+            await kernel.SendBytesAsync(MessageEncoder.Encode(new PortInputFormatSetupSingleMessage()
+            {
+                PortId = 0,
+                Mode = 0x01,
+                DeltaInterval = 10,
+                NotificationEnabled = true,
+            }));
+
+            await kernel.SendBytesAsync(MessageEncoder.Encode(new PortInputFormatSetupSingleMessage()
+            {
+                PortId = 0,
+                Mode = 0x02,
+                DeltaInterval = 10,
+                NotificationEnabled = true,
+            }));
+
+
+            await kernel.SendBytesAsync(MessageEncoder.Encode(new PortInputFormatSetupSingleMessage()
+            {
+                PortId = 0,
+                Mode = 0x03,
+                DeltaInterval = 10,
+                NotificationEnabled = true,
+            }));
+
+
+            await kernel.SendBytesAsync(MessageEncoder.Encode(new PortInputFormatSetupCombinedModeMessage()
+            {
+                PortId = 0,
+                SubCommand = PortInputFormatSetupCombinedSubCommand.UnlockAndStartWithMultiUpdateEnabled,
+            }));
+        }
     }
 }
diff --git a/src/SharpBrick.PoweredUp/Protocol/Formatter/MessageEncoder.cs b/src/SharpBrick.PoweredUp/Protocol/Formatter/MessageEncoder.cs
@@ -18,9 +18,11 @@ public static byte[] Encode(PoweredUpMessage message)
                 PortInformationRequestMessage msg => MessageType.PortInformationRequest,
                 PortModeInformationRequestMessage msg => MessageType.PortModeInformationRequest,
                 PortInputFormatSetupSingleMessage msg => MessageType.PortInputFormatSetupSingle,
+                PortInputFormatSetupCombinedModeMessage msg => MessageType.PortInputFormatSetupCombinedMode,
                 PortInformationMessage msg => MessageType.PortInformation,
                 PortModeInformationMessage msg => MessageType.PortModeInformation,
                 PortInputFormatSingleMessage msg => MessageType.PortInputFormatSingle,
+                PortInputFormatCombinedModeMessage msg => MessageType.PortInputFormatCombinedMode,
                 _ => throw new NotImplementedException(),
             };
 
@@ -50,9 +52,11 @@ private static IMessageContentEncoder CreateEncoder(MessageType messageType)
                 MessageType.PortInformationRequest => new PortInformationRequestEncoder(),
                 MessageType.PortModeInformationRequest => new PortModeInformationRequestEncoder(),
                 MessageType.PortInputFormatSetupSingle => new PortInputFormatSetupSingleEncoder(),
+                MessageType.PortInputFormatSetupCombinedMode => new PortInputFormatSetupCombinedModeEncoder(),
                 MessageType.PortInformation => new PortInformationEncoder(),
                 MessageType.PortModeInformation => new PortModeInformationEncoder(),
                 MessageType.PortInputFormatSingle => new PortInputFormatSingleEncoder(),
+                MessageType.PortInputFormatCombinedMode => new PortInputFormatCombinedModeEncoder(),
                 _ => null,
             };
 
diff --git a/src/SharpBrick.PoweredUp/Protocol/Formatter/PortInputFormatCombinedModeEncoder.cs b/src/SharpBrick.PoweredUp/Protocol/Formatter/PortInputFormatCombinedModeEncoder.cs
@@ -0,0 +1,32 @@
+using System;
+using System.Linq;
+using SharpBrick.PoweredUp.Protocol.Messages;
+
+namespace SharpBrick.PoweredUp.Protocol.Formatter
+{
+    public class PortInputFormatCombinedModeEncoder : IMessageContentEncoder
+    {
+        public ushort CalculateContentLength(PoweredUpMessage message)
+            => throw new NotImplementedException();
+
+        public PoweredUpMessage Decode(in Span<byte> data)
+        {
+            ushort bitMask = BitConverter.ToUInt16(data.Slice(2, 2));
+
+            return new PortInputFormatCombinedModeMessage()
+            {
+                PortId = data[0],
+                UsedCombinationIndex = (byte)(data[1] & 0b0000_0111),
+                MultiUpdateEnabled = (byte)(data[1] & 0b1000_0000) > 0,
+                ConfiguredModeDataSetIndex = Enumerable.Range(0, 16).Select(pos =>
+                    (bitMask & (0x01 << pos)) > 0 ? pos : -1
+                ).Where(mdi => mdi >= 0).ToArray(),
+            };
+        }
+
+        public void Encode(PoweredUpMessage message, in Span<byte> data)
+            => throw new NotImplementedException();
+
+    }
+
+}
diff --git a/src/SharpBrick.PoweredUp/Protocol/Formatter/PortInputFormatSetupCombinedModeEncoder.cs b/src/SharpBrick.PoweredUp/Protocol/Formatter/PortInputFormatSetupCombinedModeEncoder.cs
@@ -0,0 +1,36 @@
+﻿using System;
+using SharpBrick.PoweredUp.Protocol.Messages;
+
+namespace SharpBrick.PoweredUp.Protocol.Formatter
+{
+    public class PortInputFormatSetupCombinedModeEncoder : IMessageContentEncoder
+    {
+        public ushort CalculateContentLength(PoweredUpMessage message)
+            => (ushort)(message is PortInputFormatSetupCombinedModeForSetModeDataSetMessage setMessage ? 3 + setMessage.ModeDataSets.Length : 2);
+
+        public PoweredUpMessage Decode(in Span<byte> data)
+            => throw new NotImplementedException();
+
+        public void Encode(PoweredUpMessage message, in Span<byte> data)
+            => Encode(message as PortInputFormatSetupCombinedModeMessage ?? throw new ArgumentException(nameof(message)), data);
+        public void Encode(PortInputFormatSetupCombinedModeMessage message, in Span<byte> data)
+        {
+            data[0] = message.PortId;
+            data[1] = (byte)message.SubCommand;
+
+            if (message is PortInputFormatSetupCombinedModeForSetModeDataSetMessage setMessage)
+            {
+                data[2] = setMessage.CombinationIndex;
+                for (int idx = 0; idx < setMessage.ModeDataSets.Length; idx++)
+                {
+                    byte flag = (byte)(
+                        ((setMessage.ModeDataSets[idx].Mode & 0b0000_1111) << 4) +
+                        (setMessage.ModeDataSets[idx].DataSet & 0b0000_1111)
+                    );
+
+                    data[3 + idx] = flag;
+                }
+            }
+        }
+    }
+}
diff --git a/src/SharpBrick.PoweredUp/Protocol/Messages/PortInputFormatCombinedModeMessage.cs b/src/SharpBrick.PoweredUp/Protocol/Messages/PortInputFormatCombinedModeMessage.cs
@@ -0,0 +1,10 @@
+namespace SharpBrick.PoweredUp.Protocol.Messages
+{
+    public class PortInputFormatCombinedModeMessage : PoweredUpMessage
+    {
+        public byte PortId { get; set; }
+        public byte UsedCombinationIndex { get; set; }
+        public bool MultiUpdateEnabled { get; set; }
+        public int[] ConfiguredModeDataSetIndex { get; set; }
+    }
+}
diff --git a/src/SharpBrick.PoweredUp/Protocol/Messages/PortInputFormatSetupCombinedModeMessage.cs b/src/SharpBrick.PoweredUp/Protocol/Messages/PortInputFormatSetupCombinedModeMessage.cs
@@ -0,0 +1,14 @@
+﻿namespace SharpBrick.PoweredUp.Protocol.Messages
+{
+    public class PortInputFormatSetupCombinedModeMessage : PoweredUpMessage
+    {
+        public byte PortId { get; set; }
+        public PortInputFormatSetupCombinedSubCommand SubCommand { get; set; }
+    }
+
+    public class PortInputFormatSetupCombinedModeForSetModeDataSetMessage : PortInputFormatSetupCombinedModeMessage
+    {
+        public byte CombinationIndex { get; set; }
+        public PortInputFormatSetupCombinedModeModeDataSet[] ModeDataSets { get; set; }
+    }
+}
diff --git a/src/SharpBrick.PoweredUp/Protocol/Messages/PortInputFormatSetupCombinedModeModeDataSet.cs b/src/SharpBrick.PoweredUp/Protocol/Messages/PortInputFormatSetupCombinedModeModeDataSet.cs
@@ -0,0 +1,8 @@
+﻿namespace SharpBrick.PoweredUp.Protocol.Messages
+{
+    public class PortInputFormatSetupCombinedModeModeDataSet
+    {
+        public byte Mode { get; set; }
+        public byte DataSet { get; set; }
+    }
+}
diff --git a/src/SharpBrick.PoweredUp/Protocol/Messages/PortInputFormatSetupCombinedSubCommand.cs b/src/SharpBrick.PoweredUp/Protocol/Messages/PortInputFormatSetupCombinedSubCommand.cs
@@ -0,0 +1,11 @@
+namespace SharpBrick.PoweredUp.Protocol.Messages
+{
+    public enum PortInputFormatSetupCombinedSubCommand : byte
+    {
+        SetModeAndDataSetCombination = 0x01,
+        LockDeviceForSetup = 0x02,
+        UnlockAndStartWithMultiUpdateEnabled = 0x03,
+        UnlockAndStartWithMultiUpdateDisabled = 0x04,
+        ResetSensor = 0x06,
+    }
+}
diff --git a/src/SharpBrick.PoweredUp/Protocol/Messages/PortValueSingleMessage.cs b/src/SharpBrick.PoweredUp/Protocol/Messages/PortValueSingleMessage.cs
@@ -0,0 +1,8 @@
+namespace SharpBrick.PoweredUp.Protocol.Messages
+{
+    public class PortValueSingleMessage : PoweredUpMessage
+    {
+        public byte PortId { get; set; }
+        public byte[] InputValue { get; set; }
+    }
+}
diff --git a/test/SharpBrick.PoweredUp.Test/Protocol/Formatter/PortInputFormatCombinedModeEncoderTest.cs b/test/SharpBrick.PoweredUp.Test/Protocol/Formatter/PortInputFormatCombinedModeEncoderTest.cs
@@ -0,0 +1,28 @@
+using System;
+using System.Linq;
+using SharpBrick.PoweredUp.Protocol.Messages;
+using SharpBrick.PoweredUp.Utils;
+using Xunit;
+
+namespace SharpBrick.PoweredUp.Protocol.Formatter
+{
+    public class PortInputFormatCombinedModeEncoderTest
+    {
+        [Theory]
+        [InlineData("07-00-48-00-80-07-00", 0x00, 0x00, true, new int[] { 0, 1, 2 })]
+        public void PortInputFormatCombinedModeEncoder_Decode(string dataAsString, byte expectedPortId, byte expectedCombinationIndex, bool expectedEnabled, int[] expectedIndexes)
+        {
+            // arrange
+            var data = BytesStringUtil.StringToData(dataAsString);
+
+            // act
+            var message = MessageEncoder.Decode(data) as PortInputFormatCombinedModeMessage;
+
+            // assert
+            Assert.Equal(expectedPortId, message.PortId);
+            Assert.Equal(expectedCombinationIndex, message.UsedCombinationIndex);
+            Assert.Equal(expectedEnabled, message.MultiUpdateEnabled);
+            Assert.Collection(message.ConfiguredModeDataSetIndex, expectedIndexes.Select<int, Action<int>>(exp => (act) => Assert.Equal(exp, act)).ToArray());
+        }
+    }
+}
diff --git a/test/SharpBrick.PoweredUp.Test/Protocol/Formatter/PortInputFormatSetupCombinedModeEncoderTest.cs b/test/SharpBrick.PoweredUp.Test/Protocol/Formatter/PortInputFormatSetupCombinedModeEncoderTest.cs
diff --git a/test/SharpBrick.PoweredUp.Test/Protocol/Formatter/PortInputFormatSetupSingleEncoderTest.cs b/test/SharpBrick.PoweredUp.Test/Protocol/Formatter/PortInputFormatSetupSingleEncoderTest.cs
