summaryrefslogtreecommitdiff
path: root/docs/system
diff options
context:
space:
mode:
Diffstat (limited to 'docs/system')
-rw-r--r--docs/system/advanced-index.rst1
-rw-r--r--docs/system/lcd.rst45
2 files changed, 46 insertions, 0 deletions
diff --git a/docs/system/advanced-index.rst b/docs/system/advanced-index.rst
index b6b8d091..36469763 100644
--- a/docs/system/advanced-index.rst
+++ b/docs/system/advanced-index.rst
@@ -15,3 +15,4 @@ Advanced System Tweaks
serial-console
syslog
task-scheduler
+ 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
+