When advertising a service with a 16bit UUID, the service is listed as a 128bit UUID on NRF Connect (#90)

Signed-off-by: Serge Gommers <[email protected]>

Author: sergegommers

Tests/NFUnitTest1/NFUnitTest1.nfproj

@@ -29,6 +29,7 @@
     <RunSettingsFilePath>$(MSBuildProjectDirectory)\nano.runsettings</RunSettingsFilePath>
   </PropertyGroup>
   <ItemGroup>
+    <Compile Include="TestUuidUtilities.cs" />
     <Compile Include="UnitTest1.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
   </ItemGroup>
@@ -37,6 +38,9 @@
       <HintPath>..\..\packages\nanoFramework.CoreLibrary.1.15.5\lib\mscorlib.dll</HintPath>
       <Private>True</Private>
     </Reference>
+    <Reference Include="nanoFramework.System.Runtime">
+      <HintPath>..\..\packages\nanoFramework.System.Runtime.1.0.27\lib\nanoFramework.System.Runtime.dll</HintPath>
+    </Reference>
     <Reference Include="nanoFramework.System.Text, Version=1.2.54.0, Culture=neutral, PublicKeyToken=c07d481e9758c731">
       <HintPath>..\..\packages\nanoFramework.System.Text.1.2.54\lib\nanoFramework.System.Text.dll</HintPath>
       <Private>True</Private>
@@ -57,6 +61,9 @@
   <ItemGroup>
     <ProjectReference Include="..\..\nanoFramework.Device.Bluetooth\nanoFramework.Device.Bluetooth.nfproj" />
   </ItemGroup>
+  <ItemGroup>
+    <Content Include="packages.lock.json" />
+  </ItemGroup>
   <Import Project="$(NanoFrameworkProjectSystemPath)NFProjectSystem.CSharp.targets" Condition="Exists('$(NanoFrameworkProjectSystemPath)NFProjectSystem.CSharp.targets')" />
   <!-- MANUAL UPDATE HERE -->
   <ProjectExtensions>

Tests/NFUnitTest1/TestUuidUtilities.cs

@@ -0,0 +1,89 @@
+//
+// Copyright (c) .NET Foundation and Contributors
+// See LICENSE file in the project root for full license information.
+//
+
+using System;
+using nanoFramework.TestFramework;
+using nanoFramework.Device.Bluetooth;
+
+namespace NFUnitTest1
+{
+  /// <summary>
+  /// Tests the different conversion and type detection functions for Bluetooth uuids
+  /// </summary>
+  [TestClass]
+  public class TestUuidUtilities
+  {
+    [TestMethod]
+    public void BaseUuidIsBluetoothSigUuid()
+    {
+      var baseUuid = new Guid("00000000-0000-1000-8000-00805f9b34fb");
+
+      Assert.IsTrue(Utilities.IsBluetoothSigUUID(baseUuid));
+
+      // the base uid marks the start of the pre-allocated range of 16bit or 32bit uuid values
+      // the 16bit or 32bit value is 0 so we give it the Uuid16 type
+      Assert.IsTrue(Utilities.TypeOfUuid(baseUuid) == Utilities.UuidType.Uuid16, "Expecting a 16bit uuid");
+    }
+
+    [TestMethod]
+    public void NonBaseUuidIs128Uuid()
+    {
+      var uuid = new Guid("00000000-0000-1000-8000-00805f9b34fc"); // last digit differs from base uuid
+
+      Assert.IsFalse(Utilities.IsBluetoothSigUUID(uuid));
+
+      // as this uid is not based on the base uid, the type is a random Uuid128
+      Assert.IsTrue(Utilities.TypeOfUuid(uuid) == Utilities.UuidType.Uuid128, "Expecting a 128bit uuid");
+    }
+
+    [TestMethod]
+    public void Test16BitUuids()
+    {
+      ushort value16 = 0x1234;
+
+      var serviceUid = Utilities.CreateUuidFromShortCode(value16);
+
+      var bytes = serviceUid.ToByteArray();
+      Assert.AreEqual((byte)0x34, bytes[0]);
+      Assert.AreEqual((byte)0x12, bytes[1]);
+      Assert.AreEqual((byte)0x00, bytes[2]);
+      Assert.AreEqual((byte)0x00, bytes[3]);
+
+      // the uuid must be recognized as falling in the range of 16 or 32bit uuids
+      Assert.IsTrue(Utilities.IsBluetoothSigUUID(serviceUid));
+
+      Assert.IsTrue(Utilities.TypeOfUuid(serviceUid) == Utilities.UuidType.Uuid16, "Expecting a 16bit uuid");
+
+      ushort result = Utilities.ConvertUuidToShortId(serviceUid);
+
+      Assert.AreEqual(value16, result, "After conversion, the end result must be the same value we started with");
+
+      var refGuid = new Guid("00001234-0000-1000-8000-00805F9B34FB");
+
+      Assert.AreEqual(refGuid, serviceUid, "The 16bit value is in the expected place of the 128bit uuid");
+    }
+
+    [TestMethod]
+    public void Test32BitUuids()
+    {
+      var uuid32 = new Guid("12345678-0000-1000-8000-00805F9B34FB"); // 32bit value equals 0x12345678
+
+      var bytes = uuid32.ToByteArray();
+      Assert.AreEqual((byte)0x78, bytes[0]);
+      Assert.AreEqual((byte)0x56, bytes[1]);
+      Assert.AreEqual((byte)0x34, bytes[2]);
+      Assert.AreEqual((byte)0x12, bytes[3]);
+
+      // the uuid must be recognized as falling in the range of 16 or 32bit uuids
+      Assert.IsTrue(Utilities.IsBluetoothSigUUID(uuid32));
+
+      Assert.IsTrue(Utilities.TypeOfUuid(uuid32) == Utilities.UuidType.Uuid32, "Expecting a 32bit uuid");
+
+      var result = Utilities.ConvertUuidToIntId(uuid32);
+
+      Assert.AreEqual(0x12345678, result, "After conversion, the end result must be the same value we started with");
+    }
+  }
+}

Tests/NFUnitTest1/nano.runsettings

@@ -10,6 +10,6 @@
    </RunConfiguration>
    <nanoFrameworkAdapter>
        <Logging>None</Logging>
-       <IsRealHardware>False</IsRealHardware>
+       <IsRealHardware>true</IsRealHardware>
    </nanoFrameworkAdapter>
 </RunSettings>

Tests/NFUnitTest1/packages.config

@@ -1,6 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
   <package id="nanoFramework.CoreLibrary" version="1.15.5" targetFramework="netnano1.0" />
+  <package id="nanoFramework.System.Runtime" version="1.0.27" targetFramework="netnano1.0" />
   <package id="nanoFramework.System.Text" version="1.2.54" targetFramework="netnano1.0" />
   <package id="nanoFramework.TestFramework" version="2.1.107" targetFramework="netnano1.0" developmentDependency="true" />
 </packages>

Tests/NFUnitTest1/packages.lock.json

@@ -8,6 +8,12 @@
         "resolved": "1.15.5",
         "contentHash": "u2+GvAp1uxLrGdILACAZy+EVKOs28EQ52j8Lz7599egXZ3GBGejjnR2ofhjMQwzrJLlgtyrsx8nSLngDfJNsAg=="
       },
