serialControlString

The serialControlString specifies the settings of a serial port.

# Metadata

Platforms: desktop OS: mac, windows, linux Introduced: 1.0 Security: disk

# Syntax

set the serialControlString to settingsList

# Examples

set the serialControlString to storedSerial

# Description

Use the serialControlString property to set a serial port before use.

The possible settings are as follows:

* BAUD=number: the port's baud rate * PARITY=N, O, or E: no parity, odd parity, or even parity * DATA=numberOfDataBits * STOP=numberOfStopBits * to=on or off: use timeouts * xon=on or off: software handshaking * odsr=on or off: (output) data set ready * octs=on or off: (output) clear to send * dtr=on or off: data terminal ready * rts=on or off: ready to sent * isdr=on or off: (input) data set ready

By default, the serialControlString is set to BAUD=9600 PARITY=N DATA=8 STOP=1.

To set a serial port's settings, first set the serialControlString to the desired settings. Then open the serial port using the open file command or the open driver command.

On Mac OS systems, the serialControlString property can be used to set the printer or modem ports. On Windows, the serialControlString can be used to set the COM ports. On OS X, the serialControlString can be used to set a serial peripheral device returned by the driverNames function.

The format of the serialControlString is compatible with the extended MS-DOS "mode" command.

# Tags

networking,

# See

- **keyword:** modem:, COMn: - **command:** close file, open driver, open file - **function:** driverNames - **glossary:** property, OS X, sign, Windows, port, command, peripheral device