mirror of https://github.com/Desuuuu/klipper.git
233 lines
9.9 KiB
Python
233 lines
9.9 KiB
Python
# Support for PWM driven LEDs
|
|
#
|
|
# Copyright (C) 2019-2022 Kevin O'Connor <kevin@koconnor.net>
|
|
#
|
|
# This file may be distributed under the terms of the GNU GPLv3 license.
|
|
import logging, ast
|
|
from .display import display
|
|
|
|
# Time between each led template update
|
|
RENDER_TIME = 0.500
|
|
|
|
# Helper code for common LED initialization and control
|
|
class LEDHelper:
|
|
def __init__(self, config, update_func, led_count=1):
|
|
self.printer = config.get_printer()
|
|
self.update_func = update_func
|
|
self.led_count = led_count
|
|
self.need_transmit = False
|
|
# Initial color
|
|
red = config.getfloat('initial_RED', 0., minval=0., maxval=1.)
|
|
green = config.getfloat('initial_GREEN', 0., minval=0., maxval=1.)
|
|
blue = config.getfloat('initial_BLUE', 0., minval=0., maxval=1.)
|
|
white = config.getfloat('initial_WHITE', 0., minval=0., maxval=1.)
|
|
self.led_state = [(red, green, blue, white)] * led_count
|
|
# Register commands
|
|
name = config.get_name().split()[-1]
|
|
gcode = self.printer.lookup_object('gcode')
|
|
gcode.register_mux_command("SET_LED", "LED", name, self.cmd_SET_LED,
|
|
desc=self.cmd_SET_LED_help)
|
|
def get_led_count(self):
|
|
return self.led_count
|
|
def set_color(self, index, color):
|
|
if index is None:
|
|
new_led_state = [color] * self.led_count
|
|
if self.led_state == new_led_state:
|
|
return
|
|
else:
|
|
if self.led_state[index - 1] == color:
|
|
return
|
|
new_led_state = list(self.led_state)
|
|
new_led_state[index - 1] = color
|
|
self.led_state = new_led_state
|
|
self.need_transmit = True
|
|
def check_transmit(self, print_time):
|
|
if not self.need_transmit:
|
|
return
|
|
self.need_transmit = False
|
|
try:
|
|
self.update_func(self.led_state, print_time)
|
|
except self.printer.command_error as e:
|
|
logging.exception("led update transmit error")
|
|
cmd_SET_LED_help = "Set the color of an LED"
|
|
def cmd_SET_LED(self, gcmd):
|
|
# Parse parameters
|
|
red = gcmd.get_float('RED', 0., minval=0., maxval=1.)
|
|
green = gcmd.get_float('GREEN', 0., minval=0., maxval=1.)
|
|
blue = gcmd.get_float('BLUE', 0., minval=0., maxval=1.)
|
|
white = gcmd.get_float('WHITE', 0., minval=0., maxval=1.)
|
|
index = gcmd.get_int('INDEX', None, minval=1, maxval=self.led_count)
|
|
transmit = gcmd.get_int('TRANSMIT', 1)
|
|
sync = gcmd.get_int('SYNC', 1)
|
|
color = (red, green, blue, white)
|
|
# Update and transmit data
|
|
def lookahead_bgfunc(print_time):
|
|
self.set_color(index, color)
|
|
if transmit:
|
|
self.check_transmit(print_time)
|
|
if sync:
|
|
#Sync LED Update with print time and send
|
|
toolhead = self.printer.lookup_object('toolhead')
|
|
toolhead.register_lookahead_callback(lookahead_bgfunc)
|
|
else:
|
|
#Send update now (so as not to wake toolhead and reset idle_timeout)
|
|
lookahead_bgfunc(None)
|
|
def get_status(self, eventtime=None):
|
|
return {'color_data': self.led_state}
|
|
|
|
# Main LED tracking code
|
|
class PrinterLED:
|
|
def __init__(self, config):
|
|
self.printer = config.get_printer()
|
|
self.led_helpers = {}
|
|
self.active_templates = {}
|
|
self.render_timer = None
|
|
# Load templates
|
|
dtemplates = display.lookup_display_templates(config)
|
|
self.templates = dtemplates.get_display_templates()
|
|
gcode_macro = self.printer.lookup_object("gcode_macro")
|
|
self.create_template_context = gcode_macro.create_template_context
|
|
# Register handlers
|
|
gcode = self.printer.lookup_object('gcode')
|
|
gcode.register_command("SET_LED_TEMPLATE", self.cmd_SET_LED_TEMPLATE,
|
|
desc=self.cmd_SET_LED_TEMPLATE_help)
|
|
def setup_helper(self, config, update_func, led_count=1):
|
|
led_helper = LEDHelper(config, update_func, led_count)
|
|
name = config.get_name().split()[-1]
|
|
self.led_helpers[name] = led_helper
|
|
return led_helper
|
|
def _activate_timer(self):
|
|
if self.render_timer is not None or not self.active_templates:
|
|
return
|
|
reactor = self.printer.get_reactor()
|
|
self.render_timer = reactor.register_timer(self._render, reactor.NOW)
|
|
def _activate_template(self, led_helper, index, template, lparams):
|
|
key = (led_helper, index)
|
|
if template is not None:
|
|
uid = (template,) + tuple(sorted(lparams.items()))
|
|
self.active_templates[key] = (uid, template, lparams)
|
|
return
|
|
if key in self.active_templates:
|
|
del self.active_templates[key]
|
|
def _render(self, eventtime):
|
|
if not self.active_templates:
|
|
# Nothing to do - unregister timer
|
|
reactor = self.printer.get_reactor()
|
|
reactor.register_timer(self.render_timer)
|
|
self.render_timer = None
|
|
return reactor.NEVER
|
|
# Setup gcode_macro template context
|
|
context = self.create_template_context(eventtime)
|
|
def render(name, **kwargs):
|
|
return self.templates[name].render(context, **kwargs)
|
|
context['render'] = render
|
|
# Render all templates
|
|
need_transmit = {}
|
|
rendered = {}
|
|
template_info = self.active_templates.items()
|
|
for (led_helper, index), (uid, template, lparams) in template_info:
|
|
color = rendered.get(uid)
|
|
if color is None:
|
|
try:
|
|
text = template.render(context, **lparams)
|
|
parts = [max(0., min(1., float(f)))
|
|
for f in text.split(',', 4)]
|
|
except Exception as e:
|
|
logging.exception("led template render error")
|
|
parts = []
|
|
if len(parts) < 4:
|
|
parts += [0.] * (4 - len(parts))
|
|
rendered[uid] = color = tuple(parts)
|
|
need_transmit[led_helper] = 1
|
|
led_helper.set_color(index, color)
|
|
context.clear() # Remove circular references for better gc
|
|
# Transmit pending changes
|
|
for led_helper in need_transmit.keys():
|
|
led_helper.check_transmit(None)
|
|
return eventtime + RENDER_TIME
|
|
cmd_SET_LED_TEMPLATE_help = "Assign a display_template to an LED"
|
|
def cmd_SET_LED_TEMPLATE(self, gcmd):
|
|
led_name = gcmd.get("LED")
|
|
led_helper = self.led_helpers.get(led_name)
|
|
if led_helper is None:
|
|
raise gcmd.error("Unknown LED '%s'" % (led_name,))
|
|
led_count = led_helper.get_led_count()
|
|
index = gcmd.get_int("INDEX", None, minval=1, maxval=led_count)
|
|
template = None
|
|
lparams = {}
|
|
tpl_name = gcmd.get("TEMPLATE")
|
|
if tpl_name:
|
|
template = self.templates.get(tpl_name)
|
|
if template is None:
|
|
raise gcmd.error("Unknown display_template '%s'" % (tpl_name,))
|
|
tparams = template.get_params()
|
|
for p, v in gcmd.get_command_parameters().items():
|
|
if not p.startswith("PARAM_"):
|
|
continue
|
|
p = p.lower()
|
|
if p not in tparams:
|
|
raise gcmd.error("Invalid display_template parameter: %s"
|
|
% (p,))
|
|
try:
|
|
lparams[p] = ast.literal_eval(v)
|
|
except ValueError as e:
|
|
raise gcmd.error("Unable to parse '%s' as a literal" % (v,))
|
|
if index is not None:
|
|
self._activate_template(led_helper, index, template, lparams)
|
|
else:
|
|
for i in range(led_count):
|
|
self._activate_template(led_helper, i+1, template, lparams)
|
|
self._activate_timer()
|
|
|
|
PIN_MIN_TIME = 0.100
|
|
MAX_SCHEDULE_TIME = 5.0
|
|
|
|
# Handler for PWM controlled LEDs
|
|
class PrinterPWMLED:
|
|
def __init__(self, config):
|
|
self.printer = printer = config.get_printer()
|
|
# Configure pwm pins
|
|
ppins = printer.lookup_object('pins')
|
|
cycle_time = config.getfloat('cycle_time', 0.010, above=0.,
|
|
maxval=MAX_SCHEDULE_TIME)
|
|
hardware_pwm = config.getboolean('hardware_pwm', False)
|
|
self.pins = []
|
|
for i, name in enumerate(("red", "green", "blue", "white")):
|
|
pin_name = config.get(name + '_pin', None)
|
|
if pin_name is None:
|
|
continue
|
|
mcu_pin = ppins.setup_pin('pwm', pin_name)
|
|
mcu_pin.setup_max_duration(0.)
|
|
mcu_pin.setup_cycle_time(cycle_time, hardware_pwm)
|
|
self.pins.append((i, mcu_pin))
|
|
if not self.pins:
|
|
raise config.error("No LED pin definitions found in '%s'"
|
|
% (config.get_name(),))
|
|
self.last_print_time = 0.
|
|
# Initialize color data
|
|
pled = printer.load_object(config, "led")
|
|
self.led_helper = pled.setup_helper(config, self.update_leds, 1)
|
|
self.prev_color = color = self.led_helper.get_status()['color_data'][0]
|
|
for idx, mcu_pin in self.pins:
|
|
mcu_pin.setup_start_value(color[idx], 0.)
|
|
def update_leds(self, led_state, print_time):
|
|
if print_time is None:
|
|
eventtime = self.printer.get_reactor().monotonic()
|
|
mcu = self.pins[0][1].get_mcu()
|
|
print_time = mcu.estimated_print_time(eventtime) + PIN_MIN_TIME
|
|
print_time = max(print_time, self.last_print_time + PIN_MIN_TIME)
|
|
color = led_state[0]
|
|
for idx, mcu_pin in self.pins:
|
|
if self.prev_color[idx] != color[idx]:
|
|
mcu_pin.set_pwm(print_time, color[idx])
|
|
self.last_print_time = print_time
|
|
self.prev_color = color
|
|
def get_status(self, eventtime=None):
|
|
return self.led_helper.get_status(eventtime)
|
|
|
|
def load_config(config):
|
|
return PrinterLED(config)
|
|
|
|
def load_config_prefix(config):
|
|
return PrinterPWMLED(config)
|