Skip to content

Commit

Permalink
fixed v0_display pin and improved overrides docs (#535)
Browse files Browse the repository at this point in the history
  • Loading branch information
infowolfe authored Mar 5, 2024
1 parent 51216e4 commit 5cfd280
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 3 deletions.
2 changes: 1 addition & 1 deletion config/hardware/displays/V0_display.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ i2c_bus: i2c1a
# Standard: Right (clockwise) scrolls down or increases values. Left (counter-clockwise scrolls up or decreases values.
encoder_pins: ^v0_display:PA3, ^v0_display:PA4
# Reversed: Right (clockwise) scrolls up or decreases values. Left (counter-clockwise scrolls down or increases values.
#encoder_pins: ^display:PA4, ^display:PA3
#encoder_pins: ^v0_display:PA4, ^v0_display:PA3
click_pin: ^!v0_display:PA1
kill_pin: ^!v0_display:PA5
#x_offset: 2
Expand Down
4 changes: 3 additions & 1 deletion docs/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,6 @@ Here you can find a list of all the custom features availables in the macros or
## Hardware

This config support out of the box a lot of different machine hardware configurations.
More info will be added in this section later...

Please see [How to write an override](./overrides.md#how-to-write-an-override) in docs/overrides.md for more information on customizing your configuration.

13 changes: 12 additions & 1 deletion docs/overrides.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,18 @@ Additionally, if you want to add a new macro to Klippain or even replace an exis

The following examples should help you add all the overrides you need to customize Klippain and make it work correctly with your printer!

Let's say you want to change the motor current for the X-axis. You'll need to override the `[tmc2209 stepper_x]` section because that's where the current is defined. To do this, simply add the following to your `overrides.cfg` file:
If something in your hardware isn't working as expected, first inspect the relevant default configuration file for your hardware. For example if your v0 display encoder is rotating in the opposite direction:
`cd ~/printer_data/config` then `less config/hardware/displays/V0_display.cfg`, copy the relevant portion then edit to suit in your `overrides.cfg`:
```
[display]
# Set the direction of the encoder wheel
# Standard: Right (clockwise) scrolls down or increases values. Left (counter-clockwise scrolls up or decreases values.
#encoder_pins: ^v0_display:PA3, ^v0_display:PA4
# Reversed: Right (clockwise) scrolls up or decreases values. Left (counter-clockwise scrolls down or increases values.
encoder_pins: ^v0_display:PA4, ^v0_display:PA3
```

Or let's say you want to change the motor current for the X-axis. You'll need to override the `[tmc2209 stepper_x]` section because that's where the current is defined. To do this, simply add the following to your `overrides.cfg` file:
```
[tmc2209 stepper_x]
run_current: ...
Expand Down

0 comments on commit 5cfd280

Please sign in to comment.