Add documentation for all macros before v1.0 - Githubissues

The-Conglomerate / Voron-Klipper-Common

Apache License 2.0

78 stars 15 forks source link

Add documentation for all macros before v1.0 #11

Open Jasrags opened 2 years ago

Jasrags commented 2 years ago

Add documentation for all MACROS

macros/adaptive_bed_mesh.cfg:

[ ] 33: [gcode_macro TOGGLE_ADAPTIVE_BED_MESH]
[ ] 45: [gcode_macro ADAPTIVE_BED_MESH]

macros/calibration.cfg:

[ ] 4: [gcode_macro _CALIBRATE]

macros/common_variable.cfg:

[ ] 4: [gcode_macro TOGGLE_DEBUG]
[ ] 18: [gcode_macro DISPLAY_COMMON_FEATURES]
[ ] 95: [gcode_macro _COMMON_VARIABLE]

macros/fans.cfg:

[ ] 4: [gcode_macro _CIRCULATION_START]
[ ] 36: [gcode_macro _CIRCULATION_END]

macros/filament.cfg:

[ ] 10: [gcode_macro FILAMENT]
[ ] 60: [gcode_macro LOAD_FILAMENT]
[ ] 155: [gcode_macro UNLOAD_FILAMENT]
[ ] 247: [gcode_macro _FORM_TIP_STANDALONE]
[ ] 344: [gcode_macro _RUNOUT_INFO]

macros/flexplate.cfg:

[ ] 50: [gcode_macro TOGGLE_FLEXPLATE]
[ ] 88: [gcode_macro _SET_PLATE_OFFSET]
[ ] 123: [gcode_macro _DISPLAY_PLATE]
[ ] 156: [gcode_macro _INIT_PLATE_ARRAY]
[ ] 182: [gcode_macro LIST_PLATES]
[ ] 214: [gcode_macro SET_PLATE]
[ ] 253: [gcode_macro ADD_NEW_PLATE]
[ ] 287: [gcode_macro REMOVE_PLATE]
[ ] 345: [gcode_macro CHANGE_PLATE_OFFSET]
[ ] 397: [gcode_macro CHANGE_PLATE_NAME]

macros/homing.cfg:

[ ] 6: [gcode_macro _CG28]
[ ] 23: [gcode_macro _SET_Z_CURRENT]
[ ] 69: [gcode_macro _SET_ACC]

macros/klipper.cfg:

[ ] 4: [gcode_macro DUMP_WARNINGS]
[ ] 26: [gcode_macro DUMP_PARAMETERS]
[ ] 53: [gcode_macro SEARCH_VARS]

macros/leds.cfg:

[ ] 4: [gcode_macro _SET_LEDS]
[ ] 34: [gcode_macro _SET_LED_STATE_BY_NAME]
[ ] 80: [gcode_macro _SET_LED_COLOR_BY_NAME]
[ ] 135: [gcode_macro _LED_PAUSE]

macros/marlin_compat.cfg:

[ ] 5: [gcode_macro M115]
[ ] 33: [gcode_macro M125]
[ ] 62: [gcode_macro M204]
[ ] 89: [gcode_macro M205]
[ ] 117: [gcode_macro M300]
[ ] 152: [gcode_macro M600]
[ ] 180: [gcode_macro M701]
[ ] 201: [gcode_macro M702]
[ ] 226: [gcode_macro M900]

macros/park.cfg:

[ ] 4: [gcode_macro PARK_FRONT]
[ ] 34: [gcode_macro PARK_FRONT_MID]
[ ] 63: [gcode_macro PARK_FRONT_LOW]
[ ] 92: [gcode_macro PARK_CENTER]
[ ] 118: [gcode_macro PARK_BED]
[ ] 145: [gcode_macro PARK_REAR]
[ ] 174: [gcode_macro _PARK_SAFE_PAUSE]
[ ] 242: [gcode_macro _PARK_SAFE_END]
[ ] 300: [gcode_macro PARK]

macros/pause_resume.cfg:

[ ] 4: [gcode_macro PAUSE]
[ ] 38: [gcode_macro RESUME]

macros/printing.cfg:

[ ] 4: [gcode_macro TOGGLE_BACK_TO_BACK]
[ ] 18: [gcode_macro PRINT_START]
[ ] 99: [gcode_macro _PREHEAT]
[ ] 155: [gcode_macro PRINT_END]
[ ] 211: [gcode_macro CANCEL_PRINT]

macros/statistics.cfg:

[ ] 7: [gcode_macro _ADD_PRINT_TIME]
[ ] 47: [gcode_macro _DISPLAY_PRINT_TIME]
[ ] 75: [gcode_macro _SD_PRINT_STATS]
[ ] 105: [gcode_macro _SD_PRINTER_STATS]
[ ] 169: [gcode_macro RST_FILTER]
[ ] 185: [gcode_macro RST_SERVICE]

macros/timers.cfg:

[ ] 4: [gcode_macro _SOAK_TIMER_BEFORE]
[ ] 18: [gcode_macro _SOAK_TIMER_AFTER]
[ ] 50: [gcode_macro _TIMED_SOAK]
[ ] 76: [gcode_macro _RUN_BA]

macros/tones.cfg:

[ ] 11: [gcode_macro TOGGLE_BEEPER]
[ ] 23: [gcode_macro _SONG_SINGLE_BEEP]
[ ] 27: [gcode_macro _SONG_DOOM_MAP]
[ ] 93: [gcode_macro _SONG_DOOM]
[ ] 183: [gcode_macro _SONG_SMB_DEATH]
[ ] 198: [gcode_macro _SONG_SMB_UNDER]
[ ] 206: [gcode_macro _SONG_STARWARS_IMP]
[ ] 218: [gcode_macro _SONG_FUNKY_TOWN]
[ ] 241: [gcode_macro _SONG_FUN_DONE]
[ ] 252: [gcode_macro _SONG_SIMPLE_DONE]
[ ] 259: [gcode_macro _SONG_SMB_FLAGPOLE]
[ ] 293: [gcode_macro _SONG_FF_VICTORY]
[ ] 309: [gcode_macro _SONG_ZELDA_TREASURE]
[ ] 360: [gcode_macro _SONG_PORTAL_ALIVE]
[ ] 368: [gcode_macro _SONG_RICE_COOKER_DONE]

macros/tuning.cfg:

[ ] 7: [gcode_macro TUNE_PRESSURE_ADVANCE]
[ ] 36: [gcode_macro TUNE_FAN_SPEED]
[ ] 62: [gcode_macro TUNE_Z_OFFSET]
[ ] 91: [gcode_macro TEST_SPEED]
[ ] 179: [gcode_macro TR_GRAPH]

Jasrags commented 2 years ago

Also add a flow graph for macros that have logic branches like PRINT_START, CALIBRATE