Elata SDK

AI-assisted integration? Start with the AI-assisted development map (routes to tutorials, vendor checklists, and package llms.txt), then the getting started guide, consumer guides, or Mintlify docs.

A cross-platform biosignal SDK spanning EEG device pipelines, browser transports, and rPPG processing for web and native clients.

What Is In This Repo

• EEG core crates, signal processing, and models
• WebAssembly bindings for EEG and rPPG
• Web Bluetooth EEG headset transport (eeg-web-ble; built-in Muse, open to more devices)
• Native FFI layers for iOS and Android integration
• App scaffolding and in-repo development demos

Quick Start

Scaffold an app

The recommended way to try the SDK is to scaffold a starter app with create-elata-demo.

# Show the current template list
pnpm dlx @elata-biosciences/create-elata-demo -- --list-templates

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

# rPPG starter app
npm create @elata-biosciences/elata-demo my-app -- --template rppg

# EEG starter app
npm create @elata-biosciences/elata-demo my-app -- --template eeg-demo

# EEG starter app (alias)
npm create @elata-biosciences/elata-demo my-app -- --template eeg

# EEG starter app with BLE starter name
npm create @elata-biosciences/elata-demo my-app -- --template eeg-ble

# EEG starter app with BLE alias
npm create @elata-biosciences/elata-demo my-app -- --template ble

# List templates
pnpm dlx @elata-biosciences/create-elata-demo -- --list-templates

You can also call the scaffolder directly:

pnpm dlx @elata-biosciences/create-elata-demo my-app
npx @elata-biosciences/create-elata-demo my-app

The scaffolder supports interactive app-type selection when you omit --template, then prompts for the project name when needed. It also supports template aliases (rppg, eeg, ble) and uses rppg-demo as the non-interactive default.

After scaffolding:

cd my-app
npm install
npm run dev

If the new app lives inside another pnpm workspace, run this from the parent directory instead:

pnpm --dir my-app --ignore-workspace install
pnpm --dir my-app --ignore-workspace run dev

Full details: docs/create-elata-demo.md

Add packages to an existing app

Published JavaScript and TypeScript packages live under the @elata-biosciences scope on npm (org landing page: all packages in one place).

pnpm add @elata-biosciences/eeg-web
pnpm add @elata-biosciences/eeg-web-ble
pnpm add @elata-biosciences/rppg-web

Choose The Right Package

Use this quick guide if you are starting from an existing app:

Goal	Start here	Notes
Scaffold a new app	@elata-biosciences/create-elata-demo	Fastest path for evaluation and onboarding
Run EEG WASM APIs in the browser	@elata-biosciences/eeg-web	Signal processing, models, and WASM helpers
Connect to an EEG headset over Web Bluetooth in the browser	@elata-biosciences/eeg-web-ble	Requires @elata-biosciences/eeg-web and Web Bluetooth; Muse built-in; extend for other headsets
Run camera-based rPPG in a browser app	@elata-biosciences/rppg-web	Includes processor, backend loader, and demo helpers

If you are trying the SDK for the first time, prefer create-elata-demo over manual package setup.

Wrong turns to avoid:

• Do not start with ./run.sh sync-to unless you are modifying packages/eeg-web inside this monorepo.
• Do not treat in-repo dev demos as the normal consumer install path; they are reference and SDK-development surfaces.
• If you scaffold inside another pnpm workspace, check the --ignore-workspace flow before assuming the template is broken.

Example applications

Open source browser apps that use @elata-biosciences/eeg-web, eeg-web-ble, and rppg-web together (with live GitHub Pages demos) are listed in docs/guides/example-apps.md. The Mintlify site exposes the same content as Example applications under elata-docs/sdk/guides/example-apps.mdx.

Packages

Scope overview: @elata-biosciences on npm lists every published package in this workspace.

• @elata-biosciences/eeg-web: EEG WASM wrapper and re-export surface
• @elata-biosciences/eeg-web-ble: Web Bluetooth transport for EEG headbands (Muse built-in; contributor extensions)
• @elata-biosciences/rppg-web: rPPG processing wrapper and demo helpers
• @elata-biosciences/create-elata-demo: app scaffolder with multiple templates

Compatibility Summary

Surface	Chrome / Edge	Safari macOS	Safari iOS	Node.js
create-elata-demo	n/a	n/a	n/a	>= 18
eeg-web	Supported	Supported	Supported	>= 20 for local repo tooling
eeg-web-ble	Supported in secure context	Not supported for this workflow	Not supported for this workflow	>= 20 for local repo tooling
rppg-web	Supported	Supported	Supported with camera permissions	>= 20 for local repo tooling

Browser caveats:

