Components | All | New | MacOS | Windows | Linux | iOS | ||||
Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old |
SerialPort.SetDataAvailableEvaluate
Sets the data available expression for this serial port.
Component | Version | macOS | Windows | Linux | Server | iOS SDK |
SerialPort | 6.2 | ✅ Yes | ✅ Yes | ❌ No | ✅ Yes, on macOS and Windows | ❌ No |
MBS( "SerialPort.SetDataAvailableEvaluate"; PortReference; Expression ) More
Parameters
Parameter | Description | Example |
---|---|---|
PortReference | The reference number of the port. You get this number from SerialPort.Open when you open the port. | $port |
Expression | The expression to evaluate. | "Let ( $$Done = 1 ; 1 )" |
Result
Returns OK or error.
Description
Sets the data available expression for this serial port.When new data arrives, this expression is evaluated, so you can call SerialPort.Read functions.
Be aware that script may be called when just a few bytes are in the read buffer. So the data message you wait for may only be available partly. In that case, please read available bytes, check if whole packet/message arrived and if not, store read data for later and wait for next evaluation.
In the expression the text $$ID$$ will be replaced when evaluated with the serial port reference, so you can pass it to other functions if needed.
See also
- PortMidi.SetDataAvailableEvaluate
- SerialPort.Open
- SerialPort.Read
- SerialPort.SetDataAvailableHandler
- Shell.SetDataAvailableEvaluate
- Socket.SetDataAvailableEvaluate
Blog Entries
This function checks for a license.
Created 29th March 2016, last changed 29th March 2016