Platforms to show: All Mac Windows Linux Cross-Platform
SerialPortMBS class
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| class | SerialPort | MBS Util Plugin | 22.3 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | All |
While we compiled this class also for iOS, we don't expect anyone to find a serial port on an iPhone.
- event DataAvailable
- 15 properties
- property Handle as Integer
- property Lasterror as Integer
- property Path as String
- property Suspended as Boolean
- property Tag as Variant
- property BaudRate as Integer
- property CTS as Boolean
- property DataBits as Integer
- property DSR as Boolean
- property DTR as Boolean
- property Parity as Integer
- property RTS as Boolean
- property StopBits as Double
- property WinRTSControl as Integer
- property XON as Boolean
- 16 methods
- method AvailableBytes as Integer
- method Clear
- method Close
- method Constructor
- method HasDataAvailable as Boolean
- method HasLine as Boolean
- method Open(Name as String, Index as Integer = 0)
- method OpenPath(Path as String)
- method Poll
- method Read(MaxByteSizeToRead as Integer) as String
- method ReadByte as Integer
- method ReadLine as String
- method Resume
- method Suspend
- method Write(value as String) as Integer
- method WriteByte(value as Integer) as Integer
- shared method List(Mode as Integer = 0) as String()
- 7 constants
Parity
| Constant | Value | Description |
|---|---|---|
| kParityEven | 2 |
Even parity |
| kParityNone | 0 |
No parity |
| kParityOdd | 1 |
Odd parity |
RTS Flow Control Settings
| Constant | Value | Description |
|---|---|---|
| kWinRTSControlDisabled | 0 |
Disables the RTS line when the device is opened and leaves it disabled. |
| kWinRTSControlEnabled | 1 |
Enables the RTS line when the device is opened and leaves it on. |
| kWinRTSControlHandshake | 2 |
Enables RTS handshaking. The driver raises the RTS line when the "type-ahead" (input) buffer is less than one-half full and lowers the RTS line when the buffer is more than three-quarters full. |
| kWinRTSControlToggle | 3 |
Specifies that the RTS line will be high if bytes are available for transmission. After all buffered bytes have been sent, the RTS line will be low. |
This class has no sub classes.
Blog Entries
- MBS Xojo Plugins, version 25.1pr1
- News from the MBS Xojo Plugins Version 23.4
- MonkeyBread Software Releases the MBS Xojo Plugins in version 23.4
- MBS Xojo Plugins, version 23.4pr6
- News from the MBS Xojo Plugins in Version 23.0
- MBS Xojo Plugins, version 22.6pr1
- News from the MBS Xojo Plugins Version 22.4
- MBS Xojo Plugins in version 22.4
- News from the MBS Xojo Plugins Version 22.3
- MBS Xojo Plugins in version 22.3
Xojo Developer Magazine
Release notes
- Version 25.1
- Improved setting Baudrate in SerialPortMBS class to not try to change if the baud rate if the old and new rate are the same.
- Version 23.4
- Added OpenPath method to SerialPortMBS class.
- Version 23.0
- Added Tag and Path properties to SerialPortMBS class.
- Version 22.4
- Added WinRTSControl property to SerialPortMBS class to control RTS line state.
- Version 22.3
- Added SerialPortMBS class.
Some examples using this class:
The items on this page are in the following plugins: MBS Util Plugin.
Separator - SFAcousticFeatureMBS
