mirror of
https://github.com/ruvnet/RuVector.git
synced 2026-05-29 19:33:34 +00:00
4d5de56344
User flagged "both [ruvllm + ruview] are in scope" for this branch.
ruvllm is HEF-blocked (LLM weights need Hailo Dataflow Compiler);
ruview's ADR-018 CSI UDP protocol is fully documented and shippable
today. Closing the ruview side first.
New crates/ruvector-hailo-cluster/src/bin/ruview-csi-bridge.rs
(seventh bin, ~310 LOC):
Listens on UDP (default 0.0.0.0:5005, RuView's stock port) for
ADR-018 binary CSI frames. Two header magics accepted:
0xC511_0001 (raw I/Q v1)
0xC511_0006 (feature state v6)
Parses the 20-byte header (node_id, n_antennas, n_subcarriers,
channel, rssi, noise_floor, timestamp_us) — header-only parse,
doesn't materialise the I/Q payload because the embed RPC's NL
description doesn't need it. Pure-Rust, no_std-friendly,
zero-allocation hot path same as the mmwave parser.
Each parsed frame:
1. Emits one JSONL line on stdout (downstream pipeline-friendly):
{"t_ms":508,"src":"10.0.0.42:54321","kind":"csi_feature_state",
"node_id":7,"channel":6,"rssi_dbm":-42,"noise_dbm":-90,...}
2. Synthesizes a short NL description ("wifi csi feature-state
packet from node 7 channel 6 rssi -42 dBm noise -90 dBm
antennas 2 subcarriers 64") and posts via cluster.embed_one_blocking
when --workers is set.
Same flag set as ruvector-mmwave-bridge:
--listen <addr> UDP bind (default 0.0.0.0:5005)
--workers <csv> Cluster sink
--dim --fingerprint --allow-empty-fingerprint (§2a parity)
--tls-ca --tls-domain --tls-client-cert --tls-client-key
(§1a / §1b parity, requires --features tls)
--quiet --help --version
Cluster post failures are logged but don't kill the bridge —
same resilience pattern as mmwave-bridge: stdout JSONL keeps
flowing even when the cluster is down.
Live verification:
- Spun up fakeworker on ephemeral port (fingerprint fp:csi-demo)
- Spawned ruview-csi-bridge on a free UDP port pointing at it
- Synthesized 5 ADR-018 v6 packets (node 7, channel 6, rssi -42,
noise -90, 2 antennas, 64 subcarriers) and sent to the listener
- Result: 5 JSONL lines on stdout, 5 successful "posted text=…"
cluster-side lines on stderr, 0 failures
Cargo.toml: new [[bin]] entry.
ADR-168 (CLI surface): adds the seventh bin to the table.
Validation:
- cargo build --bin ruview-csi-bridge: clean (default + tls)
- clippy --all-targets -D warnings: clean for both configs
- 19 test groups all green (was 18 — cargo discovered the new
bin's compile path)
Bridge ecosystem now has parallel surfaces for both major sensor
modalities documented in ADR-SYS-0024:
* mmwave (radar/MR60BHA2): ruvector-mmwave-bridge (iter 115)
* wifi-csi (RuView/ADR-018): ruview-csi-bridge (iter 123)
ruvllm side stays HEF-blocked; will pick up once a Hailo HEF lands.
Co-Authored-By: claude-flow <ruv@ruv.net>
|
||
|---|---|---|
| .. | ||
| adr | ||
| analysis | ||
| api | ||
| architecture | ||
| benchmarks | ||
| cloud-architecture | ||
| cnn | ||
| code-reviews | ||
| dag | ||
| development | ||
| examples | ||
| gnn | ||
| guides | ||
| hnsw | ||
| hooks | ||
| implementation | ||
| integration | ||
| nervous-system | ||
| optimization | ||
| plans/subpolynomial-time-mincut | ||
| postgres | ||
| project-phases | ||
| publishing | ||
| research | ||
| reviews | ||
| ruvllm | ||
| rvagent | ||
| sdk | ||
| security | ||
| sparse-inference | ||
| sql | ||
| testing | ||
| training | ||
| .gitkeep | ||
| .nojekyll | ||
| agi-container.md | ||
| C2-shell-execution-hardening.md | ||
| C8_RESULT_VALIDATION_IMPLEMENTATION.md | ||
| consciousness-api.md | ||
| IMPLEMENTATION-C5.md | ||
| index.html | ||
| INDEX.md | ||
| moe-routing-optimization-analysis.md | ||
| README.md | ||
| REPO_STRUCTURE.md | ||
| research-openfang.md | ||
RuVector Documentation
Complete documentation for RuVector, the high-performance Rust vector database with global scale capabilities.
📚 Documentation Structure
docs/
├── adr/ # Architecture Decision Records
├── analysis/ # Research & analysis docs
├── api/ # API references (Rust, Node.js, Cypher)
├── architecture/ # System design docs
├── benchmarks/ # Performance benchmarks & results
├── cloud-architecture/ # Cloud deployment guides
├── code-reviews/ # Code review documentation
├── dag/ # DAG implementation
├── development/ # Developer guides
├── examples/ # SQL examples
├── gnn/ # GNN/Graph implementation
├── guides/ # User guides & tutorials
├── hnsw/ # HNSW index documentation
├── hooks/ # Hooks system documentation
├── implementation/ # Implementation details & summaries
├── integration/ # Integration guides
├── nervous-system/ # Nervous system architecture
├── optimization/ # Performance optimization guides
├── plans/ # Implementation plans
├── postgres/ # PostgreSQL extension docs
├── project-phases/ # Development phases
├── publishing/ # NPM publishing guides
├── research/ # Research documentation
├── ruvllm/ # RuVLLM documentation
├── security/ # Security audits & reports
├── sparse-inference/ # Sparse inference docs
├── sql/ # SQL examples
├── testing/ # Testing documentation
└── training/ # Training & LoRA docs
Getting Started
- guides/GETTING_STARTED.md - Getting started guide
- guides/BASIC_TUTORIAL.md - Basic tutorial
- guides/INSTALLATION.md - Installation instructions
- guides/AGENTICDB_QUICKSTART.md - AgenticDB quick start
- guides/wasm-api.md - WebAssembly API documentation
Architecture & Design
- architecture/ - System architecture details
- cloud-architecture/ - Global cloud deployment
- adr/ - Architecture Decision Records
- nervous-system/ - Nervous system architecture
API Reference
- api/RUST_API.md - Rust API reference
- api/NODEJS_API.md - Node.js API reference
- api/CYPHER_REFERENCE.md - Cypher query reference
Performance & Benchmarks
- benchmarks/ - Performance benchmarks & results
- optimization/ - Performance optimization guides
- analysis/ - Research & analysis docs
Security
- security/ - Security audits & reports
Implementation
- implementation/ - Implementation details & summaries
- integration/ - Integration guides
- code-reviews/ - Code review documentation
Specialized Topics
- gnn/ - GNN/Graph implementation
- hnsw/ - HNSW index documentation
- postgres/ - PostgreSQL extension docs
- ruvllm/ - RuVLLM documentation
- training/ - Training & LoRA docs
Development
- development/CONTRIBUTING.md - Contribution guidelines
- development/MIGRATION.md - Migration guide
- testing/ - Testing documentation
- publishing/ - NPM publishing guides
Research
- research/ - Research documentation
- cognitive-frontier/ - Cognitive frontier research
- gnn-v2/ - GNN v2 research
- latent-space/ - HNSW & attention research
- mincut/ - MinCut algorithm research
🚀 Quick Links
For New Users
- Start with Getting Started Guide
- Try the Basic Tutorial
- Review API Documentation
For Cloud Deployment
- Read Architecture Overview
- Follow Deployment Guide
- Apply Performance Optimizations
For Contributors
- Read Contributing Guidelines
- Review Architecture Decisions
- Check Migration Guide
For Performance Tuning
- Review Optimization Guide
- Run Benchmarks
- Check Analysis
📊 Documentation Status
| Category | Directory | Status |
|---|---|---|
| Getting Started | guides/ | ✅ Complete |
| Architecture | architecture/, adr/ | ✅ Complete |
| API Reference | api/ | ✅ Complete |
| Performance | benchmarks/, optimization/, analysis/ | ✅ Complete |
| Security | security/ | ✅ Complete |
| Implementation | implementation/, integration/ | ✅ Complete |
| Development | development/, testing/ | ✅ Complete |
| Research | research/ | 📚 Ongoing |
Total Documentation: 460+ documents across 60+ directories
🔗 External Resources
- GitHub Repository: https://github.com/ruvnet/ruvector
- Main README: ../README.md
- Changelog: ../CHANGELOG.md
- License: ../LICENSE
Last Updated: 2026-02-26 | Version: 2.0.4 (core) / 0.1.100 (npm) | Status: Production Ready