aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Config_Reference.md
diff options
context:
space:
mode:
authorAlexander Bazarov <63168142+bazarovdev@users.noreply.github.com>2024-12-02 13:23:46 -0500
committerGitHub <noreply@github.com>2024-12-02 13:23:46 -0500
commitaecb29d2b02eed7846204fad9b40b584f79d0095 (patch)
tree895b10a129be50ef95dac116b7f13bac7a57d943 /docs/Config_Reference.md
parent9ce631e8d1a7b739f96c360a7a4250489ae8deb8 (diff)
downloadkutter-aecb29d2b02eed7846204fad9b40b584f79d0095.tar.gz
kutter-aecb29d2b02eed7846204fad9b40b584f79d0095.tar.xz
kutter-aecb29d2b02eed7846204fad9b40b584f79d0095.zip
display: Add support for `AIP31068` based displays (#6639)
display: Add support for `AIP31068` based displays
Diffstat (limited to 'docs/Config_Reference.md')
-rw-r--r--docs/Config_Reference.md32
1 files changed, 29 insertions, 3 deletions
diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md
index d73a3a64..6a5a7582 100644
--- a/docs/Config_Reference.md
+++ b/docs/Config_Reference.md
@@ -4139,15 +4139,16 @@ Support for a display attached to the micro-controller.
[display]
lcd_type:
# The type of LCD chip in use. This may be "hd44780", "hd44780_spi",
-# "st7920", "emulated_st7920", "uc1701", "ssd1306", or "sh1106".
+# "aip31068_spi", "st7920", "emulated_st7920", "uc1701", "ssd1306", or
+# "sh1106".
# See the display sections below for information on each type and
# additional parameters they provide. This parameter must be
# provided.
#display_group:
# The name of the display_data group to show on the display. This
# controls the content of the screen (see the "display_data" section
-# for more information). The default is _default_20x4 for hd44780
-# displays and _default_16x4 for other displays.
+# for more information). The default is _default_20x4 for hd44780 or
+# aip31068_spi displays and _default_16x4 for other displays.
#menu_timeout:
# Timeout for menu. Being inactive this amount of seconds will
# trigger menu exit or return to root menu when having autorun
@@ -4273,6 +4274,31 @@ spi_software_miso_pin:
...
```
+#### aip31068_spi display
+
+Information on configuring an aip31068_spi display - a very similar to hd44780_spi
+a 20x04 (20 symbols by 4 lines) display with slightly different internal
+protocol.
+
+```
+[display]
+lcd_type: aip31068_spi
+latch_pin:
+spi_software_sclk_pin:
+spi_software_mosi_pin:
+spi_software_miso_pin:
+# The pins connected to the shift register controlling the display.
+# The spi_software_miso_pin needs to be set to an unused pin of the
+# printer mainboard as the shift register does not have a MISO pin,
+# but the software spi implementation requires this pin to be
+# configured.
+#line_length:
+# Set the number of characters per line for an hd44780 type lcd.
+# Possible values are 20 (default) and 16. The number of lines is
+# fixed to 4.
+...
+```
+
#### st7920 display
Information on configuring st7920 displays (which is used in