Build against open schemas.
Everything an implementer needs, in the order it is needed: the schemas, a checker that runs in your browser, quickstarts for validation and the conformance suite, and the wire binding of every plane. Code is licensed under Apache-2.0.
Path
From the first schema to a conformance claim.
- Read the schemasEvery object as an open JSON schema, explored field by field.
- Check a documentCheck a document against its schema in your browser.
- Run the quickstartsValidate, run the conformance suite, read the bindings.
- Pick a profileWhat each kind of implementation provides.
- State your claimProfiles, levels and the evidence each needs.
API reference
The wire binding of every plane.
| Plane | Binding |
|---|---|
| Control | TLS 1.3 with mutual authentication; protobuf messages over gRPC or HTTP/2. |
| Data, in the field | MQTT 5 with Sparkplug B; connectors for LoRaWAN, OPC UA and instrument buses. |
| Data, site to upstream | At-least-once publication with repeat-safe keys over the control channel or NATS JetStream; QUIC MAY be used on lossy links. |
| Events | Event envelopes mapped to CloudEvents 1.0; channels described in AsyncAPI 3. |
| Exchange | OpenAPI 3.1; the OGC API family; SensorThings; STAC; WIS 2.0. |
| Evidence | DSSE-signed in-toto statements; SLSA provenance; SCITT transparency receipts. |
| Telemetry | OpenTelemetry OTLP. |
Profiles
What each kind of implementation provides.
| Profile | Functions | For |
|---|---|---|
| OBSP-NODE | Join, Describe, Time, Observe, Qualify, Orchestrate (apply), Exit | Node agents and devices |
| OBSP-SITE | OBSP-NODE plus Admit (local), Orchestrate (plan), Correct, Prove (verifier) | Site controllers |
| OBSP-GRID | OBSP-SITE plus Federate and Exchange | Cluster and grid control planes |
| OBSP-PROVIDER | Admit, Describe, Exit | Hardware, software, model and data providers |
| OBSP-CONSUMER | Exchange, Correct (subscribe) | Applications reading products |
Tools
Tools that run in your browser and on your machine.
Schemas
Every object of the protocol, as an open JSON schema.
- attestation-evidenceAttestationEvidenceRATS (RFC 9334) evidence a node presents to a verifier during Join (OBSP 0.1 section 5.1): fresh verifier nonce, claims, measurement digests, root-of-trust class with its quote or certificate digests, and the time quality in force.
- attestation-resultAttestationResultVerifier appraisal of AttestationEvidence (RFC 9334 attestation result, AR4SI tiers), bound to the nonce and the evidence digest it appraised and valid only until expiresAt.
- calibration-recordCalibrationRecordOne calibration of one observed property of a sensor (OBSP 0.1 section 5.3): reference standard, traceability chain, uncertainty with units, validity window, method and the role that performed it.
- conformance-claimConformanceClaimA participant's claim that one implementation version conforms to named OBSP profiles at named levels, with the evidence by digest (OBSP 0.1 section 10).
- conformance-reportConformanceReportOutput of a conformance suite run (conformance/README.md): the suite version, the profile tested, each case result, the requirement coverage and the digests of the evidence tested.
- correction-noticeCorrectionNoticeCorrection of one version of a record (OBSP 0.1 section 5.9): the corrected record and version, the state transition from the encoded transition table, the reason, the issuer role and every dependant it invalidates.
- decommission-recordDecommissionRecordClosing record for a node, site cell, cluster or provider integration (OBSP 0.1 section 5.12): identities revoked, keys wiped or returned, the owner's data exported in open formats with a digest-bound manifest, and final evidence.
- error-problemErrorProblemCanonical RFC 7807-shaped Observatory problem contract with bounded diagnostic disclosure.
- event-envelopeEventEnvelopeCanonical Observatory event envelope.
- fleet-projectionFleetProjectionCanonical Fleet Site Cell projection.
- model-manifestModelManifest
- native-envelopeNativeEnvelope
- node-bootstrap-bundleNodeBootstrapBundleBounded Node enrollment/assignment envelope referencing Plan, deployment, Site, policy and attestation requirements.
- node-manifestNodeManifest
- observation-recordObservationRecord
- observed-state-receiptObservedStateReceiptCanonical Node-emitted observed-state receipt for central deployment-state ingestion.
- participant-manifestParticipantManifestHow an organisation enters the protocol community through a participant gateway: its class, the roles it takes, the gateways it uses, the profiles it intends to implement or operate and its jurisdiction.
- planPlanImmutable governed deployment proposal produced by the System Pack compiler.
- product-manifestProductManifest
- proof-receiptProofReceipt
- provenanceProvenanceW3C PROV-O shaped provenance bundle (OBSP 0.1 section 5.6) that travels with observations and derived products: entities, activities and agents (by UNI and protocol role) with used, wasGeneratedBy, wasDerivedFrom, wasAssociatedWith, wasAttributedTo and actedOnBehalfOf relations.
- provider-manifestProviderManifest
- qualification-recordQualificationRecord
- quality-flagQualityFlagOne quality flag from the controlled vocabulary (OBSP 0.1 section 5.6) with the test and test version that set it.
- reconciliation-assignmentReconciliationAssignment
- reconciliation-receiptReconciliationReceipt
- replay-batch-resultReplayBatchResultPer-event dispositions for a ReplayBatch.
- replay-batchReplayBatchNode store-and-forward replay batch for reconnect catch-up.
- request-contextRequestContextObservatory Protocol request context (OBSP 0.1 section 4.3).
- sensor-passportSensorPassportVersioned passport of one sensor (OBSP 0.1 section 5.3): device class, model, serial, firmware digest, mounting and exposure, sampling plan, observed properties with UCUM units and the calibration history.
- source-manifestSourceManifest
- source-releaseSourceRelease
- supply-chain-receiptSupplyChainReceiptSupply-chain receipt for an admitted software artifact (OBSP 0.1 section 5.2): artifact digest, SBOM (SPDX or CycloneDX) reference and digest, SLSA provenance reference and build level, and an optional SCITT transparency receipt.
- system-packSystemPack
- time-qualityTimeQualityTime quality a node reports with its observations and receipts (OBSP 0.1 section 5.4): source class, offset bound, holdover and integrity flags.