📝 Add sections for schema

MarlinFirmware/Marlin#24528
2025-07-24 15:14:02 -06:00 · 2022-08-02 01:59:56 -05:00 · 2022-08-02 01:59:56 -05:00 · 48ffab7d02
commit 48ffab7d02
parent c0e4a07015
599 changed files with 40103 additions and 8744 deletions
--- a/config/examples/Creality/CR-10
+++ b/config/examples/Creality/CR-10
@ -32,6 +32,24 @@
 */
 #define CONFIGURATION_ADV_H_VERSION 02010100

+// @section develop
+
+/**
+ * Configuration Dump to JSON and INI format
+ *
+ * Dump the configuration as part of the build. (See signature.py)
+ * Output files are saved with the build (e.g., .pio/build/mega2560).
+ *
+ * See `build_all_examples --ini` as an example of config.ini archiving.
+ *
+ *  1 = marlin_config.json - Dictionary containing the configuration.
+ *      This file is also generated for CONFIGURATION_EMBEDDING.
+ *  2 = config.ini - File format for PlatformIO preprocessing.
+ *  3 = schema.json - The entire configuration schema. (13 = pattern groups)
+ *  4 = schema.yml - The entire configuration schema.
+ */
+//#define CONFIG_DUMP   // :[1:'JSON', 2:'config.ini', 3:'schema.json', 4:'schema.yml']
+
 //===========================================================================
 //============================= Thermal Settings ============================
 //===========================================================================
@ -2566,6 +2584,8 @@
  #endif
 #endif // HAS_MULTI_EXTRUDER

+// @section advanced pause
+
 /**
 * Advanced Pause for Filament Change
 *  - Adds the G-code M600 Filament Change to initiate a filament change.
@ -2624,13 +2644,12 @@
  #define FILAMENT_UNLOAD_ALL_EXTRUDERS         // Allow M702 to unload all extruders above a minimum target temp (as set by M302)
 #endif

-// @section tmc
-
 /**
 * TMC26X Stepper Driver options
 *
 * The TMC26XStepper library is required for this stepper driver.
 * https://github.com/trinamic/TMC26XStepper
+ * @section tmc/tmc26x
 */
 #if HAS_DRIVER(TMC26X)

@ -2768,8 +2787,6 @@

 #endif // TMC26X

-// @section tmc_smart
-
 /**
 * To use TMC2130, TMC2160, TMC2660, TMC5130, TMC5160 stepper drivers in SPI mode
 * connect your SPI pins to the hardware SPI interface on your board and define
@ -2785,6 +2802,7 @@
 *
 * TMCStepper library is required to use TMC stepper drivers.
 * https://github.com/teemuatlut/TMCStepper
+ * @section tmc/config
 */
 #if HAS_TRINAMIC_CONFIG

@ -3008,6 +3026,8 @@
    //#define E7_HOLD_MULTIPLIER 0.5
  #endif

+  // @section tmc/spi
+
  /**
   * Override default SPI pins for TMC2130, TMC2160, TMC2660, TMC5130 and TMC5160 drivers here.
   * The default pins can be found in your board's pins file.
@ -3045,6 +3065,8 @@
  //#define TMC_SW_MISO       -1
  //#define TMC_SW_SCK        -1

+  // @section tmc/serial
+
  /**
   * Four TMC2209 drivers can use the same HW/SW serial port with hardware configured addresses.
   * Set the address using jumpers on pins MS1 and MS2.
@ -3080,6 +3102,8 @@
  //#define E6_SLAVE_ADDRESS 0
  //#define E7_SLAVE_ADDRESS 0

+  // @section tmc/smart
+
  /**
   * Software enable
   *
@ -3088,6 +3112,8 @@
   */
  //#define SOFTWARE_DRIVER_ENABLE

