diff options
Diffstat (limited to 'docs/system')
| -rw-r--r-- | docs/system/advanced-index.rst | 2 | ||||
| -rw-r--r-- | docs/system/lcd.rst | 45 | ||||
| -rw-r--r-- | docs/system/system-display.rst | 90 |
3 files changed, 46 insertions, 91 deletions
diff --git a/docs/system/advanced-index.rst b/docs/system/advanced-index.rst index de6cd3e1..36469763 100644 --- a/docs/system/advanced-index.rst +++ b/docs/system/advanced-index.rst @@ -15,4 +15,4 @@ Advanced System Tweaks serial-console syslog task-scheduler - system-display + lcd diff --git a/docs/system/lcd.rst b/docs/system/lcd.rst new file mode 100644 index 00000000..441becf5 --- /dev/null +++ b/docs/system/lcd.rst @@ -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 + diff --git a/docs/system/system-display.rst b/docs/system/system-display.rst deleted file mode 100644 index 65e490a2..00000000 --- a/docs/system/system-display.rst +++ /dev/null @@ -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. |