Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add show_macros_in_webui option like Shake Tune #24

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+75 −24
Open

Add show_macros_in_webui option like Shake Tune #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9aec048
Document option
thetic Jul 27, 2024
6ccac45
Implement show_macros_in_webui
thetic Jul 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,7 @@ The values listed below are the defaults Auto Speed uses. You can include them i
#validate_inner_margin: 20.0 ; Margin for VALIDATE inner pattern
#validate_iterations: 50 ; Perform VALIDATE pattern this many times

# show_macros_in_webui: False ; Display macros in web UI (e.g. Mainsail, Fluidd)
#results_dir: ~/printer_data/config ; Destination directory for graphs
```

Expand Down
27 changes: 27 additions & 0 deletions autospeed/dummy_macros.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# This file is used when the `show_macros_in_webui` option is enabled. It wraps
# the native Python commands in macros so that they will show up in web UIs
# like Mainsail and Fluidd.

[gcode_macro AUTO_SPEED]
gcode: _AUTO_SPEED {rawparams}

[gcode_macro AUTO_SPEED_VELOCITY]
gcode: _AUTO_SPEED_VELOCITY {rawparams}

[gcode_macro AUTO_SPEED_ACCEL]
gcode: _AUTO_SPEED_ACCEL {rawparams}

[gcode_macro AUTO_SPEED_VALIDATE]
gcode: _AUTO_SPEED_VALIDATE {rawparams}

[gcode_macro AUTO_SPEED_GRAPH]
gcode: _AUTO_SPEED_GRAPH

[gcode_macro X_ENDSTOP_ACCURACY]
gcode: _X_ENDSTOP_ACCURACY {rawparams}

[gcode_macro Y_ENDSTOP_ACCURACY]
gcode: _Y_ENDSTOP_ACCURACY {rawparams}

[gcode_macro Z_ENDSTOP_ACCURACY]
gcode: _Z_ENDSTOP_ACCURACY {rawparams}
71 changes: 47 additions & 24 deletions autospeed/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ def __init__(self, config):
self.validate_iterations = config.getint( 'validate_iterations', default=50, minval=1)

results_default = os.path.expanduser('~')
show_macros = config.getboolean('show_macros_in_webui', default=False)

for path in ( # Could be problematic if neither of these paths work
os.path.dirname(self.printer.start_args['log_file']),
os.path.expanduser('~/printer_data/config'),
Expand All @@ -64,30 +66,51 @@ def __init__(self, config):
self.printer.register_event_handler("klippy:connect", self.handle_connect)
self.printer.register_event_handler("homing:home_rails_end", self.handle_home_rails_end)

self.gcode.register_command('AUTO_SPEED',
self.cmd_AUTO_SPEED,
desc=self.cmd_AUTO_SPEED_help)
self.gcode.register_command('AUTO_SPEED_VELOCITY',
self.cmd_AUTO_SPEED_VELOCITY,
desc=self.cmd_AUTO_SPEED_VELOCITY_help)
self.gcode.register_command('AUTO_SPEED_ACCEL',
self.cmd_AUTO_SPEED_ACCEL,
desc=self.cmd_AUTO_SPEED_ACCEL_help)
self.gcode.register_command('AUTO_SPEED_VALIDATE',
self.cmd_AUTO_SPEED_VALIDATE,
desc=self.cmd_AUTO_SPEED_VALIDATE_help)
self.gcode.register_command('AUTO_SPEED_GRAPH',
self.cmd_AUTO_SPEED_GRAPH,
desc=self.cmd_AUTO_SPEED_GRAPH_help)
self.gcode.register_command('X_ENDSTOP_ACCURACY',
self.cmd_X_ENDSTOP_ACCURACY,
desc=self.cmd_AUTO_SPEED_GRAPH_help)
self.gcode.register_command('Y_ENDSTOP_ACCURACY',
self.cmd_Y_ENDSTOP_ACCURACY,
desc=self.cmd_AUTO_SPEED_GRAPH_help)
self.gcode.register_command('Z_ENDSTOP_ACCURACY',
self.cmd_Z_ENDSTOP_ACCURACY,
desc=self.cmd_AUTO_SPEED_GRAPH_help)
measurement_commands = [
('AUTO_SPEED', self.cmd_AUTO_SPEED, self.cmd_AUTO_SPEED_help),
('AUTO_SPEED_VELOCITY', self.cmd_AUTO_SPEED_VELOCITY, self.cmd_AUTO_SPEED_VELOCITY_help),
('AUTO_SPEED_ACCEL', self.cmd_AUTO_SPEED_ACCEL, self.cmd_AUTO_SPEED_ACCEL_help),
('AUTO_SPEED_VALIDATE', self.cmd_AUTO_SPEED_VALIDATE, self.cmd_AUTO_SPEED_VALIDATE_help),
('AUTO_SPEED_GRAPH', self.cmd_AUTO_SPEED_GRAPH, self.cmd_AUTO_SPEED_GRAPH_help),
('X_ENDSTOP_ACCURACY', self.cmd_X_ENDSTOP_ACCURACY, self.cmd_AUTO_SPEED_GRAPH_help),
('Y_ENDSTOP_ACCURACY', self.cmd_Y_ENDSTOP_ACCURACY, self.cmd_AUTO_SPEED_GRAPH_help),
('Z_ENDSTOP_ACCURACY', self.cmd_Z_ENDSTOP_ACCURACY, self.cmd_AUTO_SPEED_GRAPH_help),
]
command_descriptions = {name: desc for name, _, desc in measurement_commands}
gcode = self.printer.lookup_object('gcode')
for name, command, description in measurement_commands:
gcode.register_command(f'_{name}' if show_macros else name, command, desc=description)

# Load the dummy macros with their description in order to show them in the web interfaces
if show_macros:
pconfig = self.printer.lookup_object('configfile')
dirname = os.path.dirname(os.path.realpath(__file__))
filename = os.path.join(dirname, 'dummy_macros.cfg')
try:
dummy_macros_cfg = pconfig.read_config(filename)
except Exception as err:
raise config.error(f'Cannot load AutoSpeed dummy macro {filename}') from err

for gcode_macro in dummy_macros_cfg.get_prefix_sections('gcode_macro '):
gcode_macro_name = gcode_macro.get_name()

# Replace the dummy description by the one here (to avoid code duplication and define it in only one place)
command = gcode_macro_name.split(' ', 1)[1]
description = command_descriptions.get(command, 'AutoSpeed macro')
gcode_macro.fileconfig.set(gcode_macro_name, 'description', description)

# Add the section to the Klipper configuration object with all its options
if not config.fileconfig.has_section(gcode_macro_name.lower()):
config.fileconfig.add_section(gcode_macro_name.lower())
for option in gcode_macro.fileconfig.options(gcode_macro_name):
value = gcode_macro.fileconfig.get(gcode_macro_name, option)
config.fileconfig.set(gcode_macro_name.lower(), option, value)

# Small trick to ensure the new injected sections are considered valid by Klipper config system
config.access_tracking[(gcode_macro_name.lower(), option.lower())] = 1

# Finally, load the section within the printer objects
self.printer.load_object(config, gcode_macro_name.lower())

self.level = None

Expand Down