Skip to content

Commit

Permalink
Merge pull request #261 from Frix-x/develop
Browse files Browse the repository at this point in the history
v4.1.0
  • Loading branch information
Frix-x authored Aug 18, 2023
2 parents 67f6bb9 + 9ec5941 commit 5e24c04
Show file tree
Hide file tree
Showing 74 changed files with 919 additions and 317 deletions.
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: "\U0001F41B Bug report"
description: Report a bug or problem with Klippain.
labels: ["bug", "triage"]

body:
- type: markdown
attributes:
value: |
This issue form is for reporting bugs only!
If you have a feature request, please use [feature_request](/new?template=feature_request.yml) instead.
- type: checkboxes
id: klippain-branch
attributes:
label: Klippain branch
description: By submitting this issue, you confirm using a "public" release of Klippain from the main branch. We do not provide support for the dev version from other branches as they are known to be unstable.
options:
- label: I confirm using the main branch
required: true
- type: input
id: klippain-version
attributes:
label: Version
description: Specify the version of Klippain used on your printer. You can find this in the update section of Mainsail/Fluidd.
placeholder: ex. v4.0.1-44-g84aba96
validations:
required: true
- type: textarea
id: what-happened
attributes:
label: Describe the bug and expected behavior
description: >-
Provide a clear and concise description of the bug and why it's problematic.
If applicable, suggest a desired solution.
validations:
required: true
- type: textarea
id: additional-info
attributes:
label: Additional information and klippy.log
description: |
If possible, attach a klippy.log to help us diagnose your issue!
You can also provide any additional helpful details.
Please note, you can attach files or screenshots by dragging and dropping them directly in the field.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Public \#Klippain thread in the Voron Discord
url: https://discord.com/channels/460117602945990666/1096701708643614820
about: Quickest way to get in contact if you just want to have a chat
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: "\U0001F680 Feature request"
description: Suggest a new feature or hardware support for Klippain.
labels: ["enhancement", "triage"]

body:
- type: markdown
attributes:
value: |
This issue form is for suggesting features or hardware support only!
If you're facing a bug, please use the [bug_report](/new?template=bug_report.yml) instead.
- type: textarea
id: feature-description
attributes:
label: Describe the feature or hardware support you'd like
description: >-
Provide a clear and detailed description of the feature, mod, macro, or hardware you'd like to see in Klippain.
Also do not hesistate to explain how your suggestion can enhance Klippain and benefit its users.
placeholder: E.g., "I'd love to see support for this XXX new MCU model..."
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional context or information
description: |
If you have any more information, references, or context about your suggestion, please provide it here.
This can include use-cases, diagrams, documentation, links or any other helpful details.
Please note, you can attach files or screenshots by dragging and dropping them directly in the field.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

> Klippain - The pain-free recipe for (french)bread and butter Klipper configuration!
Klippain is a generic, modular, and highly customizable Klipper configuration for CoreXY 3D printers. Designed for use on various machines, it has been reported working correctly on Voron V2.4, Voron Trident, Voron V0, TriZero, VZbot, Ender5, etc... I even use it myself on an heavily modified Prusa i3 MK3s.
Klippain is a generic, modular, and highly customizable Klipper configuration for 3D printers. Designed for use on various machines such as Cartesian, CoreXY and CoreXZ, it has been reported working correctly on Voron V2.4, Voron Trident, Voron V0, Voron SwitchWire, TriZero, VZbot, Ender5, Ender3, Prusas, etc...

![Klippain](./docs/klippain.png)

The configuration is regularly updated with new features and merged PRs from users. You can reach me on the Voron Discord as **Frix_x#0161**.
Klippain is regularly updated with new features and merged PRs from users. You can reach me on the Voron Discord as **Frix_x#0161**.

Fun fact: "pain" \pɛ̃\ is the French word for bread, so there's no pain in this pain—only joy! Thanks to the French channel "honhonhonbaguette-FR" on the Voron Discord for the joke and name suggestion!

Expand Down
2 changes: 1 addition & 1 deletion config/hardware/axis/X/0.9deg.cfg
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[stepper_x]
rotation_distance: 40
microsteps: 64
microsteps: 32
full_steps_per_rotation: 400

# We also include the default wiring and speeds from here to avoid duplicating
Expand Down
2 changes: 1 addition & 1 deletion config/hardware/axis/X/1.8deg.cfg
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[stepper_x]
rotation_distance: 40
microsteps: 64
microsteps: 32
full_steps_per_rotation: 200

# We also include the default wiring and speeds from here to avoid duplicating
Expand Down
4 changes: 2 additions & 2 deletions config/hardware/axis/X/TMC/TMC2209.cfg
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# X TMC2209 definition

[gcode_macro _USER_VARIABLES]
variable_x_driver: "TMC2209"
variable_x_driver: "tmc2209"
gcode:

