feat(BluetoothDevice): add GetCurrentTime method (#4501)

* doc: 更新示例

* feat: 增加 BluetoothDeviceInfo 类

* doc: 更新示例

* feat: 增加蓝牙服务扩展方法

* feat: 增加 SoftwareRevision 参数

* feat: 增加 GetAllServices 扩展方法

* doc: 更新示例

* chore: 增加命名空间配置

* test: 增加测试代码

* feat: 增加 CurrentTime 解析方法

* feat: 增加 GetCurrentTime 方法

* doc: 更新示例

* feat: 支持时区

* doc: 更新注释

* doc: 更新示例

* test: 增加单元测试

* test: 增加单元测试

* doc: 更新示例

* test: 更新单元测试

Author: ArgoZhang

.editorconfig

@@ -217,7 +217,7 @@ visual_basic_preferred_modifier_order = Partial,Default,Private,Protected,Public
 [*.cs]
 # Add file header
 file_header_template = Licensed to the .NET Foundation under one or more agreements.\nThe .NET Foundation licenses this file to you under the Apache 2.0 License\nSee the LICENSE file in the project root for more information.\nMaintainer: Argo Zhang([email protected]) Website: https://www.blazor.zone
-csharp_style_namespace_declarations = block_scoped:silent
+csharp_style_namespace_declarations = file_scoped:silent
 csharp_style_expression_bodied_local_functions = false:silent
 csharp_using_directive_placement = outside_namespace:silent
 csharp_prefer_simple_using_statement = true:suggestion

src/BootstrapBlazor.Server/Components/Samples/Bluetooth.razor

@@ -21,6 +21,9 @@ private IBluetoothService? BluetoothService { get; set; }</Pre>
 <DemoBlock Title="@Localizer["BaseUsageTitle"]"
            Introduction="@Localizer["BaseUsageIntro"]"
            Name="Normal">
+    <section ignore>
+        @Localizer["UsageDesc"]
+    </section>
     <div class="row form-inline g-3">
         <div class="col-12">
             <Button Text="@Localizer["BluetoothRequestText"]" Icon="fa-brands fa-bluetooth" OnClick="RequestDevice"></Button>
@@ -36,6 +39,25 @@ private IBluetoothService? BluetoothService { get; set; }</Pre>
                 <label class="d-flex align-items-center"><progress value="@_batteryValue" max="100" class="ms-3"></progress><span class="ms-3">@_batteryValueString</span></label>
             </div>
         </div>
+        <div class="col-12">
+            <div class="d-flex align-items-center">
+                <Button Text="@Localizer["BluetoothGetCurrentTimeText"]" Icon="fa-solid fa-clock" IsDisabled="@(_blueDevice is not { Connected: true })" OnClick="GetTimeValue"></Button>
+                <label class="ms-3">@_currentTimeValueString</label>
+            </div>
+        </div>
+        <div class="col-12">
+            <div class="d-flex align-items-center">
+                <Button Text="@Localizer["BluetoothDeviceInfoText"]" Icon="fa-solid fa-microchip" IsDisabled="@(_blueDevice is not { Connected: true })" OnClick="GetDeviceInfoValue"></Button>
+            </div>
+        </div>
+        <div class="col-12">
+            <div>
+                @foreach (var info in _deviceInfoList)
+                {
+                    <div>@info</div>
+                }
+            </div>
+        </div>
     </div>
 </DemoBlock>
 

src/BootstrapBlazor.Server/Components/Samples/Bluetooth.razor.cs

@@ -24,9 +24,20 @@ public partial class Bluetooth
 
     private string? _batteryValueString = null;
 
+    private string? _currentTimeValueString = null;
+
     private async Task RequestDevice()
     {
-        _blueDevice = await BluetoothService.RequestDevice();
+        _blueDevice = await BluetoothService.RequestDevice(new BluetoothRequestOptions()
+        {
+            Filters = [
+                new BluetoothFilter()
+                {
+                     NamePrefix = "Argo"
+                }
+            ],
+            OptionalServices = ["device_information"]
+        });
         if (BluetoothService.IsSupport == false)
         {
             await ToastService.Error(Localizer["NotSupportBluetoothTitle"], Localizer["NotSupportBluetoothContent"]);
@@ -60,6 +71,11 @@ private async Task Disconnect()
             {
                 await ToastService.Error("Disconnect", _blueDevice.ErrorMessage);
             }
+            else
+            {
+                _batteryValue = null;
+                _batteryValueString = null;
+            }
         }
     }
 
@@ -81,4 +97,36 @@ private async Task GetBatteryValue()
             _batteryValueString = $"{_batteryValue} %";
         }
     }
