set profile

Purpose

Associates a particular port with one of several port configuration profiles, or displays the current port-profile settings.

Port profiles are a defined set of port configuration settings for a particular use. A port profile reconfigures serial-port settings to the necessary default values in order for the profile to operate correctly.

Port-profile configuration is most often performed through the web interface for a device. It is not often specified from the command line, but is available if needed.

Digi devices support several port profiles, shown in the command syntax. The profiles supported on your Digi device may vary.

Required permissions

For Digi products with two or more users, to use this command, permissions must be set to one of the following:

For a user to display the profile settings for the line on which they are logged in: set permissions s-profile=r-self.
For a user to display the profile settings for any line: set permissions s‑profile=read.
For a user to display and set the profile settings for the line on which they are logged in: set permissions s-profile=rw-self.
For a user to display the profile settings for any line, and set modem emulation settings for the line on which the user is logged in: set permissions s-profile=w-self-r.
For a user to display and set the profile settings on any line: set permissions s-profile=rw.

See set permissions for details on setting user permissions for commands.

Syntax

Configure port profile settings

set profile port=port 
  profile={unassigned|console_management|local_config|
  modem_emulation|realport|tcp_sockets|tunneling|udp_sockets|
  custom|ia|dialserv|gps}

Display current port profile settings for all available serial ports

set profile

Display current port profile settings for a particular serial port

set profile port=port

Options

port=port

The serial port number or range of serial ports associated with the port profile. Required when configuring port profiles.

profile={unassigned|console_management|local_config|
modem_emulation|realport|tcp_sockets|tunneling|udp_sockets|
custom|ia|dialserv}

The port profile to use for the serial port. Required when configuring port profiles. Choosing a particular port profile causes the serial port’s configuration to be reset to defaults, and then for the default settings for that port profile to take effect.

Depending on the port-profile choices available for the device, the value of profile can be one of the following:

unassigned

No port profile is assigned to the port. This option can be used to clear a previously assigned profile and its associated serial settings from the port.

console_management

Associates the Console Management port profile with the port. This profile allows access to a device’s console port over a network connection.

local_config

Associates the Local Configuration port profile with the port.This profile configures the serial port to act as a modem.

modem_emulation

Associates the Modem Emulation port profile with the port. This profile allows connections to standard terminals or terminal emulation programs to the serial port, to use the serial port as a console to access the command line interface.

realport

Associates the RealPort port profile with the port. This profile allows mapping a COM or TTY port to the serial port.

tcp_sockets

Associates the TCP Sockets port profile with the port. This profile allows a serial device to communicate over a TCP network.

When the TCP Sockets profile is set, the DTR flow-control signal indicates when a TCP socket connection has been established. This information can be useful in monitoring the serial line and using it as a flow-control mechanism to determine when the Digi device is connected to a remote device with which communication is being established. This mechanism can be combined with using the DCD signal to close the connection and the DSR signal to do RCI over serial. Together, these signals can be used to make the Digi device auto connect to many devices, deterministically, on the network.

For ConnectPort X2 gateways, TCP Sockets can be used to directly access the XBee RF module on a gateway. See Direct Access communication with the XBee RF module on ConnectPort X2 gateways.

tunneling

Associates the Serial Bridge port profile with the port. This profile is known in the web interface as the Serial Bridge profile. It configures one side of a serial bridge. A serial bridge connects two serial devices over the network, as if they were connected with a serial cable.

udp_sockets

Associates the UDP Sockets port profile with the port. This profile allows a serial device to communicate using UDP.

custom

Associates the Custom port profile with the port.This profile is an advanced option to allow full configuration of the serial port. It allows you to view all settings associated with the serial port.

Associates the Industrial Automation (IA) port profile with the port. IA profile, which configures the serial port for use in Industrial Automation (IA). The default configuration settings assume Modbus/RTU slaves with addresses 1 to 32 are attached to the serial port. Default port characteristics are 9600:8,N,1. Unit ID zero (0) is auto-mapped to Modbus/RTU slave address 1. The electrical interface is set as EIA-232, EIA-422, or EIA-485 by the four DIP switches on the bottom of the unit.

dialserv

Associates the Dialserv port profile with the port. Digi DialServ is an RJ-11 phone line simulator that allows legacy devices with built-in modems to communicate across LANs/WANs. This profile configures the Digi device to connect/tunnel serial data to an external host when the DialServ receives an incoming call, causes the DialServ to make outgoing calls, and tunnels TCP data from the incoming connection over the Dialserv when TCP traffic is received on the configured ports on the Digi device.

Important: Use of this profile is required for DialServ interoperation.

gps

Associates the GPS port profile with the port. This profile allows the Digi device to make use of an NMEA-0183 compliant Global Positioning System (GPS) data stream for location and geofencing.

Example

#> set profile port=1 profile=realport