SerialPort is not supported on Mac Catalyst #75120

rolfbjarne · 2022-09-06T09:49:28Z

From @trantamcdt92 on Tue, 06 Sep 2022 09:07:49 GMT

Steps to Reproduce

Create a SerialPort class
Configure the serial port settings
Open the serial port

Expected Behavior

Can connect to device

Actual Behavior

Exception "System.DllNotFoundException: libSystem.IO.Ports.Native" occurred

Environment

Monterey, Visual Studio Preview

Version information

Build Logs

Example Project (If Possible)

Archive.zip

Copied from original issue xamarin/xamarin-macios#15874

The text was updated successfully, but these errors were encountered:

rolfbjarne · 2022-09-06T09:49:28Z

From @rolfbjarne on Tue, 06 Sep 2022 09:48:57 GMT

The SerialPort class is currently not supported on Mac Catalyst:

/Users/rolf/Downloads/Archive/MainPage.xaml.cs(16,9): warning CA1416: This call site is reachable on: 'MacCatalyst' 14.0 and later. 'SerialPort.PortName' is unsupported on: 'maccatalyst' all versions.
/Users/rolf/Downloads/Archive/MainPage.xaml.cs(14,9): warning CA1416: This call site is reachable on: 'MacCatalyst' 14.0 and later. 'SerialPort.DataBits' is unsupported on: 'maccatalyst' all versions.
/Users/rolf/Downloads/Archive/MainPage.xaml.cs(19,13): warning CA1416: This call site is reachable on: 'MacCatalyst' 14.0 and later. 'SerialPort.Open()' is unsupported on: 'maccatalyst' all versions.
/Users/rolf/Downloads/Archive/MainPage.xaml.cs(15,9): warning CA1416: This call site is reachable on: 'MacCatalyst' 14.0 and later. 'SerialPort.StopBits' is unsupported on: 'maccatalyst' all versions.
/Users/rolf/Downloads/Archive/MainPage.xaml.cs(13,9): warning CA1416: This call site is reachable on: 'MacCatalyst' 14.0 and later. 'SerialPort.Parity' is unsupported on: 'maccatalyst' all versions.
/Users/rolf/Downloads/Archive/MainPage.xaml.cs(12,9): warning CA1416: This call site is reachable on: 'MacCatalyst' 14.0 and later. 'SerialPort.BaudRate' is unsupported on: 'maccatalyst' all versions.
/Users/rolf/Downloads/Archive/MainPage.xaml.cs(13,23): warning CA1416: This call site is reachable on: 'MacCatalyst' 14.0 and later. 'Parity.None' is unsupported on: 'maccatalyst' all versions.
/Users/rolf/Downloads/Archive/MainPage.xaml.cs(15,25): warning CA1416: This call site is reachable on: 'MacCatalyst' 14.0 and later. 'StopBits.One' is unsupported on: 'maccatalyst' all versions.
/Users/rolf/Downloads/Archive/MainPage.xaml.cs(11,27): warning CA1416: This call site is reachable on: 'MacCatalyst' 14.0 and later. 'SerialPort' is unsupported on: 'maccatalyst' all versions.

Since this works for macOS apps, it seems to me that it just needs to be implemented for Mac Catalyst, so I'm moving this to dotnet/runtime where that code lives.

dotnet-issue-labeler · 2022-09-06T09:49:31Z

I couldn't figure out the best area label to add to this issue. If you have write-permissions please help me learn by adding exactly one area label.

trantamcdt92 · 2022-09-06T10:09:42Z

@rolfbjarne
Are you planning to support SerialPort on MacOS? if you are, when it will be officially released?
I copied libSystem.IO.Ports.Native.dylib from Visual Studio (Preview) to my application and could communicate with my device.
Is this safe to use it now?

ghost · 2022-09-06T10:20:29Z

Tagging subscribers to this area: @dotnet/area-system-io
See info in area-owners.md if you want to be subscribed.

Issue Details

From @trantamcdt92 on Tue, 06 Sep 2022 09:07:49 GMT

Steps to Reproduce

Create a SerialPort class
Configure the serial port settings
Open the serial port

Expected Behavior

Can connect to device

Actual Behavior

Exception "System.DllNotFoundException: libSystem.IO.Ports.Native" occurred

Environment

Monterey, Visual Studio Preview

Version information

Build Logs

Example Project (If Possible)

Archive.zip

Copied from original issue xamarin/xamarin-macios#15874

Author:	rolfbjarne
Assignees:	-
Labels:	`area-System.IO`, `untriaged`
Milestone:	-

