mirror of https://github.com/Desuuuu/klipper.git
286 lines
12 KiB
Python
286 lines
12 KiB
Python
# Code to configure miscellaneous chips
|
|
#
|
|
# Copyright (C) 2017 Kevin O'Connor <kevin@koconnor.net>
|
|
#
|
|
# This file may be distributed under the terms of the GNU GPLv3 license.
|
|
import pins, mcu
|
|
|
|
|
|
######################################################################
|
|
# Statically configured output pins
|
|
######################################################################
|
|
|
|
class PrinterStaticDigitalOut:
|
|
def __init__(self, printer, config):
|
|
pin_list = [pin.strip() for pin in config.get('pins').split(',')]
|
|
for pin_desc in pin_list:
|
|
mcu_pin = pins.setup_pin(printer, 'digital_out', pin_desc)
|
|
mcu_pin.setup_static()
|
|
|
|
class PrinterStaticPWM:
|
|
def __init__(self, printer, config):
|
|
mcu_pwm = pins.setup_pin(printer, 'pwm', config.get('pin'))
|
|
mcu_pwm.setup_max_duration(0.)
|
|
hard_pwm = config.getint('hard_pwm', None, minval=1)
|
|
if hard_pwm is None:
|
|
mcu_pwm.setup_cycle_time(config.getfloat(
|
|
'cycle_time', 0.100, above=0.))
|
|
else:
|
|
mcu_pwm.setup_hard_pwm(hard_pwm)
|
|
scale = config.getfloat('scale', 1., above=0.)
|
|
value = config.getfloat('value', minval=0., maxval=scale)
|
|
mcu_pwm.setup_static_pwm(value / scale)
|
|
|
|
|
|
######################################################################
|
|
# Servos
|
|
######################################################################
|
|
|
|
SERVO_MIN_TIME = 0.100
|
|
SERVO_SIGNAL_PERIOD = 0.020
|
|
|
|
class PrinterServo:
|
|
def __init__(self, printer, config):
|
|
self.mcu_servo = pins.setup_pin(printer, 'pwm', config.get('pin'))
|
|
self.mcu_servo.setup_max_duration(0.)
|
|
self.mcu_servo.setup_cycle_time(SERVO_SIGNAL_PERIOD)
|
|
self.min_width = config.getfloat(
|
|
'minimum_pulse_width', .001, above=0., below=SERVO_SIGNAL_PERIOD)
|
|
self.max_width = config.getfloat(
|
|
'maximum_pulse_width', .002
|
|
, above=self.min_width, below=SERVO_SIGNAL_PERIOD)
|
|
self.max_angle = config.getfloat('maximum_servo_angle', 180.)
|
|
self.angle_to_width = (self.max_width - self.min_width) / self.max_angle
|
|
self.width_to_value = 1. / SERVO_SIGNAL_PERIOD
|
|
self.last_value = self.last_value_time = 0.
|
|
def set_pwm(self, print_time, value):
|
|
if value == self.last_value:
|
|
return
|
|
print_time = max(self.last_value_time + SERVO_MIN_TIME, print_time)
|
|
self.mcu_servo.set_pwm(print_time, value)
|
|
self.last_value = value
|
|
self.last_value_time = print_time
|
|
# External commands
|
|
def set_angle(self, print_time, angle):
|
|
angle = max(0., min(self.max_angle, angle))
|
|
width = self.min_width + angle * self.angle_to_width
|
|
self.set_pwm(print_time, width * self.width_to_value)
|
|
def set_pulse_width(self, print_time, width):
|
|
width = max(self.min_width, min(self.max_width, width))
|
|
self.set_pwm(print_time, width * self.width_to_value)
|
|
|
|
def get_printer_servo(printer, name):
|
|
return printer.objects.get('servo ' + name)
|
|
|
|
|
|
######################################################################
|
|
# AD5206 digipot
|
|
######################################################################
|
|
|
|
class ad5206:
|
|
def __init__(self, printer, config):
|
|
enable_pin_params = pins.get_printer_pins(printer).parse_pin_desc(
|
|
config.get('enable_pin'))
|
|
self.mcu = enable_pin_params['chip']
|
|
self.pin = enable_pin_params['pin']
|
|
self.mcu.add_config_object(self)
|
|
scale = config.getfloat('scale', 1., above=0.)
|
|
self.channels = [None] * 6
|
|
for i in range(len(self.channels)):
|
|
val = config.getfloat('channel_%d' % (i+1,), None,
|
|
minval=0., maxval=scale)
|
|
if val is not None:
|
|
self.channels[i] = int(val * 256. / scale + .5)
|
|
def build_config(self):
|
|
for i, val in enumerate(self.channels):
|
|
if val is not None:
|
|
self.mcu.add_config_cmd(
|
|
"send_spi_message pin=%s msg=%02x%02x" % (self.pin, i, val))
|
|
|
|
|
|
######################################################################
|
|
# Replicape board
|
|
######################################################################
|
|
|
|
REPLICAPE_MAX_CURRENT = 3.84
|
|
REPLICAPE_SHIFT_REGISTER_BUS = 1
|
|
REPLICAPE_SHIFT_REGISTER_DEVICE = 1
|
|
REPLICAPE_PCA9685_BUS = 2
|
|
REPLICAPE_PCA9685_ADDRESS = 0x70
|
|
REPLICAPE_PCA9685_CYCLE_TIME = .001
|
|
|
|
class pca9685_pwm:
|
|
def __init__(self, replicape, channel, pin_params):
|
|
self._replicape = replicape
|
|
self._channel = channel
|
|
if pin_params['type'] not in ['digital_out', 'pwm']:
|
|
raise pins.error("Pin type not supported on replicape")
|
|
self._mcu = replicape.host_mcu
|
|
self._mcu.add_config_object(self)
|
|
self._bus = REPLICAPE_PCA9685_BUS
|
|
self._address = REPLICAPE_PCA9685_ADDRESS
|
|
self._cycle_time = REPLICAPE_PCA9685_CYCLE_TIME
|
|
self._max_duration = 2.
|
|
self._oid = None
|
|
self._invert = pin_params['invert']
|
|
self._last_clock = 0
|
|
self._pwm_max = 0.
|
|
self._cmd_queue = self._mcu.alloc_command_queue()
|
|
self._set_cmd = None
|
|
self._static_value = None
|
|
def get_mcu(self):
|
|
return self._mcu
|
|
def setup_max_duration(self, max_duration):
|
|
self._max_duration = max_duration
|
|
def setup_cycle_time(self, cycle_time):
|
|
pass
|
|
def setup_hard_pwm(self, hard_cycle_ticks):
|
|
if hard_cycle_ticks:
|
|
raise pins.error("pca9685 does not support hard_pwm parameter")
|
|
def setup_static_pwm(self, value):
|
|
if self._invert:
|
|
value = 1. - value
|
|
self._static_value = max(0., min(1., value))
|
|
def build_config(self):
|
|
self._pwm_max = self._mcu.get_constant_float("PCA9685_MAX")
|
|
cycle_ticks = self._mcu.seconds_to_clock(self._cycle_time)
|
|
if self._static_value is not None:
|
|
value = int(self._static_value * self._pwm_max + 0.5)
|
|
self._mcu.add_config_cmd(
|
|
"set_pca9685_out bus=%d addr=%d channel=%d"
|
|
" cycle_ticks=%d value=%d" % (
|
|
self._bus, self._address, self._channel,
|
|
cycle_ticks, value))
|
|
return
|
|
self._oid = self._mcu.create_oid()
|
|
self._mcu.add_config_cmd(
|
|
"config_pca9685 oid=%d bus=%d addr=%d channel=%d"
|
|
" cycle_ticks=%d max_duration=%d" % (
|
|
self._oid, self._bus, self._address, self._channel,
|
|
cycle_ticks, self._mcu.seconds_to_clock(self._max_duration)))
|
|
self._set_cmd = self._mcu.lookup_command(
|
|
"schedule_pca9685_out oid=%c clock=%u value=%hu")
|
|
def set_pwm(self, print_time, value):
|
|
clock = self._mcu.print_time_to_clock(print_time)
|
|
if self._invert:
|
|
value = 1. - value
|
|
value = int(max(0., min(1., value)) * self._pwm_max + 0.5)
|
|
self._replicape.note_enable(print_time, self._channel, not not value)
|
|
msg = self._set_cmd.encode(self._oid, clock, value)
|
|
self._mcu.send(msg, minclock=self._last_clock, reqclock=clock
|
|
, cq=self._cmd_queue)
|
|
self._last_clock = clock
|
|
def set_digital(self, print_time, value):
|
|
if value:
|
|
self.set_pwm(print_time, 1.)
|
|
else:
|
|
self.set_pwm(print_time, 0.)
|
|
|
|
class ReplicapeDACEnable:
|
|
def __init__(self, replicape, channel, pin_params):
|
|
if pin_params['type'] != 'digital_out':
|
|
raise pins.error("Replicape virtual enable pin must be digital_out")
|
|
if pin_params['invert']:
|
|
raise pins.error("Replicape virtual enable pin can not be inverted")
|
|
self.mcu = replicape.host_mcu
|
|
self.value = replicape.stepper_dacs[channel]
|
|
self.pwm = pca9685_pwm(replicape, channel, pin_params)
|
|
self.last = 0
|
|
def get_mcu(self):
|
|
return self.mcu
|
|
def setup_max_duration(self, max_duration):
|
|
self.pwm.setup_max_duration(max_duration)
|
|
def set_digital(self, print_time, value):
|
|
if value:
|
|
self.pwm.set_pwm(print_time, self.value)
|
|
else:
|
|
self.pwm.set_pwm(print_time, 0.)
|
|
self.last = value
|
|
def get_last_setting(self):
|
|
return self.last
|
|
|
|
ReplicapeStepConfig = {
|
|
'disable': None,
|
|
'1': (1<<7)|(1<<5), '2': (1<<7)|(1<<5)|(1<<6), 'spread2': (1<<5),
|
|
'4': (1<<7)|(1<<5)|(1<<4), '16': (1<<7)|(1<<5)|(1<<6)|(1<<4),
|
|
'spread4': (1<<5)|(1<<4), 'spread16': (1<<7), 'stealth4': (1<<7)|(1<<6),
|
|
'stealth16': 0
|
|
}
|
|
|
|
class Replicape:
|
|
def __init__(self, printer, config):
|
|
pins.get_printer_pins(printer).register_chip('replicape', self)
|
|
revisions = {'B3': 'B3'}
|
|
config.getchoice('revision', revisions)
|
|
self.host_mcu = mcu.get_printer_mcu(printer, config.get('host_mcu'))
|
|
# Setup enable pin
|
|
self.mcu_enable = pins.setup_pin(
|
|
printer, 'digital_out', config.get('enable_pin', '!P9_41'))
|
|
self.mcu_enable.setup_max_duration(0.)
|
|
self.enabled_channels = {}
|
|
# Setup power pins
|
|
self.pins = {
|
|
"power_e": (pca9685_pwm, 5), "power_h": (pca9685_pwm, 3),
|
|
"power_hotbed": (pca9685_pwm, 4),
|
|
"power_fan0": (pca9685_pwm, 7), "power_fan1": (pca9685_pwm, 8),
|
|
"power_fan2": (pca9685_pwm, 9), "power_fan3": (pca9685_pwm, 10) }
|
|
# Setup stepper config
|
|
self.stepper_dacs = {}
|
|
shift_registers = [1] * 5
|
|
for port, name in enumerate('xyzeh'):
|
|
prefix = 'stepper_%s_' % (name,)
|
|
sc = config.getchoice(
|
|
prefix + 'microstep_mode', ReplicapeStepConfig, 'disable')
|
|
if sc is None:
|
|
continue
|
|
if config.getboolean(prefix + 'chopper_off_time_high', False):
|
|
sc |= 1<<3
|
|
if config.getboolean(prefix + 'chopper_hysteresis_high', False):
|
|
sc |= 1<<2
|
|
if config.getboolean(prefix + 'chopper_blank_time_high', True):
|
|
sc |= 1<<1
|
|
shift_registers[port] = sc
|
|
channel = port + 11
|
|
cur = config.getfloat(
|
|
prefix + 'current', above=0., maxval=REPLICAPE_MAX_CURRENT)
|
|
self.stepper_dacs[channel] = cur / REPLICAPE_MAX_CURRENT
|
|
self.pins[prefix + 'enable'] = (ReplicapeDACEnable, channel)
|
|
shift_registers.reverse()
|
|
self.host_mcu.add_config_cmd("send_spi bus=%d dev=%d msg=%s" % (
|
|
REPLICAPE_SHIFT_REGISTER_BUS, REPLICAPE_SHIFT_REGISTER_DEVICE,
|
|
"".join(["%02x" % (x,) for x in shift_registers])))
|
|
def note_enable(self, print_time, channel, is_enable):
|
|
if is_enable:
|
|
is_off = not self.enabled_channels
|
|
self.enabled_channels[channel] = 1
|
|
if is_off:
|
|
self.mcu_enable.set_digital(print_time, 1)
|
|
elif channel in self.enabled_channels:
|
|
del self.enabled_channels[channel]
|
|
if not self.enabled_channels:
|
|
self.mcu_enable.set_digital(print_time, 0)
|
|
def setup_pin(self, pin_params):
|
|
pin = pin_params['pin']
|
|
if pin not in self.pins:
|
|
raise pins.error("Unknown replicape pin %s" % (pin,))
|
|
pclass, channel = self.pins[pin]
|
|
return pclass(self, channel, pin_params)
|
|
|
|
|
|
######################################################################
|
|
# Setup
|
|
######################################################################
|
|
|
|
def add_printer_objects(printer, config):
|
|
if config.has_section('replicape'):
|
|
printer.add_object('replicape', Replicape(
|
|
printer, config.getsection('replicape')))
|
|
for s in config.get_prefix_sections('static_digital_output '):
|
|
printer.add_object(s.section, PrinterStaticDigitalOut(printer, s))
|
|
for s in config.get_prefix_sections('static_pwm_output '):
|
|
printer.add_object(s.section, PrinterStaticPWM(printer, s))
|
|
for s in config.get_prefix_sections('servo '):
|
|
printer.add_object(s.section, PrinterServo(printer, s))
|
|
for s in config.get_prefix_sections('ad5206 '):
|
|
printer.add_object(s.section, ad5206(printer, s))
|