[tmc2209 stepper_x]
uart_pin: X_TMCUART
interpolate: False
interpolate: True
run_current: 0.8
sense_resistor: 0.110
stealthchop_threshold: 0
15 changes: 15 additions & 0 deletions config/hardware/axis/X/TMC/TMC2240.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# X TMC2240 definition

[gcode_macro _USER_VARIABLES]
variable_x_driver: "tmc2240"
gcode:

[tmc2240 stepper_x]
cs_pin: X_TMCUART
spi_speed: 500000
spi_software_sclk_pin: DRIVER_SPI_SCK
spi_software_mosi_pin: DRIVER_SPI_MOSI
spi_software_miso_pin: DRIVER_SPI_MISO
interpolate: True
run_current: 0.7
stealthchop_threshold: 0
2 changes: 1 addition & 1 deletion config/hardware/axis/Y/0.9deg.cfg
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[stepper_y]
rotation_distance: 40
microsteps: 64
microsteps: 32
full_steps_per_rotation: 400

# We also include the default wiring and speeds from here to avoid duplicating
Expand Down
2 changes: 1 addition & 1 deletion config/hardware/axis/Y/1.8deg.cfg
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[stepper_y]
rotation_distance: 40
microsteps: 64
microsteps: 32
full_steps_per_rotation: 200

# We also include the default wiring and speeds from here to avoid duplicating
Expand Down
4 changes: 2 additions & 2 deletions config/hardware/axis/Y/TMC/TMC2209.cfg
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Y TMC2209 definition

[gcode_macro _USER_VARIABLES]
variable_y_driver: "TMC2209"
variable_y_driver: "tmc2209"
gcode:

[tmc2209 stepper_y]
uart_pin: Y_TMCUART
interpolate: False
interpolate: True
run_current: 0.8
sense_resistor: 0.110
stealthchop_threshold: 0
15 changes: 15 additions & 0 deletions config/hardware/axis/Y/TMC/TMC2240.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Y TMC2240 definition

[gcode_macro _USER_VARIABLES]
variable_y_driver: "tmc2240"
gcode:

[tmc2240 stepper_y]
cs_pin: Y_TMCUART
spi_speed: 500000
spi_software_sclk_pin: DRIVER_SPI_SCK
spi_software_mosi_pin: DRIVER_SPI_MOSI
spi_software_miso_pin: DRIVER_SPI_MISO
interpolate: True
run_current: 0.7
stealthchop_threshold: 0
4 changes: 2 additions & 2 deletions config/hardware/axis/Z/TMC/TMC2209_1-Motor.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

# User variable only needed here as they are called recursively
[gcode_macro _USER_VARIABLES]
variable_z_driver: "TMC2209"
variable_z_driver: "tmc2209"
gcode:


[tmc2209 stepper_z]
uart_pin: Z_TMCUART
interpolate: False
interpolate: True
run_current: 0.8
sense_resistor: 0.110
stealthchop_threshold: 0
4 changes: 2 additions & 2 deletions config/hardware/axis/Z/TMC/TMC2209_3-Motors.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@

[tmc2209 stepper_z1]
uart_pin: Z1_TMCUART
interpolate: False
interpolate: True
run_current: 0.8
sense_resistor: 0.110
stealthchop_threshold: 0

[tmc2209 stepper_z2]
uart_pin: Z2_TMCUART
interpolate: False
interpolate: True
run_current: 0.8
sense_resistor: 0.110
stealthchop_threshold: 0
2 changes: 1 addition & 1 deletion config/hardware/axis/Z/TMC/TMC2209_4-Motors.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[tmc2209 stepper_z3]
uart_pin: Z3_TMCUART
interpolate: False
interpolate: True
run_current: 0.8
sense_resistor: 0.110
stealthchop_threshold: 0
17 changes: 17 additions & 0 deletions config/hardware/axis/Z/TMC/TMC2240_1-Motor.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Z TMC2240 definition

# User variable only needed here as they are called recursively
[gcode_macro _USER_VARIABLES]
variable_z_driver: "tmc2240"
gcode:


[tmc2240 stepper_z]
cs_pin: Z_TMCUART
spi_speed: 500000
spi_software_sclk_pin: DRIVER_SPI_SCK
spi_software_mosi_pin: DRIVER_SPI_MOSI
spi_software_miso_pin: DRIVER_SPI_MISO
interpolate: True
run_current: 0.7
stealthchop_threshold: 0
21 changes: 21 additions & 0 deletions config/hardware/axis/Z/TMC/TMC2240_3-Motors.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
[include TMC2240_1-Motor.cfg]

[tmc2240 stepper_z1]
cs_pin: Z1_TMCUART
spi_speed: 500000
spi_software_sclk_pin: DRIVER_SPI_SCK
spi_software_mosi_pin: DRIVER_SPI_MOSI
spi_software_miso_pin: DRIVER_SPI_MISO
interpolate: True
run_current: 0.7
stealthchop_threshold: 0