+
+    private async Task GetTimeValue()
+    {
+        _currentTimeValueString = null;
+
+        if(_blueDevice != null) 
+        {
+            var val = await _blueDevice.GetCurrentTime();
+            if (val.HasValue && !string.IsNullOrEmpty(_blueDevice.ErrorMessage))
+            {
+                await ToastService.Error("Current Time", _blueDevice.ErrorMessage);
+                return;
+            }
+            _currentTimeValueString = val.ToString();
+        }
+    }
+
+    private readonly List<string> _deviceInfoList = [];
+
+    private async Task GetDeviceInfoValue()
+    {
+        _deviceInfoList.Clear();
+        if (_blueDevice != null)
+        {
+            var info = await _blueDevice.GetDeviceInfo();
+            _deviceInfoList.Add($"Manufacturer Name: {info?.ManufacturerName}");
+            _deviceInfoList.Add($"Module Number: {info?.ModelNumber}");
+            _deviceInfoList.Add($"Firmware Revision: {info?.FirmwareRevision}");
+            _deviceInfoList.Add($"Hardware Revision: {info?.HardwareRevision}");
+            _deviceInfoList.Add($"Software Revision: {info?.SoftwareRevision}");
+        }
+    }
 }

src/BootstrapBlazor.Server/Locales/en-US.json

@@ -5901,7 +5901,10 @@
     "BluetoothGetBatteryText": "Battery",
     "BluetoothGetHeartRateText": "HeartRate",
     "BaseUsageTitle": "Basic usage",
-    "BaseUsageIntro": "Request communication with Bluetooth devices through the <code>IBluetoothService</code> service"
+    "BaseUsageIntro": "Request communication with Bluetooth devices through the <code>IBluetoothService</code> service",
+    "BluetoothGetCurrentTimeText": "Time",
+    "BluetoothDeviceInfoText": "Device Info",
+    "UsageDesc": "Click the Scan button and select the phone to test in the pop-up window"
   },
   "BootstrapBlazor.Server.Components.Samples.FileIcons": {
     "Title": "File Icon",

src/BootstrapBlazor.Server/Locales/zh-CN.json

@@ -5901,7 +5901,10 @@
     "BluetoothGetBatteryText": "读取电量",
     "BluetoothGetHeartRateText": "读取心率",
     "BaseUsageTitle": "基础用法",
-    "BaseUsageIntro": "通过 <code>IBluetoothService</code> 服务，请求与蓝牙设备通讯"
+    "BaseUsageIntro": "通过 <code>IBluetoothService</code> 服务，请求与蓝牙设备通讯",
+    "BluetoothGetCurrentTimeText": "读取时间",
+    "BluetoothDeviceInfoText": "读取硬件信息",
+    "UsageDesc": "点击扫描按钮，在弹窗中选中手机进行测试"
   },
   "BootstrapBlazor.Server.Components.Samples.FileIcons": {
     "Title": "File Icon 文件图标",

src/BootstrapBlazor/Extensions/BluetoothExtensions.cs

@@ -0,0 +1,27 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the Apache 2.0 License
+// See the LICENSE file in the project root for more information.
+// Maintainer: Argo Zhang([email protected]) Website: https://www.blazor.zone
+
+using System.Reflection;
+using System.Text.Json.Serialization;
+
+namespace BootstrapBlazor.Components;
+
+/// <summary>
+/// Bluetooth 扩展方法
+/// </summary>
+public static class BluetoothExtensions
+{
+    /// <summary>
+    /// 获得指定蓝牙服务字符串集合
+    /// </summary>
+    /// <param name="services"></param>
+    /// <returns></returns>
+    public static List<string> GetServicesList(this IEnumerable<BluetoothServices> services) => services.Select(i =>
+    {
+        var v = i.ToString();
+        var attributes = typeof(BluetoothServices).GetField(v)!.GetCustomAttribute<JsonPropertyNameAttribute>(false)!;
+        return attributes.Name;
+    }).ToList();
+}

src/BootstrapBlazor/Services/Bluetooth/BluetoothDevice.cs

@@ -3,6 +3,8 @@
 // See the LICENSE file in the project root for more information.
 // Maintainer: Argo Zhang([email protected]) Website: https://www.blazor.zone
 
+using System.Globalization;
+
 namespace BootstrapBlazor.Components;
 
 /// <summary>
@@ -97,6 +99,41 @@ public async Task<bool> Disconnect(CancellationToken token = default)
         return ret;
     }
 
