3D-printing/klipper
1
0
Fork 0
mirror of https://github.com/Klipper3d/klipper.git synced 2025-07-24 15:14:00 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

menu_keys: Move button handling from menu.py to new file menu_keys.py

Browse source 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
This commit is contained in:
Kevin O'Connor 2020-03-13 21:45:08 -04:00
parent a1fc1ac214
commit 7d8ade74e8
2 changed files with 196 additions and 155 deletions
Download patch file Download diff file Expand all files Collapse all files

180
klippy/extras/display/menu_keys.py Normal file
View file

@ -0,0 +1,180 @@
# -*- coding: utf-8 -*-
# Support for menu button press tracking
#
# Copyright (C) 2018 Janar Sööt <janar.soot@gmail.com>
#
# This file may be distributed under the terms of the GNU GPLv3 license.
LONG_PRESS_DURATION = 0.800
TIMER_DELAY = .200
class MenuKeys:
def __init__(self, config, callback):
self.printer = config.get_printer()
self.callback = callback
# buttons
self.encoder_pins = config.get('encoder_pins', None)
self.click_pin = config.get('click_pin', None)
self.back_pin = config.get('back_pin', None)
self.up_pin = config.get('up_pin', None)
self.down_pin = config.get('down_pin', None)
self.kill_pin = config.get('kill_pin', None)
# analog button ranges
self.analog_range_click_pin = config.get(
'analog_range_click_pin', None)
self.analog_range_back_pin = config.get(
'analog_range_back_pin', None)
self.analog_range_up_pin = config.get(
'analog_range_up_pin', None)
self.analog_range_down_pin = config.get(
'analog_range_down_pin', None)
self.analog_range_kill_pin = config.get(
'analog_range_kill_pin', None)
self._last_click_press = 0
self.analog_pullup = config.getfloat(
'analog_pullup_resistor', 4700., above=0.)
self._encoder_fast_rate = config.getfloat(
'encoder_fast_rate', .03, above=0.)
self._last_encoder_cw_eventtime = 0
self._last_encoder_ccw_eventtime = 0
# printer objects
self.buttons = self.printer.load_object(config, "buttons")
# register buttons & encoder
if self.buttons:
# digital buttons
if self.encoder_pins:
try:
pin1, pin2 = self.encoder_pins.split(',')
except Exception:
raise config.error("Unable to parse encoder_pins")
self.buttons.register_rotary_encoder(
pin1.strip(), pin2.strip(),
self.encoder_cw_callback, self.encoder_ccw_callback)
if self.click_pin:
if self.analog_range_click_pin is not None:
try:
p_min, p_max = map(
float, self.analog_range_click_pin.split(','))
except Exception:
raise config.error(
"Unable to parse analog_range_click_pin")
self.buttons.register_adc_button(
self.click_pin, p_min, p_max, self.analog_pullup,
self.click_callback)
else:
self.buttons.register_buttons(
[self.click_pin], self.click_callback)
if self.back_pin:
if self.analog_range_back_pin is not None:
try:
p_min, p_max = map(
float, self.analog_range_back_pin.split(','))
except Exception:
raise config.error(
"Unable to parse analog_range_back_pin")
self.buttons.register_adc_button_push(
self.back_pin, p_min, p_max, self.analog_pullup,
self.back_callback)
else:
self.buttons.register_button_push(
self.back_pin, self.back_callback)
if self.up_pin:
if self.analog_range_up_pin is not None:
try:
p_min, p_max = map(
float, self.analog_range_up_pin.split(','))
except Exception:
raise config.error(
"Unable to parse analog_range_up_pin")
self.buttons.register_adc_button_push(
self.up_pin, p_min, p_max, self.analog_pullup,
self.up_callback)
else:
self.buttons.register_button_push(
self.up_pin, self.up_callback)
if self.down_pin:
if self.analog_range_down_pin is not None:
try:
p_min, p_max = map(
float, self.analog_range_down_pin.split(','))
except Exception:
raise config.error(
"Unable to parse analog_range_down_pin")
self.buttons.register_adc_button_push(
self.down_pin, p_min, p_max, self.analog_pullup,
self.down_callback)
else:
self.buttons.register_button_push(
self.down_pin, self.down_callback)
if self.kill_pin:
if self.analog_range_kill_pin is not None:
try:
p_min, p_max = map(
float, self.analog_range_kill_pin.split(','))
except Exception:
raise config.error(
"Unable to parse analog_range_kill_pin")
self.buttons.register_adc_button_push(
self.kill_pin, p_min, p_max, self.analog_pullup,
self.kill_callback)
else:
self.buttons.register_button_push(
self.kill_pin, self.kill_callback)
# start timer
reactor = self.printer.get_reactor()
reactor.register_timer(self.timer_event, reactor.NOW)
def timer_event(self, eventtime):
# check long press
if (self._last_click_press > 0 and (
eventtime - self._last_click_press) >= LONG_PRESS_DURATION):
# long click
self._last_click_press = 0
self.callback('long_click', eventtime)
return eventtime + TIMER_DELAY
# buttons & encoder callbacks
def encoder_cw_callback(self, eventtime):
fast_rate = ((eventtime - self._last_encoder_cw_eventtime)
<= self._encoder_fast_rate)
self._last_encoder_cw_eventtime = eventtime
if fast_rate:
self.callback('fast_up', eventtime)
else:
self.callback('up', eventtime)
def encoder_ccw_callback(self, eventtime):
fast_rate = ((eventtime - self._last_encoder_ccw_eventtime)
<= self._encoder_fast_rate)
self._last_encoder_ccw_eventtime = eventtime
if fast_rate:
self.callback('fast_down', eventtime)
else:
self.callback('down', eventtime)
def click_callback(self, eventtime, state):
if self.click_pin:
if state:
self._last_click_press = eventtime
elif self._last_click_press > 0:
if (eventtime - self._last_click_press) < LONG_PRESS_DURATION:
# short click
self._last_click_press = 0
self.callback('click', eventtime)
def back_callback(self, eventtime):
if self.back_pin:
self.callback('back', eventtime)
def up_callback(self, eventtime):
if self.up_pin:
self.callback('up', eventtime)
def down_callback(self, eventtime):
if self.down_pin:
self.callback('down', eventtime)
def kill_callback(self, eventtime):
if self.kill_pin:
# Emergency Stop
self.printer.invoke_shutdown("Shutdown due to kill button!")