diff options
author | Stefan Dej <meteyou@gmail.com> | 2021-06-02 16:45:27 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-06-02 10:45:27 -0400 |
commit | b5e4f3d20453b2720fbb2e21b1585637048271f8 (patch) | |
tree | 7b992ca01ca217ec342c9e839c374ba778017098 /klippy/extras/resonance_tester.py | |
parent | 55be26097f6a287a73db523f4d11556add8970e6 (diff) | |
download | kutter-b5e4f3d20453b2720fbb2e21b1585637048271f8.tar.gz kutter-b5e4f3d20453b2720fbb2e21b1585637048271f8.tar.xz kutter-b5e4f3d20453b2720fbb2e21b1585637048271f8.zip |
gcode: Update gcode descriptions (#4335)
Add help description to HELP
Add help description to RESPOND
Add help description to MEASURE_AXES_NOISE, TEST_RESONANCES and SHAPER_CALIBRATE
Add help description to PAUSE, RESUME, CLEAR_PAUSE and CANCEL_PRINT
Add help description to GET_POSITION
Add help description to SET_RETRACTION and GET_RETRACTION
Signed-off-by: Stefan Dej <meteyou@gmail.com>
Diffstat (limited to 'klippy/extras/resonance_tester.py')
-rw-r--r-- | klippy/extras/resonance_tester.py | 17 |
1 files changed, 11 insertions, 6 deletions
diff --git a/klippy/extras/resonance_tester.py b/klippy/extras/resonance_tester.py index b78305e1..14efcd61 100644 --- a/klippy/extras/resonance_tester.py +++ b/klippy/extras/resonance_tester.py @@ -97,11 +97,14 @@ class ResonanceTester: self.gcode = self.printer.lookup_object('gcode') self.gcode.register_command("MEASURE_AXES_NOISE", - self.cmd_MEASURE_AXES_NOISE) + self.cmd_MEASURE_AXES_NOISE, + desc=self.cmd_MEASURE_AXES_NOISE_help) self.gcode.register_command("TEST_RESONANCES", - self.cmd_TEST_RESONANCES) + self.cmd_TEST_RESONANCES, + desc=self.cmd_TEST_RESONANCES_help) self.gcode.register_command("SHAPER_CALIBRATE", - self.cmd_SHAPER_CALIBRATE) + self.cmd_SHAPER_CALIBRATE, + desc=self.cmd_SHAPER_CALIBRATE_help) self.printer.register_event_handler("klippy:connect", self.connect) def connect(self): @@ -159,7 +162,7 @@ class ResonanceTester: else: calibration_data[axis].add_data(new_data) return calibration_data - + cmd_TEST_RESONANCES_help = ("Runs the resonance test for a specifed axis") def cmd_TEST_RESONANCES(self, gcmd): # Parse parameters if len(self.test.get_supported_axes()) > 1: @@ -197,7 +200,8 @@ class ResonanceTester: helper, axis, data) gcmd.respond_info( "Resonances data written to %s file" % (csv_name,)) - + cmd_SHAPER_CALIBRATE_help = ( + "Simular to TEST_RESONANCES but suggest input shaper config") def cmd_SHAPER_CALIBRATE(self, gcmd): # Parse parameters axis = gcmd.get("AXIS", None) @@ -241,7 +245,8 @@ class ResonanceTester: gcmd.respond_info( "The SAVE_CONFIG command will update the printer config file\n" "with these parameters and restart the printer.") - + cmd_MEASURE_AXES_NOISE_help = ( + "Measures noise of all enabled accelerometer chips") def cmd_MEASURE_AXES_NOISE(self, gcmd): meas_time = gcmd.get_float("MEAS_TIME", 2.) for _, chip in self.accel_chips: |