Update Mode Config Serial Port


Configure a serial communications port.

Note

This workflow is available only for use in Microsoft Windows environments.

 Workflow inputs – Update Mode Config Serial Port

Call Workflow Input

Description

Required

Default Value

connection details

XML document conforming to the Connection Details common object that contains the information required to execute a command via command line.

Yes

n/a

port number

Specifies the number of the asynchronous–communications (COM) port.

 

Valid values: 1 – 4.

Yes

n/a

baud rate

Specifies the transmission rate in bits per second.

Example: This lists valid abbreviations for related rate.

Value Rate 11 110 15 150 30 300 60 600 12 1200 24 2400 48 4800 96 9600 19 19200

No

n/a

parity

Specifies how the system uses the parity bit to check for transmission errors.

The default value is 'e'.

 

Valid values: n – none, e even, o odd, m mark, s space.

 

Note

Not all computers support the values 'm' and 's'

No

e

data

Specifies the number of data bits in a character. The default value is 7.

 

Valid values: 5 – 8.

 

Note

Not all computers support the values 5 and 6.

No

7

stop

Specifies the number of stop bits that define the end of a character.

No

n/a

timeout

Specifies whether infinite time–out processing is on or off. The default is off.

 

Valid values: on, off

No

n/a

xon

Specifies whether the xon or xoff protocol for data–flow control is on or off.

 

Valid values: on, off.

No

n/a

odsr

Specifies whether output handshaking that uses the Data Set Ready (DSR) circuit is on or off.

 

Valid values: on, off

No

n/a

octs

Specifies whether output handshaking that uses the Clear To Send (CTS) circuit is on or off.

No

n/a

data terminal ready

Specifies whether the Data Terminal Ready (DTR) circuit is on or off

No

n/a

request to send

Specifies whether the Request To Send (RTS) circuit is set to on

No

n/a

dsr circuit

Specifies whether the DSR circuit sensitivity is on or off.

No

n/a

 

 Workflow outputs – Update Mode Config Serial Port

Call Workflow Output

Description

output

XML document consisting of one or more <line> elements that contain the command response. Each <line> element contains an index attribute indicating the order in which the information was returned by the command.

success

Did the operation succeed?

 

Valid values: true, false

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*