Add external renderProgress API endpoint#976
Open
azuer88 wants to merge 4 commits intoFormerLurker:masterfrom
Open
Add external renderProgress API endpoint#976azuer88 wants to merge 4 commits intoFormerLurker:masterfrom
azuer88 wants to merge 4 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
1 participant
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
/plugin/octolapse/renderProgressREST endpoint so external scripts can push rendering progressupdates to OctoPrint's UI without polling
get_current_rendering_job()toRenderingProcessorto expose the active jobsetup.py(sources were pointing to wrong directory)examples/(Python and Bash)Motivation
When Octolapse renders a timelapse using an external render script, there's no way for that script to
report progress back to the UI. This endpoint allows the script to POST progress updates that are forwarded
to connected clients via WebSocket.
Test plan
/plugin/octolapse/renderProgressand verify progress appears in theUI
examples/send_render_progress.pyorexamples/send_render_progress.shagainst a live OctoPrintinstance