Muse Gestures is a Java library used for recognizing specific gestures using a Muse headband. It includes an interface and server class which allow you to create classes which will automatically have certain methods called when gestures are performed.
public class MuseCar implements MuseGestures {
public MuseCar() {
int port = 5000;
MuseGestureServer server = new MuseGestureServer(this, port);
server.start();
}
public void onBlink() {
System.out.println("Flash lights!")
}
public void onJawClench() {
this.goForward();
}
}
For a complete list of the recognized gestures, see the documentation on MuseGesture.
In order to be able to use the Muse Gestures library in a project, you can include the jar for the library in most build tools using JitPack. Note that you will also need to include the oscP5 library as well, as it is a dependency for the Muse Gestures library.
For example, to include the library in a Gradle project, you should have the following in your build.gradle file:
repositories {
maven { url "https://jitpack.io" }
}
dependencies {
compile "com.github.SUNY-Oswego-MUSE-Project:muse-gestures:0.1.0+", "com.github.sojamo:oscp5:v2.0.4"
}
The Muse Gestures library requires the following libraries in order to be compiled and run:
A copy of the documentation for Muse Gestures is available from the following page. It is manually updated, so it may occasionally be out of date. In order to make sure you have the most up to date version of the documentation you can compile the documentation from source.
The following sections contain information reguarding the development of Muse Gestures.
Muse Gestures can be compiled into a jar file by running the following command from within the main directory of the project:
make jar
The documentation for Muse Gestures can be generated by running the following command from within the main directory of the project:
make doc
Muse Gestures is available under the GPLv3 License, see LICENSE for more information.