Skip to content

Latest commit

 

History

29 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Resonance

Resonance

Open spatial acoustic intelligence infrastructure.

crates.io SDK crates.io Platform crates.io Edge Incident confidence breakdown
Every incident includes a full confidence breakdown with per-dimension evidence scores,
alternative hypotheses, spatial context, and a cryptographic provenance chain.

Simulation terminal output
The simulator creates virtual sensor networks for development without physical hardware.
Events propagate realistically through the mesh with configurable environmental conditions.


Published Crates

All core libraries are published on crates.io:

Crate Description Link
resonance-sdk Signal processing, DOA estimation, fingerprinting, detector SDK crates.io
resonance-platform Spatial cells, correlation, incidents, provenance, timing, atmosphere crates.io
resonance-edge Edge node runtime: HAL, DSP, privacy kernel, REP publisher crates.io
# Add to your Cargo.toml
[dependencies]
resonance-sdk = "4.0"

Why Resonance?

Capability Conventional systems Resonance
Localization output Single coordinate Acoustic Probability Surface with explicit uncertainty
Confidence reporting Single percentage Multi-dimensional breakdown (classifier, agreement, timing, signal, environment)
Privacy Policy-based Architecturally enforced � no raw audio protocol fields exist
Hardware Proprietary black box Open specification, any manufacturer can build
Auditability Vendor report Cryptographic provenance chain, deterministic replay
Environmental compensation Not core Native � wind, temperature, humidity correct every estimate
Reflection handling Ignored or confused EchoGraph explicitly models multi-path propagation
Contradiction detection Hidden in averaging ConflictGuard surfaces disagreements, caps confidence
Offline operation Cloud-dependent Edge-first � full detection continues without connectivity
Detector development Vendor-only Open SDK � third parties can build detector modules
Mixed hardware Fleet replacement required Protocol-based � different node generations interoperate

Platform Components

Signal Processing � resonance-sdk

The signal intelligence layer operates on multi-channel acoustic data to produce directional observations with explicit uncertainty.

  • VectorWave â€â€Â� direction-of-arrival estimation combining GCC-PHAT cross-correlation with delay-and-sum beamforming. Produces bearing vectors with 95% confidence intervals. Never claims precision the physics doesn't support.
  • WavePrint â€â€Â� perceptual acoustic fingerprinting that captures envelope shape, spectral distribution, impulse width, spectral decay, and temporal profile. Survives propagation differences between sensors.
  • EchoGraph â€â€Â� multi-path decomposition that separates direct arrivals from reflections. Learns reflection surfaces over time. Late arrivals are analyzed, not discarded.
  • Acoustic Probability Surface (APS) â€â€Â� continuous spatial probability field over a geographic grid. Replaces point estimates with probabilistic regions showing containment areas.
  • ConflictGuard â€â€Â� automatic contradiction detection. If sensors disagree on direction, timing, or classification, confidence is capped proportionally rather than hidden in an average.
  • Scene Health â€â€Â� assesses whether environmental conditions (wind, rain, noise floor, sensor availability) support reliable analysis. Poor conditions automatically cap achievable confidence.
  • Confidence Timeline â€â€Â� tracks how confidence evolves as evidence arrives. Shows whether the final score was stable or dependent on one late observation.
  • Feature Extraction â€â€Â� FFT spectrum, 13 MFCCs, spectral centroid/rolloff, zero-crossing rate, envelope analysis, SHA-256 acoustic fingerprint.

Spatial Intelligence � resonance-platform

The backend brain that correlates observations from multiple nodes into incidents.

  • Chronos â€â€Â� precision timing management. Tracks GNSS PPS quality, oscillator holdover, clock drift. Weights observations by timing reliability.
  • Atmosphere Engine â€â€Â� computes speed of sound from measured temperature. Applies wind correction to DOA estimates. Never hardcodes 343 m/s.
  • NodeCare â€â€Â� predictive maintenance scoring. Analyzes microphone health, clock drift, calibration age, thermal state, enclosure humidity. Generates maintenance predictions before failure.
  • Spatial Cells â€â€Â� geographic regions served by sensor groups. Support 4-node nominal, 3-node degraded, 2-node observation modes.
  • Provenance Chain â€â€Â� cryptographic hash chain of every processing step. Enables deterministic replay and independent verification.
  • Incident Lifecycle â€â€Â� explicit state machine: candidate → active → reviewing → confirmed/rejected → closed.

Edge Runtime � resonance-edge

The firmware running on each sensor node.

  • Hardware Abstraction Layer â€â€Â� traits for AudioDevice, ClockSource, LocationProvider, HardwareHealth. Linux and Simulator backends included.
  • DSP Pipeline â€â€Â� normalizer (calibration + noise floor estimation) → impulse detector (hysteresis state machine) → feature extractor.
  • Privacy Kernel â€â€Â� compile-time prohibited capabilities. Raw audio stays in a 5-second ring buffer and never crosses the privacy boundary. Only extracted features are transmitted.
  • REP Publisher â€â€Â� Ed25519-signed observations with replay-nonce protection. Offline queue with automatic reconnect replay.
  • Health Monitor â€â€Â� composite health scoring with automatic degradation detection.

