A modern JavaScript library for connecting to Muse EEG devices using Web Bluetooth API. This project aims to provide a maintained alternative to muse-js which is no longer actively maintained.
- 🔄 Active Development: Unlike muse-js, web-muse is actively maintained and works with current Muse firmware
- 🌐 Web Bluetooth: Direct browser connection without additional software
- ⚛️ React Integration: Built-in React hooks and context for easy integration
- 🧪 Mock Data: Development support with mock data capabilities
- 📊 Signal Processing: Built-in EEG processing utilities
- Direct connection to Muse EEG devices via Web Bluetooth
- Real-time EEG data streaming at 256Hz
- Built-in signal processing utilities
- React hooks and context for easy integration
- Mock data mode for development and testing (no device required!)
- Support for:
- EEG data (4 channels)
- PPG data (3 channels)
- Accelerometer data
- Gyroscope data
- Battery level monitoring
- Clone the repository:
git clone https://github.com/itayinbarr/web-muse.git
cd web-muse- Install dependencies:
npm install- Build the library:
npm run buildYou can install web-muse directly from your local clone using one of these methods:
# In web-muse directory
npm link
# In your project directory
npm link web-museAdd this to your project's package.json:
{
"dependencies": {
"web-muse": "file:../path/to/web-muse"
}
}Then run npm install
Add this to your project's package.json:
{
"dependencies": {
"web-muse": "github:itayinbarr/web-muse"
}
}Then run npm install
import { connectMuse } from "web-muse";
async function connectToMuse() {
// Connect to a real Muse device
const muse = await connectMuse();
console.log("Connected to Muse device:", muse);
// Start receiving EEG data
setInterval(() => {
const eegData = muse.eeg.map((buffer) => buffer.read());
console.log("EEG Data:", eegData);
}, 1000 / 256); // 256Hz sampling rate
}
// Or use mock mode for development (no device required!)
async function connectToMuseMock() {
const muse = await connectMuse({ mock: true });
console.log("Connected in mock mode:", muse);
// Same API - works identically to real device
setInterval(() => {
const eegData = muse.eeg.map((buffer) => buffer.read());
console.log("Mock EEG Data:", eegData);
}, 1000 / 256);
}import { useEEG, EEGProvider } from "web-muse/react";
// Wrap your app with the provider
function App() {
return (
<EEGProvider>
<YourComponent />
</EEGProvider>
);
}
// Use the hook in your components
function YourComponent() {
const { isConnected, connectMuse, rawEEG } = useEEG();
const handleConnectReal = async () => {
await connectMuse();
};
const handleConnectMock = async () => {
await connectMuse({ mock: true });
};
return (
<div>
{!isConnected ? (
<>
<button onClick={handleConnectReal}>Connect to Real Device</button>
<button onClick={handleConnectMock}>Use Mock Data</button>
</>
) : (
<div>EEG Data: {JSON.stringify(rawEEG)}</div>
)}
</div>
);
}Mock mode allows you to develop and test your application without a physical Muse device. It plays back pre-recorded EEG data in a loop, providing realistic data for development and testing.
Vanilla JavaScript:
import { connectMuse } from "web-muse";
// Connect with mock data
const muse = await connectMuse({ mock: true });
// Optionally specify a custom CSV file
const muse = await connectMuse({
mock: true,
mockDataPath: "/path/to/your/data.csv",
});Direct Instantiation:
import { Muse } from "web-muse";
const muse = new Muse({ mock: true });
await muse.connect();The default mock data is located at assets/resting-state.csv and contains real EEG recordings from a Muse device. The format is:
Timestamp (ms),TP9 (left ear),AF7 (left forehead),AF8 (right forehead),TP10 (right ear)
5,-0.48828125,0,-0.48828125,-0.48828125
7,0,-0.48828125,-0.48828125,0
...You can provide your own CSV file in the same format for custom mock data scenarios.
# Install dependencies
npm install
# Run example
npm run dev
# Build library
npm run build
# Run tests
npm test- A Muse headband (tested with Muse 2 and Muse S)
- A Web Bluetooth-compatible browser:
- Chrome (desktop & android)
- Edge (desktop)
- Opera (desktop & android)
- Samsung Internet (android)
Note: Safari and iOS devices do not currently support Web Bluetooth.
Web Bluetooth API is required. Check browser compatibility.
MIT
- Thanks to muse-js for pioneering Web Bluetooth support for Muse devices
- Thanks to Interaxon for creating the Muse headband