BFiVRC: BrainFlowsIntoVRChat

This is a BrainFlow implementation of my bci-workshop fork that sends your brain's relaxation and focus metrics, and power values based on the common frequency bands used in EEG measuements, for left, right and both sides of the head. Logic to read actions off of your brainwaves using machine learning. Read the README.md in the model/intent directory for more information. Additional support for heart rate and respiration is available when supported by your hardware.

Why BrainFlow?

The BrainFlow library provides a uniform API that is device agnostic, allowing this implementation of my workshop fork to work for all supported biosensors (including the muse headbands). No extra software needed!

Demos

Instructions

Download this project to a folder and remember its folder path
Install Python 3.11.5
Open the command prompt by typing searching cmd at the start menu
Navigate to the project's path within the command prompt.
- example: cd "C:\Users\<YOUR USERNAME HERE>\Documents\GitHub\BrainFlowsIntoVRChat"
Execute this command to install needed depedencies: python -m pip install -r requirements.txt
Look up your device's name or board ID: Board IDs Page
Turn on your headband
Run the script main.py with your device name or ID. For example, the command for running with a Muse 2 headband would be: python .\main.py --board-id muse_2_board

OSC Avatar Parameter Schema

Here are the various avatar parameters sent to VRChat. Neurofeedback scores range from -1 to 1 for signed floats, 0 to 1 for unsigned, with higher and lower values corresponding to higher and lower relax/focus scores. Depending on the board you're using, heartrate, respiration and battery information might be available. Power Band numbers are also sent per location as well, ranging from 0 to 1 averaging at 0.2.

To use these parameters within VRChat, write the parameter name as a path. For example, to get the left side alpha value, the parameter name would be:

BFI/PwrBands/Left/Alpha

BFI:
  Info:
    - VersionMajor [int]
    - VersionMinor [int]
    - SecondsSinceLastUpdate [float]
    - DeviceConnected [bool]
    - BatterySupported [bool]
    - BatteryLevel [float]
  NeuroFB:
    - FocusLeft [float]
    - FocusLeftPos [float]
    - FocusRight [float]
    - FocusRightPos [float]
    - FocusAvg [float]
    - FocusAvgPos [float]
    - RelaxLeft [float]
    - RelaxLeftPos [float]
    - RelaxRight [float]
    - RelaxRightPos [float]
    - RelaxAvg [float]
    - RelaxAvgPos [float]
  PwrBands:
    Left:
      - Gamma [float]
      - Beta [float]
      - Alpha [float]
      - Theta [float]
      - Delta [float]
    Right:
      - Gamma [float]
      - Beta [float]
      - Alpha [float]
      - Theta [float]
      - Delta [float]
    Avg:
      - Gamma [float]
      - Beta [float]
      - Alpha [float]
      - Theta [float]
      - Delta [float]
  Addons:
    - HueShift [float 0-1]
  Biometrics:
    - Supported [bool]
    - HeartBeatsPerSecond [float]
    - HeartBeatsPerMinute [int]
    - OxygenPercent [float]
    - BreathsPerSecond [float]
    - BreathsPerMinute [int]

Migration from Old Parameter Schema

Need to migrate your existing prefabs? Convert their parameter names using this wiki: Migration of Old Parameters

Parameter Descriptions

Utility

These utility Parameters give basic information about your device and BFiVRC | Parameter | Description | Type | | ------ | ----- | ----- | | BFI/Info/VersionMajor | The major version number of current parameter schema | Int | | BFI/Info/VersionMinor | The minor version number of current parameter schema | Int | | BFI/Info/SecondsSinceLastUpdate | The refresh rate of BFiVRCs data stream | Float | | BFI/Info/DeviceConnected | The connection status of your device to BFiVRC | Bool | | BFI/Info/BatterySupported | If your device supports sending battery status to BFiVRC | Bool | | BFI/Info/BatteryLevel | The current charge status of your devices battery | Float |

Neurofeedback

These Parameters are calculated based on your current mental state and make use of the full signed positive and negative float range. | Parameter | Description | Type | Range | | ------ | ----- | ----- | ----- | | BFI/NeuroFB/FocusLeft | Left Unfocused to Focused | Float | [-1.0, 1.0] | | BFI/NeuroFB/FocusRight | Right Unfocused to Focused | Float | [-1.0, 1.0] | | BFI/NeuroFB/FocusAvg | Unfocused to Focused | Float | [-1.0, 1.0] | | BFI/NeuroFB/RelaxLeft | Left Excited to Relaxed | Float | [-1.0, 1.0] | | BFI/NeuroFB/RelaxRight | Right Excited to Relaxed | Float | [-1.0, 1.0] | | BFI/NeuroFB/RelaxAvg | Excited to Relaxed | Float | [-1.0, 1.0] |

