Serial Console User Guide

User Guide

Overview of the serial console Direct link to this section

The serial console is an interface that allows you to restart or reconfigure a sensor when you connect to it using a cable or AirConsole adapter. This is typically used for troubleshooting when other methods do not work. This page describes the hardware requirements for the serial console, as well as how to use the serial console.

Sensor requirements Direct link to this section

This section details the hardware and driver requirements to use the serial console for each model.

Hardware requirements Direct link to this section

These are the hardware requirements for serial console sessions:

Sensor model Cable Driver Chip
AWN101 Black mini USB serial cable Prolific driver PL2303 chip
AWN200 Blue RJ45 to USB serial cable OS X FTDI driver Not applicable
AWN201 Blue RJ45 to USB serial cable OS X FTDI driver Not applicable
AWN202 Blue RJ45 to USB serial cable OS X FTDI driver Not applicable
AWN203 DB9 to USB cable Not applicable Not applicable
AWN301 DB9 to USB cable Not applicable Not applicable
AWN1000 Blue RJ45 to USB serial cable OS X FTDI driver Not applicable

Installing required drivers Direct link to this section

This section guides you through the installation of required drivers to use the serial console.

AWN101 serial console session driver Direct link to this section

To install the required driver for the AWN101 sensor:

  1. If you are using a Mac, and this Mac was previously used for another console session, run this command in a terminal to uninstall the previously installed driver:

    sudo rm -rf /System/Library/Extensions/ProlificUsbSerial.kext
  2. Download the driver from Prolific, and install it.

    Note: macOS requires approval before installation. You are prompted to enter your password during the installation.

  3. Use the cable identified in Hardware requirements to connect the sensor and your computer.

Console session drivers for all other sensors Direct link to this section

To install the required driver on all other sensor models:

Notes:

  1. Use the cable identified in Hardware requirements to connect the sensor and your computer.

  2. In a terminal, run the following command to check the serial device name:

    ls /dev/tty.usbserial*
  3. Run the following command, where <SERIAL_NUMBER> is the number output in step 2:

    screen /dev/tty.usbserial-<SERIAL_NUMBER>

AirConsole requirements Direct link to this section

AirConsole is a portable, battery powered RS232 serial port over WiFi or a Bluetooth adapter. If you cannot use a physical cable, and you own an AirConsole adapter, you can use it instead.

For AirConsole, you need the:

To connect AirConsole:

  1. Launch the AirConsoleOSX application on your Mac.
  2. Change AirConsole from Auto to Manual.
  3. Enter the hostname of the AirConsole. For example, aircon1.
  4. Connect to the AirConsole device with this command, where <serial_number> is the serial number of the device:
    sudo screen /dev/cu.Airconsole-1 <serial_number>

Connecting to the serial console Direct link to this section

To connect to the serial console:

Note: Before you begin, ensure that you have the necessary equipment and drivers. See Hardware requirements for a list of necessary equipment for each sensor.

  1. If your operating system is:
    • Windows — Use PuTTY and select the following settings:
      • Serial line — Select the serial line for the console cable.
      • Speed — 115200
      • Connection type — Serial
    • Mac or Linux — Open a terminal and use the following command:
    screen /dev/tty.usbserial 115200
  2. Press Enter three times to initiate the serial console session.

Navigating the serial console Direct link to this section

Onscreen instructions display how to navigate the serial console UI. Generally, you can perform the following actions using these keys:

Serial console tasks Direct link to this section

These are the tasks available while using the serial console with an activated sensor:

Note: Leaving the serial console session idle while performing a task returns you to the main task screen without applying changes.

Updating network parameters Direct link to this section

To update network parameters:

  1. Navigate to the main task screen.
  2. Select Reconfigure on the management interface.
  3. Select either DHCP or Static networking as the option that you wish to configure your management interface with.
  4. If you selected Static networking, edit the following fields:
    • IP address
    • Netmask/Subnet
    • Primary DNS server
    • Secondary DNS server
    • Gateway
  5. Select Next. This runs a series of connectivity tests. If the tests:
    • Pass — You are redirected to the main task screen.
    • Fail — Select Back to return to the previous screen. Change the configuration and retry the connectivity tests.

Viewing the current configuration and connectivity status Direct link to this section

To display the current device configuration details:

Note: You cannot make any modifications to the configuration from this screen.

  1. Navigate to the main task screen.
  2. Select Show the current configuration. The following information displays:
    • Customer-ID — The customer ID.
    • Deployment-ID — The deployment ID.
    • Deployment-Type — The deployment type. This can be Internal Tap, Mirroring, or Scanner.
    • Network Type — The network type. This can be DHCP or Static networking.
    • Connectivity to Switchboard 1 and Connectivity to Switchboard 2 — The connectivity status of the sensor. This can be PASS or FAIL.
  3. Select Next to return to the main task screen.

Reconfiguring the deployment type Direct link to this section

You can reconfigure the deployment to a different deployment type. To reconfigure the deployment:

  1. Navigate to the main taskn screen.
  2. Select Reconfigure the deployment type.
  3. Select either Internal Tap, Mirroring, or Scanner.
  4. Select Next to return to the main task screen.

Note: You may need to restart the sensor to apply the new deployment type.

Restarting the sensor Direct link to this section

To restart the sensor, navigate to the post-activation screen and select Reboot the device.