Cloud Platform � apps/cloud/

Multi-tenant SaaS control plane built with Fastify + TypeScript.

  • Multi-tenancy â€â€Â� Organization → Workspace → Deployment hierarchy with enforced tenant isolation
  • RBAC â€â€Â� 8 roles (Owner, Administrator, Engineer, Operator, Reviewer, Technician, Researcher, Viewer) with 30+ granular permissions
  • Authentication â€â€Â� JWT with refresh tokens, API keys with scopes, webhook signing
  • Event-Driven â€â€Â� typed domain events bus enabling real-time UI, audit logging, and webhook delivery
  • Background Jobs â€â€Â� BullMQ queues with exponential backoff, jitter, and dead-letter handling
  • State Machines â€â€Â� explicit lifecycle states for nodes, incidents, models, and deployments with validated transitions
  • Alerting â€â€Â� policy-based alert engine with conditions, routing (email/Slack/Teams/webhook), and cooldown
  • Configuration Versioning â€â€Â� every config change gets a version, diff, author, and reason. Supports rollback.
  • Feature Flags â€â€Â� centralized flag system with boolean, percentage rollout, and org/workspace targeting
  • Data Retention â€â€Â� configurable lifecycle tiers (hot → warm → archive → delete) per resource type

Design System � packages/surface/

The visual language for all Resonance interfaces.

  • Semantic design tokens (colors, spacing, typography, radius, elevation, density, z-index)
  • Dark and light theme via CSS custom properties
  • Motion specification (micro/navigation/state/spatial/attention) respecting prefers-reduced-motion
  • Component interface contracts for 15+ primitives (Button, DataTable, ConfidenceCurve, EvidenceGraph, HealthGauge, DirectionPlot, Timeline)
  • Accessibility targeting WCAG 2.1 AA

Reference Hardware

Resonance is a software platform. We do not manufacture hardware.

We publish open reference designs so that hardware partners, contract manufacturers, and research labs can build compatible sensor nodes. Three reference designs are specified:

Node Purpose Who builds it
RN-D1 Development / education / lab testing Individual developers, universities
RN-F1 (VectorNode X1) Production field deployment Contract electronics manufacturers
RN-P1 Research / precision timing Instrumentation companies, national labs

The VectorNode X1 reference design includes:

  • 8–12 synchronized acoustic channels + precision pressure reference
  • Ultrasonic 2D wind vector sensor
  • Temperature, humidity, barometric pressure
  • Multi-constellation GNSS with PPS (≤100ns accuracy)
  • ARM64 compute with optional NPU
  • Secure element for device identity
  • IP67 enclosure rated -30°C to +60°C

All hardware designs are published under CERN Open Hardware Licence v2 � Permissive.

→ Full VectorNode X1 specification
→ Manufacturing plan for contract manufacturers
→ Reference BOM and node family definitions


Quick Start

# Clone the repository
git clone https://github.com/theworker02/resonance
cd resonance

# Build all Rust crates
cargo build --workspace

# Run the simulator (no hardware needed)
python simulator/src/main.py --nodes 25 --environment suburban --duration 5m

# Start the Cloud API
cd apps/cloud && npm install && npm run dev

# Open the console
cd apps/console && npm install && npm run dev
# → http://localhost:3000

Using the SDK in your own project

[dependencies]
resonance-sdk = "4.0"
use resonance_sdk::detector::{DetectorInterface, DetectorInput, DetectorOutput};

struct MyDetector;

impl DetectorInterface for MyDetector {
    fn name(&self) -> &str { "my-custom-detector" }
    fn version(&self) -> &str { "1.0.0" }
    fn supported_classes(&self) -> &[&str] { &["gunshot", "explosion", "unknown"] }
    fn analyze(&self, input: &DetectorInput) -> DetectorOutput {
        // Your classification logic here
        todo!()
    }
    fn health(&self) -> bool { true }
}

Simulation

Develop the entire platform without manufacturing hardware:

# 25-node suburban mesh, 5 minutes of simulated time
python simulator/src/main.py --nodes 25 --environment suburban --duration 5m

# Dense urban deployment
python simulator/src/main.py --nodes 64 --environment urban --duration 15m

# Sparse rural network
python simulator/src/main.py --nodes 9 --environment rural --duration 10m

The simulator models realistic acoustic propagation (inverse-square law + atmospheric attenuation), clock jitter, packet loss, and node failures. Events are correlated across the virtual mesh exactly as they would be on real hardware.


Privacy by Architecture

Resonance is architecturally incapable of mass surveillance.

