Skip to content

Configuration settings

Joshua Wise edited this page Jun 9, 2024 · 3 revisions

X1Plus is migrating to a key-based configuration store that lives in /mnt/sdcard/x1plus/printers/{serialno}/settings.json. You should not write to this file directly while the printer is running; instead, you should use the x1plus command line tool to do it for you, since otherwise, the x1plusd may overwrite your changes again. To do this, you can ssh to your printer, and:

  • to print a current setting: x1plus settings get SETTINGNAME
  • to show all settings: x1plus settings show
  • to change a setting: x1plus settings set SETTINGNAME VALUE (values are stored as JSON objects; to be specific about how your value is stored, see x1plus settings set --help).

Available configuration keys

  • boot.quick_boot: a bool, if true will skip the kexec ui at boot if no new .x1p is on the sdcard.
  • boot.dump_emmc: a bool, if true will dump the device emmc to sdcard at x1plus/printers/SDEVICE_SN/emmc.bin. Only dumps if an existing dump doesnt exist, and there's enough free space.
  • boot.sdcard_syslog: a bool, if true enables syslog to the sdcard, which will be in a folder called log
  • boot.perf_log: a bool, if true enables logging performance and memory info to the sdcard at x1plus/printers/SDEVICE_SN/logs/perf_log.txt
  • boot.wifi_driver.bcmdhd: a bool, set to true to load the legacy WiFi driver on startup instead of the X1Plus driver
  • ota.enabled: a bool, set to false to disable checking for X1Plus OTA updates
  • ota.json_url: a string, overriding the endpoint that x1plusd.ota uses to check for updates
  • lockscreen.passcode: a string containing a numeric passcode
  • lockscreen.mode: an integer, 0 for screen saver only, 1 for slide to unlock, 2 for passcode
  • lockscreen.image: a string containing an absolute filesystem path to an image file that will be displayed on the lockscreen (i.e., "/mnt/sdcard/lockscreen.png")
  • homescreen.image: a string containing an absolute filesystem path to an image file that will be displayed on the home screen while the printer is idle
  • homescreen.image.printing: a string containing an absolute filesystem path to an image file that will be displayed on the home screen while the printer is either printing or has a HMS alert active
  • homescreen.graph.enabled: (EXPERIMENTAL) replaces the home screen logo with a Klipperscreen-style graph if true
  • vnc.enabled: whether the VNC server will accept connections (enabled if non-false)
  • vnc.password: a string, or null; null uses the LAN access code as the password, an empty string sets no password, and any other string overrides the VNC password

Welcome to the X1Plus wiki!

Perhaps you would like to read:

Or perhaps you would just like to download the latest release?

Clone this wiki locally