195 lines
11 KiB
Markdown
195 lines
11 KiB
Markdown
# Step-14 - OBDX Pro GT readiness and read-only integration specification
|
|
|
|
## STEP IDENTIFIER
|
|
|
|
Step-14, hardware-readiness checkpoint only.
|
|
Step-13 with Step-13A accepted 2026-11-01; 654 cases reported passing.
|
|
This is the sole active manual worker assignment. It does not authorize
|
|
adapter implementation or accept the full Step-14 hardware milestone.
|
|
Read [STATE.md](STATE.md), [ROADMAP.md](ROADMAP.md) and the revised
|
|
[WORKER-QUALITY-GATE.md](WORKER-QUALITY-GATE.md). STOP after the requested report.
|
|
|
|
## STEP TITLE
|
|
|
|
Establish exact sourced OBDX Pro GT prerequisites and the smallest supported
|
|
read-only adapter boundary before any hardware code or vehicle traffic.
|
|
|
|
## OBJECTIVE
|
|
|
|
One deliverable: an attributable, reviewable GT readiness specification with
|
|
known facts, unresolved prerequisites and a bounded first implementation/test
|
|
contract. Do not combine research with a new transport/state machine/UI.
|
|
This prerequisite-first scope and final evidence reconciliation are deliberate
|
|
controls to reduce preventable corrective handoffs.
|
|
|
|
Produce `docs/obdx-pro-gt-readiness.md` and `prompts/Step-14-Report.md`.
|
|
No application source/tests/project/package/driver/runtime changes, builds/
|
|
tests/inference, adapter opening or physical diagnostic transmission.
|
|
|
|
## ARCHITECTURAL CONTEXT
|
|
|
|
Existing nine-project .NET 10 modular monolith: Core neutral contracts,
|
|
Diagnostics ports/protocol/result validation, Simulation isolated virtual
|
|
providers, Application use cases, UI presentation, Client thin Windows MAUI
|
|
composition, independent Components and tests under `src/tests`.
|
|
Simulation/RecordedReplay/PhysicalHardware are explicit; never substitute one
|
|
for another. Existing synthetic JSON v1/v2 is NOT an automotive wire protocol.
|
|
Physical read-only support cannot imply programming/clearing/actuation authority.
|
|
|
|
Inspect the actual [provider contracts](../src/AutoForge.Diagnostics/ProviderContracts.cs),
|
|
relevant session/target composition and existing typed result/capture boundaries
|
|
only as needed to propose the smallest safe integration. Do not refactor them.
|
|
|
|
## CURRENT IMPLEMENTATION STATE
|
|
|
|
- Corrected synthetic comparison/demo accepted; 179 unit + 475 integration =
|
|
654 cases, clean nine-project Release and native affected paths reported.
|
|
- Real local-only model and synthetic diagnostics/dynamics/proposals/rehearsal/
|
|
archive/replay are accepted. They are not evidence of physical support.
|
|
- No OBDX Pro GT driver/API/protocol/device qualification is established.
|
|
Actual local device ownership, hardware/firmware revision, transport and
|
|
approved vehicle/bench access may be unavailable.
|
|
- Keep existing source, original assignments/reports, user data and model
|
|
runtime unchanged. No new permission form for unrelated model/runtime work.
|
|
|
|
## REQUIRED IMPLEMENTATION
|
|
|
|
### Frozen research matrix
|
|
|
|
| ID | Research action | Required outcome |
|
|
|---|---|---|
|
|
| C-01 | Verify exact GT product/version/interface and primary documentation | Cite precise primary URLs/revisions/retrieval date; do not borrow another OBDX model's claims without explicit GT applicability |
|
|
| C-02 | Establish host/API/protocol/licensing requirements | Distinguish documented native interface, any actual J2534 support, USB/serial/wireless transports, Windows/architecture/driver/library constraints and unsupported/unknown items |
|
|
| C-03 | Read-only accessible local prerequisite inventory | Distinguish OS-enumerated device/installed files from an actual tested connection; absent/uncertain access is explicit, no driver install/device open/vehicle traffic |
|
|
| C-04 | Specify one smallest evidenced read-only adapter slice | Exact request/reply/units/identity/error/limits/lifecycle contract and real hardware qualification plan, reused project/ports; no unsupported frame/API invention or broad feature backlog |
|
|
| C-05 | Review source assertions, negative/lifecycle spec and report completeness | Every factual claim attributable or labelled unknown; future admission/publication/completion-tail tests concrete; no implementation/hardware success claimed from research |
|
|
|
|
### 1. Exact sourced support matrix
|
|
|
|
Prioritize manufacturer product/manual/protocol/SDK/driver/license sources.
|
|
Use maintained authoritative repositories if linked or verifiably applicable.
|
|
Third-party claims are secondary, labelled and cross-checked. Record source
|
|
URL/title/version/date and which exact matrix rows each supports.
|
|
|
|
Identify product variants/firmware/hardware revisions and:
|
|
|
|
- Documented connection interfaces and host wire framing/API command set.
|
|
- Supported vehicle protocols/buses and their exact GT/version conditions.
|
|
- Actual J2534 support, if evidenced; do not assume it from a family/name.
|
|
- Windows version/CPU architecture, native library ABI/driver/install/access
|
|
prerequisites, maintained .NET integration options and distribution/license
|
|
constraints. A vendor SDK being downloadable does not prove usability.
|
|
- Device metadata versus vehicle/module metadata, supported read-only services
|
|
and clear boundaries against writes/reset/clear/actuation/security/programming.
|
|
- Timing, framing, request IDs, buffer limits and documented failures relevant
|
|
to the first proposed slice. Unknown field sizes are unknown, not invented.
|
|
|
|
If sources disagree/unavailable, name the uncertainty and evidence needed.
|
|
Do not repeatedly search indefinitely or turn missing specs into plausible
|
|
implementation instructions. No private code/data/credentials upload.
|
|
|
|
### 2. Read-only local readiness
|
|
|
|
If accessible, inspect existing OS device enumeration and installed driver/
|
|
library metadata by exact scoped identity/path. Do not scan personal files,
|
|
dump environment/serial identifiers or open serial/Bluetooth/device handles.
|
|
No pairing, driver/SDK installation, probing hardware commands or vehicle
|
|
connection/startup. Public documentation retrieval is permitted.
|
|
|
|
Record observed/not observed/unverified precisely. Discovery in Device Manager
|
|
is not verified physical support. If device access is absent, finish source
|
|
research and make the future hardware-test prerequisite explicit.
|
|
Do not block all research just because no device can be tested in this task.
|
|
|
|
### 3. Smallest next implementation contract
|
|
|
|
Propose ONE primary new hardware contract, preferably explicit adapter
|
|
connection/device identification plus one well-documented read-only capability
|
|
if the evidence supports it. Do not bundle a complete CAN/UDS/J2534 stack,
|
|
multiple adapters/protocols, DTC clearing, dashboards or physical programming.
|
|
If no safe actionable API is evidenced, return no-go/required evidence rather
|
|
than scaffolding empty interfaces.
|
|
|
|
Specify existing project/port reuse and necessary minimal additions, without
|
|
writing code or new assignment files. The plan must state:
|
|
|
|
- Exact physical selection/provider identity and no synthetic/replay fallback.
|
|
- Eligibility/read-only allowlist before dispatch, actual framing/API outcome
|
|
validation before positive result and metadata provenance/unknown handling.
|
|
- Bounds/cancellation/deadline/single-owner rules and synchronous-prefix/
|
|
post-work release/drain/Close ordering.
|
|
- Normal/rejected/boundary/disconnect/overlap cases with concrete test stimulus
|
|
and measurable expected output/unchanged state. Use the revised shared
|
|
source-order ledger as the future implementation acceptance design.
|
|
- Fault injection below actual adapter boundary; simulated/recorded fixtures
|
|
labelled controlled, actual installed-device/native qualification separate.
|
|
- Specific missing driver/device/authorized bench/vehicle prerequisites and
|
|
how real evidence will establish or reject the proposed supported subset.
|
|
|
|
No hardware safe-to-write claim or generic raw-command UI. Restrict physical
|
|
testing in the proposed later plan to approved, documented read-only operations.
|
|
The orchestrator will review this before authorizing an implementation handoff.
|
|
|
|
## FILES OR PROJECTS EXPECTED TO CHANGE
|
|
|
|
Create the sourced readiness document and sole worker report named above.
|
|
Update `docs/README.md` with its link/current research-only status if appropriate.
|
|
No other docs need historical rewrite; no source/tests/dependencies/config/
|
|
orchestration/gate/old report changes.
|
|
|
|
## INTERFACE AND DEPENDENCY REQUIREMENTS
|
|
|
|
Research/specification only. Preserve nine projects/graph, physical restrictions,
|
|
source/unit/protocol/archive and owner contracts. No new package/host/runtime/
|
|
driver/SDK installation, simulation rewrite, cloud/model operations or firmware
|
|
reverse engineering without separate scope. No agents, automatic handoff,
|
|
staging/commit/push or shared-server/device changes.
|
|
|
|
## TESTING REQUIREMENTS
|
|
|
|
No application build/test or native hardware smoke is assigned: no code changes.
|
|
Validate requested document links, source applicability and required output
|
|
shape; inspect cited primary evidence instead of trusting search summaries.
|
|
Every C-01..C-05 row needs a specific source/observation/specification result.
|
|
Source-ordering ledger may be N/A for executed code because none is changed;
|
|
its relevant future tests must be concrete in the specification.
|
|
Do not manufacture a passing hardware test or rerun 654 cases as a proxy for
|
|
research accuracy. Preserve all earlier execution evidence unchanged.
|
|
|
|
## DOCUMENTATION REQUIREMENTS
|
|
|
|
The readiness document contains exact GT sourced support matrix, local observed/
|
|
missing prerequisites, bounded proposed adapter/test boundary, licensing risks,
|
|
unknowns and explicit go/no-go for that subset. Distinguish research readiness
|
|
from implemented/tested physical capability.
|
|
No standalone planning/checklist files beyond these requested deliverables.
|
|
|
|
## ACCEPTANCE CRITERIA
|
|
|
|
| ID | Readiness criterion | Evidence |
|
|
|---|---|---|
|
|
| AC-01 | C-01/C-02 exact attributable GT interface/API/host/protocol/licensing facts | Primary-source rows, explicit variant/revision scope and labelled unknown/conflicting secondary claims |
|
|
| AC-02 | C-03 honest local prerequisites, no physical/installation action | Exact scoped metadata observations or explicit unavailable status; no enumeration-as-tested claim |
|
|
| AC-03 | C-04 one bounded implementable read-only subset or justified no-go | Reused real ports, concrete framing/result/owner/negative/hardware test specification and dependencies |
|
|
| AC-04 | C-05 final source/coverage reconciliation and preservation | Named source mapping, link checks, self-review and no undocumented/code/hardware claims |
|
|
| AC-05 | Research-only report/manual gate truthful | Requested deliverables, precise checkpoint status and STOP before implementation |
|
|
|
|
## OUT-OF-SCOPE WORK
|
|
|
|
Adapter/application coding/scaffolding, builds/tests, driver/SDK installation,
|
|
device open/pairing/vehicle traffic, read-only hardware smoke, protocol execution,
|
|
any physical clear/reset/write/security/programming, model/runtime changes,
|
|
generic framework, new milestone renumbering or Step-15.
|
|
|
|
## REPORTING REQUIREMENTS
|
|
|
|
Save `prompts/Step-14-Report.md` entirely inside one plain triple-backtick fence,
|
|
no language tag/outside content/nested fences. Include identifier/title,
|
|
COMPLETE FOR READINESS or INCOMPLETE/BLOCKED precisely; C/AC source/evidence
|
|
mapping, deliverable links, exact proposed subset/no-go/unknowns, local checks
|
|
performed, source-ordering self-review/N/A rationale, preservation and issues.
|
|
Research can be complete with an explicit unavailable-device prerequisite;
|
|
actual physical integration/hardware milestone is still NOT IMPLEMENTED.
|
|
Missing authoritative evidence for the proposed subset is a no-go, not assumed
|
|
support. Save and STOP for manual review before any implementation assignment.
|