Features.yml

Features.yml

Table of Contents

What is the features.yml file?

The features.yml file is what Pantheon uses on each machine to describes the printer’s software and hardware configuration. It uses this file to automatically generate the corresponding printer.cfg file that Klipper needs for full control of the machine. This file can be found under config/features.yml in the MACHINE tab of the web-console.

It is important to familiarize yourself with the structure of this file when adding or removing hardware or software features to your machine.

Template

There are instructions in the beginning of the template for how to use and key rules.

Format

Features.yml is a YAML formatted file listing the basic features and settings for your HS-Pro or HS3. There are mandatory fields for features all printers have, and optional fields for features only some printers have.

Below is an example of a features.yml file

--- printer: process: FFF axes-limits: x: 404 y: 402 z: 314 hardware: chassis: hspro printhead-board: hspro-ph-v1-0 printhead: original nozzle-scrubber: original ...

Format Rules

  1. All files must start with --- and end with ... characters.

  2. Sections must be indented as shown in the above example

This would be invalid:

--- printer: process: FFF axes-limits: x: 300 y: 307.5 z: 300 hardware: chassis: original mainboard: manta-m8p-v2-0 printhead-board: ebb42-v1-2 printhead: original z-ballscrews: ground camera-light: direct-wired filament-sensor: direct-wired ...
  1. All names are case-sensitive

This would be invalid:

--- Printer: PROCESS: fff AxEs-liMits: X: 300 y: 307.5 z: 300 hardware: Chassis: Original mainboard: Manta-m8p-v2-0 printhead-board: ebb42-v1-2 printhead: original z-ballscrews: GROUND camera-light: direct-wired filament-sensor: direct-wired ...

Mandatory Fields

The following is the mandatory minimum set of fields for a features.yml file:

printer: process: FFF axes-limits: x: 404 y: 402 z: 314 hardware: chassis: hspro printhead-board: hspro-ph-v1-0 printhead: original

axes-limits

x, y, z Maximum travel for each axis in millimeters

hardware

chassis Machine frame style. original is the only option

printhead Printhead style. original is the only option

mainboard Machine main board. Either manta-m8p-v1-2 or manta-m8p-v2-0

printhead-board Printhead board. ebb42-v1-2 is the only option

Optional Hardware Fields

All of these options must be added under the hardware: level in features.yml

# ------------------------------------------------------------------------- # OPTIONAL (uncomment + set if present on this machine) # ------------------------------------------------------------------------- # Main controller board selection. # Allowed: any | auto | manta-m8p-v1-1 | manta-m8p-v2-0 #mainboard: manta-m8p-v2-0 # Printhead CAN / IO board selection. # Allowed: ebb42-v1-2 | hspro-ph-v1-0 | hspro-ph-v2-0 #printhead-board: hspro-ph-v2-0 # Z ballscrews type. (HS3 Only) # Allowed: rolled | ground #z-ballscrews: ground # Z stepper motor model. (HS-Pro Only) # Allowed: sm-23hs30-2804s-h | sm-23hs22-2804s-c17 #z-stepper: sm-23hs30-2804s-h # Chamber heater wiring style. (HS3 Only) # Allowed: any | direct-wired #chamber-heater: direct-wired # Camera light wiring style. (HS3 Only) # Allowed: direct-wired #camera-light: direct-wired # Filament sensor wiring style. (HS3 Only) # Allowed: direct-wired #filament-sensor: direct-wired # Accelerometer type (for input shaping / resonance testing). # Allowed: adxl345 #accelerometer: adxl345 # Nozzle scrubber hardware. (HS-Pro Only) # Allowed: original #nozzle-scrubber: original # Enable timelapse support in generated printer.cfg. # Allowed: true | false #timelapse: false # Include an extra Klipper config file at the very end of printer.cfg. # Value: filename or path (string) #custom-config: user-custom.cfg

 

www.pantheondesign.com