+      "nanoFramework.System.Runtime": {
+        "type": "Direct",
+        "requested": "[1.0.27, 1.0.27]",
+        "resolved": "1.0.27",
+        "contentHash": "aMwvQV6AR+XlDc+dHR/fWWnTe5dc7LDaqZS0ccfmd31Y39dZnmX3iQB2wXWtZGvXLCC+obc3IF3Vc70FiG0raw=="
+      },
       "nanoFramework.System.Text": {
         "type": "Direct",
         "requested": "[1.2.54, 1.2.54]",

nanoFramework.Device.Bluetooth/Utilities.cs

@@ -138,7 +138,7 @@ public static ushort ConvertUuidToShortId(Guid uuid)
         public static UInt32 ConvertUuidToIntId(Guid uuid)
         {
             byte[] bytes = uuid.ToByteArray();
-            return (UInt32)((bytes[2] << 24) + (bytes[3] << 16) + (bytes[0] << 8) + bytes[1]);
+            return (UInt32)(bytes[0] | (bytes[1] << 8) | (bytes[2] << 16) | bytes[3] << 24);
         }
 
         /// <summary>
@@ -165,7 +165,7 @@ public static Guid CreateUuidFromShortCode(ushort uuid16)
         public static bool IsBluetoothSigUUID(Guid uuid)
         {
             byte[] bytes = uuid.ToByteArray();
-            for (int index = 0; index < baseUuid.Length; index++)
+            for (int index = 4; index < baseUuid.Length; index++)
             {
                 if (baseUuid[index] != bytes[index])
                 {
@@ -183,6 +183,12 @@ public static bool IsBluetoothSigUUID(Guid uuid)
         /// <returns>True if Sig UUID is 16bit UUID</returns>
         public static bool IsBluetoothSigUUID16(Guid uuid)
         {
+            // first check if the uid is based on the bluetooth base uid
+            if (!IsBluetoothSigUUID(uuid))
+            {
+                return false;
+            }
+
             byte[] bytes = uuid.ToByteArray();
             return (bytes[2] == 0) && (bytes[3] == 0);
         }
@@ -194,21 +200,20 @@ public static bool IsBluetoothSigUUID16(Guid uuid)
         /// <returns>UUID type.</returns>
         public static UuidType TypeOfUuid(Guid uuid)
         {
-            if (IsBluetoothSigUUID(uuid))
+            // 16bit values are based on the base uid and have the 2 MSB set to 0
+            if (IsBluetoothSigUUID16(uuid))
             {
-                // 16 bit or 32 bit Bluetooth SIG UUID
-                if (IsBluetoothSigUUID16(uuid))
-                {
-                    // 16bit UUID
-                    return UuidType.Uuid16;
-                }
-                else
-                {
-                    // 32bit UUID
-                    return UuidType.Uuid32;
-                }
+                // 16bit UUID
+                return UuidType.Uuid16;
+            }
+            // a 32bit value is based on the base uid
+            else if (IsBluetoothSigUUID(uuid))
+            {
+                // 32bit UUID
+                return UuidType.Uuid32;
             }
 
+            // the uid is not based on the base uid
             return UuidType.Uuid128;
         }
     }