Therzok · 2022-09-06T10:47:00Z

I copied libSystem.IO.Ports.Native.dylib from Visual Studio (Preview)

VSMac pulls that from the System.IO.Ports nuget: https://www.nuget.org/packages/System.IO.Ports

trantamcdt92 · 2022-09-06T23:38:28Z

@Therzok yes, I know. I'd like to confirm whether using System.IO.Ports on MacOS is OK?

liulunjnu · 2023-01-07T08:39:11Z

@rolfbjarne
Are you planning to support SerialPort on MacOS? if you are, when it will be officially released?
I copied libSystem.IO.Ports.Native.dylib from Visual Studio (Preview) to my application and could communicate with my device.
Is this safe to use it now?

where the "libSystem.IO.Ports.Native.dylib" Copy to debug/release directory? why when I copied to my Macbook Pro M2 can't run?

newt0ns · 2023-02-22T00:46:41Z

@rolfbjarne Are you planning to support SerialPort on MacOS? if you are, when it will be officially released? I copied libSystem.IO.Ports.Native.dylib from Visual Studio (Preview) to my application and could communicate with my device. Is this safe to use it now?

Where did you copy this from and to? I have copied it over from other working MacOS projects (from the runtime folders) and into the same folder as my Mac Catalyst app, but am met with the same System.DllNotFoundException error.

trantamcdt92 · 2023-02-22T01:07:36Z

When you have installed Visual Studio Preview app in your Mac PC, the Visual Studio.app appears in the Desktop folder. You can see libSystem.IO.Ports.Native.dylib in the framework folder inside Visual Studio.app. Then copy this file to your executable folder.

newt0ns · 2023-02-22T07:28:25Z

We're currently on the normal installation of VS 2022 v17.5. No Preview versions here, just a normal up to date install. I do not know where I would go looking for the equivalent file you are using.

I have libSystem.IO.Ports.Native.dylib from the same version of a MacOS app of our libraries that works fine, compiled just minutes ago. If I copy and place that in the same folder as our Mac Catalyst maui app it isn't loaded/found

bxdint · 2023-04-04T10:58:59Z

Hi, We are developing MAUI multi platform desktop focused app, app needs to connect to a serial port to read UART data, we are able to achieve this on Win but Mac side is not working. It becomes major blocker for our project. How soon are you going to support mac and android platforms? For any update regarding this issue please let us know, thanks.

jenswet · 2023-04-18T12:59:12Z

Hi

I am wondering if there is any progress with this issue?

I've included

<PackageReference Include="System.IO.Ports" Version="7.0.0" />

in my dependencies.

This has a dependency to https://www.nuget.org/packages/runtime.osx-arm64.runtime.native.System.IO.Ports/
This package contains libSystem.IO.Ports.Native.dylib.

If I copy the libSystem.IO.Ports.Native.dylib file into my debug/release directory everything works. But the build process doesn't copy it automatically.

So the whole ticket is not really about supporting MacCatalyst, but about fixing the build process to copy the required libraries, no?

Is this related to the efforts made in #63187? I tried 8.0.0-preview.2.23128.3 without success.

Thanks

krwq · 2023-05-30T15:56:40Z

cc: @carlossanlop can you help us get this fixed?

filipnavara · 2023-06-14T11:15:53Z

FWIW the native lib would compile just fine on iOS/tvOS/MacCatalyst if it was enabled (

runtime/src/native/libs/CMakeLists.txt

Lines 145 to 147 in e1afb22

    
           if (NOT CLR_CMAKE_TARGET_BROWSER AND NOT CLR_CMAKE_TARGET_WASI AND NOT CLR_CMAKE_TARGET_MACCATALYST AND NOT CLR_CMAKE_TARGET_IOS AND NOT CLR_CMAKE_TARGET_TVOS AND NOT CLR_CMAKE_TARGET_ANDROID) 
        
               add_subdirectory(System.IO.Ports.Native) 
        
           endif ()

). Then the NuGet packaging would need to be sorted out since it's OOB but that's relatively trivial copy & paste.

nterreaux · 2023-06-21T16:32:08Z

Any updates? It still doesn't work on my mac (Ventura 13.4) ... (Windows works perfectly)

asi-evin · 2023-07-07T15:33:08Z

I am also very interested in getting Serial Port working in MacCatalyst.

@jenswet

Hi

I am wondering if there is any progress with this issue?

I've included
<PackageReference Include="System.IO.Ports" Version="7.0.0" />
in my dependencies.

