Merge remote-tracking branch 'upstream/edge' into feature/soft-endstops
[clinton/Smoothieware.git] / ConfigSamples / Snippets / spindle.config
1 # Spindle control settings
2
3 spindle.enable true # [Default false] Set this to false to disable the spindle module
4 #spindle.ignore_on_halt true # [Default false] Don't stop the spindle on HALT. Not recommended unless you really know what you're doing.
5
6 # PWM spindle settings
7
8 spindle.type pwm # [Default pwm] Spindle module mode (pwm, analog, modbus)
9 spindle.pwm_pin 2.3 # [Default nc] PWM output pin. Must be hardware PWM capable. (See http://smoothieware.org/pinout)
10 spindle.pwm_period 50000 # [Default 1000] PWM period in microseconds.
11 spindle.max_pwm 0.85 # [Default 1.0] Max duty cycle. MC2100 uses 85% duty cycle for max speed.
12 spindle.feedback_pin 0.22 # [Default nc] Tach input pin. Must be interrupt capable.
13 spindle.pulses_per_rev 1.0 # [Default 1] Number of pulses per spindle revolution.
14 spindle.default_rpm 60 # [Default 5000] RPM value to use if no RPM is provided to initial M3.
15 #spindle.control_P 0.1 # [Default 0.0001] Proportional term for the PID controller.
16 #spindle.control_I 0.1 # [Default 0.0001] Integral term for the PID controller.
17 #spindle.control_D 0.1 # [Default 0.0001] Derivative term for the PID controller.
18 #spindle.control_smoothing 0.1 # [Default 0.1] Low pass filter time constant in seconds.
19
20 # Analog spindle settings
21
22 #spindle.type analog # [Default pwm] Analog can also be used for ESC spindles controlled by a PWM.
23 #spindle.pwm_pin 2.3 # [Default nc] PWM output pin. Must be hardware PWM capable. (See http://smoothieware.org/pinout)
24 #spindle.min_rpm 100 # [Default 100] Minimum RPM when spindle is on.
25 #spindle.max_rpm 24000 # [Default 5000] Maximum RPM at 100% PWM.
26 #spindle.pwm_period 50000 # [Default 1000] PWM period in microseconds.
27 #spindle.switch_on_pin 2.6 # [Default nc] Optional output pin used to enable the VFD.
28
29 # Modbus spindle settings
30
31 #spindle.type modbus # [Default pwm] Modbus / RS485.
32 #spindle.vfd_type huanyang # [Default none] Huanyang is currently the only supported VFD type.
33 #spindle.rx_pin 2.6 # [Default nc] TX pin for soft serial.
34 #spindle.tx_pin 2.4 # [Default nc] RX pin for soft serial.
35 #spindle.dir_pin 2.5 # [Default nc] RS485 is only half-duplex, so we need a pin to switch between sending and receiving.