Serial_Open (function reference)

By May 10, 2017 August 6th, 2018 Online Help, Troi Serial Plug-in
Troi Serial Plug-in for FileMaker Pro

Serial_Open

Opens a serial port with this name and the specified parameters.

SyntaxFunction badge

Serial_Open ( switches ; portname ; settings ; filename ; scriptname )

Parameters

switches(optional) specifies how this function receives the data
portnamethe name of the port to open
settings(optional) specifies the setting of the port like the speed of the port, parity, etc.
filename(optional) the name of the file which contains the script to trigger when data comes in
scriptname(optional) specifies the name of the script to trigger when data comes in

Switches

switches can be one of this:

-ResumeWhenScriptPausedwhen the trigger script needs to run, and an other script is already paused, the paused script will resume after the triggerscript is finished.
-NoIdleWaitTimedon’t add idle wait times, the triggering will be faster, but the plug-in will need more computer time.

Returned Result

Data type returned

Error code

Result

Returned result is an error code. Returned error codes can be:

0no errorthe port was opened
$$-50paramErrthere was an error with the parameter
$$-108memFullErrran out of memory
$$-97portInUsecould not open port, the port is in use
$$-4210portDoesnotExistErrport with this name is not available on this computer
$$-4211allPortsNullErrno serial ports are available on this computer

Other errors may be returned.

Originated in

Troi Serial Plug-in 3.0

Compatibility

FileMaker Pro 13 to 17

Considerations

If you specify a filename and scriptname any scripts specified with the function “Serial_SetDispatchScript” will be ignored for this port.

If you specify a filename you must also provide a scriptname.

Example

Set Field [ gErrorCode ; Serial_Open ( "-Unused" ; "COM2" ; "baud=19200 parity=none      
               data=8 stop=10 flowControl=DTRDSR  flowControl=RTSCTS" ) ]

will open the COM2 port with a speed of 19200 baud and the specified options.

Example 2

Set Field [ gErrorCode ;
	Serial_Open ( "-Unused" ; gPortName1 ; 
		gSpeed & " " & gStopBits & " " & gDataBits & " " & gParity &  " "& gFlowControl ;
		Get ( FileName ) ;
		"Process Data Received for 1st Port"
		) 
            ]

This will open the port in field gPortName1 with the specified speed and other options. When data comes in the script “Process Data Received for 1st Port” in the current filename will be triggered.

Related functionsFunction badge

Serial_Close
Serial_Reinitialize

Related script stepsScript step badge

Open Serial Port
Set Serial Direct Insert

Related topics

Troi Serial Plug-in online help (overview)


Online Help Page for Troi Serial Plug-in for 13 to 17 –> Serial_Open (serip4805) 2018-0806 08:48:25