+  // @section tmc/stealthchop
+
  /**
   * TMC2130, TMC2160, TMC2208, TMC2209, TMC5130 and TMC5160 only
   * Use Trinamic's ultra quiet stepping mode.
@ -3142,6 +3168,8 @@
  //#define CHOPPER_TIMING_E6 CHOPPER_TIMING_E
  //#define CHOPPER_TIMING_E7 CHOPPER_TIMING_E

+  // @section tmc/status
+
  /**
   * Monitor Trinamic drivers
   * for error conditions like overtemperature and short to ground.
@ -3161,6 +3189,8 @@
    #define STOP_ON_ERROR
  #endif

+  // @section tmc/hybrid
+
  /**
   * TMC2130, TMC2160, TMC2208, TMC2209, TMC5130 and TMC5160 only
   * The driver will switch to spreadCycle when stepper speed is over HYBRID_THRESHOLD.
@ -3217,6 +3247,7 @@
   * homing and adds a guard period for endstop triggering.
   *
   * Comment *_STALL_SENSITIVITY to disable sensorless homing for that axis.
+   * @section tmc/stallguard
   */
  //#define SENSORLESS_HOMING // StallGuard capable drivers only

@ -3240,6 +3271,8 @@
    //#define IMPROVE_HOMING_RELIABILITY
  #endif

+  // @section tmc/config
+
  /**
   * TMC Homing stepper phase.
   *
@ -3320,7 +3353,7 @@
  #define I2C_SLAVE_ADDRESS  0  // Set a value from 8 to 127 to act as a slave
 #endif

-// @section extras
+// @section photo

 /**
 * Photo G-code
@ -3363,6 +3396,8 @@
  #endif
 #endif

+// @section cnc
+
 /**
 * Spindle & Laser control
 *
@ -3567,6 +3602,8 @@
  #define COOLANT_FLOOD_INVERT false  // Set "true" if the on/off function is reversed
 #endif

+// @section filament width
+
 /**
 * Filament Width Sensor
 *
@ -3603,6 +3640,8 @@
  //#define FILAMENT_LCD_DISPLAY
 #endif

+// @section power
+
 /**
 * Power Monitor
 * Monitor voltage (V) and/or current (A), and -when possible- power (W)
@ -3626,6 +3665,8 @@
  #define POWER_MONITOR_VOLTAGE_OFFSET  0         // Offset (in volts) applied to the calculated voltage
 #endif

+// @section safety
+
 /**
 * Stepper Driver Anti-SNAFU Protection
 *
@ -3635,6 +3676,8 @@
 */
 //#define DISABLE_DRIVER_SAFE_POWER_PROTECT

+// @section cnc
+
 /**
 * CNC Coordinate Systems
 *
@ -3651,6 +3694,8 @@
 */
 //#define CNC_DRILLING_CYCLE

+// @section reporting
+
 /**
 * Auto-report fan speed with M123 S<seconds>
 * Requires fans with tachometer pins
@ -3678,6 +3723,8 @@
  //#define M115_GEOMETRY_REPORT
 #endif

+// @section security
+
 /**
 * Expected Printer Check
 * Add the M16 G-code to compare a string to the MACHINE_NAME.
@ -3685,6 +3732,8 @@
 */
 //#define EXPECTED_PRINTER_CHECK

+// @section volumetrics
+
 /**
 * Disable all Volumetric extrusion options
 */
@ -3713,14 +3762,7 @@
  #endif
 #endif

-/**
- * Enable this option for a leaner build of Marlin that removes all
- * workspace offsets, simplifying coordinate transformations, leveling, etc.
- *
- *  - M206 and M428 are disabled.
- *  - G92 will revert to its behavior from Marlin 1.0.
- */
-#define NO_WORKSPACE_OFFSETS
+// @section reporting

 // Extra options for the M114 "Current Position" report
 #define M114_DETAIL           // Use 'M114` for details to check planner calculations
@ -3729,6 +3771,8 @@

 //#define REPORT_FAN_CHANGE   // Report the new fan speed when changed by M106 (and others)

+// @section gcode
+
 /**
 * Spend 28 bytes of SRAM to optimize the G-code parser
 */
@ -3746,6 +3790,15 @@

 //#define REPETIER_GCODE_M360     // Add commands originally from Repetier FW

+/**
+ * Enable this option for a leaner build of Marlin that removes all
+ * workspace offsets, simplifying coordinate transformations, leveling, etc.
+ *
+ *  - M206 and M428 are disabled.
+ *  - G92 will revert to its behavior from Marlin 1.0.
+ */
+#define NO_WORKSPACE_OFFSETS
+
 /**
 * CNC G-code options
 * Support CNC-style G-code dialects used by laser cutters, drawing machine cams, etc.
@ -3762,6 +3815,8 @@
 #endif
 //#define G0_ANGULAR_FEEDRATE 2700 // (°/min)

+// @section gcode
+
 /**
 * Startup commands
 *
@ -3786,6 +3841,8 @@
 * Up to 25 may be defined, but the actual number is LCD-dependent.
 */

