deboss_during_print
Carve a debossed image into the top of an in-progress 3D print and generate carved G-code plus a resume package to continue the job.
Instructions
Carve a debossed image into the top of an in-flight print (Pro).
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"image_path": "<image_path>",
"gcode_path": "<gcode_path>",
"current_layer": "<current_layer>"
},
"name": "deboss_during_print"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| bevel | No | Add a 1-layer bevel ring around the deboss for cleaner visual edges. Default ``True``. Default: true. | |
| bed_temp | No | Bed setpoint for the 3MF metadata, read the same way as ``hotend_temp``. | |
| depth_mm | No | Deboss depth in mm. Must be in (0, 5]. Default: 1.2. | |
| threshold | No | Heightmap value above which a pixel is treated as carved-away (0.0–1.0, default 0.35). Default: 0.35. | |
| gcode_path | Yes | Original sliced .gcode of the in-flight job. | |
| image_path | Yes | PNG/JPG to deboss into the top. | |
| output_dir | No | Output directory for the carved + resume files. ``None`` uses the system temp dir. | |
| top_layers | No | Reserved override for the top-layer count. ``None`` (default) uses the value detected from ``analyze_top_region`` (TYPE:Top tags or solid-infill inference). | |
| hotend_temp | No | Hotend setpoint for the resume 3MF metadata. Leave unset to use the temperature the print's own file heats to; a value that differs from it is kept and said in ``warnings``. | |
| image_scale | No | Heightmap-to-bed scale factor — 0.7 means the image fills 70% of the carved region's bounding box. Default: 0.7. | |
| resume_z_mm | No | Explicit resume Z height in mm. ``None`` means the resume scanner derives it from the carved G-code at ``current_layer + 1``. | |
| aspect_policy | No | How to fit a non-matching aspect ratio onto the carve region. ``"auto_crop"`` crops the image to match (default), ``"auto_scale"`` letterboxes it, ``"strict"`` rejects mismatches. Default: "auto_crop". | |
| current_layer | Yes | 1-indexed layer the printer is paused at. The deboss starts at ``current_layer + 1`` so the carve never touches the layer currently being laid down. | |
| filament_type | No | The print's material, for 3MF metadata. Leave it out and Kiln reads the print's own material; when nothing says which, the call is refused (``PRINT_MATERIAL_UNKNOWN``). | |
| package_as_3mf | No | When ``True`` (default), the tool also wraps the resume gcode as a Bambu resume-mode 3MF and returns its path as ``resume_3mf_path``. Disable for non-Bambu targets or when you want to inspect the carved gcode before packaging. On failure the error is surfaced via ``warnings`` — the .gcode path is still returned so the caller can recover. Default: true. | |
| printer_z_known | No | REQUIRED ``True``. Same safety gate as ``generate_recovery_gcode`` — if the printer's Z isn't trustworthy, refuses with ``PRINTER_Z_UNKNOWN``. Default: false. | |
| source_3mf_path | No | Passed through to the 3MF wrapper. Supplying the original job's .3mf preserves its thumbnail and 3D model preview on the printer's display. Default: "". |