Configuration

This will document the behavior of guppyconfig.json properties.

guppyconfig#

Guppy Screen configuration is found in guppyconfig.json. This file lives in the same path as the guppyscreen executable. The default install path is usuaully /usr/data/guppyscreen/ or /home/<user>/guppyscreen.

display_rotate#

This attribute defines the rotation of the UI in 90&deg increments. Valid values are 0, 1, 2, 3.

• 0 - no rotation
• 1 - 90°
• 2 - 180°
• 3 - 270°

default_printer#

default_printer is the reference to a printer object defined in printers. This is the current active printer that’s shown Gupppy Screen. Multiple printers can be configured and updating this attribute will switch Guppy Screen to said printer. Printer switch can also be done in Settings -> Printers.

default_macros#

default_macros is defined per printer object, i.e. printers.<printer-name>.default_macros. These attributes maps to the Cooldown, Load, and Unload buttons in the Extrude Panel. The values are macros defined by Guppy Screen or customed by the user to perform respective actions.

cooldown#

Defines the action to take for cooling the printer.

• default - SET_HEATER_TEMPERATURE HEATER=extruder TARGET=0\nSET_HEATER_TEMPERATURE HEATER=heater_bed TARGET=0"

load_filament#

Defines the action to load filament.

• default value - _GUPPY_LOAD_MATERIAL

[gcode_macro _GUPPY_LOAD_MATERIAL]
gcode:
  {% set extruder_temp = params.EXTRUDER_TEMP|default(240)|int %}
  {% set extrude_len = params.EXTRUDE_LEN|default(35)|int %}
  LOAD_MATERIAL_CLOSE_FAN2
  M109 S{extruder_temp}
  G91
  G1 E{extrude_len} F180
  LOAD_MATERIAL_RESTORE_FAN2 # k1 stuff

unload_filament#

Defines the action to unload filament.

• default value - _GUPPY_QUIT_MATERIAL

[gcode_macro _GUPPY_QUIT_MATERIAL]
gcode:
  {% set extruder_temp = params.EXTRUDER_TEMP|default(240)|int %}
  SAVE_GCODE_STATE NAME=myMoveState
  M109 S{extruder_temp}
  G91
  G1 E20 F180
  G1 E-30 F180
  G1 E-50 F2000
  RESTORE_GCODE_STATE NAME=myMoveState

fans#

fans is a per printer configuration. If value is [], then Guppy Screen will automatically discover display the fans. Each fan is has defines the attributes display_name and id.

• display_name - Fan name shown in the Fans Panel.
• id - The fan object name defined in Klipper printer.cfg.

"fans": [
  {
    "display_name": "Toolhead Fan",
    "id": "output_pin fan0"
  },
  {
    "display_name": "Back Fan",
    "id": "output_pin fan1"
  }
]

monitored_sensors#

monitored_sensors is defined per printer. If value is [], Guppy Screen will automatically discover and display them in the main panel. Each sneor object defines the fowlloing attributes:

• display_name - Sensor name shown in the Guppy Screen.
• id - Sensor/heater object name defined in Klipper printer.cfg.
• controllable - bool (true/false) to indicate whether its temperate is editable using Guppy Screen.
• color - int (0 - 18), color legend for the sensor element. See here for color choices, starting at value 0 (LV_PALLET_RED).

"moinitored_sensors": [
  {
    "display_name": "Extruder",
    "id": "extruder",
    "controllable": true,
    "color": 0,
  },
  {
    "display_name": "Bed Heater",
    "id": "heater_bed",
    "controllable": true,
    "color": 1,
  },
  {
    "display_name": "Chamber",
    "id": "temperature_sensor chamber",
    "controllable": false,
    "color": 2,
  }
]

moonraker_host#

moonraker_host is the hostname or IP address to the Moonraker instance for the configured printer.

• 127.0.0.1 - is the default value (localhost).

moonraker_port#

moonraker_port is the port of the Moonraker instance for the configured printer.

• 7125 - is the default port value.

prompt_emergency_stop#

prompt_emergency_stop indicates whether to prompt for buttons like Stop, Pause, and Cancel.

• true - prompt before executing action.
• false - no prompting for action execution.

display_sleep_sec#

display_sleep_sec is the number of seconds of touch inactivity before putting the screen to sleep.

• -1 - is used to mean never.

touch_calibrated#

touch_calibrated takes a bool (true/false) value. If true and touch_calibration_coeff is not defined, then Guppy Screen will run touch input calibration on start.

• true - calibrate or use existing calibrated coefficients.
• false - no touch calibration.

touch_calibration_coeff#

touch_calibration_coeff stores the calibrated coefficents for touch input. Touch calibration can be restarted by deleting this property and restarting Guppy Screen.

theme#

theme refers a theme file without the .json extension in the themes folder. The referenced theme will be applied in Guppy Screen.

• purple - references theme/purple.json and loads the purple theme.

thumbnail_path#

Where the gcode thumbnails will be stored to viewing in Guppy Screen.

wpa_supplicant#

Guppy Screen WIFI integrate uses wpa_supplicant. It tries to discover this path and the wpa_supplicant Unix Domain Socket. GUppy Screen will not start if it can’t locate this path. By default, it looks in /var/run/wpa_supplicant.