Exclude Objects (Superscedes #4716) #5413

kageurufu · 2022-04-13T01:13:39Z

module: Exclude Objects

Adding Klipper functionality to support cancelling objects while printing.

This module keeps track of motion in and out of objects and adjusts movements as needed. It also
tracks object status and provides that to clients.

The Klipper module is relatively simple, and only provides one piece of the workflow. Support from Moonraker is underway to pre-process gcode files from various slicers with the extended gcode commands supplied by this module. UI's such as Fluidd and Mainsail will provide the user facing controls.

There has been a small group sharing code. In addition to the Moonraker work, I have Fluidd code that will be submitted shortly. Mainsail support is also underway.

Signed-off-by: Troy Jacobson [email protected]
Co-authored-by: Franklyn [email protected]
Co-authored-by: Eric Callahan [email protected]

This PR superscedes #4716, has the requested changes from the prior PR, and fixes the failing test. Troy is currently busy, so I'm opening a new PR to push things along

Signed-off-by: Troy Jacobson <[email protected]> Co-authored-by: Franklyn Tackitt <[email protected]>

Adding Klipper functionality to support cancelling objects while printing. This module keeps track of motion in and out of objects and adjusts movements as needed. It also tracks object status and provides that to clients. The Klipper module is relatively simple, and only provides one piece of the workflow. Moonraker already supports processing uploaded files to insert the required gcode markers for cancelling objects, using https://github.com/kageurufu/cancelobject-preprocessor. This library is also available as an executable for use in slicers, and pip installations also include the script as a callable. Mainsail has integrated support, and code changes for Fluidd are available. Support in other interfaces is planned, and we've spoken to several other developers about integrating frontend support in their projects. Signed-off-by: Troy Jacobson <[email protected]> Co-authored-by: Franklyn Tackitt <[email protected]> Co-authored-by: Eric Callahan <[email protected]>

Also include sample macros to add M486 compatibility. Signed-off-by: Franklyn Tackitt <[email protected]> Co-authored-by: Troy Jacobson <[email protected]>

nightime7 · 2022-05-02T14:02:38Z

I've been running this for a couple of weeks now. seems to work quite well. is there any update regarding delivering this to the master repo? @Arksine @kageurufu

mjoconr · 2022-05-17T08:57:17Z

Has worked really well for me also. Be nice to know when it might be included in to Klipper.

lbibass · 2022-05-18T19:04:33Z

This has also been working very well for me. I would also like to see it merged soon so I can get back to mainline.

JRHeaton · 2022-05-25T21:08:40Z

Another +1 from me for seemingly stable working. Would love to see a review on this from @KevinOConnor and get it into main! This is one of those killer features for big bed batch printers. Great work

batista16 · 2022-05-31T16:07:36Z

+1 been using it for months now.. let's get it merged? :)

gurusonwheels · 2022-05-31T23:31:29Z

+1 please merge soon . this is needed like yesterday .

obamin · 2022-06-02T02:31:15Z

+1 please merge soon .

Arksine

I found some minor issues that I do not believe would functionally impair the module, overall the implementation looks good to me. We could correct these after the merging, however I will leave that up to Kevin. I would be willing to submit a PR to do so at his request.

Arksine · 2022-06-02T09:56:02Z

docs/Exclude_Object.md

+### Object Definitions
+
+The `EXCLUDE_OBJECT_DEFINE` command is used to provide a summary of each object
+in the gcode file to be printed.  Provides a summary of an object in the file.


"Provides a summary of an object in the file" appears to be stale documentation.

Arksine · 2022-06-02T10:13:25Z

klippy/extras/exclude_object.py

+        if not any(obj["name"] == name for obj in self.objects):
+            self._add_object_definition({"name": name})
+        self.current_object = name
+        self.was_excluded_at_start = self._test_in_excluded_region()


Stale attribute? It doesn't appear that was_excluded_at_start is accessed in the module.

Arksine · 2022-06-02T10:24:27Z

klippy/extras/exclude_object.py

+                              " currently active")
+            return
+        name = gcmd.get('NAME', default=None)
+        if name != None and name.upper() != self.current_object:


Generally identity should be used when testing for a NoneType, ie:

if self.current_object is None and self.next_transform: gcmd.respond_info("EXCLUDE_OBJECT_END called, but no object is" " currently active") return if name is not None and name.upper() != self.current_object: # rest of code

Arksine · 2022-06-02T10:26:13Z

klippy/extras/exclude_object.py

+            if center != None:
+                obj['center'] = json.loads('[%s]' % center)
+
+            if polygon != None:


The center and polygon conditions should test for identity.

KevinOConnor · 2022-06-03T16:43:24Z

Thanks. Looks good to me. I agree minor changes should just be made after merging. It's been a few weeks since this was submitted so I'd like confirmation from @kageurufu that everything is still good for committing and then I will commit.

-Kevin

kageurufu · 2022-06-03T18:03:36Z

@KevinOConnor It's still working great on my machine, and a few others I know. I think we're good!

KevinOConnor · 2022-06-03T18:12:14Z

Thanks!

