portcfg command

This command configures and displays the settings for the CMM serial port.

If command syntax is not correctly entered, or if a command fails to run, an error message is returned. See Common errors for a list of error messages that apply to all commands or portcfg command errors for a list of error messages that are specific to the portcfg command.

Table 1. portcfg command.

The command table is a multi-row, four-column table where each row describes a CMM CLI command option: column one lists command function, column two provides a detailed command description, column three shows command-option syntax, and column four lists valid command targets.
Function What it does Command Target (see paths in Command targets)
Display CMM serial port configuration Displays the current configuration of the CMM serial port. Possible return values are:
  • -b baud_rate
  • -p parity
  • -s stop_bits
 portcfg -com1
Primary CMM:
  • mm[p]
  • mm[P]
  • mm[x]
  • where x is the primary CMM bay number.
Set CMM serial port baud rate Checks syntax and sets the baud (communications) rate of the CMM serial port. portcfg -com1 -b baud_rate

where baud_rate is 2400, 4800, 9600, 19200, 38400, 57600, or 115200.

This command can only be run by users who have one or more of the following command authorities:
  • Supervisor
  • Chassis configuration
See Commands and user authority for additional information.
Primary CMM:
  • mm[p]
  • mm[P]
  • mm[x]
  • where x is the primary CMM bay number.
Set CMM serial port parity Checks syntax and sets the parity of the CMM serial port. portcfg -com1 -p parity
where parity is
  • none
  • odd
  • even
  • mark
  • space
This command can only be run by users who have one or more of the following command authorities:
  • Supervisor
  • Chassis configuration
See Commands and user authority for additional information.
Primary CMM:
  • mm[p]
  • mm[P]
  • mm[x]
  • where x is the primary CMM bay number.
Set CMM serial port stop bits Checks syntax and sets the number of stop bits for the CMM serial port.
Note: When 2 stop bits is selected, the software automatically adjusts between 1.5 and 2 stop bits, based on the detected data-word size.
 portcfg -com1 -s stop_bits

where stop_bits is:

  • 1 for 1 stop bit.
  • 2 for 1.5 or 2 stop bits.
This command can only be run by users who have one or more of the following command authorities:
  • Supervisor
  • Chassis configuration
See Commands and user authority for additional information.
Primary CMM:
  • mm[p]
  • mm[P]
  • mm[x]
  • where x is the primary CMM bay number.

Example:

To display the configuration for the CMM serial port, while the primary CMM in bay 1 is set as the persistent command environment, at the system:mm[1]> prompt, type 
portcfg -com1
To set the baud rate for the CMM serial port to 9600, while the primary CMM in bay 1 is set as the persistent command environment, at the system:mm[1]> prompt, type 
portcfg -com1 -b 9600

The following example shows the information that is returned from these two commands:

system:mm[1]> portcfg -com1
-b 2400
-p none
-s 1
system:mm[1]> portcfg -com1 -b 9600
These configuration changes will become active after the next reset of the MM.
system:mm[1]>
Parent topic: Command reference