• eeg-web-ble requires Web Bluetooth and an https:// origin or localhost
• Safari and the system iOS browser do not provide usable Web Bluetooth for this workflow; use Chrome or Edge on desktop, Chrome on Android, or Bluefy on iOS if you need in-browser BLE
• rppg-web needs camera access and packaged WASM assets when using loadWasmBackend()

Package docs:

• packages/eeg-web/README.md · npm
• packages/eeg-web-ble/README.md · npm
• packages/rppg-web/README.md · npm
• packages/create-elata-demo/README.md · npm

Common Repo Workflows

Use run.sh as the canonical task runner:

./run.sh doctor
./run.sh dev all
./run.sh build all
./run.sh demo eeg
./run.sh demo rppg
./run.sh test create-elata-demo
./run.sh test
./run.sh verify-all
./run.sh rust-release-check all

Public Rust crates currently intended for crates.io: elata-eeg-hal, elata-eeg-signal, elata-eeg-models, elata-muse-proto, and elata-rppg. Synthetic, binding-focused, and experimental crates in the workspace are internal unless the release docs explicitly say otherwise.

In-Repo Dev Demos And Examples

The repo also includes in-repo dev demos and example surfaces for SDK development:

• ./run.sh demo rppg builds the in-repo packages/rppg-web demo assets, copies them to a temporary directory, and serves them on http://127.0.0.1:8080 by default.
• ./run.sh demo eeg builds the EEG WASM package and serves eeg-demo/ on http://127.0.0.1:4173 by default.
• ./run.sh demo hal runs the native Rust HAL example.
• ios-demo/ and android-demo/ are native integration references, not the normal browser onboarding path.

Useful flags while working on demos:

• PORT=9000 ./run.sh demo rppg
• KEEP_TMP=1 ./run.sh demo rppg
• EEG_DEMO_BLE=1 ./run.sh demo eeg
• EEG_DEMO_BLE=1 EEG_DEMO_BLE_TEST=1 ./run.sh demo eeg

Use these in-repo dev demos when developing or debugging the SDK itself. For a clean end-user starting point, prefer create-elata-demo.

Contributing

If you want to contribute, start with CONTRIBUTING.md. It covers setup, PR flow, testing expectations, and changesets.

If you want a quick repo walkthrough first, see the contributor video: Elata SDK contributor walkthrough

If you are working with AI coding agents in this repo, also read AGENTS.md.

Local EEG package linking

sync-to still exists, but it is only for local packages/eeg-web development. It builds the EEG WASM wrapper and installs that package into an existing local app.

./run.sh sync-to ../my-app
SAVE=1 ./run.sh sync-to ../my-app
./run.sh sync-to ../my-app debug

Use create-elata-demo for new apps. Use sync-to only when iterating on the local EEG package against an app you already have.

Docs Map

• docs/README.md: docs index
• elata-docs/README.md: Mintlify docs site submodule for docs.elata.bio
• docs/repo-map.md: package ownership and repo layout
• docs/create-elata-demo.md: scaffolding workflow
• docs/dev_setup.md: local setup and iteration tips
• docs/guides/README.md: consumer guide index
• docs/guides/getting-started.md: fastest path to a running app
• elata-docs/sdk/guides/example-apps.mdx: example applications on the docs portal as Example Applications
• docs/guides/choose-the-right-package.md: package selection help
• docs/guides/using-eeg-in-a-browser-app.md: browser EEG integration guide
• docs/guides/using-web-bluetooth-with-supported-devices.md: browser Web Bluetooth headset flow
• docs/contributing-eeg-transports.md: contributing new headset transports
• docs/vendor-headset-onboarding-checklist.md: vendor onboarding checklist for new headset support
• docs/guides/using-rppg-in-a-browser-app.md: browser rPPG integration guide
• docs/guides/compatibility.md: browser, device, and tooling expectations
• docs/guides/troubleshooting.md: common setup and runtime failures
• docs/sdk-adoption-baseline.md: current onboarding baseline and friction summary
• docs/sdk-adoption-issues.md: grouped issue list for remaining SDK DX work
• docs/maintainers.md: maintainer-focused workflow guide
• docs/releasing.md: release and publish flow

Architecture and planning notes:

• docs/architecture-rppg.md
• docs/architecture-sentiment.md
• docs/implementation-plan-rppg.md
• docs/implementation-plan-sentiment.md
• docs/implementation-plan-demo-scaffolding.md
• docs/implementation-plan-sdk-adoption.md
• docs/implementation-plan-ios-safari-ble-bridge.md
• docs/implementation-plan-harmonic-selection.md

Some implementation-plan docs are historical or exploratory snapshots. Treat run.sh, package READMEs, and the maintainer/scaffolding docs above as the current operational source of truth.

Contributor And Agent Guides

• CONTRIBUTING.md: contributor workflow
• AGENTS.md: repo-specific instructions for AI coding agents
• CODE_OF_CONDUCT.md
• SECURITY.md

License

MIT