This has a dependency to https://www.nuget.org/packages/runtime.osx-arm64.runtime.native.System.IO.Ports/ This package contains libSystem.IO.Ports.Native.dylib.

If I copy the libSystem.IO.Ports.Native.dylib file into my debug/release directory everything works. But the build process doesn't copy it automatically.

So the whole ticket is not really about supporting MacCatalyst, but about fixing the build process to copy the required libraries, no?

Is this related to the efforts made in #63187? I tried 8.0.0-preview.2.23128.3 without success.

Thanks

I attempted your work around, copying both the SerialPort DLL and the native DYLIB files into the bin/debug. However, I get a "System.DllNotFoundException: libSystem.IO.Ports.Native" error. I tried with both the OSX-x64 and OSX-Arm64 native libraries to no avail. Are there any other steps I need to do?

nterreaux · 2023-07-07T15:39:14Z

Hi @asi-evin,
I found a solution by putting the libSystem.IO.Ports.Native.dylib file in my project and going into its properties. Just click on "Always copy" as in the attached screenshot and it works for me...

asi-evin · 2023-07-07T16:31:44Z

@nterreaux No dice unfortunately. Still get the following message:

Error while opening port: libSystem.IO.Ports.Native
System.DllNotFoundException: libSystem.IO.Ports.Native
at Interop.Serial.SerialPortOpen(String name)
at System.IO.Ports.SafeSerialDeviceHandle.Open(String portName)
at System.IO.Ports.SerialStream..ctor(String portName, Int32 baudRate, Parity parity, Int32 dataBits, StopBits stopBits, Int32 readTimeout, Int32 writeTimeout, Handshake handshake, Boolean dtrEnable, Boolean rtsEnable, Boolean discardNull, Byte parityReplace)
at System.IO.Ports.SerialPort.Open()

nterreaux · 2023-07-07T16:48:54Z

@asi-evin Are your maccatalyst dependencies like mine?

If not, I had to delete the output folder and restart the application... it didn't work the first time either, but now it does.

This solution is by far not optimal, but in my case it does the job.

asi-evin · 2023-07-07T18:36:08Z

Yeah, everything described is the same, but it still doesn't work. Thanks for the help, I'm just going to abandon this for now.

scottkdavis · 2023-09-07T22:35:48Z

Has anyone found a work around to the issue? It appears the DLL packaging been resolved, however now I am getting an explicit "Platform not supported" error message. It appears support is intentionally blocked.

I have tried using SerialPortNet and SerialPortLibNetCore nuget packages, I couldn't get either to work on Maui Mac. I have an ORSSerialPort binding library from a Xamarin project that works fine in Xamarin, but have been unable to figure out how to get it ported to Maui. There is virtually no documentation or samples on binding libraries for Maui, let along Mac Maui. I've tried to get some native calls to work and only see Mac hard crashes with nothing helpful in the Apple crash report.

Anyone have any solutions? This is holding up our port from Xamarin to Maui. It is a project that communicates over USB Serial to control heavy equipment via modbus protocol.

scottkdavis · 2023-09-07T22:43:35Z

The documentation on the Nuget package needs to be updated to remove Mac. Should that be a separate bug?
https://www.nuget.org/packages/System.IO.Ports/8.0.0-preview.7.23375.6#supportedframeworks-body-tab

It also lists support for Xamarin.Mac which is also not true.

ronimizy · 2023-11-02T23:15:00Z

@jeffhandley hi, any updates on this issue? it became a blocker for our project as well

would be down to contribute to resolve this issue. and would highly appreciate if you give me some direction on what's the most suitable way of doing it.

wfurt · 2023-11-03T22:11:32Z

It should be similar to #63187 + change @filipnavara suggested. I can take a look next week.

scottkdavis · 2023-12-12T14:58:23Z

@wfurt @akoeplinger does the merged pull request for #86619, which fixes the serial port issues for Android and Linux include a fix for Mac Catalyst?

akoeplinger · 2023-12-12T15:24:42Z

No, Catalyst is a different story but as far as I know @wfurt is working on it.

00000vish · 2023-12-20T22:51:29Z

Hi

I am wondering if there is any progress with this issue?

I've included
<PackageReference Include="System.IO.Ports" Version="7.0.0" />
in my dependencies.

This has a dependency to https://www.nuget.org/packages/runtime.osx-arm64.runtime.native.System.IO.Ports/ This package contains libSystem.IO.Ports.Native.dylib.

If I copy the libSystem.IO.Ports.Native.dylib file into my debug/release directory everything works. But the build process doesn't copy it automatically.

