MatNIC Matlab Toolkit

From Neuroelectric's Wiki
Jump to: navigation, search

Controlling NIC with Matlab: the MatNIC toolkit

MatNIC Remote stimulation client is a Matlab toolkit for agile, programmatinc control of NE devices for advanced researchers. MatNIC functions give you full control of all Neuroelectrics devices. With MatNIC you can, for example, modify in real-time any stimulation parameter, or receive and process EEG data.

For more information, visit the Neuroeletrics website in order to see video tutorials. And if you are interested, please contact us for pricing and more information.


The MatNIC zip file (contact us for more info) contains the following:

- The MatNIC user manual (an explanation on how to use the Matlab functions to remotely control NIC and examples)
- MatNIC, a folder with all the Matlab functions for remotely controlling NIC)


With MatNIC you can command the following actions:

/--------------------------------------------------\
| Action                       | Device            |
|--------------------------------------------------|
| Start EEG streaming          | Enobio & StarStim |
| Stop EEG streaming           | Enobio & StarStim |
| Start Stimulation            | StarStim          |
| Abort Stimulation            | StarStim          |
| Online tACS Frequency Change | StarStim          |
| Online tACS Amplitude change | StarStim          |
| Online tDCS Amplitude change | StarStim          |
| Online tRNS Amplitude change | StarStim          |
| Load template                | StarStim          |
| Request status               | Enobio & StarStim |
\--------------------------------------------------/

NIC responds to those commands with a set of status commands to indicate whether the commands are successfully processed, the stimulation is ready to be started and so on. The following table shows all the possible status value that NIC might send.

/--------------------------------------------------------\
| Status                             | Device            |
|--------------------------------------------------------|
| Remote control allowed             | Enobio & StarStim |
| Remote control rejected            | Enobio & StarStim |
| Device is idle                     | Enobio & StarStim |
| EEG streaming is ON                | Enobio & StarStim |
| EEG streaming is OFF               | Enobio & StarStim | 
| Template not loaded                | StarStim          |
| Template loaded                    | StarStim          |
| Stimulation is ready to be started | StarStim          |
| Stimulation is ON                  | StarStim          |
| Stimulation is OFF                 | StarStim          |
\--------------------------------------------------------/

To run the example please make the following call:

>> ret = RemoteStimulationClient (templateName, '127.0.0.1', 1235)

where templaName is set with a name of an already defined stimulation template NIC, then the host where NIC is running (in the example above we use the localhost IP, so NIC is running in the same computer) and finally the port 1235 which is where the NIC server runs. Here is the header of the example client code:

function [ret] = MatNICTutorial(templateName, host, port)
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% MatNICTutorial
%
% This function implements a client to connect to the NIC Remote
% Stimulation Server. The server is running on the machine where the NIC
% application runs on the port 1235.
%
% The NIC Remote Server waits for the client to send the name of the 
% template that the client wants to use. If the NIC user accepts the
% remote control session, the template is loaded and the client is
% informed when the system is ready to start the stimulation.
%
% The client then might send the code to start the stimulation or the one
% to abort it. The abort command might be sent in any moment of the
% stimulation session. If the stimulation session is aborted locally from
% the NIC GUI the connection is automatically closed so the client needs
% to connect, send the template and wait again for the permission. When
% the stimulation script execution is finished the system prepares itself
% to start again a new stimulation so the code informing about that is
% received.
%
% The client might also send commands to start and stop receiving the EEG
% streaming. The data is received through a separate server on the port
% 1234. The 8/20/32 channel samples are sent in 4 bytes in two's complement.
% The MSB byte is sent first.
%
% The following are the functions to connect, send the commands to the
% - MatNICConnect
% - MatNICConnectQueryStatus
% - MatNICConnectLoadTemplate
% - MatNICConnectOnlineFreqChange
% - MatNICConnectStartStimulation
% - MatNICConnectAbortStimulation
% - MatNICConnectStartEEG
% - MatNICConnectStopEEG
% - MatNICConnectOnlineAtdcsChange
% - MatNICConnectOnlineAtacsChange
% - MatNICConnectOnlineFtacsChange
% - MatNICConnectOnlinePtacsChange
% - MatNICConnectOnlineAtrnsChange
% - MatNICConnectEnableTRNSFilter
%
%
% Input:
% templateName: Name of the template to be loaded on NIC.
% host: Name or IP of the host where NIC is running.
%
% Output:
% ret: Zero or positive number if the function completes successfully. A
% negative number otherwise:
% -1: The connection to the host and port number did not succeed.
% -2: Error writing template name.
% -3: Error reading from server.
% -4: Template not loaded.
% -5: Error writing command to the server.
%
% Author: Javier Acedo (javier.acedo@starlab.es) - Sergi Torrellas (sergi.torrellas@neuroelectrics.com)
% Company: Neuroelectrics
% Created: 16 Jan 2013
% Known issues: None
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Personal tools
Namespaces

Variants
Actions
BASIC USE
EEG APPLICATIONS
STIMULATION (tCS)
DATA ANALYSIS
ADVANCED
Toolbox