introduce BP35A1Options for renaming and mark BP35A1Configurations obsolete

Author: smdn

src/Smdn.Devices.BP35XX/Smdn.Devices.BP35XX/BP35A1.cs

@@ -35,57 +35,69 @@ public static ValueTask<BP35A1> CreateAsync(
     CancellationToken cancellationToken = default
   )
     => CreateAsync(
-      configurations: new BP35A1Configurations() {
+      options: new BP35A1Options() {
         SerialPortName = serialPortName,
       },
       serviceProvider: serviceProvider,
       cancellationToken: cancellationToken
     );
 
+  [Obsolete($"Use {nameof(BP35A1Options)} instead.")]
   public static ValueTask<BP35A1> CreateAsync(
     BP35A1Configurations configurations,
     IServiceProvider? serviceProvider = null,
     CancellationToken cancellationToken = default
+  )
+    => CreateAsync(
+      options: configurations ?? throw new ArgumentNullException(nameof(configurations)),
+      serviceProvider: serviceProvider,
+      cancellationToken: cancellationToken
+    );
+
+  public static ValueTask<BP35A1> CreateAsync(
+    BP35A1Options options,
+    IServiceProvider? serviceProvider = null,
+    CancellationToken cancellationToken = default
   )
     => InitializeAsync(
 #pragma warning disable CA2000
       device: new BP35A1(
-        configurations: configurations ?? throw new ArgumentNullException(nameof(configurations)),
+        options: options ?? throw new ArgumentNullException(nameof(options)),
         serviceProvider: serviceProvider
       ),
 #pragma warning restore CA2000
-      tryLoadFlashMemory: configurations.TryLoadFlashMemory,
+      tryLoadFlashMemory: options.TryLoadFlashMemory,
       serviceProvider: serviceProvider,
       cancellationToken: cancellationToken
     );
 
   /// <summary>
-  /// Initializes a new instance of the <see cref="BP35A1"/> class with specifying configurations.
+  /// Initializes a new instance of the <see cref="BP35A1"/> class with specifying options.
   /// </summary>
-  /// <param name="configurations">
-  /// A <see cref="BP35A1Configurations"/> that holds the configurations to the <see cref="BP35A1"/> instance.
+  /// <param name="options">
+  /// A <see cref="BP35A1Options"/> that holds the options to configure the new instance.
   /// </param>
   /// <param name="serviceProvider">
   /// The <see cref="IServiceProvider"/>.
   /// This constructor overload attempts to get a service of <see cref="IBP35SerialPortStreamFactory"/>, to create an <see cref="System.IO.Ports.SerialPort"/>.
   /// </param>
   private BP35A1(
-    BP35A1Configurations configurations,
+    BP35A1Options options,
     IServiceProvider? serviceProvider = null
   )
     : base(
-      serialPortName: configurations.SerialPortName,
+      serialPortName: options.SerialPortName,
 #pragma warning disable CA2000
-      serialPortStreamFactory: serviceProvider?.GetService<IBP35SerialPortStreamFactory>() ?? new BP35A1SerialPortStreamFactory(configurations),
+      serialPortStreamFactory: serviceProvider?.GetService<IBP35SerialPortStreamFactory>() ?? new BP35A1SerialPortStreamFactory(options),
 #pragma warning restore CA2000
       erxudpDataFormat: SkStackERXUDPDataFormat.Binary,
       logger: serviceProvider?.GetService<ILoggerFactory>()?.CreateLogger<BP35A1>()
     )
   {
   }
 
-  private sealed class BP35A1SerialPortStreamFactory(BP35A1Configurations configurations) : SerialPortStreamFactory {
-    public override BP35UartBaudRate BaudRate { get; } = configurations.BaudRate;
-    public override bool UseFlowControl { get; } = configurations.UseFlowControl;
+  private sealed class BP35A1SerialPortStreamFactory(BP35A1Options options) : SerialPortStreamFactory {
+    public override BP35UartBaudRate BaudRate { get; } = options.BaudRate;
+    public override bool UseFlowControl { get; } = options.UseFlowControl;
   }
 }

src/Smdn.Devices.BP35XX/Smdn.Devices.BP35XX/BP35A1Configurations.cs

@@ -1,25 +1,9 @@
 // SPDX-FileCopyrightText: 2023 smdn <smdn@smdn.jp>
 // SPDX-License-Identifier: MIT
-namespace Smdn.Devices.BP35XX;
-
-public sealed class BP35A1Configurations {
-  /// <summary>
-  /// Gets or sets the <see cref="string"/> value that holds the serial port name for communicating with the device that implements the SKSTACK-IP protocol.
-  /// </summary>
-  public string? SerialPortName { get; set; }
+using System;
 
-  /// <summary>
-  /// Gets or sets the <see cref="BP35UartBaudRate"/> value that specifies the baud rate of the serial port for communicating with the device.
-  /// </summary>
-  public BP35UartBaudRate BaudRate { get; set; } = BP35A1.DefaultValueForBP35UartBaudRate;
-
-  /// <summary>
-  /// Gets or sets a value indicating whether or not to use the Request-to-Send (RTS) hardware flow control for communicating with the device.
-  /// </summary>
-  public bool UseFlowControl { get; set; } = BP35A1.DefaultValueForUseFlowControl;
+namespace Smdn.Devices.BP35XX;
 
-  /// <summary>
-  /// Gets or sets a value indicating whether or not to attempt to load the configuration from flash memory during initialization.
-  /// </summary>
-  public bool TryLoadFlashMemory { get; set; } = BP35Base.DefaultValueForTryLoadFlashMemory;
+[Obsolete($"Use {nameof(BP35A1Options)} instead.")]
+public sealed class BP35A1Configurations : BP35A1Options {
 }

src/Smdn.Devices.BP35XX/Smdn.Devices.BP35XX/BP35A1Options.cs

@@ -0,0 +1,27 @@
+// SPDX-FileCopyrightText: 2025 smdn <smdn@smdn.jp>
+// SPDX-License-Identifier: MIT
+namespace Smdn.Devices.BP35XX;
+
+public
+/* sealed */ // TODO: remove BP35A1Configurations and seal BP35A1Options
+class BP35A1Options {
+  /// <summary>
+  /// Gets or sets the <see cref="string"/> value that holds the serial port name for communicating with the device that implements the SKSTACK-IP protocol.
+  /// </summary>
+  public string? SerialPortName { get; set; }
+
+  /// <summary>
+  /// Gets or sets the <see cref="BP35UartBaudRate"/> value that specifies the baud rate of the serial port for communicating with the device.
+  /// </summary>
+  public BP35UartBaudRate BaudRate { get; set; } = BP35A1.DefaultValueForBP35UartBaudRate;
+
+  /// <summary>
+  /// Gets or sets a value indicating whether or not to use the Request-to-Send (RTS) hardware flow control for communicating with the device.
+  /// </summary>
+  public bool UseFlowControl { get; set; } = BP35A1.DefaultValueForUseFlowControl;
+
+  /// <summary>
+  /// Gets or sets a value indicating whether or not to attempt to load the configuration from flash memory during initialization.
+  /// </summary>
+  public bool TryLoadFlashMemory { get; set; } = BP35Base.DefaultValueForTryLoadFlashMemory;
+}

tests/Smdn.Devices.BP35XX/Smdn.Devices.BP35XX/BP35A1.Commands.cs

@@ -51,7 +51,7 @@ public class BP35A1CommandsTests {
     factory.Stream.ResponseWriter.Write("OK 00\r");
 
     var bp35a1 = await BP35A1.CreateAsync(
-      new BP35A1Configurations() {
+      options: new BP35A1Options() {
         SerialPortName = "/dev/pseudo-serial-port",
         TryLoadFlashMemory = true,
       },

tests/Smdn.Devices.BP35XX/Smdn.Devices.BP35XX/BP35A1.cs

@@ -61,7 +61,7 @@ public void CreateAsync(bool tryLoadFlashMemory)
     Assert.DoesNotThrowAsync(
       async () => {
         using var bp35a1 = await BP35A1.CreateAsync(
-          new BP35A1Configurations() {
+          options: new BP35A1Options() {
             SerialPortName = "/dev/pseudo-serial-port",
             TryLoadFlashMemory = tryLoadFlashMemory,
           },
@@ -103,7 +103,7 @@ public void CreateAsync_ExceptionThrownBySerialPortStreamFactory(string? serialP
     Assert.That(
       async () => {
         using var bp35a1 = await BP35A1.CreateAsync(
-          new BP35A1Configurations() {
+          options: new BP35A1Options() {
             SerialPortName = serialPortName,
           },
           services.BuildServiceProvider()
@@ -161,7 +161,7 @@ public async Task Properties()
     factory.Stream.ResponseWriter.Write("OK 00\r");
 
     using var bp35a1 = await BP35A1.CreateAsync(
-      new BP35A1Configurations() {
+      options: new BP35A1Options() {
         SerialPortName = "/dev/pseudo-serial-port",
       },
       services.BuildServiceProvider()
@@ -213,7 +213,7 @@ public async Task Dispose()
     factory.Stream.ResponseWriter.Write("OK 00\r");
 
     using var bp35a1 = await BP35A1.CreateAsync(
-      new BP35A1Configurations() {
+      options: new BP35A1Options() {
         SerialPortName = "/dev/pseudo-serial-port",
         TryLoadFlashMemory = true,
       },