Specification, conformance assets, datasets, and tooling for verifying implementations of the OpenSynaptic ecosystem.
This repository is the neutral source of truth for:
- protocol and behavior requirements
- conformance profiles
- golden vectors and canonical datasets
- report schemas and baseline results
- cross-implementation runners and adapters
It does not host the production implementation source code for OpenSynaptic Core, OSynaptic-FX, OSynaptic-RX, or OSynaptic-TX. Those repositories implement the protocol. This repository defines how compatibility is measured and reproduced.
Current phase: Adapter integration — all initial infrastructure milestones are complete.
The repository now has stable machine-readable profiles, datasets, schemas, adapter manifests, an executable mock adapter, CI-ready runner entry points, active repository-backed adapters for OpenSynaptic Core, OSynaptic-FX, OSynaptic-RX, and OSynaptic-TX, and published mock adapter baseline reports for all five conformance levels.
Current validation posture:
- L1 and L2 profiles are stable; L3 and L4 are draft pending clean real-adapter runs
- mock adapter runs L1–L5 all pass and serve as the strict PASS baseline for repository-owned contract coverage
- real adapters are wired into smoke validation against representative profiles
- real-adapter smoke treats contract/runtime
ERRORas regressions while preserving honestFAILandSKIPresults for current implementation gaps
Next steps:
- resolve remaining
FAIL/SKIPresults in real-adapter smoke runs - promote L3 and L4 profiles to
stableonce real-adapter runs are clean - advance
config/sibling-refs.jsonafter each revalidated release - promote real-adapter baseline reports to
reports/baselines/once a clean run is achieved
Seeded documents already present in this repository:
Published mock adapter baselines (see reports/baselines/):
| Profile | Cases | Aggregate |
|---|---|---|
| L1 Wire Compatible | 34/34 | — |
| L2 Protocol Conformant | 8/8 | — |
| L3 Fusion Certified | 6/6 | — |
| L4 Security Validated | 13/13 | — |
| L5 Full Ecosystem | 4 suites | 1255/1257 (skipped=2) |
Seeded machine-readable assets already present in this repository:
- L1 Wire Compatible profile
- L2 Protocol Conformant profile
- L3 Fusion Certified profile
- L4 Security Validated profile
- L5 Full Ecosystem profile
- L1 CRC reference vectors
- L1 Base62 reference vectors
- L2 interoperability dataset
- L3 fusion dataset
- L4 security dataset
- L5 ecosystem dataset
- Adapter interface contract
- Mock adapter manifest
- Profile schema
- Vector-set schema
- Report schema
- Dataset-manifest schema
- Adapter-manifest schema
- Adapter-info schema
- Adapter-capabilities schema
OpenSynaptic already spans multiple implementations and targets:
- OpenSynaptic Core for the reference server and protocol runtime
- OSynaptic-FX for full embedded encoding and fusion behavior
- OSynaptic-RX for constrained decoding on low-end MCUs
- OSynaptic-TX for minimal transmit-only encoding
As the ecosystem grows, validation assets should not live inside only one implementation repository. Keeping them here prevents drift between repositories and makes third-party verification possible.
This repository is intended to contain:
- technical whitepaper and certification documentation
- machine-readable conformance profiles for L1 to L5 verification
- golden vectors for CRC, Base62, frame layout, commands, and behavior
- canonical and exhaustive datasets, or reproducible generators for them
- schemas for reports, profiles, and vector definitions
- shared runners and adapters that execute checks against multiple implementations
- baseline reports for official OpenSynaptic releases
This repository should not become:
- another implementation repository
- a general application demo repository
- a dump for large transient logs or ad-hoc local test output
- the place where implementation-specific unit tests replace protocol-level conformance assets
| Path | Purpose |
|---|---|
docs/ |
Whitepaper, certification, protocol notes, and operational guidance |
profiles/ |
Versioned conformance profiles and level definitions |
vectors/ |
Golden vectors and known-answer test inputs/outputs |
datasets/ |
Canonical datasets, exhaustive datasets, and generators |
schemas/ |
JSON schemas or equivalent contracts for repository artifacts |
config/ |
Locked sibling implementation revisions and other reproducibility inputs |
runners/ |
Shared execution entry points for verification workflows |
adapters/ |
Per-implementation integration layers |
reports/ |
Baseline conformance reports and compatibility summaries |
tests/ |
Repository-local verification for runners, schemas, and adapters |
Conformance is the technical base layer.
If OpenSynaptic later formalizes a public certification program, that program should reference tagged versions of this repository rather than replace it. In other words, a future certification outcome should always read like:
based on OpenSynaptic-Conformance vX.Y
This keeps policy and branding separate from the reproducible technical evidence.
- ✅ Move the whitepaper and certification process into versioned documentation under
docs/. - ✅ Publish the first machine-readable L1 and L2 profiles.
- ✅ Add CRC, Base62, FULL, DIFF, HEART, and control-command golden vectors.
- ✅ Define report schemas for official baseline output.
- ✅ Ship a reference runner that can verify OpenSynaptic Core, FX, RX, and TX against the same assets.
- ✅ Freeze an executable adapter contract with repository-owned smoke coverage and CI enforcement.
Small, stable golden vectors should be committed directly.
Large exhaustive datasets should be stored as one of the following:
- compact canonical snapshots that are stable across releases
- generated artifacts with a checked-in generator and fixed seed
- release assets or Git LFS objects when repository size would otherwise become unmanageable
Every certification or compatibility claim should be traceable to:
- a repository tag or commit
- a profile version
- a dataset version
- a generated report artifact
The repository-owned validate workflow also resolves sibling implementation checkouts from config/sibling-refs.json. That lock file is the reproducible input for ecosystem smoke validation and should only be advanced intentionally after the corresponding compatibility baseline has been revalidated.
See CONTRIBUTING.md for repository scope, contribution rules, and expectations for deterministic verification assets.
- Whitepaper index: docs/whitepaper/README.md
- Certification index: docs/certification/README.md
- Documentation overview: docs/README.md
- Profiles index: profiles/README.md
- Vectors index: vectors/README.md
- Schemas index: schemas/README.md
- Datasets index: datasets/README.md
- Adapters index: adapters/README.md
- Reports index: reports/README.md
- Runner index: runners/README.md
- Tests index: tests/README.md
- OpenSynaptic Core adapter is active, passes L1 end-to-end, and now reduces L4 security failures to the remaining timestamp replay API gap.
- OSynaptic-FX, OSynaptic-RX, and OSynaptic-TX adapters are active and smoke-stable: they emit valid reports without adapter execution errors, while remaining FAIL cases reflect current runtime incompatibilities rather than harness faults.
- OpenSynaptic Core: https://github.com/OpenSynaptic/OpenSynaptic
- OSynaptic-FX: https://github.com/OpenSynaptic/OSynaptic-FX
- OSynaptic-RX: https://github.com/OpenSynaptic/OSynaptic-RX
- OSynaptic-TX: https://github.com/OpenSynaptic/OSynaptic-TX