Skip to main content

polar_bear_biochip/
lib.rs

1//! # polar-bear-biochip
2//!
3//! Bio-chip intelligence framework for Polar Bear (๐Ÿจ).
4//!
5//! ## Architecture
6//!
7//! ```text
8//! โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
9//! โ”‚                    polar-bear-biochip                       โ”‚
10//! โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
11//! โ”‚  sensors::bci           EEG (ฮด ฮธ ฮฑ ฮฒ ฮณ bands + indices)    โ”‚
12//! โ”‚  sensors::accelerometer 3-axis MEMS (m/sยฒ)                  โ”‚
13//! โ”‚  sensors::fusion        SensorFusion โ†’ FusedReading         โ”‚
14//! โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
15//! โ”‚  agent::biochip_agent   rig-core LLM agent (ai-agent feat) โ”‚
16//! โ”‚                         curl fallback (no feature flag)     โ”‚
17//! โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
18//! โ”‚  provenance::ecdsa_signer  secp256k1 ECDSA sign + verify    โ”‚
19//! โ”‚                            SHA-256 payload hashing          โ”‚
20//! โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
21//! โ”‚  types   BciReading ยท AccelerometerReading ยท FusedReading   โ”‚
22//! โ”‚          InferenceResult ยท SignedOutput ยท AlertLevel        โ”‚
23//! โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
24//! ```
25//!
26//! ## Usage
27//!
28//! ```rust,no_run
29//! use polar_bear_biochip::{
30//!     sensors::fusion::SensorFusion,
31//!     provenance::ecdsa_signer::EcdsaSigner,
32//! };
33//!
34//! let mut fusion = SensorFusion::new();
35//! let reading = fusion.sample(1);
36//! println!("Cognitive load: {:.2}", reading.cognitive_load);
37//!
38//! let signer = EcdsaSigner::generate();
39//! println!("Public key: {}", signer.public_key_hex());
40//! ```
41
42/// Re-exports error types for use by callers.
43pub mod agent;
44/// Re-exports error types for use by callers.
45pub mod error;
46/// Re-exports provenance types for use by callers.
47pub mod provenance;
48/// Re-exports sensor types for use by callers.
49pub mod sensors;
50/// Re-exports type definitions for use by callers.
51pub mod types;