Topics   All   Mac OS X (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server (Not)   Client   Old   Guides   Examples
New in version: 6.2   6.3   6.4   6.5   7.0   7.1   7.2   7.3   7.4   7.5    Statistic  

SerialPort.SetDataAvailableHandler

Sets the data available handler for this serial port.

Component Version macOS Windows Server FileMaker Cloud FileMaker iOS SDK
SerialPort 5.1 Yes Yes No No No

MBS( "SerialPort.SetDataAvailableHandler"; PortReference; FileName; ScriptName )

Parameters

Parameter Description Example value
PortReference The reference number of the port. You get this number from SerialPort.Open when you open the port. $port
FileName The name of the FileMaker File that contains the script "MyDatabase.fmp12"
ScriptName The name of the script to run "DataAvailable"

Result

Returns OK or error.

Description

Sets the data available handler for this serial port.
When new data arrives, this script is called, 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 script call.

With plugin version 6.0 or newer the script name can be a script ID number. In that case the plugin queries the script name for the given script ID. This allows to call scripts by ID and avoid problems if scripts are later renamed.

Examples

Set data available handler script:

MBS( "SerialPort.SetDataAvailableHandler"; $port; Get(FileName); "SerialPortDataAvailable" )

See also


SerialPort.SetDataAvailableEvaluate   -   SerialPort.SetDataBits

Feedback: Report problem or ask question.




Links
MBS Xojo PDF Plugins