docs(validators): Blue Onyx is a supported backend (closes #12)#31
Merged
Conversation
…12) Operator verified on 2026-05-01 (post-v1.0.1 ship) that pointing the existing CodeProject.AI plugin's BaseUrl at a Blue Onyx instance works end-to-end with zero code change. The original #12 ask ("add Blue Onyx validator (CPAI-compatible drop-in)") turns out to require no new plugin — the existing plugin IS the drop-in. So #12 reduces to docs. Updated: - README.md "Validator engine status" — split into "Supported backends (verified)" and "Future backends (v1.1 roadmap)". Blue Onyx now has a worked config example showing the Validators:<name>:BaseUrl swap; CodeProject.AI is documented as the historical default with explicit note that current and older installs continue to work. - CodeProjectAiOptions XML doc remarks — added a <list> block enumerating the two supported backends (CPAI + Blue Onyx) with the Blue Onyx GPU caveat inline. Documented performance caveat (per operator's data point): Blue Onyx supports NVIDIA GPU acceleration only via its Windows EXE/service distribution. The Docker image is CPU-only and is slower than CPAI's CUDA-enabled Docker image on the same hardware. Acceptable for event-driven (sub-real-time) validation; operators with high event rates and no Windows GPU host should benchmark before swapping. No code changes. Build clean (0 warnings, 0 errors). Closes #12. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #31 +/- ##
=======================================
Coverage 90.09% 90.09%
=======================================
Files 51 51
Lines 1444 1444
Branches 240 240
=======================================
Hits 1301 1301
Misses 75 75
Partials 68 68 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
blehnen
added a commit
that referenced
this pull request
May 1, 2026
P0 hotfix release covering: PR #31 — Blue Onyx hard-confirmed as supported backend (#12) PR #33 — per-subscription CameraShortName + {camera_shortname} token, restoring legacy semantics that v1.0.0/v1.0.1 had silently dropped (#32). Affects every operator whose Frigate camera ids diverge from Blue Iris shortnames — was masked during the v1.0.0 parity window because legacy ran concurrently and fired BI with the correct name; surfaced when the operator stopped legacy on 2026-05-01. Operator-action item for anyone running v1.0.0 / v1.0.1: After upgrading to v1.0.2, set CameraShortName on each subscription and change BlueIris.TriggerUrlTemplate from &camera={camera} to &camera={camera_shortname}. Operators whose Frigate ids and BI shortnames already match — no config change needed. Co-Authored-By: Claude Opus 4.7 (1M context) <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
You verified on 2026-05-01 (post-v1.0.1 ship) that pointing the existing
FrigateRelay.Plugins.CodeProjectAiplugin'sBaseUrlat a Blue Onyx instance works end-to-end. The original #12 ask — "add Blue Onyx validator (CPAI-compatible drop-in)" — turns out to need no new plugin: the existing plugin already is the drop-in. #12 reduces to docs.What changed
README.md"Validator engine status" — restructured into two subsections:Validators:<name>:BaseUrlswap pathCodeProjectAiOptionsXML doc remarks — added a<list>block enumerating the two supported backends so IDE intellisense surfaces the Blue Onyx option to plugin consumersNo code changes. The plugin contract, request/response shapes, and existing CPAI test coverage all still apply unchanged.
Test plan
dotnet build src/FrigateRelay.Plugins.CodeProjectAi/FrigateRelay.Plugins.CodeProjectAi.csproj -c Release— 0 warnings, 0 errors (the expanded XML doc parses cleanly)FrigateRelay.Plugins.CodeProjectAi.Testscontinue to passCloses #12.