SetChannelSettings

Change the current communication channel settings: provide a new COM port number or TCP/IP address, or change the serial port settings (baud rate, parity settings, ...).

Part	Description
newSettings	Required. String with the new communication channel and/or the serial settings. See below for detailed specification
channelNo	Optional. Integer value that specifies the communication channel if Communication Mode: Monitoring is used. Default value is 1 (Channel 1).
dontTest	Optional. Boolean value. If dontTest is set to True, SetChannelSettings does not open and close the communication channel for testing purposes. See the "Remarks" section below. Default value is False (channel is tested to determine return value).

Value	Description
"COMxxx"	Select new serial communication port, e.g. "COM7"
"RemoteHost:RemotePort"	Make this channel a TCP client and connect to the specified IP address and TCP port number, e.g. "192.0.0.1:3001" (see Projects Settings)
"SERVER:LocalPort"	Make this channel a TCP server, accepting connections on the specified TCP port, e.g. "SERVER:3001" (see Projects Settings)
"UDP:RemoteHost:Port	Makes this channel a UDP peer, transmitting data to RemoteHost:Port and listening to the local Port (see Projects Settings)
"COMxxx:BaudRate,Parity,DataBits,StopBits"	Select new serial port and serial communication settings Parity can be NONE, EVEN, ODD, MARK, SPACE. Example: "COM18:9600,EVEN,8,1"
"BaudRate,Parity,DataBits,StopBits"	Changing the serial settings without knowing/changing the current serial port. Example: "38400,NONE,8,1"
"BaudRate,Parity,DataBits,StopBits, FlowControl,ParityErrorChar"	Extended syntax to additionally change the hardware flow control options: FlowControl can be OFF, RTSCTS, XONXOFF, RTSSEND ParityErrorChar: The decimal ASCII code for the Parity Error Character (see Projects Settings). Default value is 63. Example: "9600,NONE,8,2,RTSCTS,35"
">"	Find the next serial COM port available on this PC. If the currently selected port is COM1, SetChannelSettings will start searching at COM2.

You can only change the channel settings while the communication is stopped (see StopCommunication).

The SetChannelSettings method is intended for advanced Docklight Scripting applications, where control of the communication channel settings during script runtime is required. It allows you to create scripts that access different COM ports (see example below), or walk through a list of IP addresses.

SetChannelSettings method will produce an error, if an illegal value is passed with newSettings.

If the newSettings argument is ok (and the dontTest flag is not set), the communication channel will be opened and closed again immediately for a test.

If dontTest is True, SetChannelSettings will not open/close the channel for testing, and return always True. This is useful in networking applications, where additional connect/disconnect attempts might confuse the other host/device. Problems have been experienced for example with Telnet server applications.

The return value of SetChannelSettings is True, if the channel could be successfully opened. The return value is False, if an error occurred while trying to access the port (e.g. the COM port already in use, or the Firewall denied the TCP/IP access).

NOTE: Modifying the FlowControl parameter when Project Settings: Flow Control is other than "Off" can result in undefined behavior.

After running the script on a computer with a built-in modem on COM3, the Docklight communication window could look like this: