Topics   All   MacOS (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server   Client   Old   Deprecated   Guides   Examples   Videos
New in version: 12.2   12.3   12.4   12.5   13.0   13.1   13.2   13.3   13.4   13.5    Statistic    FMM    Blog  


Opens a special file, device or pipe.

Component Version macOS Windows Linux Server iOS SDK
SerialPort 13.4 ✅ Yes ✅ Yes ❌ No ✅ Yes, on macOS and Windows ❌ No
MBS( "SerialPort.OpenPath"; Path { ; Mode } )   More


Parameter Description Example Flags
Path The native path to open. "\\\\.\\pipe\\Test"
Mode The opening mode.
Can be Read, Write or ReadWrite.
Default is ReadWrite.
"ReadWrite" Optional


Returns the port reference value which you pass to other SerialPort functions.


Opens a special file, device or pipe.
This allows you to e.g. open a pipe on Windows.
Serial Port reference numbers are starting at 28000 and counting up for each new port.


Open pipe and send message:

Set Variable [ $serial ; Value: MBS( "SerialPort.OpenPath"; "\\\.\pipe\Test") ]
Set Variable [ $r ; Value: MBS( "SerialPort.Write"; $serial; "Hello World") ]
Set Variable [ $r ; Value: MBS( "SerialPort.Close"; $serial) ]

See also

Release notes

Blog Entries

This function checks for a license.

Created 29th August 2023, last changed 31st August 2023

SerialPort.Open - SerialPort.Path

💬 Ask a question or report a problem