So the whole ticket is not really about supporting MacCatalyst, but about fixing the build process to copy the required libraries, no?

Is this related to the efforts made in #63187? I tried 8.0.0-preview.2.23128.3 without success.

Thanks

@asi-evin @ronimizy

This did not work for me either.

Instead i got it working by copying the libSystem.IO.Ports.Native.dylib into /bin/debug/*/*/MyApp.app/Content/MonoBundle folder.

And make sure you have com.apple.security.device.serial set to true in the app entitlements.

akoeplinger · 2024-01-09T10:55:15Z

If anyone wants to try the fix from #96492 then you can add the following nuget feed to nuget.config:

<add key="dotnet9" value="https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet9/nuget/v3/index.json" />

and use version 9.0.0-alpha.1.24058.11 or higher of the package:

<PackageReference Include="System.IO.Ports" Version="9.0.0-alpha.1.24058.11" />

wfurt · 2024-01-16T17:31:23Z

Any luck with the updated package @00000vish?

00000vish · 2024-01-17T18:49:19Z

Any luck with the updated package @00000vish?

Yes, its working as expected!

Tested on Apple M1, Sonoma 14.1.1

rolfbjarne mentioned this issue Sep 6, 2022

MacOS libSystem.IO.Ports.Native.dylib is not copied to MonoBundle of application xamarin/xamarin-macios#15874

Closed

ghost added the untriaged New issue has not been triaged by the area owner label Sep 6, 2022

rolfbjarne changed the title ~~MacOS libSystem.IO.Ports.Native.dylib is not copied to MonoBundle of application~~ SerialPort is not supported on Mac Catalyst Sep 6, 2022

teo-tsirpanis added the area-System.IO label Sep 6, 2022

jeffhandley added this to the Future milestone Sep 16, 2022

ghost removed the untriaged New issue has not been triaged by the area owner label Sep 16, 2022

jeffhandley added area-System.IO.Ports and removed area-System.IO labels Nov 23, 2022

wfurt self-assigned this Jan 3, 2024

wfurt mentioned this issue Jan 4, 2024

add SerialStream support for MacCatalyst #96492

Merged

ghost added the in-pr There is an active PR which will close this issue when it is merged label Jan 4, 2024

wfurt closed this as completed in #96492 Jan 8, 2024

ghost removed the in-pr There is an active PR which will close this issue when it is merged label Jan 8, 2024

github-actions bot locked and limited conversation to collaborators Feb 17, 2024

SerialPort is not supported on Mac Catalyst #75120

SerialPort is not supported on Mac Catalyst #75120

Comments

rolfbjarne commented Sep 6, 2022

Steps to Reproduce

Expected Behavior

Actual Behavior

Environment

Build Logs

Example Project (If Possible)

rolfbjarne commented Sep 6, 2022

dotnet-issue-labeler bot commented Sep 6, 2022

trantamcdt92 commented Sep 6, 2022

ghost commented Sep 6, 2022

Steps to Reproduce

Expected Behavior

Actual Behavior

Environment

Build Logs

Example Project (If Possible)

Therzok commented Sep 6, 2022 • edited

trantamcdt92 commented Sep 6, 2022

liulunjnu commented Jan 7, 2023

newt0ns commented Feb 22, 2023

trantamcdt92 commented Feb 22, 2023

newt0ns commented Feb 22, 2023 • edited

bxdint commented Apr 4, 2023

jenswet commented Apr 18, 2023 • edited

krwq commented May 30, 2023

filipnavara commented Jun 14, 2023

nterreaux commented Jun 21, 2023

asi-evin commented Jul 7, 2023

nterreaux commented Jul 7, 2023

asi-evin commented Jul 7, 2023

nterreaux commented Jul 7, 2023 • edited

asi-evin commented Jul 7, 2023

scottkdavis commented Sep 7, 2023

scottkdavis commented Sep 7, 2023

ronimizy commented Nov 2, 2023 • edited

wfurt commented Nov 3, 2023

scottkdavis commented Dec 12, 2023

akoeplinger commented Dec 12, 2023

00000vish commented Dec 20, 2023 • edited

akoeplinger commented Jan 9, 2024

wfurt commented Jan 16, 2024

00000vish commented Jan 17, 2024

Therzok commented Sep 6, 2022 •

edited

newt0ns commented Feb 22, 2023 •

edited

jenswet commented Apr 18, 2023 •

edited

nterreaux commented Jul 7, 2023 •

edited

ronimizy commented Nov 2, 2023 •

edited

00000vish commented Dec 20, 2023 •

edited