These are the same Neurofeedback scores remapped to the positive 0 to 1 range for cases where it may be required. | Parameter | Description | Type | Range | | ------ | ----- | ----- | ----- | | BFI/NeuroFB/FocusLeftPos | Left Unfocused to Focused | Float | [0.0, 1.0] | | BFI/NeuroFB/FocusRightPos | Right Unfocused to Focused | Float | [0.0, 1.0] | | BFI/NeuroFB/FocusAvgPos | Unfocused to Focused | Float | [0.0, 1.0] | | BFI/NeuroFB/RelaxLeftPos | Left Excited to Relaxed | Float | [0.0, 1.0] | | BFI/NeuroFB/RelaxRightPos | Right Excited to Relaxed | Float | [0.0, 1.0] | | BFI/NeuroFB/RelaxAvgPos | Excited to Relaxed | Float | [0.0, 1.0] |

PowerBand

These Parameters give the power value for the common frequency bands used in EEG measurements, measured per location. For more information on what each power band means, read more about it here: What are Brainwaves | Parameter | Description | Type | Range | | ------ | ----- | ----- | ----- | | BFI/PwrBands/Left/Alpha | Left brainwaves Alpha band | Float | [0.0, 1.0] | | BFI/PwrBands/Right/Alpha | Right brainwaves Alpha band | Float | [0.0, 1.0] | | BFI/PwrBands/Avg/Alpha | Brainwaves Alpha band | Float | [0.0, 1.0] | | BFI/PwrBands/Left/Beta | Left brainwaves Beta band | Float | [0.0, 1.0] | | BFI/PwrBands/Right/Beta | Right brainwaves Beta band | Float | [0.0, 1.0] | | BFI/PwrBands/Avg/Beta | Brainwaves Beta band | Float | [0.0, 1.0] | | BFI/PwrBands/Left/Theta | Left brainwaves Theta band | Float | [0.0, 1.0] | | BFI/PwrBands/Right/Theta | Right brainwaves Theta band | Float | [0.0, 1.0] | | BFI/PwrBands/Avg/Theta | Brainwaves Theta band | Float | [0.0, 1.0] | | BFI/PwrBands/Left/Delta | Left brainwaves Delta band | Float | [0.0, 1.0] | | BFI/PwrBands/Right/Delta | Right brainwaves Delta band | Float | [0.0, 1.0] | | BFI/PwrBands/Avg/Delta | Brainwaves Delta band | Float | [0.0, 1.0] | | BFI/PwrBands/Left/Gamma | Left brainwaves Gamma band | Float | [0.0, 1.0] | | BFI/PwrBands/Right/Gamma | Right brainwaves Gamma band | Float | [0.0, 1.0] | | BFI/PwrBands/Avg/Gamma | Brainwaves Gamma band | Float | [0.0, 1.0] |

Addons

These Parameters are additional functions of BFiVRC | Parameter | Description | Type | Range | | ------ | ----- | ----- | ----- | | BFI/Addons/HueShift | This Parameter uses combinations of relax/focus to drive a single float Parameter for material fx | Float | [0.0, 1.0] |

Biometrics

These Parameters read other biometric data from your device if supported by your hardware | Parameter | Description | Type | Range | | ------ | ----- | ----- | ----- | | BFI/Biometrics/Supported | If your hardware supports heart rate and respiration readouts | Bool | True/False | | BFI/Biometrics/HeartBeatsPerSecond | Your heartrate calculated per second | Float | [0.0, inf) | | BFI/Biometrics/HeartBeatsPerMinute | Your heartrate calculated per minute | Int | [0, 255] | | BFI/Biometrics/OxygenPercent | Percentage of oxygen in blood | Float | [0.0, 1.0] | | BFI/Biometrics/BreathsPerSecond | Estimated breaths taken per second | Float | [0.0, inf) | | BFI/Biometrics/BreathsPerMinute | Estimated breaths taken per minute | Int | [0, 255] |

Debugging and Logging

To make it easier to debug, add --debug launch argument. This will enable the console to display debug messages for all OSC messages sent as well as make the parameter names shorter so that they are readable on VRChat's OSC debug panel as well as any other OSC displays.
To record values per second, add --enable-logs launch argument. This will create timestamped logs under logs folder and can help visualize the values to assist with adjusting animations and the like.

Using Old Parameter Scheme

We recommend updating to this schema. However, if your assets are still using the old parameter scheme, you can switch to them by adding the --use-old-reporter launch argument.

Thanks

Thanks to

@Mitzi_DelverVRC and AartHark for help with PPG signal work.
@wordweaver1001 for intial user testing.
AtriusX for helping create a parameter schema.
sync1211

BrainFlowsIntoVRChat

Install / Use

README