After attempting to install this project from the parent repo, I discovered that the project wasn't complete and the instructions did not function. I've updated the project to make it installable and runnable.

Here's a list of changes from the previous version:

• Add comprehensive build system with Rollup
• Generate ESM and CommonJS builds with source maps
• Add production-ready minified versions
• Create interactive demo page with real-time EEG visualization
• Update package.json with proper exports and build scripts
• Add comprehensive .gitignore for clean version control
• Enhance README with setup instructions and troubleshooting
• Add Muse S pairing guide and multi-point Bluetooth notes
• Include React component entry point

I'm not sure of the direction the auther would like to take the project so didn't make these changes as a pull requiest, I'm happy to make one if the author desires.

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 support for development
• Support for:
  • EEG data (4 channels)
  • PPG data (3 channels)
  • Accelerometer data
  • Gyroscope data
  • Battery level monitoring

1. Clone the repository:

git clone https://github.com/itayinbarr/web-muse.git
cd web-muse

2. Install dependencies:

npm install

3. Build the library:

npm run build

You can install web-muse using one of these methods:

# In web-muse directory
npm link

# In your project directory
npm link web-muse

Add 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

The library is built into multiple formats for maximum compatibility:

• ES Module (dist/web-muse.esm.js) - For modern browsers and bundlers with tree-shaking support
• CommonJS (dist/web-muse.cjs.js) - For Node.js and older bundlers
• Minified versions of both formats for production use

// For modern bundlers (recommended)
import { connectMuse } from "web-muse";

// For Node.js or older bundlers
const { connectMuse } = require("web-muse");

async function connectToMuse() {
  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
}

// Import React components (when available)
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();

  return (
    <div>
      {!isConnected ? (
        <button onClick={connectMuse}>Connect to Muse</button>
      ) : (
        <div>EEG Data: {JSON.stringify(rawEEG)}</div>
      )}
    </div>
  );
}

# Install dependencies
npm install

# Build library (creates dist files)
npm run build

# Run tests (when available)
npm test

The project includes an interactive demo page that showcases the web-muse library functionality.

Requirements: The demo requires a secure HTTP context for Web Bluetooth to work properly.

# Start the local web server (in a separate terminal)
python3 -m http.server 8080

# Or if you have Node.js:
npx http-server -p 8080

# Then open in browser:
http://localhost:8080/demo.html

You can open demo.html directly in your browser, but Web Bluetooth features won't work because they require HTTPS or localhost for security reasons.

• 🔗 Connect Button: Pair with your Muse headband via Web Bluetooth
• 📊 Real-time EEG Data: Live 4-channel visualization at 256Hz sampling rate
• 🔋 Battery Status: Device information and connection status
• ⚙️ Connection Controls: Start/stop data streaming and recording

• ✅ Chrome (recommended)
• ✅ Edge
• ✅ Opera
• ❌ Safari (no Web Bluetooth support)

1. Charge your Muse headband and ensure it's nearby
2. Enable Bluetooth on your computer
3. Open http://localhost:8080/demo.html in a supported browser
4. Click "Connect to Muse" and follow the pairing process
5. View real-time EEG data streaming immediately!

• 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.

Before using web-muse with your Muse S headband, you need to pair it with the official Muse mobile app first:

1. Prepare your Muse S: Press and hold the power button on your Muse S headband for six seconds until all the indicator lights are blinking.

2. Enable Bluetooth & Location Services: On your smartphone or tablet, go to your device's main settings and make sure Bluetooth and location services are turned on.

3. Open the Muse App: Open the Muse app on your mobile device.

4. Start the Pairing Process: Tap the Bluetooth icon in the top-left corner of the app's screen.

5. Connect to Your Muse S: Your Muse ID should appear in a list of available devices; tap on it to complete the pairing process.

Note: Once paired with the mobile app, your Muse S should be discoverable by web browsers that support Web Bluetooth. You typically only need to do this initial pairing once.

⚠️ Important: Muse headbands do not support multi-point Bluetooth connectivity at this time. Muse can only connect to one device at a time. If you're having connection issues, make sure your Muse is not connected to any other devices (including the Muse mobile app) before attempting to connect via web-muse.

Web Bluetooth API is required. Check browser compatibility for the latest support status.

• API Documentation
• Examples

MIT

• Thanks to muse-js for pioneering Web Bluetooth support for Muse devices
• Thanks to Interaxon for creating the Muse headband