droans/klipper_extras

Custom Extras for Klipper

klipper_extras's Issues

Feat: Allow app definitions

Long term plan. Allow user to define apps which can be called in the console or by GCode files. Apps would inherit a specialized class allowing easier access to various printer objects and functions.

Development Roadmap

This is subject to change for any reason, such as changes to Klipper, bugs discovered, new features suggested, or a ban on caffeinated beverages.

v0.4

• More utility functions
  • Goal: Functions should cover enough use cases that the majority of users don't need to write their own Python functions

v0.5

• Fix as many bugs and edge cases as possible
• Add variables and parameters for Extended Delay Macro
• Create basic Klipper config and Extended Macro config that user can import during install
  • If user chooses to use config, create ~/printer_data/functions and ~/printer_data/filters directories

v0.6

• New macro types:
  • Interval macro: runs every X seconds until stopped
  • Event macro: runs every time a certain event occurs
• Allow for scheduling macros to run at a specified time

v1.0

• Fix remaining bugs
• Add plugin support, basic plugins for services such as Home Assistant

Feat: Built-Ins

Support common built-in Python functions by default instead of requiring user to define

Feat: Allow Setting top-level macro List/Dict variables

Internal error upon issuing command

Hello, I generally try to avoid creating an issue report until I've exhausted all other avenues, but there aren't many for this plugin quite yet!

I've added an extended macro to my config to check the time of the day and, if it is a reasonable time of day, the printer will play a jingle for me to notify that a print is done. If it's an unholy hour of the night, the printer just shut itself down, instead. The problem is, the moment I issue the macro command, the terminal just shows that there was an internal error and will not give me any further context.

Here is the section for the macro:

[extended_macro FINISHED]
gcode:
	(% set hour = datetime.datetime.now().hour %}
	{% if hour < 23 and hour > 7 %}
		{ ['PR9000', 'XP9001', 'SMI3', 'SMB1'] | random }
	{% else %}
		M112
	{% endif %}

Clean Up Code

Clean up the Frankenstein code and remove excess leftover code from gcode_macro.py

Feat: Configuration Definition for Functions

Allow user to define folder(s) and/or file(s) to find Python functions.

Feat: Install Script

Feat: Plugins

Allow plugins to be created. Plugins would have their own definition in the config yaml. They would act similarly to functions but would receive the configuration from the file.

Example:

plugins:
  hass:
    plugin: homeassistant
    config:
      url: https://my.hass.com
      api: XXXXXXXX
      port: 443
      ssl: true

Object would be generated at startup and added to the environment for users.

Extended Delayed Macro: Add variables, allow passing params.

To be determined if params can only be added via a function call or if we can allow them to be passed through the console.

Add flatten-dict; method to easily updated nested dictionaries

Feat: GCode Functions

Allow Jinja templates to render a value which can be interpreted by the caller without losing support for running GCode inside the function