-Kevin

lbibass · 2022-06-03T18:12:45Z

Woohoo!!

gurusonwheels · 2022-06-03T18:53:48Z

think its missing something console shows
14:51:03
Unknown command:"DEFINE_OBJECT"
and the icon that normally there next to stop and pause for selecting objects is missing .

Arksine · 2022-06-03T19:01:19Z

The gcode commands changed. You will need to make sure you are using a file processed by preprocess-cancellation version 0.2.0.

gurusonwheels · 2022-06-03T19:35:19Z

The gcode commands changed. You will need to make sure you are using a file processed by preprocess-cancellation version 0.2.0.

thanks . got you something . check discord .

Lenbok · 2022-06-03T23:23:55Z

Just curious, what is the use case for this feature? Is it that the user wants to slice a whole bunch of items and just select at print time which ones to actually print? Is it that midway through printing a plate of parts, some parts fail, so this lets you cancel the failed part (preventing collateral damage and filament waste)? (It would be nice if the documentation gave hints when you would want to do this, as it potentially allows new workflows that people aren't aware of.)

clee · 2022-06-04T02:12:23Z

Is it that midway through printing a plate of parts, some parts fail, so this lets you cancel the failed part (preventing collateral damage and filament waste)?

This is the primary use case as far as I'm concerned.

Troy Jacobson and others added 4 commits April 11, 2022 10:03

virtual_sdcard: Add reset_file event

6eaafab

Signed-off-by: Troy Jacobson <[email protected]> Co-authored-by: Franklyn Tackitt <[email protected]>

tuning_tower: add is_active() method

d59b6d0

Signed-off-by: Troy Jacobson <[email protected]> Co-authored-by: Franklyn Tackitt <[email protected]>

docs: add exclude_object documentation

d8a07f7

Also include sample macros to add M486 compatibility. Signed-off-by: Franklyn Tackitt <[email protected]> Co-authored-by: Troy Jacobson <[email protected]>

Arksine self-assigned this Apr 20, 2022

maz0r mentioned this pull request Apr 23, 2022

Exclude Objects #5326

Closed

maz0r mentioned this pull request May 7, 2022

Exclude Objects #4716

Closed

Arksine reviewed Jun 2, 2022

View reviewed changes

KevinOConnor merged commit 638cd4d into Klipper3d:master Jun 3, 2022

kageurufu deleted the exclude-object-pr2 branch June 3, 2022 18:41

meteyou mentioned this pull request Jun 3, 2022

docs: add exclude_object.md mainsail-crew/docs#18

Merged

watzon mentioned this pull request Jun 23, 2022

[FR] Exclude object GUI support mainsail-crew/mainsail#930

Closed

matmen mentioned this pull request Jun 27, 2022

Exclude Region fluidd-core/fluidd#359

Closed

github-actions bot locked and limited conversation to collaborators Jun 4, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Exclude Objects (Superscedes #4716) #5413

Exclude Objects (Superscedes #4716) #5413

kageurufu commented Apr 13, 2022

nightime7 commented May 2, 2022

mjoconr commented May 17, 2022

lbibass commented May 18, 2022

JRHeaton commented May 25, 2022 •

edited

Loading

batista16 commented May 31, 2022

gurusonwheels commented May 31, 2022

obamin commented Jun 2, 2022

Arksine left a comment

Arksine Jun 2, 2022

Arksine Jun 2, 2022

Arksine Jun 2, 2022

Arksine Jun 2, 2022

KevinOConnor commented Jun 3, 2022

kageurufu commented Jun 3, 2022

KevinOConnor commented Jun 3, 2022

lbibass commented Jun 3, 2022

gurusonwheels commented Jun 3, 2022

Arksine commented Jun 3, 2022

gurusonwheels commented Jun 3, 2022

Lenbok commented Jun 3, 2022

clee commented Jun 4, 2022

Exclude Objects (Superscedes #4716) #5413

Exclude Objects (Superscedes #4716) #5413

Conversation

kageurufu commented Apr 13, 2022

nightime7 commented May 2, 2022

mjoconr commented May 17, 2022

lbibass commented May 18, 2022

JRHeaton commented May 25, 2022 • edited Loading

batista16 commented May 31, 2022

gurusonwheels commented May 31, 2022

obamin commented Jun 2, 2022

Arksine left a comment

Choose a reason for hiding this comment

Arksine Jun 2, 2022

Choose a reason for hiding this comment

Arksine Jun 2, 2022

Choose a reason for hiding this comment

Arksine Jun 2, 2022

Choose a reason for hiding this comment

Arksine Jun 2, 2022

Choose a reason for hiding this comment

KevinOConnor commented Jun 3, 2022

kageurufu commented Jun 3, 2022

KevinOConnor commented Jun 3, 2022

lbibass commented Jun 3, 2022

gurusonwheels commented Jun 3, 2022

Arksine commented Jun 3, 2022

gurusonwheels commented Jun 3, 2022

Lenbok commented Jun 3, 2022

clee commented Jun 4, 2022

JRHeaton commented May 25, 2022 •

edited

Loading