From d94dd8e9fdb1bde245216ada4cfd2e16bf51c4e1 Mon Sep 17 00:00:00 2001
From: Kevin O'Connor <kevin@koconnor.net>
Date: Mon, 8 Jun 2020 16:53:47 -0400
Subject: [PATCH] docs: Note changes to glyph names

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
---
 docs/Config_Changes.md            |  5 +++++
 klippy/extras/display/display.cfg | 10 ++++++++++
 klippy/extras/display/hd44780.py  |  2 +-
 3 files changed, 16 insertions(+), 1 deletion(-)

diff --git a/docs/Config_Changes.md b/docs/Config_Changes.md
index 016fc425..70496ece 100644
--- a/docs/Config_Changes.md
+++ b/docs/Config_Changes.md
@@ -6,6 +6,11 @@ All dates in this document are approximate.
 
 # Changes
 
+20200608: The LCD display support has changed the name of some
+internal "glyphs".  If a custom display layout was implemented it may
+be necessary to update to the latest glyph names (see
+klippy/extras/display/display.cfg for a list of available glyphs).
+
 20200606: The pin names on linux mcu have changed. Pins now have names
 of the form `gpiochip<chipid>/gpio<gpio>`.  For gpiochip0 you can also
 use a short `gpio<gpio>`.  For example, what was previously referred
diff --git a/klippy/extras/display/display.cfg b/klippy/extras/display/display.cfg
index bb395cc4..4939792b 100644
--- a/klippy/extras/display/display.cfg
+++ b/klippy/extras/display/display.cfg
@@ -186,6 +186,7 @@ text:
 position: 3, 0
 text: { render("_print_status") }
 
+
 ######################################################################
 # Default display glyphs
 ######################################################################
@@ -322,3 +323,12 @@ data:
   0000000000000000
   0000000000000000
   0000000000000000
+
+# In addition to the above glyphs, 16x4 displays also have the
+# following hard-coded single character glyphs: right_arrow, degrees.
+
+# The 20x4 displays do not have configurable glyphs.  They do have
+# hard-coded support for the following single character glyphs:
+# right_arrow, degrees, extruder, bed, bed_heat1 (same as bed),
+# bed_heat2 (same as bed), feedrate, clock, usb, sd, fan1, fan2 (same
+# as fan1).
diff --git a/klippy/extras/display/hd44780.py b/klippy/extras/display/hd44780.py
index b1faef45..19ad0d3e 100644
--- a/klippy/extras/display/hd44780.py
+++ b/klippy/extras/display/hd44780.py
@@ -197,5 +197,5 @@ TextGlyphs = {
     'degrees': '\x04',
     'usb': '\x05',
     'sd': '\x06',
-    'fan': '\x07', 'fan1': '\x07', 'fan2': '\x07',
+    'fan1': '\x07', 'fan2': '\x07',
 }