跳转到主要内容

Documentation Index

Fetch the complete documentation index at: https://docs.elata.bio/llms.txt

Use this file to discover all available pages before exploring further.

​
Installation

pnpm add @elata-biosciences/eeg-web-ble @elata-biosciences/eeg-web
eeg-web-ble depends on eeg-web for shared frame types and the WASM module.

​
Requirements

  • Browser with Web Bluetooth support (Chrome/Edge on desktop or Android)
  • Served from a secure context (https://)
  • Safari/iOS does not support Web Bluetooth — see platform notes for alternatives

​
Basic Usage

import { initEegWasm } from "@elata-biosciences/eeg-web";
import { BleTransport } from "@elata-biosciences/eeg-web-ble";

// Initialize WASM first
await initEegWasm();

// Create transport
const transport = new BleTransport();

// Handle incoming EEG frames
transport.onFrame = (frame) => {
  console.log(`EEG samples: ${frame.eeg.samples.length} rows`);
  console.log(`Channels: ${frame.eeg.channelNames.join(", ")}`);
};

// Handle connection status changes
transport.onStatus = (status) => {
  console.log(`Transport: ${status.state}`, status.reason || "");
};

// Connect and start streaming
await transport.connect();   // triggers Bluetooth device picker
await transport.start();     // begins EEG data stream

// ... later
await transport.stop();
await transport.disconnect();

​
BleTransport Lifecycle

MethodWhat it does
connect()Opens Bluetooth device picker, pairs, and prepares session
start()Begins EEG data stream; onFrame callbacks fire
stop()Stops the data stream; connection stays open
disconnect()Releases the Bluetooth session

​
BleTransportOptions

const transport = new BleTransport({
  sourceName: "my-app-ble",           // name tag in frame.source
  deviceOptions: {
    athenaDecoderFactory: () => new AthenaWasmDecoder(),  // for Athena headbands
    logger: (msg) => console.debug(msg),
    onDisconnected: () => console.warn("Device disconnected"),
  },
});
OptionTypeDescription
sourceNamestringIdentifier included in HeadbandFrameV1.source
deviceOptionsMuseDeviceOptionsPassed to underlying MuseBleDevice
deviceBleDeviceLikeInject a custom device implementation

​
Athena Support

Muse S headbands with Athena firmware require an Athena decoder factory: 
import { AthenaWasmDecoder } from "@elata-biosciences/eeg-web";
import { BleTransport } from "@elata-biosciences/eeg-web-ble";

const transport = new BleTransport({
  deviceOptions: {
    athenaDecoderFactory: () => new AthenaWasmDecoder(),
  },
});
Athena headbands provide 8 EEG channels, optics, accelerometer/gyroscope, and battery data in each frame.

​
Device Info

After connecting, you can query device metadata: 
await transport.connect();

const isAthena = transport.getIsAthena();
const boardInfo = transport.getBoardInfo();
const channelNames = transport.getEegNames();

​
Next

Muse Device Details

Protocol details, characteristics, and compatibility

EEG + BLE Integration

End-to-end streaming and processing guide