README.md

Neurolab Android App

Repository of Android app for the Neurolab Open Hardware platform.

This repository holds the Android app for the Neurolab Hardware. We are developing a neuro-device as a headband with integrated electronics. The goal of the Neurolab project is to create an easy to use open hardware measurement headset device for brain waves that can be plugged into an Android smartphone and a software application and enables us to understand our brains better.

Buy

• You can get the device in future from the FOSSASIA Shop.
• More resellers will be listed on the PSLab website.

Communication

• The Neurolab chat channel is on Gitter.
• Please also join us on the Mailing List.

Screenshots

One of the On-boarding screens of the app.

Home and launcher screen of the app.

Relax mode - Relaxation screen of the app.

Focus mode - Rocket game screen of the app.

Memory Graph mode - Brain data visualization.

Pin layout screen of the app with pin descriptions.

Meditation mode - Meditations screen of the app.

About us page of the project in the app.

Settings screen of the app with a Developer mode.

Navigation drawer - Navigate to different app screens.

Statistics - Scores generated in Memory Graph mode.

Spectrum - Density spectrum of neuro data in Memory Graph mode.

Goal

Our brains communicate through neurotransmitters and their activity emits electricity. The neuroheadset measures that electricity on the skin of the forehead and the software processes the signal so that it can translated into a visual or auditory representation. The data that can be collected can be analysed to identify mental health, stress, relaxation and even diseases like Alzheimer.

Current devices in the medical industry are usually not accessible by doctors due to their high pricing. They are also complicated to use. The idea of the device is to integrate it into a headband and focus on signals that can be obtained through the frontal lobe.

A difference to existing projects like OpenBCI is that it will not be necessary to 3D print large headsets. Instead we are focusing on creating a device that collects as much data as possible through the forehead. To achieve this goal we are using high-grade sensors and flexible electronics.

Features

Please check out the in-development features of the app like the Meditation mode, Bluetooth mode, etc. by enabling the Developer mode from the settings menu.

Image Feature Description Status Launcher Screen The four major program modes: Focus, Relax, Memory Graph, Meditation, Every program mode is responsible for specific activities and games with your brain activity. ✔️ Focus program Mode Focus program mode helps users to increase their focus and concentration power by playing games. The rocket game comes with features like play, stop, record, program info, datalogger, seek to specific time, etc. ✔️ Relax program mode Relax program mode is intended to help users relax his mind and diminish their stress in life. 🔜 In Progress Memory Graph program mode Memory Graph is a data visualization mode with the help of graphs, user friendly stats and a density spectrum. Users can import a dataset into the datalogger from where they can visualize it in the actual mode. This mode is implemented with features like play, stop, record, data logger, etc. ✔️ Meditation program mode Meditation program mode helps users with providing different categories of meditations which they can choose depending upon their mood. Every category has a list of meditations directed for that particular mood. Development Mode

App workflow Videos

• NeuroLab App Overview
• Device recording and file rename features

Dependencies

• Preference Fix Library
• JSyn Library
• Android About Page
• Open Sound Control library
• Java Simple Serial Connector
• JTransforms
• Java Open GL
• Circle ImageView
• MP Android Chart - Chart Library
• USB Serial Controller
• App Intro
• JFreeChart
• OpenCSV
• Gson

Branch Policy

We have the following branches

• development All development goes on in this branch. If you're making a contribution, you are supposed to make a pull request to development. PRs to development branch must pass a build check and a unit-test check on Circle CI.
• master This contains shipped code. After significant features/bugfixes are accumulated on development, we make a version update and make a release.
• apk This branch contains two apk's, that are automatically generated on the merged pull request a) debug apk and b) release apk.

Contributions Best Practices

Please help us follow the best practice to make it easy for the reviewer as well as the contributor. We want to focus on the code quality more than on managing pull request ethics.

• Single commit per pull request
• Reference the issue numbers in the commit message. Follow the pattern Fixes #<issue number> <commit message>
• Follow uniform design practices. The design language must be consistent throughout the app.
• The pull request will not get merged until and unless the commits are squashed. In case there are multiple commits on the PR, the commit author needs to squash them and not the maintainers cherrypicking and merging squashes.
• If the PR is related to any front end change, please attach relevant screenshots in the pull request description.
• Before you join development, please set up the project on your local machine, run it and go through the application completely. Press on any button you can find and see where it leads to. Explore.
• If you would like to work on an issue, drop in a comment at the issue. If it is already assigned to someone, but there is no sign of any work being done, please free to start working on it.

Maintainers and Developers

• Jaideep Prasad (@jddeep)
• Mario Behling (@mariobehling)
• Padmal (@CloudyPadmal)

License

This project is licensed under the GNU General Public License v3.0. A copy of LICENSE is to be present along with the source code. To obtain the software under a different license, please contact FOSSASIA.