Pre-release structural placeholder only.

No public SDK release is active at this stage.

Public SDK activation occurs only after Lock 1 + Lock 2 completion under SICS internal approval.

Sal-meter-ready SDK

[] [] []

Interface specification only — measurement algorithms are implementation-defined.

This repository defines the minimal interoperable exchange structure
for VCE / CRI / CFI indices.

It standardizes structure — not meaning.
It validates format — not interpretation.

---

Quick Onboarding (2 Minutes)

Clone the repository:

git clone https://github.com/salpida-foundation/sal-meter-sdk.git
cd sal-meter-sdk

Generate a demo payload:

node examples/behavioral-proxy-demo/index.js > payload.json

Validate it:

node api/validate.js payload.json

If validation passes,
you are structurally interoperable with the Sal-Meter ecosystem.

No hardware required.
No chemistry required.
No physiology required.

---

TL;DR (30 seconds)

Sal-meter-ready SDK defines a minimal interoperable interface
for exchanging human-state indices:

VCE / CRI / CFI

It standardizes payload structure — not measurement logic.
It enforces interoperability — not interpretation.

Apps, AI systems, and devices can integrate today
using proxy signals, and upgrade later
without changing the API layer.

---

Why does this exist?

Most systems today operate without awareness of human state.

• Same UI for exhausted users
• Same AI response for anxious states
• Same alerts under cognitive overload

→ UX failure, churn, increased risk, burnout

Sal-meter-ready SDK enables
state-aware systems — now, not after perfect hardware exists.

---

What the SDK provides

Standard Index Output

{
  "VCE": 0.72,
  "CRI": 0.61,
  "CFI": 0.68,
  "confidence": 0.42
}

• VCE — physiological & rhythm coherence
• CRI — contextual / relational alignment
• CFI — cognitive–emotional flow stability
• confidence — estimation reliability

---

Sensor-agnostic Design

• No Sal-Meter device required
• Behavioral / interaction proxies allowed
• Synthetic data allowed
• Adoption does not depend on hardware maturity

---

Architecture Principle

Proxy → Real sensor
Low confidence → High confidence
Precision improves without breaking existing integrations

---

Developer Usage Example

if (CFI < 0.5) {
  enableSafeMode();
}

Applications:

• Adaptive UI complexity
• AI tone adjustment
• Cognitive overload protection
• Fatigue-aware automation

---

Validation & CI Integrity

Every push and pull request triggers structural validation via GitHub Actions.

The repository automatically:

1. Generates payload
2. Validates against schema
3. Fails on structural drift

The interface protects itself.

---

Relation to the Sal-Meter Open Competition

• This SDK defines the interoperability gate
• Competition teams improve measurement precision
• Results become immediately usable

→ No research-to-product delay

Open Competition:
https://github.com/salpida-foundation/sal-meter-competition

---

What this SDK is NOT

• Not a definition of consciousness
• Not a medical diagnostic device
• Not a surveillance system
• Not tied to specific hardware
• Not a canonical authority document

Canonical definitions remain fixed via DOI-registered records.

---

Documentation

• docs/sal-meter-ready-sdk-why-what.md
• docs/developer-quick-start.md
• docs/competition-integration.md

---

API Schema

• api/vce-cri-cfi.schema.json
• api/vce-cri-cfi.schema.md
• api/validate.js

---

If You Want to Participate

You may compute VCE / CRI / CFI using:

• physiological proxy signals
• behavioral interaction metrics
• synthetic models
• research datasets

You MUST:

• Output compliant payload
• Include confidence estimation logic
• Document your measurement methodology

You are NOT required to:

• Build hardware
• Implement CAIS chemistry
• Use aptamer sensors

---

Build systems that respond to humans —
not the other way around.