From 78c2276d4e90f59fb261bb8f844da5a5e174dfdf Mon Sep 17 00:00:00 2001 From: fmertz Date: Thu, 25 Jun 2020 21:36:23 +0000 Subject: system display: T2564 Extend VyOS to support appliance LCDs * docs/system/advanced-index.rst Added reference to system display + docs/system/system-display.rst Documents system display --- docs/system/advanced-index.rst | 1 + docs/system/system-display.rst | 90 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 91 insertions(+) create mode 100644 docs/system/system-display.rst (limited to 'docs') diff --git a/docs/system/advanced-index.rst b/docs/system/advanced-index.rst index 9241821b..4557421a 100644 --- a/docs/system/advanced-index.rst +++ b/docs/system/advanced-index.rst @@ -14,3 +14,4 @@ Advanced System Tweaks serial-console syslog task-scheduler + system-display diff --git a/docs/system/system-display.rst b/docs/system/system-display.rst new file mode 100644 index 00000000..db3cd113 --- /dev/null +++ b/docs/system/system-display.rst @@ -0,0 +1,90 @@ +.. _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 + +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 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 + +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 + +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 alias + +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 + +The unit options are: + + * ``bps`` - Bits per second + * ``Bps`` - Bytes per second + * ``pps`` - packets per second + +.. cfgcmd:: set system display show clock + +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 + +This will set the title text on the display screens + +.. cfgcmd:: set system display hello +.. cfgcmd:: set system display bye + +This will set the welcome and final text on the screen as the system display +starts and stops. + +.. cfgcmd:: set system display duration + +This will set the time (in seconds) to hold each screen on the system display. + +.. cfgcmd:: set system display config + +The config option allows the entire system display configuration to be +enabled or disabled without having to delete and re-create the configuration. -- cgit v1.2.3 From 2201749e1155d0c9049c62b44810815add1ed835 Mon Sep 17 00:00:00 2001 From: fmertz Date: Thu, 25 Jun 2020 23:44:03 +0000 Subject: system display: T2564 Extend VyOS to support appliance LCDs * docs/system/system-display.rst Added supported model --- docs/system/system-display.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/system/system-display.rst b/docs/system/system-display.rst index db3cd113..43940f74 100644 --- a/docs/system/system-display.rst +++ b/docs/system/system-display.rst @@ -16,7 +16,7 @@ The first step is to identify the LCD screen model. This step is required. 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 appliances with built-in SDEC 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. -- cgit v1.2.3 From 803405f0c14c462af54043578789c0c5e4374b0d Mon Sep 17 00:00:00 2001 From: fmertz Date: Mon, 29 Jun 2020 14:50:02 +0000 Subject: system display: T2564: "display config (enable|disable)" to "display disabled" * docs/system/system-display.rst display disabled --- docs/system/system-display.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs') diff --git a/docs/system/system-display.rst b/docs/system/system-display.rst index 43940f74..5863fc14 100644 --- a/docs/system/system-display.rst +++ b/docs/system/system-display.rst @@ -84,7 +84,7 @@ starts and stops. This will set the time (in seconds) to hold each screen on the system display. -.. cfgcmd:: set system display config +.. cfgcmd:: set system display disabled -The config option allows the entire system display configuration to be -enabled or disabled without having to delete and re-create the configuration. +The disabled option allows the system display configuration to be disabled while +keeping the rest of the configuration. -- cgit v1.2.3 From 6311d4b8fd7a5254a1aef40dcb26058a1d47322d Mon Sep 17 00:00:00 2001 From: fmertz Date: Mon, 29 Jun 2020 15:05:36 +0000 Subject: system display: T2564: Lowercase models * docs/system/system-display.rst lowercase models --- docs/system/system-display.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/system/system-display.rst b/docs/system/system-display.rst index 5863fc14..e54963f3 100644 --- a/docs/system/system-display.rst +++ b/docs/system/system-display.rst @@ -15,8 +15,8 @@ The first step is to identify the LCD screen model. This step is required. 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 + * ``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. -- cgit v1.2.3 From 53e161114f037c5e0a1f1c3078a9855b2009133c Mon Sep 17 00:00:00 2001 From: fmertz Date: Mon, 29 Jun 2020 14:56:34 +0000 Subject: system display: T2564: Changed "duration" to "time" * docs/system/system-display.rst duration to time --- docs/system/system-display.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/system/system-display.rst b/docs/system/system-display.rst index e54963f3..65e490a2 100644 --- a/docs/system/system-display.rst +++ b/docs/system/system-display.rst @@ -80,7 +80,7 @@ This will set the title text on the display screens This will set the welcome and final text on the screen as the system display starts and stops. -.. cfgcmd:: set system display duration +.. cfgcmd:: set system display time This will set the time (in seconds) to hold each screen on the system display. -- cgit v1.2.3