Add external render progress API and fix C++ build paths#974
Open
azuer88 wants to merge 3 commits intoFormerLurker:masterfrom
Open
Add external render progress API and fix C++ build paths#974azuer88 wants to merge 3 commits intoFormerLurker:masterfrom
azuer88 wants to merge 3 commits intoFormerLurker:masterfrom
Conversation
- Add /renderProgress endpoint for external scripts to push progress updates - Add get_current_rendering_job() to RenderingProcessor - Fix setup.py: skip '.' in requirements, update C++ sources to data/lib/c/ - Add examples/send_render_progress.py usage example - Add CLAUDE.md project documentation
BlueprintPlugin routes are registered at /plugin/<id>/, not /api/plugin/<id>/. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
/renderProgressAPI endpoint — allows external before/after render scripts to push progress updates to the Octolapse progress bar in the OctoPrint UI. Useful for scriptsthat do their own processing (re-encoding, watermarking, masking) and want to drive the UI progress independently. Requires an Application Key to post.
setup.pyC++ source paths — sources were referencingoctoprint_octolapse/*.cppbut files live inoctoprint_octolapse/data/lib/c/. Also fixes a bug where.inrequirements.txtwas being passed toinstall_requires.examples/— usage example for the new API endpoint.Changes
octoprint_octolapse/__init__.pyPOST /renderProgressBlueprint route accepting{"percent": float}, forwarded to the UI via the existing render progress message system.octoprint_octolapse/render.pyget_current_rendering_job()toRenderingProcessorso the progress endpoint can include job info in updates.setup.pyoctoprint_octolapse/data/lib/c/paths..entry when readingrequirements.txtintoinstall_requires.examples/Test plan
POST /plugin/octolapse/renderProgresswith{"percent": 50}returns{"success": true}pip install -e .succeeds without errors about missing C++ sources