+// @section custom main menu
+
 // Custom Menu: Main Menu
 #define CUSTOM_MENU_MAIN
 #if ENABLED(CUSTOM_MENU_MAIN)
@ -3816,6 +3873,8 @@
  //#define MAIN_MENU_ITEM_5_CONFIRM
 #endif

+// @section custom config menu
+
 // Custom Menu: Configuration Menu
 //#define CUSTOM_MENU_CONFIG
 #if ENABLED(CUSTOM_MENU_CONFIG)
@ -3846,6 +3905,8 @@
  //#define CONFIG_MENU_ITEM_5_CONFIRM
 #endif

+// @section custom buttons
+
 /**
 * User-defined buttons to run custom G-code.
 * Up to 25 may be defined.
@ -3877,6 +3938,8 @@
  #endif
 #endif

+// @section host
+
 /**
 * Host Action Commands
 *
@ -3902,6 +3965,8 @@
  //#define HOST_SHUTDOWN_MENU_ITEM       // Add a menu item that tells the host to shut down
 #endif

+// @section extras
+
 /**
 * Cancel Objects
 *
@ -3920,6 +3985,7 @@
 * Alternative Supplier: https://reliabuild3d.com/
 *
 * Reliabuild encoders have been modified to improve reliability.
+ * @section i2c encoders
 */

 //#define I2C_POSITION_ENCODERS
@ -3991,6 +4057,7 @@

 /**
 * Analog Joystick(s)
+ * @section joystick
 */
 //#define JOYSTICK
 #if ENABLED(JOYSTICK)
@ -4015,6 +4082,7 @@
 * Modern replacement for the Prusa TMC_Z_CALIBRATION.
 * Adds capability to work with any adjustable current drivers.
 * Implemented as G34 because M915 is deprecated.
+ * @section calibrate
 */
 //#define MECHANICAL_GANTRY_CALIBRATION
 #if ENABLED(MECHANICAL_GANTRY_CALIBRATION)
@ -4032,6 +4100,7 @@
 /**
 * Instant freeze / unfreeze functionality
 * Potentially useful for emergency stop that allows being resumed.
+ * @section interface
 */
 //#define FREEZE_FEATURE
 #if ENABLED(FREEZE_FEATURE)
@ -4044,6 +4113,7 @@
 *
 * Add support for a low-cost 8x8 LED Matrix based on the Max7219 chip as a realtime status display.
 * Requires 3 signal wires. Some useful debug options are included to demonstrate its usage.
+ * @section debug matrix
 */
 //#define MAX7219_DEBUG
 #if ENABLED(MAX7219_DEBUG)
@ -4082,6 +4152,7 @@
 * Support for Synchronized Z moves when used with NanoDLP. G0/G1 axis moves will
 * output a "Z_move_comp" string to enable synchronization with DLP projector exposure.
 * This feature allows you to use [[WaitForDoneMessage]] instead of M400 commands.
+ * @section nanodlp
 */
 //#define NANODLP_Z_SYNC
 #if ENABLED(NANODLP_Z_SYNC)
@ -4090,6 +4161,7 @@

 /**
 * Ethernet. Use M552 to enable and set the IP address.
+ * @section network
 */
 #if HAS_ETHERNET
  #define MAC_ADDRESS { 0xDE, 0xAD, 0xBE, 0xEF, 0xF0, 0x0D }  // A MAC address unique to your network
@ -4117,6 +4189,8 @@
  //#include "Configuration_Secure.h" // External file with WiFi SSID / Password
 #endif

+// @section multi-material
+
 /**
 * Průša Multi-Material Unit (MMU)
 * Enable in Configuration.h
@ -4224,6 +4298,7 @@

 /**
 * Advanced Print Counter settings
+ * @section stats
 */
 #if ENABLED(PRINTCOUNTER)
  #define SERVICE_WARNING_BUZZES  3