The system processes only acoustic features extracted on-device � raw audio never traverses the network. The hardware and software are co-designed to make surveillance physically impossible, not merely policy-prohibited.

Prohibition Enforcement mechanism
No speech recognition Frequency bands and frame sizes are incompatible with speech decoding. No speech model can be loaded.
No speaker identification No voiceprint extraction. No biometric processing fields exist in the protocol.
No continuous streaming Sensors transmit only impulsive-event feature vectors. The protocol has no field for raw PCM.
No indefinite storage 5-second ring buffer auto-overwrites. No persistent audio archive capability exists.
No keyword monitoring Event detection triggers on acoustic energy, not linguistic content.
No individual tracking System detects acoustic events at a region level, not people at a coordinate level.

Privacy attestations are cryptographically signed by each node and independently verifiable.


Security

  • Per-device Ed25519 identity â€â€Â� every sensor has a unique keypair generated at first boot
  • Signed observations â€â€Â� every REP message carries an Ed25519 signature; backends reject unsigned data
  • Replay protection â€â€Â� random 16-byte nonce per event prevents replay attacks
  • Secure boot chain â€â€Â� ROM → signed bootloader → signed firmware → verified services
  • Hardware root of trust â€â€Â� TPM/secure element for key storage and attestation
  • Tenant isolation â€â€Â� multi-tenant data access enforced at the query layer, not just the frontend
  • Audit trail â€â€Â� append-only cryptographic chain for every significant action

→ Threat model
→ Secure boot specification
→ Fleet identity management


Specifications

Document Description
VectorNode X1 Hardware Spec 30+ formal requirements with measurement methods and validation procedures
REP Protocol Specification Wire protocol for sensor → platform communication
OpenAPI v1 Complete REST + WebSocket API specification
rep.proto Protobuf3 schema for REP messages
rep_schema.json JSON Schema for REP event validation

Project Structure

resonance/
��� platform/         Rust � spatial intelligence, correlation, incidents, API
��� edge/             Rust � sensor node runtime, DSP, privacy kernel
��� sdk/              Rust � signal processing library and detector SDK
��� intelligence/     Python � ML detector packs and ensemble
��� apps/
�   ��� cloud/        TypeScript � multi-tenant SaaS control plane
�   ��� console/      React � operator dashboard
�   ��� website/      Astro � GitHub Pages product site
��� packages/
�   ��� surface/      TypeScript � design system tokens and component contracts
��� hardware/         Reference designs, BOMs, manufacturing plan
��� specifications/   Engineering specs, OpenAPI, protocol definitions
��� simulator/        Python � virtual acoustic mesh
��� docs/             Architecture, security, privacy, ADRs, design specs
��� .github/          CI workflows, issue templates, CODEOWNERS

Documentation

Resource Link
Architecture overview ARCHITECTURE.md
Product principles PRODUCT_PRINCIPLES.md
Privacy model PRIVACY.md
Security documentation docs/security/
Design system packages/surface/
ADRs docs/adr/
UX patterns docs/design/
Quality gates docs/QUALITY_GATES.md
Developer experience docs/DEVELOPER_EXPERIENCE.md
Manufacturing plan hardware/MANUFACTURING_PLAN.md

Roadmap

See ROADMAP.md for the full roadmap. Current focus:

v4.0 (current) � Platform architecture, signal processing, multi-tenant cloud, design system
v4.1 � First prototype PCB, hardware-in-the-loop, fleet manager, public benchmarks
v5.0 � Production hardware certification, multi-region, federated learning


Contributing

We welcome contributions across all components. See CONTRIBUTING.md for:

  • Development setup (one command: ./scripts/dev.sh)
  • Testing guide (cargo test --workspace)
  • Code style and commit conventions
  • How to build custom detector modules
  • How to contribute hardware designs
  • PR review process

Funding

Resonance is unfunded open-source infrastructure. Sponsorship supports prototype PCBs, calibration equipment, test fixtures, outdoor enclosures, hosting, and dataset development.

GitHub Sponsors


Citation

If you use Resonance in research, please cite:

@software{resonance2026,
  title     = {Resonance: Spatial Acoustic Intelligence Infrastructure},
  author    = {{Resonance Contributors}},
  year      = {2026},
  url       = {https://github.com/theworker02/resonance},
  version   = {4.0.0},
  license   = {source-available proprietary}
}

License

Source-available proprietary � evaluation under LICENSE; commercial / production use via COMMERCIAL.md. See LICENSE_TRANSITION_NOTICE.md and NOTICE.


License & acquisition

This project is proprietary. Production use, redistribution, and commercial deployment require a written commercial license or completed acquisition. See LICENSE and ACQUISITION.md. Contact @theworker02.

Acquisition diligence

Buyer-facing diligence materials live in docs/acquisition/. Commercial licensing contact path: COMMERCIAL.md.

About

An open software platform and reference architecture for distributed acoustic event detection.

Topics

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Sponsor this project

Packages

Contributors

Languages