Commit Graph

116 Commits

Author SHA1 Message Date
github@matthewlloyd.net 478f26cab6 config: Specify gear_ratio for Prusa Mini+ extruder
Also clarifies the documentation for rotation_distance in the
stepper docs.

Signed-off-by: Matthew Lloyd <github@matthewlloyd.net>
2021-06-18 10:54:51 -04:00
Kevin O'Connor 6db40df6af docs: Deprecate pid_integral_max config option
The default pid_integral_max setting should be sufficient; it's not
necessary to complicate the documentation and config to support
customization.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-06-12 13:29:11 -04:00
Kevin O'Connor 977c334e2e docs: Avoid link descriptions that span multiple lines
The Jekyll markdown renderer gets confused by links that span multiple
lines.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-05-28 20:58:32 -04:00
Kevin O'Connor 624d94f6ac docs: Fix link in Config_Reference.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-05-28 20:42:06 -04:00
Kevin O'Connor 3a25db1247 docs: Move description of menu templates to Command_Templates.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-05-28 20:30:28 -04:00
Alex Zellner 341fc64a67
gcode_macro: add description property (#4317)
Signed-off-by: Alex Zellner <alexander.zellner@googlemail.com>
2021-05-26 14:21:21 -04:00
Florian Heilmann bd42d497ae safe_z_home: Update documentation
Signed-off-by: Florian Heilmann <Florian.Heilmann@gmx.net>
2021-05-26 12:57:31 -04:00
Kevin O'Connor 391ebd32c1 docs: Minor updates to sdcard_loop documentation
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-05-26 12:05:49 -04:00
Jason S. McMullan 913649de2e loop_sdcard: Add loopable SD card file sections
To support continuous belt printing, add nestable repeat
loop support via an `[sdcard_loop]` module.

Supported G-Code:
  - SDCARD_LOOP_BEGIN COUNT=n  ; Loop for N times, or infinitely if N is 0
  - SDCARD_LOOP_END            ; End of loop
  - SDCARD_LOOP_DESIST         ; Complete all loops without iterating

Marlin M808 compatibility example in `config/sample-macros.cfg`:
  - M808 Ln        ; Loop for N times, or infinitely if N is 0
  - M808           ; End of loop
  - M808 K         ; Complete all loops without iterating

Added unit tests in test/klippy/sdcard_loop.test

See https://reprap.org/wiki/G-code#M808:_Set_or_Goto_Repeat_Marker

Signed-off-by: Jason S. McMullan <jason.mcmullan@gmail.com>
2021-05-26 11:57:57 -04:00
Kevin O'Connor 7bf379d75d docs: Fix typo in Config_Reference.md
Should be "hybrid-corexy" instead of "hybrid-codexy".  Reported by
@mak0t0san.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-05-06 11:46:35 -04:00
Tircown f2c74ec023
kinematics: Add hybrid-corexy and hybrid-corexz (#4229)
Signed-off-by: Fabrice GALLET <tircown@gmail.com>
2021-05-03 14:31:23 -04:00
Kevin O'Connor f10247a498 gcode_macro: Deprecate default_parameter_<name>
The Jinja2 "set" directive is more flexible and easier to understand
than default_parameter_XXX parameters.  Deprecate it and encourage
using "set" as a replacement.

This also deprecates direct access to parameters via parameter name in
a macro.  Going forward, the `params` pseudo-variable must be used to
access a parameter.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-05-03 12:43:53 -04:00
Kevin O'Connor e77bf7431e docs: Move palette2 location in Config_Reference.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-04-28 20:40:24 -04:00
nlef 2d2db0f839
probe: Add deactivate_on_each_sample: param for Probe (#4161)
Signed-off-by: Nick Lefskiy <n.lefskiy@yandex.ru>
2021-04-24 13:39:58 -04:00
Clifford Roche e7b0e7b43b
palette2: Add ping variation + ping status reports (#4114)
Signed-off-by: Clifford Roche <clifford.roche@gmail.com>
2021-04-14 11:37:24 -04:00
Arksine a93d09cdf4 docs: document bed mesh "faulty_regions"
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2021-04-10 11:16:07 -04:00
Kevin O'Connor cacf1197b6 docs: Minor changs to pca9533 in Config_Reference.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-04-09 17:50:30 -04:00
le-Bark eb4abdd830
pca9533: RGB support for the mightyboard (#4150)
Signed-off-by: Marc-André Denis <marcadenis@msn.com>
2021-04-09 17:47:16 -04:00
Kevin O'Connor b1b2488538 docs: Minor display sectoin updates to Config_Reference.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-04-09 13:07:40 -04:00
Kevin O'Connor cf0c165361 Docs: Split the display section of Config_Reference.md into multiple sections
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-04-09 12:59:13 -04:00
Kevin O'Connor 26603e8369 docs: Minor copy-and-paste fix to Config_Reference.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-04-09 12:02:18 -04:00
le-Bark 317402d5ba
hd44780_spi: added lcd support to the mightyboard (#4121)
Signed-off-by: Marc-André Denis <marcadenis@msn.com>
2021-04-07 21:07:23 -04:00
Pascal P 88f6061cd7
output_pin: Support setting max_duration (#3995)
Also added documentation for using powered tools.

Signed-off-by: Pascal Pieper <accounts@pascalpieper.de>
2021-03-26 11:25:09 -04:00
Clifford Roche e2a3217289
palette2: Add support for P2 devices (#4057)
Module which bring support for P2 devices running in connected mode. This enables using a Palette2 directly with Klippy without Octoprint, or without Palette2 plugins for Octoprint which are not functional out of the box with Klipper.

Signed-off-by: Clifford Roche <clifford.roche@gmail.com>
2021-03-26 11:21:10 -04:00
Kevin O'Connor 5c2c43b05f docs: Revise sensorless homing configuration guide
Recommend finding the minimum and maximum stallguard settings while
tuning sensorless homing.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-03-25 12:21:13 -04:00
Kevin O'Connor dd4f2d81b6 docs: Deprecate support for the pin_map config option
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-03-25 10:50:56 -04:00
Kevin O'Connor 36b1ccd598 replicape: Don't require a host alias for the enable_pin default
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-03-25 10:49:17 -04:00
Michael Kurz b4437f8eee
bme280: Add support for BMP280 and BME680 sensors (#4040)
This adds support for BMP280 and BME680 sensor ICs,
along with fixing calibration data readout for BME280.

Gas sensor readout for the BME680 is just the raw compensated value.
To get actual meaningful values, more research is needed.

Signed-off-by: Michael Kurz <michi.kurz@gmail.com>
2021-03-15 11:50:29 -04:00
TheJoshW bf8f7133b4
filament_motion_sensor: Add filament_motion_sensor (#3857)
Add functionality to support a Filament Motion Sensor for detecting extruder jams as well as runouts.  Works by an encoder toggling the switch_pin 0/1 as the filament is pulled through the sensor.

Signed-off-by: Joshua Wherrett <thejoshw.code@gmail.com>
2021-03-14 21:36:19 -04:00
Kevin O'Connor 041692828c mcu: Add support for connecting to devices on a CAN bus
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-03-13 11:29:41 -05:00
Kevin O'Connor 715b89ce0c docs: Rename Sensorless_homing.md to TMC_Drivers.md and extend
Add additional information on configuring and using TMC drivers.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-03-10 20:09:34 -05:00
Kevin O'Connor 3ea2e4fc58 tmc2660: Do not enable SFILT by default
None of the other TMC driver enable SFILT by default and it seems
enabling SFILT may not be ideal for sensorless homing.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-03-10 12:07:18 -05:00
teeminus bc2096f543
st7920: Better support for emulated ST7920 displays (#3979)
Added new ST7920E display driver which is better suited for displays with emulated ST7920

Signed-off-by: Christian Kehe <teeminus@posteo.net>
2021-03-01 18:23:06 -05:00
Adrian Keet 16d85d1a78 fan: Add tachometer support
This adds new config options for fans:  'tachometer_pin' to specify the
GPIO pin, and 'tachometer_ppr' (default 2) to specify the number of
signal pulses per revolution.  The rpm is also exposed by get_status for
command templates and the API server.  For fast fans (at least 10000
RPM), the polling interval can be shortened using the
'tachometer_poll_interval' option.

There is a new mcu object for a generic edge counter, which repeatedly
polls a GPIO pin and periodically reports the count to the host.

Signed-off-by: Adrian Keet <arkeet@gmail.com>
2021-03-01 14:53:13 -05:00
Marco D'Alessio c7688c6bca tmc2130: Add spi daisy chain support
This patch adds the ability to daisy-chain multiple tmc2130 and
tmc5160 drivers.

Signed-off-by: Marco D'Alessio <marco@wrecklab.com>
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-02-26 10:54:47 -05:00
Stefan Dej 6b6ab45bac
docs: Use BME280 (uppercase) in Config_Reference.md (#3896)
Signed-off-by: Stefan Dej <meteyou@gmail.com>
2021-02-22 15:42:14 -05:00
Kevin O'Connor c29585f7f3 temperature_host: Rename "path" config to "sensor_path"
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-02-20 09:23:13 -05:00
Evgenii 3d35c003db temperature_host: Rename rpi_temperature and add support for custom paths
Signed-off-by: Evgenii Shavrin <shavrin0591@gmail.com>
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-02-19 18:44:28 -05:00
Alan Lord 7d4df65920
ds18b20: new module for 1-wire temperature sensor (#3462)
Initial commit of code to support 1-wire (Dallas) sensors such
as the DS18B20. Requires Linux kernel drivers to create a file
in /sysfs which is read by this module, and temperature
typically returned to a temperature_fan.

Signed-off-by: Alan Lord <alanslists@gmail.com>
Signed-off-by: Josh Headapohl <joshhead@gmail.com>
2021-02-02 14:34:56 -05:00
Thomas Kroll 60e4cddf36 hd44780: Add hd44780 protocol init config
LDO OLED needs a different init string.

Fixes: #3722
Signed-off-by: Thomas Kroll <t.kroll@outlook.com>
2021-01-31 19:35:40 -05:00
Dmitry Butyugin ab93ee9293 docs: Limiting max_smoothing for input shaper autocalibration
Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
2020-12-22 18:37:41 -05:00
Kevin O'Connor 5b31080e77 docs: Add a Rotation_Distance.md document
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2020-12-18 10:30:32 -05:00
Kevin O'Connor 96eba9f2df endstop_phase: Obtain phases directly from stepper microsteps config
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2020-12-18 10:30:32 -05:00
Kevin O'Connor 7dcc778b6c stepper: Calculate step_distance from rotation_distance
Add support for automatically calculating the internal step_distance
from new config parameters - rotation_distance, microsteps,
full_steps_per_rotation, and gear_ratio.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2020-12-18 10:30:32 -05:00
Dmitry Butyugin 4a41d228eb
docs: Input Shaper and Resonances docs improvements (#3627)
Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
2020-12-17 17:44:46 -05:00
Kevin O'Connor 2d6b44152a bltouch: Recommend using a pullup on the sensor_pin
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2020-12-11 11:01:44 -05:00
Kevin O'Connor a1baefc2c2 temperature_mcu: Add enhanced support for monitoring mcu temperature
Add a "temperature_mcu" tool that can monitor builtin micro-controller
temperature sensors.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2020-12-10 02:39:06 -05:00
Kevin O'Connor 6bbfc869a1 docs: Improve spi and i2c description in Config_Reference.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2020-12-08 08:53:18 -05:00
Kevin O'Connor 6fe2ee0380 docs: Minor wording change to thermistors in Config_Reference.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2020-12-07 12:12:21 -05:00
Kevin O'Connor 654cbeb286 docs: Group temperature sensors together in Config_Reference.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2020-12-05 18:16:20 -05:00
Kevin O'Connor fc8ac8fe25 docs: Move micro-controller information together in Config_Reference.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2020-12-05 14:39:37 -05:00
Kevin O'Connor 14952ccef5 docs: Add links to default display.cfg and menu.cfg in Config_Reference.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2020-12-03 18:11:29 -05:00
Kevin O'Connor 1f2d9c051c docs: Use relative links for files outside the docs/ directory
Use javascript to fixup the "github pages" rendering of links to files
outside the docs/ directory.  Then use normal relative links in the
documentation.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2020-12-03 15:06:58 -05:00
Kevin O'Connor 23f547169c rpi_temperature: Don't read min_temp/max_temp directly from config
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2020-12-03 12:37:56 -05:00
Al b911db4c0d
rpi_temperature: New module to monitor RPi temperature (#3587)
Module to monitor RPi cpu temperature

Signed-off-by: Al Crate <aleph@al3ph.org>
2020-12-03 12:35:37 -05:00
Kevin O'Connor d7053f6e71 save_variables: Support saving variables to a disk file
Signed-off-by: Dushyant Ahuja dusht.ahuja@gmail.com
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2020-12-03 12:19:47 -05:00
Janar Sööt 91de1560a7
menu: modifications (#3262)
- remove lot of helper methods
- differentiate class instantiate from config or directly
- don't use 'enable' template rendering when static value is used.
- new element 'disabled'
- other internal adjustments

Signed-off-by: Janar Sööt <janar.soot@gmail.com>
2020-12-03 10:46:55 -05:00
Kevin O'Connor 422386e94c docs: Clean up example values in Config_Reference.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2020-12-02 08:44:37 -05:00
Kevin O'Connor 111f084c6a docs: Add additional command reference links to Config_Reference.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2020-11-23 11:27:01 -05:00
Martin Hierholzer fcb78e50e5
hd44780: allow to configure line length (#3543)
This allows to use 16x4 displays rather than only 20x4.

Signed-off-by: Martin Hierholzer <hier@beta-centauri.de>
2020-11-20 14:49:38 -05:00
Kevin O'Connor c6f0884140 docs: Add some additional links to Config_Reference.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2020-11-20 14:22:13 -05:00
Kevin O'Connor 6c0c05774b docs: Fix quad_gantry_level header in Config_Reference.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2020-11-20 14:02:59 -05:00
Kevin O'Connor e2528c13fa docs: Add more links to Config_Reference.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2020-11-20 13:34:50 -05:00
Kevin O'Connor bdd938b578 board_pins: Use an explicit parameter to specify mcu name(s)
Add an 'mcu' option to the board_pins config and use that to specify
the name of the mcu to apply the aliases to.  Support applying the
aliases to multiple mcus.

Add support for any number of options starting with an "aliases_"
prefix.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2020-11-20 12:00:36 -05:00
Kevin O'Connor 37b475815e docs: Move replicape reference from generic-replicate.cfg to Config_Reference.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2020-11-20 11:57:18 -05:00
Kevin O'Connor 15b5dbaf8f docs: Move config reference information to new Config_Reference.md
Move all the config reference information from files in the config/
directory to a new Config_Reference.md document.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2020-11-18 20:10:21 -05:00