neuromore Studio
Editions and licensing
These docs show what the neuromore system can do. Community builds on GitHub do not include every device driver. Developers can add those drivers in their own source build. Commercial clients can get the integration as part of their custom build. Each device is labelled, so check the label before you buy hardware.
Community builds and commercial clients
Section titled “Community builds and commercial clients”| Community builds | Commercial clients | |
|---|---|---|
| Where builds come from | GitHub releases, or your own source build | Usually a custom build arranged with neuromore |
| Devices | The devices in What community builds include. You can add others in a source build | The integration, as part of the custom build |
| Account | A neuromore account | Their own neuromore account |
| Cloud | The neuromore cloud | Their own instance of the neuromore cloud, deployed in their own cloud account |
Status labels
Section titled “Status labels”Device pages use these labels:
- Supported: implemented in the code and intended for use.
- Beta: implemented and available, with documentation and validation still in progress.
- R&D: designed or explored, not implemented end to end.
- Planned: agreed target, not started.
- Legacy: superseded, or dependent on a component no longer shipped.
- Not in public build: not compiled into community builds. Available through a source build or a custom build, unless the entry says otherwise.
What community builds include
Section titled “What community builds include”| Platform | Devices compiled in |
|---|---|
| All platforms | Test Device, OpenBCI Cyton and Cyton plus Daisy, InteraXon Muse, SenseLabs Versus, Neurosity Notion and Crown, BrainFlow boards, Bluetooth LE heart rate sensors |
| Windows and Linux | eemagine eego (ANT Neuro) |
| Windows | Mitsar EEG 201 |
| Windows x86 package only | BrainMaster Discovery 20 |
Some of these need more than the build, such as a vendor library or a helper program. See Biosensors for each device’s status and setup, and Devices for transports and channels.
Mindfield eSense, gamepad, accelerometer and gyroscope are also compiled in, but Studio has no data source for them, so their nodes stay without data. See Devices.
In 1.7.3: The same devices are compiled in.
What community builds do not include
Section titled “What community builds do not include”These devices are part of the system’s capability, but they do not work in a community build:
- Emotiv EPOC, EPOC+ and Insight: Not in public build. Available through a source build (community) or a custom build (commercial clients). Windows; the vendor SDK is not in the repository.
- NeuroSky MindWave: Not in public build. Available through a source build (community) or a custom build (commercial clients). Windows; the vendor SDK is not in the repository.
- Tobii EyeX: Not in public build. Available through a source build (community) or a custom build (commercial clients). Windows; the vendor SDK is not in the repository.
- ABM B-Alert X10 and X24: Not in public build. Available through a source build (community) or a custom build (commercial clients). Windows 32-bit; vendor headers not in the repository.
- Brainquiry PET 4.0: Not in public build. Available through a source build (community) or a custom build (commercial clients). Windows 32-bit; vendor headers not in the repository.
- Brain Products actiCHamp: Not in public build. Available through a source build (community) or a custom build (commercial clients). Windows; the source has only a driver skeleton with no data path, so a build must complete it.
Device availability in Studio
Section titled “Device availability in Studio”A device being compiled in doesn’t mean you will see it. Three more things decide that.
Your account. Availability depends on your neuromore account. Without access to a device, Studio shows neither its node nor its driver, if it has one. BrainFlow is the exception: it is available to every account. To check, look under NMStudio > Settings > Devices > Drivers and in the Sensors category of the node palette. InteraXon Muse and Neurosity Notion and Crown have no driver entry for any account, so check only the Sensors category for them. If a device is missing from where it should appear, contact neuromore.
Drivers that are off by default. In community builds, turn these on under NMStudio > Settings > Devices > Drivers:
| Driver setting | Devices |
|---|---|
| Enable Bluetooth Devices | Bluetooth LE heart rate sensors |
| Enable Senselabs Devices | SenseLabs Versus |
| Enable Mitsar Devices | Mitsar EEG 201 |
Devices covers what else each of these needs. Most drivers you add in a source build are also off by default, see Source builds.
The Test Device. Studio adds it by itself when no device is connected, and removes it when a real device connects. This is normal.
Source builds
Section titled “Source builds”The public repository lets developers build Studio and add drivers themselves. Adding one of the devices above is real work, not a setting:
- Follow BUILDING.md until you have a working build.
- Get the vendor’s SDK from the vendor.
- Put the SDK files where the “Engine Devices” section of BUILDING.md says.
- Uncomment the device’s
#defineline insrc/Engine/Config.h. BUILDING.md lists the flags. These flags sit in the Windows section of the file, so these devices need a Windows build. The ABM and Brainquiry flags sit in its 32-bit part. - Check that the
.libfiles are indeps/prebuilt/win/x86for a 32-bit build, ordeps/prebuilt/win/x64for a 64-bit build. Studio’s Windows code already names the libraries for these devices, except actiCHamp, so you don’t add them to the link settings. - Build and sign in.
- Under NMStudio > Settings > Devices > Drivers, tick the driver’s checkbox. Enable Emotiv Devices, Enable NeuroSky Devices, Enable Advanced Brain Monitoring Devices and Enable Tobii Devices are off by default. Enable Brainquiry Devices is on by default.
- Look for its node in the Sensors category of the node palette.
actiCHamp has no checkbox. Its driver is not registered, so a build must register it as well as complete it.
Three limits apply to a source build of Studio:
- It still needs a neuromore account, because there is no offline mode. The cloud backend code is not in the public repository.
- It still checks your account, so a device you compiled in appears only if your account has access to it. Tobii EyeX is the exception: it has no account check.
- It still checks its version when it starts. Studio closes if the neuromore cloud reports a newer version, see Installation.
The Engine library has no account check. It registers every device compiled into it, see Engine library and source builds.
Downloads
Section titled “Downloads”Community builds are published on GitHub releases. The latest public release is 1.7.3, with packages for Windows, macOS and Ubuntu. You can also build from source. The public source does not yet include every 1.8.2 change.
Commercial clients get builds in a different way, usually a custom build arranged with neuromore. Contact neuromore.
Installation lists the packages for each system.
Account and cloud
Section titled “Account and cloud”neuromore Studio requires a neuromore account. You sign in when Studio starts, and there is no offline mode. You can create a free community account. Studio sends session details to the neuromore cloud when a session ends. Whether physiological data is uploaded depends on your account. See the Privacy Policy.
Commercial clients can have their own instance of the neuromore cloud, deployed in their own cloud account, and their own neuromore account. Contact neuromore or see the Platform page.
Licensing
Section titled “Licensing”Licensing: see neuromore Licensing, the Terms & Conditions, the End User Agreement and the Privacy Policy.
Licence text: neuromore Public License.
Vendor SDK licensing is not yet confirmed.
The first time you log in, Studio shows the Licenses window with the tabs Licensing, Terms and Conditions, and Privacy Policy. Click I Agree to continue. Cancel closes Studio. To read them again, open Help > Licenses.