+    /// <summary>
+    /// <inheritdoc />
+    /// </summary>
+    /// <param name="token"></param>
+    /// <returns></returns>
+    public async Task<BluetoothDeviceInfo?> GetDeviceInfo(CancellationToken token = default)
+    {
+        BluetoothDeviceInfo? ret = null;
+        if (Connected)
+        {
+            ErrorMessage = null;
+            ret = await _module.InvokeAsync<BluetoothDeviceInfo?>("getDeviceInfo", token, _clientId, _interop, nameof(OnError));
+        }
+        return ret;
+    }
+
+    /// <summary>
+    /// <inheritdoc />
+    /// </summary>
+    /// <param name="token"></param>
+    /// <returns></returns>
+    public async Task<DateTimeOffset?> GetCurrentTime(CancellationToken token = default)
+    {
+        DateTimeOffset? ret = null;
+        if (Connected)
+        {
+            ErrorMessage = null;
+            var timeString = await _module.InvokeAsync<string?>("getCurrentTime", token, _clientId, _interop, nameof(OnError));
+            if (DateTimeOffset.TryParseExact(timeString, "yyyy-MM-ddTHH:mm:sszzz", DateTimeFormatInfo.InvariantInfo, DateTimeStyles.None, out var d))
+            {
+                ret = d;
+            }
+        }
+        return ret;
+    }
     /// <summary>
     /// JavaScript 报错回调方法
     /// </summary>

src/BootstrapBlazor/Services/Bluetooth/BluetoothDeviceInfo.cs

@@ -0,0 +1,88 @@
+// Copyright (c) Argo Zhang ([email protected]). All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+// Website: https://www.blazor.zone or https://argozhang.github.io/
+
+namespace BootstrapBlazor.Components;
+
+/// <summary>
+/// 蓝牙设备信息
+/// </summary>
+public class BluetoothDeviceInfo
+{
+    /// <summary>
+    /// 获得/设置 ManufacturerName
+    /// </summary>
+    public string? ManufacturerName { get; set; }
+
+    /// <summary>
+    /// 获得/设置 ModelNumber
+    /// </summary>
+    public string? ModelNumber { get; set; }
+
+    /// <summary>
+    /// 获得/设置 HardwareRevision
+    /// </summary>
+    public string? HardwareRevision { get; set; }
+
+    /// <summary>
+    /// 获得/设置 FirmwareRevision
+    /// </summary>
+    public string? FirmwareRevision { get; set; }
+
+    /// <summary>
+    /// 获得/设置 SoftwareRevision
+    /// </summary>
+    public string? SoftwareRevision { get; set; }
+
+    /// <summary>
+    /// 获得/设置 SystemId
+    /// </summary>
+    public SystemId? SystemId { get; set; }
+
+    /// <summary>
+    /// 获得/设置 IEEERegulatoryCertificationDataList
+    /// </summary>
+    public string? IEEERegulatoryCertificationDataList { get; set; }
+
+    /// <summary>
+    /// 获得/设置 PnPID
+    /// </summary>
+    public PnPID? PnPID { get; set; }
+}
+
+/// <summary>
+/// SystemId 类
+/// </summary>
+public class SystemId
+{
+    /// <summary>
+    /// 获得/设置 ManufacturerIdentifier
+    /// </summary>
+    public string? ManufacturerIdentifier { get; set; }
+
+    /// <summary>
+    /// 获得/设置 OrganizationallyUniqueIdentifier
+    /// </summary>
+    public string? OrganizationallyUniqueIdentifier { get; set; }
+}
+
+/// <summary>
+/// PnPID 类
+/// </summary>
+public class PnPID
+{
+    /// <summary>
+    /// 获得/设置 VendorIdSource
+    /// </summary>
+    public string? VendorIdSource { get; set; }
+
+    /// <summary>
+    /// 获得/设置 ProductId
+    /// </summary>
+    public string? ProductId { get; set; }
+
+    /// <summary>
+    /// 获得/设置 ProductVersion
+    /// </summary>
+    public string? ProductVersion { get; set; }
+}

src/BootstrapBlazor/Services/Bluetooth/BluetoothRequestOptions.cs

@@ -3,6 +3,7 @@
 // See the LICENSE file in the project root for more information.
 // Maintainer: Argo Zhang([email protected]) Website: https://www.blazor.zone
 
+using System.Reflection;
 using System.Text.Json.Serialization;
 
 namespace BootstrapBlazor.Components;
@@ -39,6 +40,18 @@ public class BluetoothRequestOptions
     /// <summary>
     /// A boolean value indicating that the requesting script can accept all Bluetooth devices. The default is false.
     /// </summary>
+    /// <remarks>This option is appropriate when devices have not advertised enough information for filtering to be useful. When acceptAllDevices is set to true you should omit all filters and exclusionFilters, and you must set optionalServices to be able to use the returned device.</remarks>
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
     public bool AcceptAllDevices { get; set; }
+
+    /// <summary>
+    /// 获得所有蓝牙服务
+    /// </summary>
+    /// <returns></returns>
+    public static List<string> GetAllServices() => Enum.GetNames(typeof(BluetoothServices)).Select(i =>
+    {
+        var v = i.ToString();
+        var attributes = typeof(BluetoothServices).GetField(v)!.GetCustomAttribute<JsonPropertyNameAttribute>(false)!;
+        return attributes.Name;
+    }).ToList();
 }