Add a USB serial port
Your IX30 can be configured to support USB-to-serial adapters for serial access to the device, remote serial out-of-band (OOB) access to other devices, or for use in python applications. The following USB-to-serial chipsets are supported:
- FTDI
- Prolific
To add a USB serial port:
Web
- Log into Digi Remote Manager, or log into the local Web UI as a user with full Admin access rights.
- Access the device configuration:
Remote Manager:
- Locate your device as described in Use Digi Remote Manager to view and manage your device.
- Click the Device ID.
- Click Settings.
- Click to expand Config.
Local Web UI:- On the menu, click System. Under Configuration, click Device Configuration.
The Configuration window is displayed.
- Click Serial.
- For Add Serial port, type a name for the group and click .
The serial port configuration window is displayed.
The new USB serial port is Enabled by default.
For Type, USB serial port is currently the only option.
- For Serial mode, select one of the following options. The fields in the page change, depending on which option you select.
Note The USB fields are the same for all Serial mode option selections, and they are described in the following steps.
- Login: Allows the user to log into the device through the serial port. See Configure Login mode for a serial port.
- Remote access: Allows for remote access to another device that is connected to the serial port. See Configure Remote Access mode for a serial port.
- Application: Provides access to the serial device from Python applications.
- Modbus: Allows you to use the serial port for Modbus. See Modbus gateway.
- (Optional) For Label, type a descriptive label for this serial port.
- For USB port, select the USB port you want to use. For example, front.
- (Optional) If the device's USB port is connected to a USB hub, for USB hub path, type the path to a USB-to-serial adapter on the hub. Leave this field blank if the if the USB-to-serial adapter is connected directly to the device's USB port.
- (Optional) USB devices with multiple ports may identify ports by using an interface descriptor. For USB interface descriptor, type the appropriate descriptor number. Leave this option at the default of 0 for USB devices with only one serial port.
- (Optional) USB devices with multiple ports may identify ports by using a port number. For USB port number, type or select the appropriate port number. Leave this option at the default of 0 for USB devices with only one serial port.
- Expand Authentication to add the new USB serial port to a group, which enables a user to access the serial port by SSH, Terminal, WebUI, or Digi Remote Manager.
- Click to expand Groups.
- For Group, either select an existing group to which you want to add the USB serial port (for example, the serial group) or click and type a name for the new USB serial port group.
- For the group you just created, click to expand acl.
- Click to expand serial.
- Enable Serial access.
- For Serial ports, click and select the Port you created. The usb serial port will be added to the group.
-
Once you have added the USB serial port to the authentication group, make sure that group is assigned to the user who will be logging into the device and using the USB serial port.
-
Click Users to expand.
-
Click User, and then click the name of the user.
-
Click to expand Groups to confirm that the USB serial port is listed for the user.
-
- Click Apply to save the configuration and apply the change.
Command line
- Select the device in Remote Manager and click Actions > Open Console, or log into the IX30 local command line as a user with full Admin access rights.
Depending on your device configuration, you may be presented with an Access selection menu. Type admin to access the Admin CLI.
- At the command line, type config to enter configuration mode:
> config (config)>
- Add the serial port:
(config)> add serial USB_port (config serial USB_port)>
- Set the mode:
(config serial USB_port)> mode mode (config serial USB_port)>
where mode is either:
- ppp_dialin: Allows the device to answer Point-to-Point Protocol (PPP) connections over serial ports. See Configure PPP dial-in mode for a serial port.
- modem_emulator: Allows the device to act as a dial-up modem emulator for handling incoming AT dial-ins. See Configure Modem emulator mode for a serial port.
- udp: Provides access to the device through a UDP serial port. See Configure UDP serial mode for a serial port.
The default is Remote.
- (Optional) Set a label that will be used when referring to this port.
(config serial USB_port)> label label (config serial USB_port)>
- Add the new USB serial port to a new or already-existing group, which enables a user to access the serial port by SSH, Terminal, WebUI, or Digi Remote Manager.
- To enable serial access:
(config auth group serial acl serial) enable
To add the USB serial port to a group:
(config auth group serial acl serial ports) add <path> <key | index > [value]
Where value is the serial port you want to add to the group.
- To enable serial access:
-
Once you have added the USB serial port to the authentication group, make sure that group is assigned to the user who will be logging into the device and using the USB serial port.
(config auth users user [username]) add <path> <key | index > [value]
Where value is the name of the USB serial port group.
- Save the configuration and apply the change
(config serial USB_port)> save Configuration saved. > - Type exit to exit the Admin CLI.
Depending on your device configuration, you may be presented with an Access selection menu. Type quit to disconnect from the device.
PDF
