mirror of
https://github.com/vyos/vyos-documentation.git
synced 2025-10-26 08:41:46 +01:00
lcd: T2564: adjust to latest CLI
This commit is contained in:
Christian Poessinger
parent
5b81f10bd7
commit
b0ea62e22d
@ -53,6 +53,7 @@ VyOS User Guide
|
||||
:name: system-operation
|
||||
:maxdepth: 2
|
||||
|
||||
information
|
||||
troubleshooting
|
||||
command-list-operation
|
||||
|
||||
|
||||
97
docs/information.rst
Normal file
97
docs/information.rst
Normal file
@ -0,0 +1,97 @@
|
||||
.. _information:
|
||||
|
||||
***********
|
||||
Information
|
||||
***********
|
||||
|
||||
VyOS features a rich set of operational level commands to retrieve arbitrary
|
||||
infomration about your running system.
|
||||
|
||||
########
|
||||
Hardware
|
||||
########
|
||||
|
||||
.. _hardware_usb:
|
||||
|
||||
USB
|
||||
===
|
||||
|
||||
In the past serial interface have been defined as ttySx and ttyUSBx where x was
|
||||
an instance number of the serial interface. It was discovered that from system
|
||||
boot to system boot the mapping of USB based serial interfaces will differ,
|
||||
depending which driver was loaded first by the operating system. This will become
|
||||
rather painful if you not only have serial interfaces for a console server
|
||||
connected but in addition also a serial backed :ref:`wwan-interface`.
|
||||
|
||||
To overcome this issue and the fact that in almost 50% of all cheap USB to serial
|
||||
converters there is no serial number programmed, the USB to serial interface is
|
||||
now directly identified by the USB root bridge and bus it connects to. This
|
||||
somehow mimics the new network interface definitions we see in recend Linux
|
||||
distributions.
|
||||
|
||||
For additional details you can refer to https://phabricator.vyos.net/T2490.
|
||||
|
||||
.. opcmd:: show hardware usb
|
||||
|
||||
Retrieve a tree like representation of all connected USB devices.
|
||||
|
||||
.. note:: If a device is unplugged and re-plugged it will receive a new
|
||||
Port, Dev, If identification.
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
vyos@vyos:~$ show hardware usb
|
||||
/: Bus 03.Port 1: Dev 1, Class=root_hub, Driver=ehci-pci/2p, 480M
|
||||
|__ Port 1: Dev 2, If 0, Class=Hub, Driver=hub/4p, 480M
|
||||
|__ Port 3: Dev 4, If 0, Class=Vendor Specific Class, Driver=qcserial, 480M
|
||||
|__ Port 3: Dev 4, If 2, Class=Vendor Specific Class, Driver=qcserial, 480M
|
||||
|__ Port 3: Dev 4, If 3, Class=Vendor Specific Class, Driver=qcserial, 480M
|
||||
|__ Port 3: Dev 4, If 8, Class=Vendor Specific Class, Driver=qmi_wwan, 480M
|
||||
/: Bus 02.Port 1: Dev 1, Class=root_hub, Driver=xhci_hcd/2p, 5000M
|
||||
/: Bus 01.Port 1: Dev 1, Class=root_hub, Driver=xhci_hcd/2p, 480M
|
||||
|__ Port 1: Dev 2, If 0, Class=Vendor Specific Class, Driver=pl2303, 12M
|
||||
|__ Port 2: Dev 3, If 0, Class=Hub, Driver=hub/4p, 480M
|
||||
|__ Port 4: Dev 5, If 2, Class=Vendor Specific Class, Driver=ftdi_sio, 480M
|
||||
|__ Port 4: Dev 5, If 0, Class=Vendor Specific Class, Driver=ftdi_sio, 480M
|
||||
|__ Port 4: Dev 5, If 3, Class=Vendor Specific Class, Driver=ftdi_sio, 480M
|
||||
|__ Port 4: Dev 5, If 1, Class=Vendor Specific Class, Driver=ftdi_sio, 480M
|
||||
|__ Port 3: Dev 4, If 0, Class=Hub, Driver=hub/4p, 480M
|
||||
|__ Port 3: Dev 6, If 0, Class=Hub, Driver=hub/4p, 480M
|
||||
|__ Port 4: Dev 8, If 2, Class=Vendor Specific Class, Driver=ftdi_sio, 480M
|
||||
|__ Port 4: Dev 8, If 0, Class=Vendor Specific Class, Driver=ftdi_sio, 480M
|
||||
|__ Port 4: Dev 8, If 3, Class=Vendor Specific Class, Driver=ftdi_sio, 480M
|
||||
|__ Port 4: Dev 8, If 1, Class=Vendor Specific Class, Driver=ftdi_sio, 480M
|
||||
|__ Port 4: Dev 7, If 3, Class=Vendor Specific Class, Driver=ftdi_sio, 480M
|
||||
|__ Port 4: Dev 7, If 1, Class=Vendor Specific Class, Driver=ftdi_sio, 480M
|
||||
|__ Port 4: Dev 7, If 2, Class=Vendor Specific Class, Driver=ftdi_sio, 480M
|
||||
|__ Port 4: Dev 7, If 0, Class=Vendor Specific Class, Driver=ftdi_sio, 480M
|
||||
|
||||
|
||||
.. opcmd:: show hardware usb serial
|
||||
|
||||
Retrieve a list and description of all connected USB serial devices. The device name
|
||||
displayed, e.g. `usb0b2.4p1.0` can be directly used when accessing the serial console
|
||||
as console-server device.
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
vyos@vyos$ show hardware usb serial
|
||||
Device Model Vendor
|
||||
------ ------ ------
|
||||
usb0b1.3p1.0 MC7710 Sierra Wireless, Inc.
|
||||
usb0b1.3p1.2 MC7710 Sierra Wireless, Inc.
|
||||
usb0b1.3p1.3 MC7710 Sierra Wireless, Inc.
|
||||
usb0b1p1.0 USB-Serial_Controller_D Prolific Technology, Inc.
|
||||
usb0b2.3.3.4p1.0 Quad_RS232-HS Future Technology Devices International, Ltd
|
||||
usb0b2.3.3.4p1.1 Quad_RS232-HS Future Technology Devices International, Ltd
|
||||
usb0b2.3.3.4p1.2 Quad_RS232-HS Future Technology Devices International, Ltd
|
||||
usb0b2.3.3.4p1.3 Quad_RS232-HS Future Technology Devices International, Ltd
|
||||
usb0b2.3.4p1.0 Quad_RS232-HS Future Technology Devices International, Ltd
|
||||
usb0b2.3.4p1.1 Quad_RS232-HS Future Technology Devices International, Ltd
|
||||
usb0b2.3.4p1.2 Quad_RS232-HS Future Technology Devices International, Ltd
|
||||
usb0b2.3.4p1.3 Quad_RS232-HS Future Technology Devices International, Ltd
|
||||
usb0b2.4p1.0 Quad_RS232-HS Future Technology Devices International, Ltd
|
||||
usb0b2.4p1.1 Quad_RS232-HS Future Technology Devices International, Ltd
|
||||
usb0b2.4p1.2 Quad_RS232-HS Future Technology Devices International, Ltd
|
||||
usb0b2.4p1.3 Quad_RS232-HS Future Technology Devices International, Ltd
|
||||
|
||||
@ -15,88 +15,7 @@ serial converter (Prolific PL2303 or FTDI FT232/FT4232 based chips).
|
||||
If you happened to use a Cisco NM-16A - Sixteen Port Async Network Module or
|
||||
NM-32A - Thirty-two Port Async Network Module - this is your VyOS replacement.
|
||||
|
||||
Setup
|
||||
=====
|
||||
|
||||
In the past serial interface have been defined as ttySx and ttyUSBx where x was
|
||||
an instance number of the serial interface. It was discovered that from system
|
||||
boot to system boot the mapping of USB based serial interfaces will differ,
|
||||
depending which driver was loaded first by the operating system. This will become
|
||||
rather painful if you not only have serial interfaces for a console server
|
||||
connected but in addition also a serial backed :ref:`wwan-interface`.
|
||||
|
||||
To overcome this issue and the fact that in almost 50% of all cheap USB to serial
|
||||
converters there is no serial number programmed, the USB to serial interface is
|
||||
now directly identified by the USB root bridge and bus it connects to. This
|
||||
somehow mimics the new network interface definitions we see in recend Linux
|
||||
distributions.
|
||||
|
||||
For additional details you can refer to https://phabricator.vyos.net/T2490.
|
||||
|
||||
.. opcmd:: show hardware usb
|
||||
|
||||
Retrieve a tree like representation of all connected USB devices.
|
||||
|
||||
.. note:: If a device is unplugged and re-plugged it will receive a new
|
||||
Port, Dev, If identification.
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
vyos@vyos:~$ show hardware usb
|
||||
/: Bus 03.Port 1: Dev 1, Class=root_hub, Driver=ehci-pci/2p, 480M
|
||||
|__ Port 1: Dev 2, If 0, Class=Hub, Driver=hub/4p, 480M
|
||||
|__ Port 3: Dev 4, If 0, Class=Vendor Specific Class, Driver=qcserial, 480M
|
||||
|__ Port 3: Dev 4, If 2, Class=Vendor Specific Class, Driver=qcserial, 480M
|
||||
|__ Port 3: Dev 4, If 3, Class=Vendor Specific Class, Driver=qcserial, 480M
|
||||
|__ Port 3: Dev 4, If 8, Class=Vendor Specific Class, Driver=qmi_wwan, 480M
|
||||
/: Bus 02.Port 1: Dev 1, Class=root_hub, Driver=xhci_hcd/2p, 5000M
|
||||
/: Bus 01.Port 1: Dev 1, Class=root_hub, Driver=xhci_hcd/2p, 480M
|
||||
|__ Port 1: Dev 2, If 0, Class=Vendor Specific Class, Driver=pl2303, 12M
|
||||
|__ Port 2: Dev 3, If 0, Class=Hub, Driver=hub/4p, 480M
|
||||
|__ Port 4: Dev 5, If 2, Class=Vendor Specific Class, Driver=ftdi_sio, 480M
|
||||
|__ Port 4: Dev 5, If 0, Class=Vendor Specific Class, Driver=ftdi_sio, 480M
|
||||
|__ Port 4: Dev 5, If 3, Class=Vendor Specific Class, Driver=ftdi_sio, 480M
|
||||
|__ Port 4: Dev 5, If 1, Class=Vendor Specific Class, Driver=ftdi_sio, 480M
|
||||
|__ Port 3: Dev 4, If 0, Class=Hub, Driver=hub/4p, 480M
|
||||
|__ Port 3: Dev 6, If 0, Class=Hub, Driver=hub/4p, 480M
|
||||
|__ Port 4: Dev 8, If 2, Class=Vendor Specific Class, Driver=ftdi_sio, 480M
|
||||
|__ Port 4: Dev 8, If 0, Class=Vendor Specific Class, Driver=ftdi_sio, 480M
|
||||
|__ Port 4: Dev 8, If 3, Class=Vendor Specific Class, Driver=ftdi_sio, 480M
|
||||
|__ Port 4: Dev 8, If 1, Class=Vendor Specific Class, Driver=ftdi_sio, 480M
|
||||
|__ Port 4: Dev 7, If 3, Class=Vendor Specific Class, Driver=ftdi_sio, 480M
|
||||
|__ Port 4: Dev 7, If 1, Class=Vendor Specific Class, Driver=ftdi_sio, 480M
|
||||
|__ Port 4: Dev 7, If 2, Class=Vendor Specific Class, Driver=ftdi_sio, 480M
|
||||
|__ Port 4: Dev 7, If 0, Class=Vendor Specific Class, Driver=ftdi_sio, 480M
|
||||
|
||||
|
||||
.. opcmd:: show hardware usb serial
|
||||
|
||||
Retrieve a list and description of all connected USB serial devices. The device name
|
||||
displayed, e.g. `usb0b2.4p1.0` can be directly used when accessing the serial console
|
||||
as console-server device.
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
vyos@vyos$ show hardware usb serial
|
||||
Device Model Vendor
|
||||
------ ------ ------
|
||||
usb0b1.3p1.0 MC7710 Sierra Wireless, Inc.
|
||||
usb0b1.3p1.2 MC7710 Sierra Wireless, Inc.
|
||||
usb0b1.3p1.3 MC7710 Sierra Wireless, Inc.
|
||||
usb0b1p1.0 USB-Serial_Controller_D Prolific Technology, Inc.
|
||||
usb0b2.3.3.4p1.0 Quad_RS232-HS Future Technology Devices International, Ltd
|
||||
usb0b2.3.3.4p1.1 Quad_RS232-HS Future Technology Devices International, Ltd
|
||||
usb0b2.3.3.4p1.2 Quad_RS232-HS Future Technology Devices International, Ltd
|
||||
usb0b2.3.3.4p1.3 Quad_RS232-HS Future Technology Devices International, Ltd
|
||||
usb0b2.3.4p1.0 Quad_RS232-HS Future Technology Devices International, Ltd
|
||||
usb0b2.3.4p1.1 Quad_RS232-HS Future Technology Devices International, Ltd
|
||||
usb0b2.3.4p1.2 Quad_RS232-HS Future Technology Devices International, Ltd
|
||||
usb0b2.3.4p1.3 Quad_RS232-HS Future Technology Devices International, Ltd
|
||||
usb0b2.4p1.0 Quad_RS232-HS Future Technology Devices International, Ltd
|
||||
usb0b2.4p1.1 Quad_RS232-HS Future Technology Devices International, Ltd
|
||||
usb0b2.4p1.2 Quad_RS232-HS Future Technology Devices International, Ltd
|
||||
usb0b2.4p1.3 Quad_RS232-HS Future Technology Devices International, Ltd
|
||||
|
||||
For USB port information please refor to: :ref:`hardware_usb`.
|
||||
|
||||
Configuration
|
||||
=============
|
||||
|
||||
@ -15,4 +15,4 @@ Advanced System Tweaks
|
||||
serial-console
|
||||
syslog
|
||||
task-scheduler
|
||||
system-display
|
||||
lcd
|
||||
|
||||
45
docs/system/lcd.rst
Normal file
45
docs/system/lcd.rst
Normal file
@ -0,0 +1,45 @@
|
||||
.. _system-display:
|
||||
|
||||
********************
|
||||
System Display (LCD)
|
||||
********************
|
||||
|
||||
The system LCD :abbr:`LCD (Liquid-crystal display)` option is for users running
|
||||
VyOS on hardware that features an LCD display. This is typically a small display
|
||||
built in an 19 inch rack-mountable appliance. Those displays are used to show
|
||||
runtime data.
|
||||
|
||||
To configure your LCD display you must first identify the used hardware, and
|
||||
connectivity of the display to your system. This can be any serial port
|
||||
(`ttySxx`) or serial via USB or even old parallel port interfaces.
|
||||
|
||||
Configuration
|
||||
=============
|
||||
|
||||
.. cfgcmd:: set system lcd device <device>
|
||||
|
||||
This is the name of the physical interface used to connect to your LCD
|
||||
display. Tab completion is supported and it will list you all available
|
||||
serial interface.
|
||||
|
||||
For serial via USB port information please refor to: :ref:`hardware_usb`.
|
||||
|
||||
.. cfgcmd:: set system lcd model <model>
|
||||
|
||||
This is the LCD model used in your system.
|
||||
|
||||
At the time of this writing the following displays are supported:
|
||||
|
||||
* Crystalfontz CFA-533
|
||||
|
||||
* Crystalfontz CFA-631
|
||||
|
||||
* Crystalfontz CFA-633
|
||||
|
||||
* Crystalfontz CFA-635
|
||||
|
||||
.. note:: We can't support all displays from the beginning. If your display
|
||||
type is missing, please create a feature request via Phabricator_.
|
||||
|
||||
.. include:: ../common-references.rst
|
||||
|
||||
@ -1,90 +0,0 @@
|
||||
.. _system-display:
|
||||
|
||||
##############
|
||||
System Display
|
||||
##############
|
||||
|
||||
The system display options are for users running VyOS on hardware that features
|
||||
an LCD screen. This is typically a small display built in a 1U rack-mountable
|
||||
appliance. These displays can be used to show runtime data like network traffic
|
||||
and CPU load histogram.
|
||||
|
||||
The first step is to identify the LCD screen model. This step is required.
|
||||
|
||||
.. cfgcmd:: set system display model <device>
|
||||
|
||||
Available models are: (see completion helper for the most up-to-date list):
|
||||
|
||||
* ``ezio`` - Display model for Portwell, Caswell appliances with built-in EZIO-100 or EZIO-300 LCD
|
||||
* ``sdec`` - Display model for Lanner, Watchguard, Nexcom NSA, Sophos UTM appliances with built-in SDEC LCD
|
||||
|
||||
.. note:: This model is to be understood as a macro type, to be expanded over
|
||||
time as needed.
|
||||
|
||||
The next step is to select what screen(s) to show on the system display.
|
||||
|
||||
.. cfgcmd:: set system display show <category>
|
||||
|
||||
Screens are grouped in the following categories:
|
||||
|
||||
* ``host`` - For all host-related screens, like CPU and memory
|
||||
* ``network`` - For network traffic
|
||||
* ``clock`` - For a choice of several clock formats
|
||||
|
||||
.. cfgcmd:: set system display show host <screen>
|
||||
|
||||
The host category offers the following options:
|
||||
|
||||
* ``cpu`` - Detailed CPU usage
|
||||
* ``cpu-all`` - CPU usage overview (one line per CPU)
|
||||
* ``cpu-hist`` - CPU usage histogram
|
||||
* ``disk`` - File systems fill level
|
||||
* ``load-hist`` - Load histogram
|
||||
* ``memory`` - Memory and swap usage
|
||||
* ``proc`` - Top processes by size
|
||||
* ``uptime`` - System uptime
|
||||
|
||||
.. cfgcmd:: set system display show network <interface> alias <name>
|
||||
|
||||
The network category allows the selection of the network interface for which
|
||||
to show traffic. A list of available interfaces is available by pressing tab.
|
||||
An alias like WAN or LAN can also be entered if needed.
|
||||
|
||||
The units of network traffic can be chosen with the following command:
|
||||
|
||||
.. cfgcmd:: set system display show network units <unit>
|
||||
|
||||
The unit options are:
|
||||
|
||||
* ``bps`` - Bits per second
|
||||
* ``Bps`` - Bytes per second
|
||||
* ``pps`` - packets per second
|
||||
|
||||
.. cfgcmd:: set system display show clock <type>
|
||||
|
||||
The clock category offers the following options:
|
||||
|
||||
* ``big`` - Multi-line clock
|
||||
* ``mini`` - Minimal clock
|
||||
* ``date-time`` - Clock with Date and Time
|
||||
|
||||
The following optional commands may help configure the screen to your liking.
|
||||
|
||||
.. cfgcmd:: set system display show title <text>
|
||||
|
||||
This will set the title text on the display screens
|
||||
|
||||
.. cfgcmd:: set system display hello <text>
|
||||
.. cfgcmd:: set system display bye <text>
|
||||
|
||||
This will set the welcome and final text on the screen as the system display
|
||||
starts and stops.
|
||||
|
||||
.. cfgcmd:: set system display time <s>
|
||||
|
||||
This will set the time (in seconds) to hold each screen on the system display.
|
||||
|
||||
.. cfgcmd:: set system display disabled
|
||||
|
||||
The disabled option allows the system display configuration to be disabled while
|
||||
keeping the rest of the configuration.
|
||||
Loading…
x
Reference in New Issue
Block a user