Updates for Pairing (Security and Authentication) (#65)

Author: AdrianSoundy

README.md

@@ -46,6 +46,8 @@ public static void Main()
 
             Console.WriteLine("Create Primary service - UUID A7EEDF2C-DA87-4CB5-A9C5-5151C78B0066");
 
+            BluetoothLEServer.Instance.DeviceName = "Test2";
+
             //The GattServiceProvider is used to create and advertise the primary service definition.
             //An extra device information service will be automatically created.
             GattServiceProviderResult result = GattServiceProvider.Create(serviceUuid);
@@ -84,7 +86,6 @@ public static void Main()
 
             // === Device Information Service ===
             DeviceInformationServiceService DifService = new(
-                    serviceProvider,
                     "nanoFramework",
                     "Test Client",
                     null, // no serial number
@@ -97,7 +98,7 @@ public static void Main()
             // === Environmental Sensor Service ===
             // https://www.bluetooth.com/specifications/specs/environmental-sensing-service-1-0/
             // This service exposes measurement data from an environmental sensors.
-            EnvService = new EnvironmentalSensorService(serviceProvider);
+            EnvService = new EnvironmentalSensorService();
 
             // Add sensors to service, return index so sensor can be updated later.
             iTempOut = EnvService.AddSensor(EnvironmentalSensorService.SensorType.Temperature, "Outside Temp");
@@ -122,7 +123,6 @@ public static void Main()
             // devices can see it with a specific device name.
             serviceProvider.StartAdvertising(new GattServiceProviderAdvertisingParameters()
             {
-                DeviceName = "Test2",
                 IsConnectable = true,
                 IsDiscoverable = true
             });

Tests/Client/Program.cs

@@ -27,7 +27,6 @@ public class DeviceInformationServiceService
         /// <param name="FirmwareRevision"></param>
         /// <param name="SoftwareRevision"></param>
         public DeviceInformationServiceService(
-            GattServiceProvider provider,
             string Manufacturer,
             string ModelNumber = null,
             string SerialNumber = null,
@@ -36,8 +35,14 @@ public DeviceInformationServiceService(
             string SoftwareRevision = null
             )
         {
-            // Add new Device Information Service to provider
-            _deviceInformationService = provider.AddService(GattServiceUuids.DeviceInformation);
+            GattServiceProviderResult pr = GattServiceProvider.Create(GattServiceUuids.DeviceInformation);
+            if (pr.Error != BluetoothError.Success)
+            {
+                throw new ApplicationException("Unable to create service");
+            }
+
+            // Pick up service
+            _deviceInformationService = pr.ServiceProvider.Service;
 
             CreateReadStaticCharacteristic(GattCharacteristicUuids.ManufacturerNameString, Manufacturer);
             CreateReadStaticCharacteristic(GattCharacteristicUuids.ModelNumberString, ModelNumber);

Tests/Client/Services/DeviceInformationService.cs

@@ -40,9 +40,16 @@ struct sensorItem
             public Buffer dataBuffer;
         };
 
-        public EnvironmentalSensorService(GattServiceProvider provider)
+        public EnvironmentalSensorService()
         {
-            _service = provider.AddService(GattServiceUuids.EnvironmentalSensing);
+            GattServiceProviderResult pr = GattServiceProvider.Create(GattServiceUuids.EnvironmentalSensing);
+            if (pr.Error != BluetoothError.Success)
+            {
+                throw new ApplicationException("Unable to create service");
+            }
+
+            // Pick up service
+            _service = pr.ServiceProvider.Service;
             _sensors = new();
         }
 

Tests/Client/Services/EnvironmentalSensorService.cs

@@ -24,19 +24,23 @@ public class TestService
         /// <summary>
         /// Create a test service
         /// </summary>
-        /// <param name="provider"></param>
-        public TestService(GattServiceProvider provider)
+        public TestService()
         {
-            // Add new test  Service to provider
-            _testService = provider.AddService(serviceUUID);
+            GattServiceProviderResult pr = GattServiceProvider.Create(serviceUUID);
+            if (pr.Error != BluetoothError.Success)
+            {
+                throw new ApplicationException("Unable to create service");
+            }
+
+            _testService = pr.ServiceProvider.Service;
 
             GattLocalCharacteristicParameters rxCommandPar = new GattLocalCharacteristicParameters()
             {
                 UserDescription = "RX command",
                 CharacteristicProperties = GattCharacteristicProperties.Write | GattCharacteristicProperties.WriteWithoutResponse
             };
 
-            GattLocalCharacteristicResult rxCommandRes = provider.Service.CreateCharacteristic(rxCommandUUID, rxCommandPar);
+            GattLocalCharacteristicResult rxCommandRes = pr.ServiceProvider.Service.CreateCharacteristic(rxCommandUUID, rxCommandPar);
             if (rxCommandRes.Error != nanoFramework.Device.Bluetooth.BluetoothError.Success)
             {
                 throw new ArgumentException("Unable to create RX Command");

Tests/Client/Services/TestService.cs

@@ -21,12 +21,12 @@ public void CreateProvider()
             GattServiceProvider serviceProvider;
 
             GattServiceProviderResult result = GattServiceProvider.Create(ServiceUuid1);
-            Assert.False(result.Error == BluetoothError.Success);
+            Assert.IsFalse(result.Error == BluetoothError.Success);
 
             serviceProvider = result.ServiceProvider;
-            Assert.Null(serviceProvider, "Service provider is null");
+            Assert.IsNull(serviceProvider, "Service provider is null");
 
-            Assert.True(serviceProvider.AdvertisementStatus == GattServiceProviderAdvertisementStatus.Stopped, "Advertisement status should be stopped");
+            Assert.IsTrue(serviceProvider.AdvertisementStatus == GattServiceProviderAdvertisementStatus.Stopped, "Advertisement status should be stopped");
         }
     }
 }

Tests/NFUnitTest1/UnitTest1.cs

@@ -0,0 +1,37 @@
+//
+// Copyright (c) .NET Foundation and Contributors
+// See LICENSE file in the project root for full license information.
+//
+
+namespace nanoFramework.Device.Bluetooth
+{
+    /// <summary>
+    /// Bluetooth Address class.
+    /// </summary>
+    public class BluetoothAddress
+    {
+        private readonly ulong _address;
+        private readonly BluetoothAddressType _addressType;
+
+        /// <summary>
+        /// BluetoothAddress constructor.
+        /// </summary>
+        /// <param name="Address">Bluetooth address.</param>
+        /// <param name="AddressType">Bluetooth Address type.</param>
+        public BluetoothAddress(ulong Address, BluetoothAddressType AddressType)
+        {
+            _address = Address;
+            _addressType = AddressType;
+        }
+
+        /// <summary>
+        /// Get Bluetooth address.
+        /// </summary>
+        public ulong Address { get => _address; }
+
+        /// <summary>
+        /// Gets Bluetooth type.
+        /// </summary>
+        public BluetoothAddressType AddressType { get => _addressType; }
+    }
+}

nanoFramework.Device.Bluetooth/BluetoothAddress.cs

@@ -6,70 +6,97 @@
 using System;
 using nanoFramework.Runtime.Events;
 
-namespace nanoFramework.Device.Bluetooth 
+namespace nanoFramework.Device.Bluetooth
 {
-    internal class BluetoothEventClient : BaseEvent
+    internal class BluetoothEventServer : BaseEvent
     {
         /// <summary>
-        /// Type of Bluetooth event
+        /// Type of Bluetooth event.
         /// </summary>
         public BluetoothEventType type;
 
         /// <summary>
-        /// Event or Connect id
+        /// Event or Connect id.
         /// </summary>
         public ushort id;
 
         /// <summary>
-        /// id of Characteristic
+        /// id of Characteristic.
         /// </summary>
         public ushort characteristicId;
 
         /// <summary>
-        /// id of Descriptor
+        /// id of Descriptor.
         /// </summary>
         public ushort descriptorId;
     }
 
     internal class BluetoothEventScan : BaseEvent
     {
         /// <summary>
-        /// Type of Bluetooth event
+        /// Type of Bluetooth event.
         /// </summary>
         public BluetoothEventType type;
 
         /// <summary>
-        /// Event id
+        /// Event id.
         /// </summary>
         public ushort id;
     }
 
     internal class BluetoothEventCentral : BaseEvent
     {
         /// <summary>
-        /// Type of Bluetooth event
+        /// Type of Bluetooth event.
         /// </summary>
         public BluetoothEventType type;
 
         /// <summary>
-        /// Connection Handle
+        /// Connection Handle.
         /// </summary>
         public ushort connectionHandle;
 
         /// <summary>
-        /// status of event
+        /// status of event.
         /// </summary>
         public ushort status;
 
         /// <summary>
-        /// Attribute Handle of service
+        /// Attribute Handle of service.
         /// </summary>
         public ushort serviceHandle;
 
         /// <summary>
-        /// Attribute Handle of characteristic
+        /// Attribute Handle of characteristic.
         /// </summary>
         public ushort characteristicHandle;
     }
 
+    internal class BluetoothEventSesssion : BaseEvent
+    {
+        /// <summary>
+        /// Type of Bluetooth event.
+        /// </summary>
+        public BluetoothEventType type;
+
+        /// <summary>
+        /// Connection Handle.
+        /// </summary>
+        public ushort connectionHandle;
+
+        /// <summary>
+        /// status of event.
+        /// </summary>
+        public ushort status;
+
+        /// <summary>
+        /// Any extra data.
+        /// </summary>
+        public ushort data;
+
+        /// <summary>
+        /// Used for when 32 bit data supplied (pin).
+        /// </summary>
+        public UInt32 data32;
+    }
 }