aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Status_Reference.md
Commit message (Collapse)AuthorAgeFilesLines
* docs: Fix typos in config and docs (#6991)Thijs Triemstra2025-07-271-1/+1
| | | | | | | * fix typos in configs * fix typos in docs Signed-off-by: Thijs Triemstra <info@collab.nl>
* docs: Load Cell Probe DocumentationGareth Farrington2025-05-291-0/+9
| | | | | | Add documentation updates for Homing & Probing with load cell probe Signed-off-by: Gareth Farrington <gareth@waves.ky>
* kinematics: Generic Cartesian kinematics implementation (#6815)Dmitry Butyugin2025-05-061-0/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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>
* hall_filament_width_sensor: Add filament switch values to statusRussell Cloran2025-04-171-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | `hall_filament_width_sensor` contains a runout sensor object internally. This exposes those values in the API status result. ``` SEND: {"id":123,"method":"objects/query","params":{"objects":{"hall_filament_width_sensor":["enabled","filament_detected","is_active","Diameter","Raw"]}}} GOT: b'{"id":123,"result":{"eventtime":199567.823596603,"status":{"hall_filament_width_sensor":{"enabled":true,"filament_detected":true,"is_active":true,"Diameter":1.9499999999999986,"Raw":6113}}}}' ``` The duplication of `is_active` and `enabled` seems confusing, but both of these can be independently manipulated by GCode: ``` SEND: {"id":123,"method":"gcode/script","params":{"script":"DISABLE_FILAMENT_WIDTH_SENSOR"}} GOT: b'{"id":123,"result":{}}' SEND: {"id":123,"method":"objects/query","params":{"objects":{"hall_filament_width_sensor":["enabled","is_active"]}}} GOT: b'{"id":123,"result":{"eventtime":199770.446013297,"status":{"hall_filament_width_sensor":{"enabled":true,"is_active":false}}}}' SEND: {"id":123,"method":"gcode/script","params":{"script":"SET_FILAMENT_SENSOR SENSOR=hall_filament_width_sensor ENABLE=0"}} GOT: b'{"id":123,"result":{}}' SEND: {"id":123,"method":"objects/query","params":{"objects":{"hall_filament_width_sensor":["enabled","is_active"]}}} GOT: b'{"id":123,"result":{"eventtime":199847.927726196,"status":{"hall_filament_width_sensor":{"enabled":false,"is_active":false}}}}' ``` Signed-off-by: Russell Cloran <rcloran@gmail.com>
* docs: Fix link syntax typo for bed_screwsRussell Cloran2025-04-011-1/+1
| | | | Signed-off-by: Russell Cloran <rcloran@gmail.com>
* load_cell: Load cell gram scale (#6729)Gareth Farrington2025-03-201-0/+11
| | | | | | | | | | | | | | * 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>
* skew_correction: Supports retrieving the name of the currently loaded skew ↵GofranChang2025-02-271-0/+6
| | | | | correction … (#6821) Signed-off-by: Zhang Gaofan <zhanggaofan0827@gmail.com>
* canbus_stats: Periodically report canbus interface statisticsKevin O'Connor2025-02-021-0/+21
| | | | | | | | | Add support for a new get_canbus_status command to canserial.c . Add new canbus_stats.py module that will periodically query canbus mcus for connection status information. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* sht3x: Add sht31 support (#6560)Timofey Titovets2024-04-201-1/+2
| | | Signed-off-by: Timofey Titovets <nefelim4ag@gmail.com>
* manual_stepper: Revert "manual_stepper: Add basic status. (#6527)"Kevin O'Connor2024-04-101-7/+0
| | | | | | | | | This reverts commit b029d0466841b90b54279500f70a92deacfd6c5a. The MCU_Stepper class does not have a is_motor_enabled() method, so the change above results in an internal exception. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* manual_stepper: Add basic status. (#6527)Viesturs Zariņš2024-04-041-0/+7
| | | | | Adding position and enabled in manual_stepper status. Enabled is already available through stepper_enable object. But this makes it more straightforward to access it. Signed-off-by: Viesturs Zarins <viesturz@gmail.com>
* toolhead: Replace max_accel_to_decel with minimum_cruise_ratioKevin O'Connor2024-03-131-1/+1
| | | | | | | | | 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>
* pwm_cycle_time: New module for output pins with dynamic cycle timesKevin O'Connor2024-01-231-0/+7
| | | | | | | | | 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>
* gcode: expose status with available commandsPedro Lamas2023-12-111-0/+6
| | | | Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
* pwm_tool: Add support for high-speed PWM pin updatesKevin O'Connor2023-11-161-1/+2
| | | | | | | | | The output_pin module is only capable of updating an output pin at most once every 100ms. Add a new pwm_tool module that is capable of queuing updates in the micro-controller and thus allowing for much higher update rates. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* heaters: adds temperature monitorsPedro Lamas2023-08-011-0/+5
| | | | Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
* temperature_combined: A class that can combine several other temperature ↵Michael Jäger2023-08-011-1/+2
| | | | | sensors (#6230) Signed-off-by: Michael Jäger <michael@mjaeger.eu>
* idex_modes: COPY and MIRROR mode implementation (#6297)Dmitry Butyugin2023-08-011-4/+5
| | | | | | | | | | | COPY and MIRROR mode implementation Correctly apply input shaper params to new dual_carriage Added SAVE_/RESTORE_IDEX_STATE commands Documentation updates for the new IDEX modes Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
* screws_tilt_adjust: add max_deviation to report statusStefan Dej2023-08-011-0/+2
| | | | Signed-off-by: Stefan Dej <meteyou@gmail.com>
* docs: Add gcode_button to the Status Reference docs (#6201)Chris2023-05-141-0/+6
| | | | | Add gcode_button to the Status Reference docs Signed-off-by: Chris Laprade <chris@rootiest.com>
* tmc: Support reporting tmc2240 temperature in driver get_status()Kevin O'Connor2023-04-071-0/+3
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* probe: expose name on status reportPedro Lamas2023-03-141-0/+1
| | | | Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
* stepper_enable: report statusPedro Lamas2023-02-131-0/+6
| | | | Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
* extruder: store currently sync'ed motion queue namePedro Lamas2023-02-091-0/+3
| | | | Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
* screws_tilt_adjust: status result as dictionaryPedro Lamas2023-02-031-6/+3
| | | | Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
* screws_tilt_adjust: Add get_status() method (#5921)theophile2022-12-171-0/+22
| | | Signed-off-by: Christopher Meredith <chmeredith@gmail.com>
* print_stats: add `SET_PRINT_STATS_INFO` G-Code for pass slicer variables to ↵Stefan Dej2022-10-051-2/+6
| | | | | | | Klipper (#5726) This adds a gcode command that can be used insight the slicer to pass the total layer count and current layer information. Signed-off-by: Stefan Dej <meteyou@gmail.com>
* z_thermal_adjust: Add Z thermal adjuster module (#4157)alchemyEngine2022-09-251-0/+13
| | | | | | Use a frame-coupled temperature probe to compensate for thermal expansion in real-time. Signed-off by: Robert Pazdzior <robertp@norbital.com>
* extruder_stepper: Support configuring pressure advance from configDmitry Butyugin2022-09-011-0/+7
| | | | | | | Also added status report for extruder_stepper objects with the current pressure advance parameters values. Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
* delta: Added the possibility to get where the "cone shape" of the build ↵Nitram2022-08-191-0/+2
| | | | | | | volume starts from Macros (#5662) Added the possibility to get where the "cone shape" of the build volume starts from Macros Signed-off-by: Martin Malmqvist <Volcomosq@gmx.com>
* bed_screws: report statusPedro Lamas2022-07-281-0/+11
| | | | Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
* manual_probe: report statusPedro Lamas2022-07-211-0/+11
| | | | Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
* configfile: Expose options awaiting to be saved (#5270)Kurt Haenen2022-06-201-0/+2
| | | | | | | Adds a save_config_pending_items to the status reported by configfile reflecting the items and values that a future SAVE_CONFIG would actually persist. Signed-off-by: Kurt Haenen <kurt.haenen@gmail.com>
* docs: add exclude_object documentationFrank Tackitt2022-06-031-0/+38
| | | | | | | Also include sample macros to add M486 compatibility. Signed-off-by: Franklyn Tackitt <git@frank.af> Co-authored-by: Troy Jacobson <troy.d.jacobson@gmail.com>
* docs: Note change to neopixel/dotstar API status fieldsKevin O'Connor2022-03-311-10/+13
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* angle: Report tle5012b temperatureKevin O'Connor2022-03-291-0/+9
| | | | | | Export the tle5012b temperature readings when performing measurements. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* bed_mesh: Report actual mesh profiles as statusMisterke2022-02-161-0/+2
| | | | | | | Report the actual profiles available via BED_MESH_PROFILE via the status for use by clients. Signed-off-by: Kurt Haenen <kurt.haenen@gmail.com>
* docs: Improve filament width sensor documentation (#5058)Yifei Ding2021-12-271-1/+2
| | | | | | | | | | | Add Filament Width Sensor to G-Codes.md Remove Redundant Filament Width Sensor Entries Remove Duplicate Status Reference In Hall Filament Width Sensor Fix Indentation For Filament Width Sensors Signed-off-by: Yifei Ding<yifeiding@protonmail.com>
* docs: Match Single Blank Line Above and Below A TitleYifei Ding2021-11-191-0/+1
| | | | Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
* tmc: add current values to get_status() (#4696)Philipp Temminghoff2021-10-111-0/+2
| | | Signed-off-by: Philipp Temminghoff <philipptemminghoff@gmail.com>
* configfile: Add support for reporting deprecated optionsKevin O'Connor2021-09-161-0/+6
| | | | | | | Add a new printer.configfile.warnings with a list of config features that are deprecated. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* tmc: Add support for a get_status() methodKevin O'Connor2021-08-301-0/+15
| | | | | | Export mcu_phase_offset and drv_status information. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Fix reference to neopixel color_dataMatt Heath2021-08-171-1/+1
| | | | | | | Fix reference to neopixel color_data in status reference documentation so the given example works as expected. Signed-off-by: Matt Heath <hello@mattheath.com>
* motion_report: Add get_status() method with current requested toolhead positionKevin O'Connor2021-07-291-0/+12
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs : make modifications to all md files to make them compatible with mkdocsDamien2021-07-271-33/+35
| | | | | | | | all markdown files must have a single H1 heading at the top. Signed-off-by: Damien Martin <damlobster@gmail.com> Update CNAME
* kinematics: Add dual_carriage to hybrid-corexyz (#4296)Tircown2021-06-271-0/+9
| | | | | | | - Add dual_carriage abilities for hybrid-corexy and hybrid-corexz - Introduce the module idex_mode - Fix add_stepper to the correct rail in hybrid-corexy Signed-off-by: Fabrice GALLET <tircown@gmail.com>
* virtual_sdcard: add `file_path` and `file_size` to `status`Kamil Trzcinski2021-06-221-0/+2
| | | | | | | This provides a comprehensive information if currently we have a file loaded. Signed-off-by: Kamil Trzcinski <ayufan@ayufan.eu>
* docs: add status documentaton for neopixel and dotstarEric Callahan2021-06-181-0/+9
| | | | Signed-off-by: Eric Callahan <arksine.code@gmail.com>
* extruder: expose `can_extrude` flag based on temperatureKamil Trzcinski2021-06-141-0/+2
| | | | | | | | | Sometimes an automated filament load is implemented, but extruder might not always extrude filament. This adds a flag to check if this operation is possible. Signed-off-by: Kamil Trzcinski <ayufan@ayufan.eu>
* endstop_phase: Add support for reporting phase information via get_status()Kevin O'Connor2021-06-031-0/+14
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
generated by cgit v1.2.3-70-g09d2 (git 2.50.1) at 2025-09-02 16:11:42 +0000