aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Config_Reference.md
Commit message (Collapse)AuthorAgeFilesLines
* docs: Load Cell Probe DocumentationGareth Farrington2025-05-291-0/+59
| | | | | | Add documentation updates for Homing & Probing with load cell probe Signed-off-by: Gareth Farrington <gareth@waves.ky>
* manual_stepper: Support position_min and position_max optionsKevin O'Connor2025-05-121-0/+7
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* kinematics: Generic Cartesian kinematics implementation (#6815)Dmitry Butyugin2025-05-061-6/+229
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * tests: Added a regression test for generic_cartesian kinematics * kinematics: An intial implementation of generic_cartesian kinematics * generic_cartesian: Refactored kinematics configuration API * generic_cartesian: Use stepper instead of kinematic_stepper in configs * generic_cartesian: Added SET_STEPPER_KINEMATICS command * generic_cartesian: Fixed parsing of section names * docs: Generic Caretsian kinematics documentation and config samples * generic_cartesian: Implemented multi-mcu homing validation * generic_cartesian: Fixed typos in docs, minor fixes * generic_cartesian: Renamed `kinematics` option to `carriages` * generic_cartesian: Moved kinematic_stepper.py file * idex_modes: Internal refactoring of handling dual carriages * stepper: Refactored the code to not store a reference to config object * config: Updated example-generic-cartesian config * generic_cartesian: Restricted SET_STEPPER_CARRIAGES and exported status * idex_modes: Fixed handling stepper kinematics with input shaper enabled * config: Updated configs and tests for SET_DUAL_CARRIAGE new params * generic_cartesian: Avoid inheritance in the added classes Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
* tmc: add missing freewheel config optionsTimofey Titovets2025-04-171-0/+3
| | | | Signed-off-by: Timofey Titovets <nefelim4ag@gmail.com>
* docs: Add icm20948 descriptionMRX80242025-04-031-0/+19
| | | | Signed-off-by: Maksim Bolgov maksim8024@gmail.com
* ldc_1612: Supports configurable external crystal frequency (#6734)XiaoK2025-03-291-0/+3
| | | | | | | You can use the 40Mhz crystal oscillator recommended by TI official manual to get the best performance. refer to: [ldc1612.pdf](https://www.ti.com/cn/lit/ds/symlink/ldc1612.pdf) 7.3.4 Signed-off-by: Xiaokui Zhao <xiaok@zxkxzk.cn>
* buttons: Debounce gcode_button and filament_switch_sensor (#6848)Gareth Farrington2025-03-201-0/+9
| | | | | Add `debounce_delay` config option which sets the debounce time, defaults to 0 Signed-off-by: Gareth Farrington <gareth@waves.ky>
* load_cell: Load cell gram scale (#6729)Gareth Farrington2025-03-201-0/+10
| | | | | | | | | | | | | | * Add gram scale features to load_cell * Convert sensor counts to grams and make this available via unix socket and object status * Basic GCodes for tearing and reading the load cell * Guided Calibration * Diagnostic gcode to check the health of the load cell * Update load_cell Documentation * Add API server load_cell/dump_force endpoint * Update [load_cell] config with calibration fields * Add G-Code commands for working with load cells * Add status reference for load_cell objects Signed-off-by: Gareth Farrington <gareth@waves.ky>
* docs: Note stealthchop_threshold doesn't impact sensorless homingKevin O'Connor2025-02-151-8/+12
| | | | | | Reported by @paulfertser. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Fixed incorrect spelling in Config_Reference.md (#6819)Nicholas Parry2025-02-151-1/+1
| | | | | changed spelling of single word Signed-off-by: Nicholas Parry <rounded-gully-5r@icloud.com>
* ads1x1x: added support for ADC chip (#6584)Konstantin Koch2025-01-211-0/+44
| | | | | | Added a temperature sensor configuration for ADS1103, ADS1104, ADS1105, ADS1113, ADS1114 and ADS1115 chips that can be used to add Analog to Digital Conversion capability to machines that don't have that on their own. Like Raspberry Pi's or if more analog input pins are needed than the chip provides like for RP2040. Generally they can be used for any analog input, but the typical use case is for temperature measurement. This code also has been written with temperature measurement in mind and not as a general ADC. Signed-off-by: Konstantin Koch <korsarnek@gmail.com> Signed-off-by: Jack Wakefield <jackwakefield@protonmail.com>
* tmc2240: Allow the slope_control field to be configured via printer.cfgKevin O'Connor2025-01-101-0/+1
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* angle: mt6826s added supportTimofey Titovets2024-12-121-2/+3
| | | | Signed-off-by: Timofey Titovets <nefelim4ag@gmail.com>
* angle: mt6816 added supportTimofey Titovets2024-12-121-3/+3
| | | | Signed-off-by: Timofey Titovets <nefelim4ag@gmail.com>
* resonance_tester: Added a new sweeping_vibrations resonance test method (#6723)Dmitry Butyugin2024-12-051-1/+11
| | | | | This adds a new resonance test method that can help if a user has some mechanical problems with the printer. Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
* display: Add support for `AIP31068` based displays (#6639)Alexander Bazarov2024-12-021-3/+29
| | | display: Add support for `AIP31068` based displays
* axis_twist_compensation: AXIS_TWIST_COMPENSATION new parameter AUTO for ↵yochiwarez2024-11-121-6/+6
| | | | | | | | autocalibration This commit adds automatic calculation support for compensating X and Y axis twist in the axis_twist_compensation module. Signed-off-by: Jorge Apaza Merma <yochiwarez@gmail.com>
* axis_twist_compensation: Implement Y-axis supportyochiwarez2024-11-121-1/+18
| | | | | | | | This commit implements support for the Y-axis in the axis_twist_compensation module. This update enables the module to handle corrections for printers with a twisted Y rail. Signed-off-by: Jorge Apaza Merma <yochiwarez@gmail.com>
* docs: Add lis2dw i2c and lis3dhWulfsta2024-11-121-2/+43
| | | | Signed-off-by: Luke Vuksta <wulfstawulfsta@gmail.com>
* ads1220: Add input_mux and vref options to ADS1220 sensor (#6713)Gareth Farrington2024-10-241-1/+18
| | | | | | | | * fix type comparison bug that stopped the sensor from initializing * correct mismatch between docs and code for `sample_rate` (fixed to work same as hx71x) * add input_mux, pga_bypass and vref options * update configuration reference & fix typo Signed-off-by: Gareth Farrington <gareth@waves.ky>
* docs: Fix "XH711" typo in Config_Reference.mdKevin O'Connor2024-10-241-1/+1
| | | | | | Reported by @kabroxiko. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* stm32: allow 400Khz in stm32f0_i2c.c (#6694)Timofey Titovets2024-10-091-2/+3
| | | Signed-off-by: Timofey Titovets <nefelim4ag@gmail.com>
* docs: update temperature_probe documentationEric Callahan2024-09-011-0/+4
| | | | | | Add documentation for the "max_valid_temp" option. Signed-off-by: Eric Callahan <arksine.code@gmail.com>
* docs: Fix heading hierarchy for load_cell in Config_Reference.mdKevin O'Connor2024-07-311-8/+6
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* ads1220: Add ADS1220 bulk sensor to load_cellGareth Farrington2024-07-311-0/+34
| | | | | | Add support for the ADS1220 as an alternative to HX71x that supports SPI and higher sample rates. Signed-off-by: Gareth Farrington <gareth@waves.ky>
* hx71x: Load Cell Skeleton and HX71x bulk ADCGareth Farrington2024-07-311-0/+57
| | | | | | | * Create the load_cell host module skeleton to create the sensors and start taking samples. * Add support for the HX717 and HX711 ADC sensors. Signed-off-by: Gareth Farrington <gareth@waves.ky>
* docs: add initial temperature_probe documentationEric Callahan2024-07-171-0/+59
| | | | Signed-off-by: Eric Callahan <arksine.code@gmail.com>
* docs: add rapid probing documentationEric Callahan2024-06-191-0/+7
| | | | Signed-off-by: Eric Callahan <arksine.code@gmail.com>
* sensor_ldc1612: Add support for chips with INTB line routed to mcuKevin O'Connor2024-05-211-0/+3
| | | | | | If the INTB line is available it can reduce the MCU load. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* tmc: Save and restore thigh during sensorless homingKevin O'Connor2024-05-161-15/+6
| | | | | | | Make sure thigh is set to zero during sensorless homing, as it would not make sense for it to be enabled. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Minor wording change to coolstep_threshold in Config_Reference.mdKevin O'Connor2024-05-141-4/+4
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* tmc: Implement high_velocity_threshold for drivers that support itAlex Voinea2024-05-141-0/+24
| | | | Signed-off-by: Alex Voinea <voinea.dragos.alexandru@gmail.com>
* tmc: Implement coolstep_threshold for drivers that support itAlex Voinea2024-05-141-0/+28
| | | | Signed-off-by: Alex Voinea <voinea.dragos.alexandru@gmail.com>
* tmc: Implement CoolStep fields for all driversAlex Voinea2024-05-141-0/+11
| | | | Signed-off-by: Alex Voinea <voinea.dragos.alexandru@gmail.com>
* tmc2130: implement missing HighVelocity fields in the configAlex Voinea2024-05-141-0/+2
| | | | Signed-off-by: Alex Voinea <voinea.dragos.alexandru@gmail.com>
* bme280: Add BMP388 sensor support to BMxx80 (#6576)林玮 (Jade Lin)2024-04-241-4/+4
| | | | | | Extends the BMxx80 category with support for the BMP388 sensor, providing temperature and pressure output similar to the existing BMxx80 class of sensors. Signed-off-by: 林玮 (Jade Lin) <linw1995@icloud.com>
* sht3x: Add sht31 support (#6560)Timofey Titovets2024-04-201-0/+19
| | | Signed-off-by: Timofey Titovets <nefelim4ag@gmail.com>
* virtual_sdcard: Define a default for on_gcode_errorKevin O'Connor2024-04-151-1/+2
| | | | | | | If on_gcode_error is not specified, default to running the TURN_OFF_HEATERS command. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add documentation for probe_eddy_currentKevin O'Connor2024-04-091-0/+34
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* toolhead: Replace max_accel_to_decel with minimum_cruise_ratioKevin O'Connor2024-03-131-7/+18
| | | | | | | | | The user facing max_accel_to_decel setting is complicated and confusing. Replace it with a new minimum_cruise_ratio parameter. Internally this user-facing parameter will calculate the existing low-level "accel_to_decel" mechanism. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* bed_mesh: Remove deprecated relative_reference_indexKevin O'Connor2024-02-151-7/+0
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* bed_mesh: Implement adaptive bed mesh (#6461)voidtrance2024-01-261-0/+3
| | | | | | | | | | | | | | | | | | | | Adaptive bed mesh allows the bed mesh algorithm to probe only the area of the bed that is being used by the current print. It uses [exclude_objects] to get a list of the printed objects and their area on the bed. It, then, modifies the bed mesh parameters so only the area used by the objects is measured. Adaptive bed mesh works on both cartesian and delta kinematics printers. On Delta printers, the algorithm, adjusts the origin point and radius in order to translate the area of the bed being probe. Signed-off-by: Mitko Haralanov <voidtrance@gmail.com> Signed-off-by: Kyle Hansen <kyleisah@gmail.com> Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* pwm_cycle_time: New module for output pins with dynamic cycle timesKevin O'Connor2024-01-231-0/+18
| | | | | | | | | Remove support for changing the cycle time of pwm pins from the output_pin module. Use a new pwm_cycle_time module that supports setting dynamic cycle times. This simplifies the output_pin code and low-level pin update code. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* output_pin: Deprecate the maximum_mcu_duration parameterKevin O'Connor2024-01-231-9/+9
| | | | | | | Advise users to configure a pwm_tool config section if checking for maximum mcu duration is required. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* output_pin: Deprecate static_value parameterKevin O'Connor2024-01-231-5/+2
| | | | | | | | | | | | Remove support for configuring "static" pins in output_pin module. A "static" pin only saves a few bytes of memory in the micro-controller. The savings does not justify the increased code complexity. Deprecate the static_value parameter to warn users. In the interim, a static_value parameter will set both value and shutdown_value parameters. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* hall_filament_width_sensor: max filament diameterSami Haahtinen2023-12-171-0/+3
| | | | | | | | | Add support for maximum filament diameter to hall filament width sensor. If the diameter of the filament diameter is larger than the limit, the virtual runout sensor will trigger. The default value is set to maximum flow adjustment threshold to prevent oversized filament from clogging. Signed-off-by: Sami Haahtinen <ressu@ressukka.net>
* pwm_tool: Add support for maximum_mcu_durationKevin O'Connor2023-12-161-0/+1
| | | | | | | Implement the maximum_mcu_duration config parameter along with its associated queue flushing. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: add rp2040 to internal temp sensor list (#6426)Razor2023-12-131-1/+1
| | | Signed-off-by: Levi Szabo <iamrazorshark@gmail.com>
* docs: Improve max_accel documentation in Config_Reference.mdKevin O'Connor2023-12-051-5/+13
| | | | | | | | | | Note that the max_accel parameter is the actual acceleration used in most movements. Note that the accel/velocity limits can be changed using the SET_VELOCITY_LIMIT command. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* bmp280: Add support for BMP180 sensor (#6370)vaxxi2023-11-161-3/+3
| | | | | Extends the BMxx80 category with support for the older BMP180 sensor, providing temperature and humidity output. Signed-off-by: VAXXi Popescu <github@vaxxi.net>