Getting Started

Elata SDK

The Elata SDK is a set of npm packages for capturing and processing biosignals in the browser. The packages are built on Rust crates compiled to WebAssembly, so signal processing runs on the user’s device.

Repository: github.com/Elata-Biosciences/elata-bio-sdk · npm: @elata-biosciences

Quick start

The fastest path is to scaffold a starter app:

# Interactive template picker
npm create @elata-biosciences/elata-demo my-app

# Or pick one directly
npm create @elata-biosciences/elata-demo my-app -- --template rppg

cd my-app
npm install
npm run dev

See create-elata-demo for all five templates.

Packages

“Live” packages are on npm. “Experimental” packages are available as source code in the SDK repository and not yet on npm. See What’s live.

Sensors

Package	What it does	Status
`@elata-biosciences/rppg-web`	Heart rate and pulse signals from a webcam (rPPG). The default starting point: no hardware needed.	Live
`@elata-biosciences/eeg-web`	EEG signal processing, band powers, and models (WASM), plus the shared headband frame contract.	Live
`@elata-biosciences/eeg-web-ble`	Connect EEG headbands over Web Bluetooth. Muse built in; extensible to other devices.	Live
`@elata-biosciences/ppg-web`	Heart rate and HRV from a headband’s optical (PPG) sensor.	Live

Recording and analysis

Package	What it does	Status
`@elata-biosciences/biosignal-session`	Record multi-sensor sessions to local storage with a fault-tolerant protocol and Arrow chunks.	Experimental
`@elata-biosciences/biosignal-analytics`	EEG window features, HRV, robust statistics, and transparent headline scores.	Experimental
`@elata-biosciences/rppg-models-web`	Optional learned waveform reconstruction for `rppg-web`. You supply the model file.	Experimental

Elata

Package	What it does	Status
`@elata-biosciences/app-payments`	In-app purchases through Elata checkout	Live
`@elata-biosciences/app-state`	Per-user key-value storage. Until it’s on npm, use the `elata:state:*` messages.	Experimental
`@elata-biosciences/app-metrics`	Event records, scores, and biometric Score contribution	Live

Tooling

Package	What it does	Status
`@elata-biosciences/create-elata-demo`	Scaffold a starter app from a template	Live, known issue

Known issue: the current npm release of create-elata-demo (0.12.1) fails to start with “Missing packaged SDK version metadata for @elata-biosciences/app-metrics”. A fix is coming in the next release. Until then, add the packages to an app directly (below).

Add packages to an existing app

# Camera heart rate
npm install @elata-biosciences/rppg-web

# EEG over Web Bluetooth
npm install @elata-biosciences/eeg-web @elata-biosciences/eeg-web-ble

# Headband PPG heart rate and HRV
npm install @elata-biosciences/ppg-web @elata-biosciences/eeg-web @elata-biosciences/eeg-web-ble @elata-biosciences/rppg-web

Requirements: Node.js 20 or newer for tooling, and a modern browser with WebAssembly support.

Device support

Device	Protocol	Signals	Status
Muse 2	Classic BLE	4 EEG (TP9, AF7, AF8, TP10), PPG	Supported
Muse S	Classic BLE	4 EEG, PPG	Supported
Muse S (Athena)	Athena	8 EEG, optics, accelerometer/gyro	Supported
Any webcam	Camera	rPPG pulse	Supported

Want to add a headset? See Device Integration.

Rust crates

The packages are built on public Rust crates you can also use directly:

Crate	Purpose
`elata-eeg-hal`	Core device traits: `EegDevice`, `SampleBuffer`
`elata-eeg-signal`	FFT, band power, filtering
`elata-eeg-models`	Alpha bump detector, calmness model
`elata-rppg`	rPPG pipeline core
`elata-muse-proto`	Muse classic and Athena protocol decoding

Choose A Package

Package decision guide

Your First App

Scaffold and run a starter app

Publish on Elata

Ship it on Elata

Overview

EEG Web SDK

EEG BLE Web SDK

Camera Web SDK

PPG Web SDK

Sessions and Analytics

Operations

Contributors

Elata SDK

Quick start

Packages

Sensors

Recording and analysis

Elata

Tooling

Add packages to an existing app

Device support

Rust crates

Next

Choose A Package

Your First App

Publish on Elata

​Elata SDK

​Quick start

​Packages

​Sensors

​Recording and analysis

​Elata

​Tooling

​Add packages to an existing app

​Device support

​Rust crates

​Next

Choose A Package

Your First App

Publish on Elata

Elata SDK

Quick start

Packages

Sensors

Recording and analysis

Elata

Tooling

Add packages to an existing app

Device support

Rust crates

Next