[tmc2240 stepper_z2]
cs_pin: Z2_TMCUART
spi_speed: 500000
spi_software_sclk_pin: DRIVER_SPI_SCK
spi_software_mosi_pin: DRIVER_SPI_MOSI
spi_software_miso_pin: DRIVER_SPI_MISO
interpolate: True
run_current: 0.7
stealthchop_threshold: 0
11 changes: 11 additions & 0 deletions config/hardware/axis/Z/TMC/TMC2240_4-Motors.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
[include TMC2240_3-Motors.cfg]

[tmc2240 stepper_z3]
cs_pin: Z3_TMCUART
spi_speed: 500000
spi_software_sclk_pin: DRIVER_SPI_SCK
spi_software_mosi_pin: DRIVER_SPI_MOSI
spi_software_miso_pin: DRIVER_SPI_MISO
interpolate: True
run_current: 0.7
stealthchop_threshold: 0
2 changes: 1 addition & 1 deletion config/hardware/axis/Z/VSW_0.9deg.cfg
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[stepper_z]
rotation_distance: 40
microsteps: 64
microsteps: 32
full_steps_per_rotation: 400

# We also include the default wiring and speeds from here to avoid duplicating
Expand Down
2 changes: 1 addition & 1 deletion config/hardware/axis/Z/VSW_1.8deg.cfg
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[stepper_z]
rotation_distance: 40
microsteps: 64
microsteps: 32
full_steps_per_rotation: 200

# We also include the default wiring and speeds from here to avoid duplicating
Expand Down
4 changes: 2 additions & 2 deletions config/hardware/extruder/TMC/TMC2209.cfg
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Extruder TMC2209 definition
[gcode_macro _USER_VARIABLES]
variable_e_driver: "TMC2209"
variable_e_driver: "tmc2209"
gcode:


[tmc2209 extruder]
uart_pin: E_TMCUART
interpolate: false
interpolate: True
run_current: 0.45
sense_resistor: 0.110
stealthchop_threshold: 0
13 changes: 7 additions & 6 deletions config/hardware/extruder/TMC/TMC2240.cfg
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
# Extruder TMC2240 definition
[gcode_macro _USER_VARIABLES]
variable_e_driver: "TMC2240"
variable_e_driver: "tmc2240"
gcode:

[tmc2240 extruder]
cs_pin: E_CS
spi_software_sclk_pin: E_SCLK
spi_software_mosi_pin: E_MOSI
spi_software_miso_pin: E_MISO
cs_pin: E_TMCUART
spi_speed: 500000
spi_software_sclk_pin: DRIVER_SPI_SCK
spi_software_mosi_pin: DRIVER_SPI_MOSI
spi_software_miso_pin: DRIVER_SPI_MISO
run_current: 0.6
stealthchop_threshold: 0
spi_speed: 500000
interpolate: False
interpolate: True
2 changes: 1 addition & 1 deletion config/hardware/extruder/cw1.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ gcode:
# new_rd = previous_rd * mesured_distance / requested_distance
rotation_distance: 22.6789511
gear_ratio: 50:17
microsteps: 64
microsteps: 32
full_steps_per_rotation: 200

nozzle_diameter: 0.400
Expand Down
2 changes: 1 addition & 1 deletion config/hardware/extruder/cw2.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ gcode:
# new_rd = previous_rd * mesured_distance / requested_distance
rotation_distance: 22.6789511
gear_ratio: 50:10
microsteps: 64
microsteps: 32
full_steps_per_rotation: 200

nozzle_diameter: 0.400
Expand Down
2 changes: 1 addition & 1 deletion config/hardware/extruder/galileo.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ gcode:
# new_rd = previous_rd * mesured_distance / requested_distance
rotation_distance: 22.6789511
gear_ratio: 7.5:1
microsteps: 64
microsteps: 32
full_steps_per_rotation: 200

nozzle_diameter: 0.400
Expand Down
2 changes: 1 addition & 1 deletion config/hardware/extruder/lgx_heavy.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ gcode:
# new_rd = previous_rd * mesured_distance / requested_distance
rotation_distance: 54.4
gear_ratio: 44:14, 37:17
microsteps: 64
microsteps: 32
full_steps_per_rotation: 200

nozzle_diameter: 0.400
Expand Down
2 changes: 1 addition & 1 deletion config/hardware/extruder/lgx_lite.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ gcode:
# new_rd = previous_rd * mesured_distance / requested_distance
rotation_distance: 54.69
gear_ratio: 44:10, 37:17
microsteps: 64
microsteps: 32
full_steps_per_rotation: 200

nozzle_diameter: 0.400
Expand Down
3 changes: 1 addition & 2 deletions config/hardware/extruder/orbiter2.0.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@ gcode:
# Orbiter 2.0 Gear Ratio
# new_rd = previous_rd * mesured_distance / requested_distance
rotation_distance: 4.637
gear_ratio: 7.5:1
microsteps: 16
microsteps: 32
full_steps_per_rotation: 200

nozzle_diameter: 0.400
Expand Down
Loading

0 comments on commit 5e24c04

Please sign in to comment.