Access the Muse SDK for iOS, Android, or Windows HERE >
The zip files for iOS or Android contain frameworks & examples, as well as SDK
Documentation. This library enables communication with and control of Muse
headbands from client software.
LibMuse is a library for interfacing with Muse headbands. It can connect to them,
read their state, and receive EEG, accelerometer, gyroscope, and other data
packet types. Also provided in the library are classes for saving and reading data
in the .muse file format, simulating playback, and managing log messages.
What is the Muse SDK & what is included?
Muse SDK provides a public API for interacting with Muse devices. It handles the
Bluetooth connection and asynchronously manages that connection.
By linking with the Muse library, an application can gain access to signals from
the sensors on the Muse headband (EEG, PPG, accelerometer, etc.) along with a
few processed signals as identified in the SDK documentation. Also provided in
the library are classes for saving and reading data in the .muse file format,
simulating playback, and managing log messages.
Included:
■ We have releases for iOS and Android at this time. In the future, we are
looking to offer Windows, Unreal, and Unity releases as well.
■ Muse Library - iOS & Android zip files that allow your app to gain access to
signals from the sensors on the Muse headband (EEG, PPG, accelerometer
etc.) along with a few processed signals as identified in the SDK
documentation. However, the SDK does not provide access to the more
advanced processed signals used by the Muse mobile app.
■ Muse Lab - Included with the SDK is a standalone desktop application
called MuseLab with which you can connect to, stream and visualize the
data from a Muse headband.
■ Tutorials - for saving and reading data in the .muse file format, simulating
playback, and managing log messages.
■ Resources - SDK documentation is available as a local HTML in the SDK
download and a Muse Lab Guide pdf document is provided with the Muse
Lab download.
Get Started with SDK
The zip files for iOS or Android contain frameworks & examples, as well as SDK
Documentation. This library enables communication with and control of Muse
headbands from client software.
LibMuse is a library for interfacing with Muse headbands. It can connect to them,
read their state, and receive EEG, accelerometer, gyroscope, and other data
packet types. Also provided in the library are classes for saving and reading data
in the .muse file format, simulating playback, and managing log messages.
How do I use the SDK?
Download the SDK archive appropriate for your platform (iOS, Android) and
extract the SDK files to your computer.
Start by looking at one of the provided examples.
To view the API documentation, open README.html in your browser and click the
"doc" link.
How can I get support for SDK technical questions and
troubleshooting?
Challenges related to the Muse headband, such as the battery, Bluetooth
connectivity, or other hardware difficulties, should be directed to Muse Customer
Care at choosemuse.com/contactsupport/
Please allow 1 - 2 business days for a response.
Does this support building for iOS with a unity plugin?
It is possible but not technically supported as we haven't any testing in place for
it. It is highly version-dependent (iOS, XCode, macOS) and the released version
may not be compatible with the most recent iOS and XCode versions.
