Merge pull request #69 from anotherlab/docs

Update to .NET 10

Author: anotherlab

README.md

@@ -1,6 +1,6 @@
 # UsbSerialForAndroid
 
-This is a driver library to allow your Xamarin Android or Microsoft Android app to communicate with many common USB serial hardware. It uses the [Android USB Host API](http://developer.android.com/guide/topics/connectivity/usb/host.html)
+This is a driver library to allow your Microsoft Android app to communicate with many common USB serial hardware. It uses the [Android USB Host API](http://developer.android.com/guide/topics/connectivity/usb/host.html)
 available on Android 3.1+.
 
 No root access, ADK, or special kernel drivers are required; all drivers are implemented in
@@ -9,7 +9,7 @@ functions for use with your own protocols. The appropriate driver is picked base
 
 This is a Xamarin C# port of Mike Wakerly's Java [usb-serial-for-android](https://github.com/mik3y/usb-serial-for-android) library. It followed that library very closely when it was ported. The main changes were to make the method names follow C# standard naming conventions. Some Java specific data types were replaced with .NET types and the reflection code is .NET specific. Code examples written for the Java version of the library should translate more or less faithfully to C#.
 
-It also includes code derived from a portion of LusoVU's [XamarinUsbSerial](https://bitbucket.org/lusovu/xamarinusbserial) library. XamarinUsbSerial was a C# wrapper for the Java usb-serial-for-android. It used an older version of the usb-serial-for-android .jar file. Only the the C# code was used, the Java library is not referenced.
+It also includes code derived from a portion of LusoVU's [XamarinUsbSerial](https://bitbucket.org/lusovu/xamarinusbserial) library. XamarinUsbSerial was a C# wrapper for the Java usb-serial-for-android. It used an older version of the usb-serial-for-android .jar file. Only the C# code was used, the Java library is not referenced.
 
 The default branch has been renamed from master to main. if you have a local clone, you can run the following commands to update the name of the default branch
 
@@ -19,17 +19,17 @@ git fetch origin
 git branch -u origin/main main
 git remote set-head origin -a
 ```
-
-This library currently supports Xamarin.Android, .NET 6, .NET 7, and .NET 8. The demo app currently targets .NET 8, but the code was written for Xamarin.Android.  The code works with .NET 9 and an upcoming update will update the demo projects to .NET 9.
-
-Support for Xamarin will be dropped in the next update.  Microsoft has ended support for Xamarin and you can no longer support apps to the Google Play Store that were built with Xamarin.
+This library supports .NET 10 and Microsoft Android. Support for Xamarin Android and previous versions of .NET have been dropped. Sample application has been replaced with a new app demo. If you need the old demo or want to support older versions of .NET, please use [verson 1.1.1](https://github.com/anotherlab/UsbSerialForAndroid/releases/tag/v1.1.1).
 
 ## Structure
 
-This solution contains two projects.
+This solution contains two projects and a slnx solution file.
 
 * UsbSerialForAndroid - A port of the Java library usb-serial-for-android
-* UsbSerialExampleApp - A Xamarin version of the example app that comes with usb-serial-for-android
+* UsbSerialForAndroidDemo - A Microsoft Android version of the example app that comes with usb-serial-for-android
+
+
+The original demo and the .sln format solution file are deprecated and will be removed in a subsequent update.
 
 ## Getting Started
 **1.** Reference the library to your project
@@ -107,3 +107,5 @@ For more information about contributing or reporting an issue, please see [](htt
 This library is licensed under the MIT License. Please see [LICENSE.txt](https://github.com/anotherlab/UsbSerialForAndroid/blob/main/LICENSE.txt) for the complete license.
 
 Copyright 2017, Tyler Technologies. All Rights Reserved. Portions of this library are based on the [usb-serial-for-android](https://github.com/mik3y/usb-serial-for-android) and [XamarinUsbSerial](https://bitbucket.org/lusovu/xamarinusbserial) libraries. Their rights remain intact.
+
+The icon used for the demo app was derived from [Serial to USB by Bonegolem](https://thenounproject.com/browse/icons/term/serial-to-usb/) from <a href="https://thenounproject.com/browse/icons/term/serial-to-usb/" (CC BY 3.0)

UsbSerialExampleApp/MainActivity.cs

@@ -206,7 +206,21 @@ public UsbDeviceDetachedReceiver(MainActivity activity)
 
             public async override void OnReceive(Context context, Intent intent)
             {
-                var device = intent.GetParcelableExtra(UsbManager.ExtraDevice) as UsbDevice;
+                UsbDevice device;
+
+            if (Build.VERSION.SdkInt >= BuildVersionCodes.Tiramisu) // Android 33
+            {
+#pragma warning disable CA1416 // Suppress warning to validate platform compatibility
+                device = intent.GetParcelableExtra(UsbManager.ExtraDevice, Java.Lang.Class.FromType(typeof(UsbDevice))) as UsbDevice;
+#pragma warning restore CA1416
+            }
+            else
+            {
+#pragma warning disable CA1422 // Suppress warning for obsolete API usage
+                device = intent.GetParcelableExtra(UsbManager.ExtraDevice) as UsbDevice;
+#pragma warning restore CA1422
+            }
+
 
                 Log.Info(TAG, "USB device detached: " + device.DeviceName);
 

UsbSerialExampleApp/SerialConsoleActivity.cs

@@ -116,7 +116,21 @@ protected async override void OnResume()
 
             base.OnResume();
 
-            var portInfo = Intent.GetParcelableExtra(EXTRA_TAG) as UsbSerialPortInfo;
+            UsbSerialPortInfo portInfo;
+            
+            if (Build.VERSION.SdkInt >= BuildVersionCodes.Tiramisu) // Android 33
+            {
+#pragma warning disable CA1416 // Suppress warning to validate platform compatibility
+                portInfo = Intent.GetParcelableExtra(EXTRA_TAG, Java.Lang.Class.FromType(typeof(UsbSerialPortInfo))) as UsbSerialPortInfo;
+#pragma warning restore CA1416
+            }
+            else
+            {
+#pragma warning disable CA1422 // Suppress warning for obsolete API usage
+                portInfo = Intent.GetParcelableExtra(EXTRA_TAG) as UsbSerialPortInfo;
+#pragma warning restore CA1422
+            }
+
             int vendorId = portInfo.VendorId;
             int deviceId = portInfo.DeviceId;
             int portNumber = portInfo.PortNumber;

UsbSerialExampleApp/UsbSerialExampleApp.csproj

@@ -1,23 +1,36 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <TargetFramework>net6.0-android</TargetFramework>
+    <!-- Target .NET 10 Android -->
+    <TargetFramework>net10.0-android</TargetFramework>
+
+    <!-- Minimum supported Android API level -->
     <SupportedOSPlatformVersion>21</SupportedOSPlatformVersion>
+
+    <!-- Output type: Android app -->
     <OutputType>Exe</OutputType>
+
+    <!-- Project settings -->
     <Nullable>disable</Nullable>
     <ImplicitUsings>disable</ImplicitUsings>
+
+    <!-- Android app metadata -->
     <ApplicationId>UsbSerialExampleApp.UsbSerialExampleApp</ApplicationId>
     <ApplicationVersion>1</ApplicationVersion>
     <ApplicationDisplayVersion>1.0</ApplicationDisplayVersion>
+
+    <!-- Assembly metadata -->
     <AssemblyName>UsbSerialExampleApp</AssemblyName>
     <RootNamespace>UsbSerialExampleApp</RootNamespace>
   </PropertyGroup>
+
+  <!-- Release build settings -->
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
     <AndroidLinkTool>r8</AndroidLinkTool>
     <AndroidPackageFormat>apk</AndroidPackageFormat>
   </PropertyGroup>
-  <ItemGroup />
+
+  <!-- Project references -->
   <ItemGroup>
     <ProjectReference Include="..\UsbSerialForAndroid\UsbSerialForAndroid.csproj" />
   </ItemGroup>
-  <ItemGroup />
-</Project>
+</Project>

UsbSerialForAndroid.slnx

@@ -0,0 +1,6 @@
+<Solution>
+  <Project Path="UsbSerialForAndroid/UsbSerialForAndroid.csproj" />
+  <Project Path="UsbSerialForAndroidDemo/UsbSerialForAndroidDemo.csproj" Id="3816aadb-ed3d-4da2-b8dd-8ea2a10a9ebb">
+    <Deploy />
+  </Project>
+</Solution>

UsbSerialForAndroid/Extensions/UsbManagerExtensions.cs

@@ -39,11 +39,9 @@ public static Task<bool> RequestPermissionAsync(this UsbManager manager, UsbDevi
             }
 
             // Targeting S+ (version 31 and above) requires that one of FLAG_IMMUTABLE or FLAG_MUTABLE be specified when creating a PendingIntent.
-#if NET6_0_OR_GREATER
+#pragma warning disable CA1416
             PendingIntentFlags pendingIntentFlags = Build.VERSION.SdkInt >= BuildVersionCodes.S ? PendingIntentFlags.Mutable : 0;
-#else
-            PendingIntentFlags pendingIntentFlags = Build.VERSION.SdkInt >= (BuildVersionCodes)31 ? (PendingIntentFlags)33554432 : 0;
-#endif
+#pragma warning restore CA1416
 
             var intent = new Intent(ACTION_USB_PERMISSION);
             if (Build.VERSION.SdkInt >= BuildVersionCodes.UpsideDownCake)
@@ -68,7 +66,20 @@ public UsbPermissionReceiver(TaskCompletionSource<bool> completionSource)
 
             public override void OnReceive(Context context, Intent intent)
             {
-                var device = intent.GetParcelableExtra(UsbManager.ExtraDevice) as UsbDevice;
+                if (Build.VERSION.SdkInt >= BuildVersionCodes.Tiramisu)
+                {
+#pragma warning disable CA1416
+                    var device = intent.GetParcelableExtra(UsbManager.ExtraDevice, Java.Lang.Class.FromType(typeof(UsbDevice)));
+#pragma warning restore CA1416
+                }
+                else
+                {
+#pragma warning disable CA1422
+                    var device = intent.GetParcelableExtra(UsbManager.ExtraDevice) as UsbDevice;
+#pragma warning restore CA1422
+                }
+
+
                 var permissionGranted = intent.GetBooleanExtra(UsbManager.ExtraPermissionGranted, false);
                 context.UnregisterReceiver(this);
                 completionSource.TrySetResult(permissionGranted);

UsbSerialForAndroid/Extensions/UsbSerialPortInfo.cs

@@ -31,13 +31,15 @@ public UsbSerialPortInfo(UsbSerialPort port)
             VendorId = device.VendorId;
             DeviceId = device.DeviceId;
             PortNumber = port.PortNumber;
+            DeviceName = device.DeviceName;
         }
 
         private UsbSerialPortInfo(Parcel parcel)
         {
             VendorId = parcel.ReadInt();
             DeviceId = parcel.ReadInt();
             PortNumber = parcel.ReadInt();
+            DeviceName = parcel.ReadString();
         }
 
         public int VendorId { get; set; }
@@ -46,6 +48,8 @@ private UsbSerialPortInfo(Parcel parcel)
 
         public int PortNumber { get; set; }
 
+        public string DeviceName { get; set; }
+
         #region IParcelable implementation
 
         public int DescribeContents()
@@ -58,6 +62,7 @@ public void WriteToParcel(Parcel dest, ParcelableWriteFlags flags)
             dest.WriteInt(VendorId);
             dest.WriteInt(DeviceId);
             dest.WriteInt(PortNumber);
+            dest.WriteString(DeviceName);
         }
 
         #endregion

UsbSerialForAndroid/UsbSerialForAndroid.csproj

@@ -1,10 +1,17 @@
-<Project Sdk="Xamarin.Legacy.Sdk/0.2.0-alpha4">
+<Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <TargetFrameworks>net6.0-android;net7.0-android;monoandroid5.0</TargetFrameworks>
+    <!-- Target .NET 10 Android -->
+    <TargetFramework>net10.0-android</TargetFramework>
+
+    <!-- Minimum supported Android API level -->
     <SupportedOSPlatformVersion>21</SupportedOSPlatformVersion>
+
+    <!-- Optional project settings -->
     <Nullable>disable</Nullable>
     <ImplicitUsings>disable</ImplicitUsings>
+
+    <!-- Assembly metadata -->
     <AssemblyName>Android.UsbSerial</AssemblyName>
     <RootNamespace>Hoho.Android.UsbSerial</RootNamespace>
   </PropertyGroup>
-</Project>
+</Project>

UsbSerialForAndroid/Util/HexDump.cs

@@ -12,135 +12,31 @@ namespace Hoho.Android.UsbSerial.Util
 {
     public class HexDump
     {
-        private static char[] HEX_DIGITS = {
-            '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'
-        };
-
-        public static string DumpHexString(byte[] array)
-        {
-            return DumpHexString(array, 0, array.Length);
-        }
-        public static string DumpHexString(byte[] array, int offset, int length)
+        public static string ByteArrayToHexString(byte[] bytes)
         {
-            StringBuilder result = new StringBuilder();
-
-            byte[] line = new byte[16];
-            int lineIndex = 0;
-
-            result.Append("\n0x");
-            result.Append(ToHexString(offset));
-
-            for (int i = offset; i < offset + length; i++)
-            {
-                if (lineIndex == 16)
-                {
-                    result.Append(" ");
-
-                    for (int j = 0; j < 16; j++)
-                    {
-                        if (line[j] > ' ' && line[j] < '~')
-                        {
-                            result.Append(System.Text.Encoding.Default.GetString(line).Substring(j, 1));
-                        }
-                        else
-                        {
-                            result.Append(".");
-                        }
-                    }
-
-                    result.Append("\n0x");
-                    result.Append(ToHexString(i));
-                    lineIndex = 0;
-                }
-
-                byte b = array[i];
-                result.Append(" ");
-                result.Append(HEX_DIGITS[(b >> 4) & 0x0F]);
-                result.Append(HEX_DIGITS[b & 0x0F]);
+            if (bytes == null || bytes.Length == 0)
+                return string.Empty;
 
-                line[lineIndex++] = b;
-            }
-
-            if (lineIndex != 16)
-            {
-                int count = (16 - lineIndex) * 3;
-                count++;
-                for (int i = 0; i < count; i++)
-                {
-                    result.Append(" ");
-                }
-
-                for (int i = 0; i < lineIndex; i++)
-                {
-                    if (line[i] > ' ' && line[i] < '~')
-                    {
-                        result.Append(System.Text.Encoding.Default.GetString(line).Substring(i, 1));
-                    }
-                    else
-                    {
-                        result.Append(".");
-                    }
-                }
-            }
-
-            return result.ToString();
+            return BitConverter.ToString(bytes).Replace("-", " ");
         }
 
-        public static string ToHexString(byte[] byteArray)
+        public static string ByteArrayToHexString(byte[] bytes, int maxLength)
         {
-            return BitConverter.ToString(byteArray).Replace("-", "");
-        }
+            if (bytes == null || bytes.Length == 0 || maxLength <= 0)
+                return string.Empty;
 
-        public static string ToHexString(byte[] byteArray, int offset, int length)
-        {
-            StringBuilder hex = new StringBuilder(length*2);
+            int length = Math.Min(bytes.Length, maxLength);
+            var sb = new StringBuilder(length * 3);
 
-            while ((offset < byteArray.Length) && (length > 0))
+            for (int i = 0; i < length; i++)
             {
-                hex.AppendFormat("{0:x2}", byteArray[offset]);
+                sb.Append(bytes[i].ToString("X2"));
 
-                offset++;
-                length--;
+                if (i < length - 1)
+                    sb.Append(' ');
             }
-            return hex.ToString();
-        }
 
-        public static string ToHexString(int i)
-        {
-            return ToHexString(ToByteArray(i));
-        }
-
-        public static string ToHexString(short i)
-        {
-            return ToHexString(ToByteArray(i));
-        }
-
-        public static byte[] ToByteArray(byte b)
-        {
-            return new byte[] {b};
-        }
-
-        public static byte[] ToByteArray(int i)
-        {
-            byte[] array = new byte[4];
-
-            array[3] = (byte) (i & 0xFF);
-            array[2] = (byte) ((i >> 8) & 0xFF);
-            array[1] = (byte) ((i >> 16) & 0xFF);
-            array[0] = (byte) ((i >> 24) & 0xFF);
-
-            return array;
+            return sb.ToString();
         }
-
-        public static byte[] ToByteArray(short i)
-        {
-            byte[] array = new byte[2];
-
-            array[1] = (byte) (i & 0xFF);
-            array[0] = (byte) ((i >> 8) & 0xFF);
-
-            return array;
-        }
-
     }
 }