https://github.com/junjunjd/rustymind

A driver, parser and real time brainwave plotter for NeuroSky MindWave EEG headset
https://github.com/junjunjd/rustymind

bci brain brain-computer-interface brainwave eeg eeg-headset eeg-readings eeg-signals-processing mindwave neuroscience neurosky plot rust

Last synced: 3 months ago
JSON representation

A driver, parser and real time brainwave plotter for NeuroSky MindWave EEG headset

• Host: GitHub
• URL: https://github.com/junjunjd/rustymind
• Owner: junjunjd
• License: mit
• Created: 2021-05-18T06:47:24.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-04-25T21:24:21.000Z (almost 3 years ago)
• Last Synced: 2024-10-31T12:15:37.826Z (3 months ago)
• Topics: bci, brain, brain-computer-interface, brainwave, eeg, eeg-headset, eeg-readings, eeg-signals-processing, mindwave, neuroscience, neurosky, plot, rust
• Language: Rust
• Homepage:
• Size: 776 KB
• Stars: 46
• Watchers: 3
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# rustymind

[![crates.io](https://img.shields.io/crates/v/rustymind.svg?style=flat-square)](https://crates.io/crates/rustymind)

[![api_doc](https://img.shields.io/badge/doc-api-blue)](https://docs.rs/rustymind)

Rustymind is a driver and parser for NeuroSky MindWave EEG headset written in pure Rust. You can use it to connect, interact, and plot real time brainwave data measured from the headset.

The parser is based on the [mindwave mindset communication protocols](./docs) published by NeuroSky.

See below for a screenshot of real time mindwaves plotted by `rustymind-plot` CLI based on `rustymind` parser.

![Real time plot screenshot](./docs/plot_demo.png)

## Getting Started

`rustymind-plot` takes two arguments to run:

- MindWave device path. On Mac, the path would be in the format of `/dev/tty.usbserial-10000`

- Headset ID (printed inside the battery case)

```sh

cargo run --bin rustymind-plot "/dev/tty.usbserial-10000" a05f

```

If you don't pass in the headset ID argument, the dongle will auto-connect to any headsets it can find.

To use `rustymind` as a library, you need to use `connect_headset` function and `Parser` struct. For example:

```rust

use rustymind::{connect_headset, PacketType, Parser};

let mut port = connect_headset("/dev/tty.usbserial-10000", b"\xa0\x5f")?;

let mut buffer: Vec = vec![0; 2048];

let mut parser = Parser::new();

loop {

    let bytes_read = port.read(buffer.as_mut_slice()).unwrap();

    for i in 0..bytes_read {

        if let Some(x) = parser.parse(buffer[i]) {

            for r in x {

                match r {

                    PacketType::Attention(value) => {

                        println!("Attention value = {}", value);

                    }

                    PacketType::Meditation(value) => {

                        println!("Meditation value = {}", value);

                    }

                    PacketType::AsicEeg(value) => {

                        println!("EEG power values = {:?}", value);

                    }

                    _ => (),

                }

            }

        }

    }

}

```

This software is not intended to be used in medical diagnostics or medical

treatment.