Component: SerialPort ( Comms)

Author	MatrixTSL
Version	0.1
Category	Comms

SerialPort component

Allows connection to a serial port e.g. a standard serial COM port from the browser.

Detailed description

No detailed description exists yet for this component

Examples

Simple Data

Example program showing how to use communicate to a standard serial COM port.

Web Serial Port Example

Macro reference

Close

	Close
Closes the serial port
- VOID	Return

GetProductId

	GetProductId
Returns the productId of the selected USB COM port
- LONG	Return

GetVendorId

	GetVendorId
Returns the vendortId of the selected USB COM port
- LONG	Return

Open

	Open
Attempts to open a serial port that has already been selected using RequestPort Returns true if port is successfully opened
- BOOL	Return

ReceiveString

	ReceiveString
Receives a string from the serial port
- LONG	Timeout
Time (in ms) to wait for data
- LONG	NumChars
Number of characters to try to receive
- STRING	Return

RequestPort

	RequestPort
Asks the user which serial port to use. Returns the selected COM port as a hex string in the form 0xVVVVPPPP where VVVV and PPPP are the vendorID and productID of the USB device.
- STRING	Return

SendString

	SendString
Sends a text string through an open serial port
- STRING	sText
- VOID	Return

Property reference

	Properties
	Comms Settings
	Baud Rate
The baud rate for the serial communication
	Custom Baud
A custom baud rate that is not limited to those in the drop-down list (must be a positive integer greater than 0)
	Data Bits
Data bits per frame (default = 8)
	Stop Bits
Number of stop bits at the end of a frame (default = 1)
	Parity
The parity mode for serial communication (default = none)
	Buffer Size
Size of the read and write buffers used (default = 255) (must be an integer greater than 0)
	Flow Control
The flow control mode for communication (default = none)
	Filters
Limits the list of available COM ports to specific USB devices, for example: { usbVendorId: 0x2A03, usbProductId: 0x0043 }, { usbVendorId: 0x2341, usbProductId: 0x0043 }, { usbVendorId: 0x2341, usbProductId: 0x0001 } (leave blank for all COM ports)

Component Source Code

Please click here to download the component source project: FC_Comp_Source_WEBEXP_SerialPort.fcsx

Please click here to view the component source code (Beta): FC_Comp_Source_WEBEXP_SerialPort.fcsx