https://www.bci2000.org/mediawiki/api.php?action=feedcontributions&feedformat=atom&user=DashmeetkaurBCI2000 Wiki - User contributions [en]2026-06-30T08:40:04ZUser contributionsMediaWiki 1.43.6https://www.bci2000.org/mediawiki/index.php?title=PsychoPy&diff=8452PsychoPy2019-07-31T17:45:58Z<p>Dashmeetkaur: </p>
<hr />
<div>PsychoPy is an open-source application using which a large number of neuroscience, psychology and psychophysics experiments can be performed [1].<br />
The documentation first describes the two components that are developed to remotely start BCI2000 from the PsychoPy, then lists the steps to follow to add the new components in the PsychoPy application and finally goes over two tutorial examples.<br />
<br />
== Components ==<br />
<br />
=== BCI2000Start ===<br />
The component starts up the BCI2000 modules remotely. The component takes two parameters:<br />
; Path : Path to the BCI2000 ''prog'' directory which contains the ''BCI2000Remote.py'' file.<br />
; States : List of new states to add to the BCI2000. The states in the list are defined as follows: 'StateName defaultValue maxValue'. Eg: lastKey 0 255, correctKey 0 1.<br />
<br />
[[File:BCI2000Start.png|alt="BCI2000 start component image showing its parameters"|BCIStart Component]]<br />
<br />
=== BCI2000UpdateState ===<br />
The component defines which state to update and when. It takes the following parameters:<br />
; State Name : The name of the state in BCI2000 to update.<br />
; Response Component Variable : The variable to which the state is be set OR the variable which contains the new value of the state. '''Note-''' the variable is written as ''$VariableName''. <br />
; Use Expression : If it is checked, the code written in 'Expression' is executed for each Frame and the variable specified is not used to update the state.<br />
; Expression : The code to execute for each Frame. It is given for the cases, where the variable is not available and the users want more control over how the state is updated. '''Note-''' the user would have to use commands like ''bci.Execute'' and ''SET STATE'' to update the state in such cases. See [[Programming Reference:BCI2000Remote Class]] and [[User Reference:Operator Module Scripting]] for more details.<br />
<br />
[[File:BCI2000UpdateState.png|alt="BCI2000 update state component image showing its parameters"|BCIUpdateStart Component]]<br />
<br />
== Integrating BCI2000 into PyschoPy ==<br />
Download the PsychoPy from the [https://www.psychopy.org/download.html PyschoPy] website. <br/><br />
Here is a picture of how PsychoPy looks before integrating BCI2000 in it. Notice that in the rightmost column, under '''Custom''' Components, there is no BCI2000 component.<br />
<br />
[[File:PsychoPyWithoutBCI.png|alt="PsychoPy Homepage without BCI2000 Components"|PsychoPy Homepage without BCI2000 Components]]<br />
<br />
<br />
=== Standalone version ===<br />
For Windows, Copy the folders '''BCIStart''' and '''BCIUpdateState''' from ''src/contrib/PsychoPy Components'' directory of your BCI2000 repository into the folder {$PsychoPyHome}\Lib\site-packages\psychopy\experiment\components folder.<br />
<br />
<br />
=== Developer version ===<br />
Copy the folders '''BCIStart''' and '''BCIUpdateState''' from ''src/contrib/PsychoPy Components'' directory of your BCI2000 repository into the folder {$PsychoPyHome}\psychopy\experiment\components.<br />
Open terminal and navigate to the PsychoPy home directory where ''setup.py'' resides.<br />
Run the following command in the terminal: <br/><br />
<code>pip install -e .</code> <br/><br/><br />
<br/><br/><br />
Start Psychopy application and in the builder view, under the '''Custom''' Components (in rightmost column), you should see the two new components - ''BCI2000Start'' and ''BCI2000UpdateState'' as shown in the figure below.<br />
<br />
[[File:PsychoPy_Start.png|alt="PsychoPy Homepage with BCI2000 Components"|PsychoPy Homepage with BCI2000 Components]]<br />
<br />
'''Note:''' Make sure you don't run the experiments on full screen if you are using a single screen. <br />
<br />
== Tutorial ==<br />
In this section, 2 examples are presented to help the user understand the working of the BCI2000 within PsychoPy. The examples modifies the demo stroopExtended (already provided by PsychoPy) and integrates BCI2000 within it. The stroopExtended demo asks user to press certain keys depending on the color shown on the screen and records the response time.<br />
<br />
=== Using Response Component Variable Option ===<br />
In this tutorial, we will add a new state called '''correctKey''' in BCI2000 using PsychoPy. This state will be changed to 1 if the key pressed by user is correct, otherwise 0.<br />
<ol><br />
<li><br />
Open the stroopExtended demo in PsychoPy. This is it should looks. <br/><br />
[[File:PsychoPyDemoStart.png|alt="PsychoPy Stroop Extended Demo"|PsychoPy Stroop Extended Demo]] <br />
</li><br />
<br />
<br/><br />
<li><br />
Start BCI2000 - With '''instruct''' routine on the screen, click on '''BCI2000Start''' and enter the path to the '''prog''' directory of BCI2000 (within which BCI2000Remote.py exists) in ''Path'' field and '''correctkey 0 1''' in the ''States'' field as shown in the image. '''correctKey''' is the name we want the new state to have in BCI2000, '''0''' is the default value the state should have and '''1''' is the maximum value the state can take in any case. <br/><br />
<code>correctkey 0 1</code> <br/><br />
[[File:PsychoPyBciStart1.png|alt="PsychoPy - Add State into BCI2000"|PsychoPy - Add State into BCI2000]] <br />
</li><br />
<br/><br />
<li><br />
Update BCI2000 State - With '''trial''' routine on the screen, click on '''BCI2000UpdateState'''. Fill in the field ''State Name'' with '''$correctKey''' (BCI2000 state we want to update; '$' is used to indicate PsychoPy to treat it as a variable) and ''Response Component Variable'' with '''$resp.corr''' ('resp' is the name of the keyboard which takes the input and 'corr' is its property that stores the whether the key pressed is correct or not; you can see this variable being used in the program when you compile it to script) as shown in the image. This will essentially update the state 'correctKey' with the value of 'resp.corr'. <br/><br />
[[File:PsychoPyBciUpdateState1.png|alt="PsychoPy - Update State in BCI2000"|PsychoPy - Update State in BCI2000]]<br />
</li> <br />
<br/><br />
<li><br />
Run the experiment. BCI2000 will start. Add the newly created state to watch (on BCI2000 operator, click on View -> States and Events.., right click on correctKey and add to watch, click Ok on States and Events screen) and proceed as with your PsychoPy experiment. The output of this experiment would be similar to as shown below. '''Note:''' Make sure you don't run the experiments on full screen if you are using a single screen. <br/><br />
[[File:PsychoPyBciDemoRun1.png|alt="PsychoPy Stroop Extended Demo Run 1"|PsychoPy Stroop Extended Demo Run 1]] <br />
</li><br />
<br/><br />
</ol><br />
<br />
<br />
=== Using Use Expression Option ===<br />
In this tutorial, we will add a new state called '''responseTime''' in BCI2000 using PsychoPy. This state will represent the time the user takes to press the correct key in seconds(with no decimals).<br />
<ol><br />
<li><br />
Open the stroopExtended demo in PsychoPy. This is it should looks. <br/><br />
[[File:PsychoPyDemoStart.png|alt="PsychoPy Stroop Extended Demo"|PsychoPy Stroop Extended Demo]]<br />
</li><br />
<br/><br />
<li><br />
Start BCI2000 - With '''instruct''' routine on the screen, click on '''BCI2000Start''' and enter the path to the '''prog''' directory of BCI2000 (within which BCI2000Remote.py exists) in ''Path'' field and '''responseTime 0 600''' in the ''States'' field as shown in the image. '''responseTime''' is the name we want the new state to have in BCI2000, '''0''' is the default value the state should have and '''600''' is the maximum value the state can take in any case, i.e, the maximum response time could be 10 minutes.<br/><br />
<code>responseTime 0 600</code><br/><br />
[[File:PsychoPyBciStart2.png|alt="PsychoPy- Add State into BCI2000"|PsychoPy - Add State into BCI2000]]<br />
</li><br />
<br/><br />
<li><br />
Update BCI2000 State - With '''trial''' routine on the screen, click on '''BCI2000UpdateState'''. Check on the '''Use Expression''' option to run the expression that is written in '''Expression''' field. Write the lines of code in python language in '''Expression''' field as shown in the image. These lines first set the 'RUNNING' state of BCI2000 to 1 to make sure that BCI2000 is running. It then checks if the type of the 'resp.rt' is float, if yes that means 'resp.rt' stores the response time and sets the state 'responseTime' to the rounded value of 'resp.rt' ('resp' is the name of the keyboard which takes the input and 'rt' is its property that stores the time it took user to press the key; you can see this variable being used in the program when you compile it to script) using the bci.Execute and SET STATE command. <br/><br />
<code>bci.Execute('SET STATE RUNNUNG 1' <br/><br />
if(type(resp.rt) == float): <br/><br />
&nbsp; &nbsp; bci.Execute('SET STATE responseTime %d' % round(resp.rt))<br />
</code><br/><br />
[[File:PsychoPyBciUpdateState2.png|alt="PsychoPy - Update State in BCI2000"|PsychoPy - Update State in BCI2000]]<br />
</li> <br />
<br/><br />
<li><br />
Run the experiment. BCI2000 will start. Add the newly created state to watch (on BCI2000 operator, click on View -> States and Events.., right click on responseTime and add to watch, click Ok on States and Events screen) and proceed as with your PsychoPy experiment. The output of this experiment would be similar to as shown below. '''Note:''' Make sure you don't run the experiments on full screen if you are using a single screen. <br/><br />
[[File:PsychoPyBciDemoRun2.png|alt="PsychoPy Stroop Extended Demo Run 2"|PsychoPy Stroop Extended Demo Run 2]]<br />
</li><br />
<br/><br />
</ol><br />
<br />
<br />
== References ==<br />
1. [https://www.psychopy.org/ PsychoPy site]<br />
<br />
== See Also ==<br />
* [[Programming Reference:BCI2000Remote Class]]<br />
* [[User Reference:Operator Module Scripting]]</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=PsychoPy&diff=8451PsychoPy2019-07-31T17:40:50Z<p>Dashmeetkaur: </p>
<hr />
<div>PsychoPy is an open-source application using which a large number of neuroscience, psychology and psychophysics experiments can be performed [1].<br />
The documentation first describes the two components that are developed to remotely start BCI2000 from the PsychoPy, then lists the steps to follow to add the new components in the PsychoPy application and finally goes over two tutorial examples.<br />
<br />
== Components ==<br />
<br />
=== BCI2000Start ===<br />
The component starts up the BCI2000 modules remotely. The component takes two parameters:<br />
; Path : Path to the BCI2000 ''prog'' directory which contains the ''BCI2000Remote.py'' file.<br />
; States : List of new states to add to the BCI2000. The states in the list are defined as follows: 'StateName defaultValue maxValue'. Eg: lastKey 0 255, correctKey 0 1.<br />
<br />
[[File:BCI2000Start.png|alt="BCI2000 start component image showing its parameters"|BCIStart Component]]<br />
<br />
=== BCI2000UpdateState ===<br />
The component defines which state to update and when. It takes the following parameters:<br />
; State Name : The name of the state in BCI2000 to update.<br />
; Response Component Variable : The variable to which the state is be set OR the variable which contains the new value of the state. '''Note-''' the variable is written as ''$VariableName''. <br />
; Use Expression : If it is checked, the code written in 'Expression' is executed for each Frame and the variable specified is not used to update the state.<br />
; Expression : The code to execute for each Frame. It is given for the cases, where the variable is not available and the users want more control over how the state is updated. '''Note-''' the user would have to use commands like ''bci.Execute'' and ''SET STATE'' to update the state in such cases. See [[Programming Reference:BCI2000Remote Class]] and [[User Reference:Operator Module Scripting]] for more details.<br />
<br />
[[File:BCI2000UpdateState.png|alt="BCI2000 update state component image showing its parameters"|BCIUpdateStart Component]]<br />
<br />
== Integrating BCI2000 into PyschoPy ==<br />
Download the PsychoPy from the [https://www.psychopy.org/download.html PyschoPy] website. <br/><br />
Here is a picture of how PsychoPy looks before integrating BCI2000 in it. Notice that in the rightmost column, under '''Custom''' Components, there is no BCI2000 component.<br />
<br />
[[File:PsychoPyWithoutBCI.png|alt="PsychoPy Homepage without BCI2000 Components"|PsychoPy Homepage without BCI2000 Components]]<br />
<br />
<br />
=== Standalone version ===<br />
For Windows, Copy the folders '''BCIStart''' and '''BCIUpdateState''' from ''src/contrib/PsychoPy Components'' directory of your BCI2000 repository into the folder {$PsychoPyHome}\Lib\site-packages\psychopy\experiment\components folder.<br />
<br />
<br />
=== Developer version ===<br />
Copy the folders '''BCIStart''' and '''BCIUpdateState''' from ''src/contrib/PsychoPy Components'' directory of your BCI2000 repository into the folder {$PsychoPyHome}\psychopy\experiment\components.<br />
Open terminal and navigate to the PsychoPy home directory where ''setup.py'' resides.<br />
Run the following command in the terminal: <br/><br />
<code>pip install -e .</code> <br/><br/><br />
<br/><br/><br />
Start Psychopy application and in the builder view, under the '''Custom''' Components (in rightmost column), you should see the two new components - ''BCI2000Start'' and ''BCI2000UpdateState'' as shown in the figure below.<br />
<br />
[[File:PsychoPy_Start.png|alt="PsychoPy Homepage with BCI2000 Components"|PsychoPy Homepage with BCI2000 Components]]<br />
<br />
'''Note:''' Make sure you don't run the experiments on full screen if you are using a single screen. <br />
<br />
== Tutorial ==<br />
In this section, 2 examples are presented to help the user understand the working of the BCI2000 within PsychoPy. The examples modifies the demo stroopExtended (already provided by PsychoPy) and integrates BCI2000 within it. The stroopExtended demo asks user to press certain keys depending on the color shown on the screen and records the response time.<br />
<br />
=== Using Response Component Variable Option ===<br />
In this tutorial, we will add a new state called '''correctKey''' in BCI2000 using PsychoPy. This state will be changed to 1 if the key pressed by user is correct, otherwise 0.<br />
<ol><br />
<li><br />
Open the stroopExtended demo in PsychoPy. This is it should looks. <br/><br />
[[File:PsychoPyDemoStart.png|alt="PsychoPy Stroop Extended Demo"|PsychoPy Stroop Extended Demo]] <br />
</li><br />
<br />
<br/><br />
<li><br />
Start BCI2000 - With '''instruct''' routine on the screen, click on '''BCI2000Start''' and enter the path to the '''prog''' directory of BCI2000 (within which BCI2000Remote.py exists) in ''Path'' field and '''correctkey 0 1''' in the ''States'' field as shown in the image. '''correctKey''' is the name we want the new state to have in BCI2000, '''0''' is the default value the state should have and '''1''' is the maximum value the state can take in any case. <br/><br />
<code>correctkey 0 1</code> <br/><br />
[[File:PsychoPyBciStart1.png|alt="PsychoPy - Add State into BCI2000"|PsychoPy - Add State into BCI2000]] <br />
</li><br />
<br/><br />
<li><br />
Update BCI2000 State - With '''trial''' routine on the screen, click on '''BCI2000UpdateState'''. Fill in the field ''State Name'' with '''$correctKey''' (BCI2000 state we want to update; '$' is used to indicate PsychoPy to treat it as a variable) and ''Response Component Variable'' with '''$resp.corr''' ('resp' is the name of the keyboard which takes the input and 'corr' is its property that stores the whether the key pressed is correct or not; you can see this variable being used in the program when you compile it to script) as shown in the image. This will essentially update the state 'correctKey' with the value of 'resp.corr'. <br/><br />
[[File:PsychoPyBciUpdateState1.png|alt="PsychoPy - Update State in BCI2000"|PsychoPy - Update State in BCI2000]]<br />
</li> <br />
<br/><br />
<li><br />
Run the experiment. BCI2000 will start. Add the newly created state to watch (on BCI2000 operator, click on View -> States and Events.., right click on correctKey and add to watch, click Ok on States and Events screen) and proceed as with your PsychoPy experiment. The output of this experiment would be similar to as shown below. '''Note:''' Make sure you don't run the experiments on full screen if you are using a single screen. <br/><br />
[[File:PsychoPyBciDemoRun1.png|alt="PsychoPy Stroop Extended Demo Run 1"|PsychoPy Stroop Extended Demo Run 1]] <br />
</li><br />
<br/><br />
</ol><br />
<br />
<br />
=== Using Use Expression Option ===<br />
In this tutorial, we will add a new state called '''responseTime''' in BCI2000 using PsychoPy. This state will represent the time the user takes to press the correct key in seconds(with no decimals).<br />
<ol><br />
<li><br />
Open the stroopExtended demo in PsychoPy. This is it should looks. <br/><br />
[[File:PsychoPyDemoStart.png|alt="PsychoPy Stroop Extended Demo"|PsychoPy Stroop Extended Demo]]<br />
</li><br />
<br/><br />
<li><br />
Start BCI2000 - With '''instruct''' routine on the screen, click on '''BCI2000Start''' and enter the path to the '''prog''' directory of BCI2000 (within which BCI2000Remote.py exists) in ''Path'' field and '''responseTime 0 600''' in the ''States'' field as shown in the image. '''responseTime''' is the name we want the new state to have in BCI2000, '''0''' is the default value the state should have and '''600''' is the maximum value the state can take in any case, i.e, the maximum response time could be 10 minutes.<br/><br />
<code>responseTime 0 600</code><br/><br />
[[File:PsychoPyBciStart2.png|alt="PsychoPy- Add State into BCI2000"|PsychoPy - Add State into BCI2000]]<br />
</li><br />
<br/><br />
<li><br />
Update BCI2000 State - With '''trial''' routine on the screen, click on '''BCI2000UpdateState'''. Check on the '''Use Expression''' option to run the expression that is written in '''Expression''' field. Write the lines of code in python language in '''Expression''' field as shown in the image. These lines first set the 'RUNNING' state of BCI2000 to 1 to make sure that BCI2000 is running. It then checks if the type of the 'resp.rt' is float, if yes that means 'resp.rt' stores the response time and sets the state 'responseTime' to the rounded value of 'resp.rt' ('resp' is the name of the keyboard which takes the input and 'rt' is its property that stores the time it took user to press the key; you can see this variable being used in the program when you compile it to script) using the bci.Execute and SET STATE command. <br/><br />
<code>bci.Execute('SET STATE RUNNUNG 1' <br/><br />
if(type(resp.rt) == float): <br/><br />
bci.Execute('SET STATE responseTime %d' % round(resp.rt))<br />
</code><br/><br />
[[File:PsychoPyBciUpdateState2.png|alt="PsychoPy - Update State in BCI2000"|PsychoPy - Update State in BCI2000]]<br />
</li> <br />
<br/><br />
<li><br />
Run the experiment. BCI2000 will start. Add the newly created state to watch (on BCI2000 operator, click on View -> States and Events.., right click on responseTime and add to watch, click Ok on States and Events screen) and proceed as with your PsychoPy experiment. The output of this experiment would be similar to as shown below. '''Note:''' Make sure you don't run the experiments on full screen if you are using a single screen. <br/><br />
[[File:PsychoPyBciDemoRun2.png|alt="PsychoPy Stroop Extended Demo Run 2"|PsychoPy Stroop Extended Demo Run 2]]<br />
</li><br />
<br/><br />
</ol><br />
<br />
<br />
== References ==<br />
1. [https://www.psychopy.org/ PsychoPy site]<br />
<br />
== See Also ==<br />
* [[Programming Reference:BCI2000Remote Class]]<br />
* [[User Reference:Operator Module Scripting]]</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=PsychoPy&diff=8450PsychoPy2019-07-31T17:39:34Z<p>Dashmeetkaur: </p>
<hr />
<div>PsychoPy is an open-source application using which a large number of neuroscience, psychology and psychophysics experiments can be performed [1].<br />
The documentation first describes the two components that are developed to remotely start BCI2000 from the PsychoPy, then lists the steps to follow to add the new components in the PsychoPy application and finally goes over two tutorial examples.<br />
<br />
== Components ==<br />
<br />
=== BCI2000Start ===<br />
The component starts up the BCI2000 modules remotely. The component takes two parameters:<br />
; Path : Path to the BCI2000 ''prog'' directory which contains the ''BCI2000Remote.py'' file.<br />
; States : List of new states to add to the BCI2000. The states in the list are defined as follows: 'StateName defaultValue maxValue'. Eg: lastKey 0 255, correctKey 0 1.<br />
<br />
[[File:BCI2000Start.png|alt="BCI2000 start component image showing its parameters"|BCIStart Component]]<br />
<br />
=== BCI2000UpdateState ===<br />
The component defines which state to update and when. It takes the following parameters:<br />
; State Name : The name of the state in BCI2000 to update.<br />
; Response Component Variable : The variable to which the state is be set OR the variable which contains the new value of the state. '''Note-''' the variable is written as ''$VariableName''. <br />
; Use Expression : If it is checked, the code written in 'Expression' is executed for each Frame and the variable specified is not used to update the state.<br />
; Expression : The code to execute for each Frame. It is given for the cases, where the variable is not available and the users want more control over how the state is updated. '''Note-''' the user would have to use commands like ''bci.Execute'' and ''SET STATE'' to update the state in such cases. See [[Programming Reference:BCI2000Remote Class]] and [[User Reference:Operator Module Scripting]] for more details.<br />
<br />
[[File:BCI2000UpdateState.png|alt="BCI2000 update state component image showing its parameters"|BCIUpdateStart Component]]<br />
<br />
== Integrating BCI2000 into PyschoPy ==<br />
Download the PsychoPy from the [https://www.psychopy.org/download.html PyschoPy] website. <br/><br />
Here is a picture of how PsychoPy looks before integrating BCI2000 in it. Notice that in the rightmost column, under '''Custom''' Components, there is no BCI2000 component.<br />
<br />
[[File:PsychoPyWithoutBCI.png|alt="PsychoPy Homepage without BCI2000 Components"|PsychoPy Homepage without BCI2000 Components]]<br />
<br />
<br />
=== Standalone version ===<br />
For Windows, Copy the folders '''BCIStart''' and '''BCIUpdateState''' from ''src/contrib/PsychoPy Components'' directory of your BCI2000 repository into the folder {$PsychoPyHome}\Lib\site-packages\psychopy\experiment\components folder.<br />
<br />
<br />
=== Developer version ===<br />
Copy the folders '''BCIStart''' and '''BCIUpdateState''' from ''src/contrib/PsychoPy Components'' directory of your BCI2000 repository into the folder {$PsychoPyHome}\psychopy\experiment\components.<br />
Open terminal and navigate to the PsychoPy home directory where ''setup.py'' resides.<br />
Run the following command in the terminal: <br/><br />
<code>pip install -e .</code> <br/><br/><br />
<br/><br/><br />
Start Psychopy application and in the builder view, under the '''Custom''' Components (in rightmost column), you should see the two new components - ''BCI2000Start'' and ''BCI2000UpdateState'' as shown in the figure below.<br />
<br />
[[File:PsychoPy_Start.png|alt="PsychoPy Homepage with BCI2000 Components"|PsychoPy Homepage with BCI2000 Components]]<br />
<br />
'''Note:''' Make sure you don't run the experiments on full screen if you are using a single screen. <br />
<br />
== Tutorial ==<br />
In this section, 2 examples are presented to help the user understand the working of the BCI2000 within PsychoPy. The examples modifies the demo stroopExtended (already provided by PsychoPy) and integrates BCI2000 within it. The stroopExtended demo asks user to press certain keys depending on the color shown on the screen and records the response time.<br />
<br />
=== Using Response Component Variable Option ===<br />
In this tutorial, we will add a new state called '''correctKey''' in BCI2000 using PsychoPy. This state will be changed to 1 if the key pressed by user is correct, otherwise 0.<br />
<ol><br />
<li><br />
Open the stroopExtended demo in PsychoPy. This is it should looks. <br/><br />
[[File:PsychoPyDemoStart.png|alt="PsychoPy Stroop Extended Demo"|PsychoPy Stroop Extended Demo]] <br />
</li><br />
<br />
<br/><br />
<li><br />
Start BCI2000 - With '''instruct''' routine on the screen, click on '''BCI2000Start''' and enter the path to the '''prog''' directory of BCI2000 (within which BCI2000Remote.py exists) in ''Path'' field and '''correctkey 0 1''' in the ''States'' field as shown in the image. '''correctKey''' is the name we want the new state to have in BCI2000, '''0''' is the default value the state should have and '''1''' is the maximum value the state can take in any case. <br/><br />
<code>correctkey 0 1</code> <br/><br />
[[File:PsychoPyBciStart1.png|alt="PsychoPy - Add State into BCI2000"|PsychoPy - Add State into BCI2000]] <br />
</li><br />
<br/><br />
<li><br />
Update BCI2000 State - With '''trial''' routine on the screen, click on '''BCI2000UpdateState'''. Fill in the field ''State Name'' with '''$correctKey''' (BCI2000 state we want to update; '$' is used to indicate PsychoPy to treat it as a variable) and ''Response Component Variable'' with '''$resp.corr''' ('resp' is the name of the keyboard which takes the input and 'corr' is its property that stores the whether the key pressed is correct or not; you can see this variable being used in the program when you compile it to script) as shown in the image. This will essentially update the state 'correctKey' with the value of 'resp.corr'. <br/><br />
[[File:PsychoPyBciUpdateState1.png|alt="PsychoPy - Update State in BCI2000"|PsychoPy - Update State in BCI2000]]<br />
</li> <br />
<br/><br />
<li><br />
Run the experiment. BCI2000 will start. Add the newly created state to watch (on BCI2000 operator, click on View -> States and Events.., right click on correctKey and add to watch, click Ok on States and Events screen) and proceed as with your PsychoPy experiment. The output of this experiment would be similar to as shown below. '''Note:''' Make sure you don't run the experiments on full screen if you are using a single screen. <br/><br />
[[File:PsychoPyBciDemoRun1.png|alt="PsychoPy Stroop Extended Demo Run 1"|PsychoPy Stroop Extended Demo Run 1]] <br />
</li><br />
<br/><br />
</ol><br />
<br />
<br />
=== Using Use Expression Option ===<br />
In this tutorial, we will add a new state called '''responseTime''' in BCI2000 using PsychoPy. This state will represent the time the user takes to press the correct key in seconds(with no decimals).<br />
<ol><br />
<li><br />
Open the stroopExtended demo in PsychoPy. This is it should looks. <br/><br />
[[File:PsychoPyDemoStart.png|alt="PsychoPy Stroop Extended Demo"|PsychoPy Stroop Extended Demo]]<br />
</li><br />
<br/><br />
<li><br />
Start BCI2000 - With '''instruct''' routine on the screen, click on '''BCI2000Start''' and enter the path to the '''prog''' directory of BCI2000 (within which BCI2000Remote.py exists) in ''Path'' field and '''responseTime 0 600''' in the ''States'' field as shown in the image. '''responseTime''' is the name we want the new state to have in BCI2000, '''0''' is the default value the state should have and '''600''' is the maximum value the state can take in any case, i.e, the maximum response time could be 10 minutes.<br/><br />
[[File:PsychoPyBciStart2.png|alt="PsychoPy- Add State into BCI2000"|PsychoPy - Add State into BCI2000]]<br />
</li><br />
<br/><br />
<li><br />
Update BCI2000 State - With '''trial''' routine on the screen, click on '''BCI2000UpdateState'''. Check on the '''Use Expression''' option to run the expression that is written in '''Expression''' field. Write the lines of code in python language in '''Expression''' field as shown in the image. These lines first set the 'RUNNING' state of BCI2000 to 1 to make sure that BCI2000 is running. It then checks if the type of the 'resp.rt' is float, if yes that means 'resp.rt' stores the response time and sets the state 'responseTime' to the rounded value of 'resp.rt' ('resp' is the name of the keyboard which takes the input and 'rt' is its property that stores the time it took user to press the key; you can see this variable being used in the program when you compile it to script) using the bci.Execute and SET STATE command. <br/><br />
<code>bci.Execute('SET STATE RUNNUNG 1' <br/><br />
if(type(resp.rt) == float):<br />
bci.Execute('SET STATE responseTime %d' % round(resp.rt))<br />
</code><br/><br />
[[File:PsychoPyBciUpdateState2.png|alt="PsychoPy - Update State in BCI2000"|PsychoPy - Update State in BCI2000]]<br />
</li> <br />
<br/><br />
<li><br />
Run the experiment. BCI2000 will start. Add the newly created state to watch (on BCI2000 operator, click on View -> States and Events.., right click on responseTime and add to watch, click Ok on States and Events screen) and proceed as with your PsychoPy experiment. The output of this experiment would be similar to as shown below. '''Note:''' Make sure you don't run the experiments on full screen if you are using a single screen. <br/><br />
[[File:PsychoPyBciDemoRun2.png|alt="PsychoPy Stroop Extended Demo Run 2"|PsychoPy Stroop Extended Demo Run 2]]<br />
</li><br />
<br/><br />
</ol><br />
<br />
<br />
== References ==<br />
1. [https://www.psychopy.org/ PsychoPy site]<br />
<br />
== See Also ==<br />
* [[Programming Reference:BCI2000Remote Class]]<br />
* [[User Reference:Operator Module Scripting]]</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=PsychoPy&diff=8449PsychoPy2019-07-31T15:04:52Z<p>Dashmeetkaur: </p>
<hr />
<div>PsychoPy is an open-source application using which a large number of neuroscience, psychology and psychophysics experiments can be performed [1].<br />
The documentation first describes the two components that are developed to remotely start BCI2000 from the PsychoPy, then lists the steps to follow to add the new components in the PsychoPy application and finally goes over two tutorial examples.<br />
<br />
== Components ==<br />
<br />
=== BCI2000Start ===<br />
The component starts up the BCI2000 modules remotely. The component takes two parameters:<br />
; Path : Path to the BCI2000 ''prog'' directory which contains the ''BCI2000Remote.py'' file.<br />
; States : List of new states to add to the BCI2000. The states in the list are defined as follows: 'StateName defaultValue maxValue'. Eg: lastKey 0 255, correctKey 0 1.<br />
<br />
[[File:BCI2000Start.png|alt="BCI2000 start component image showing its parameters"|BCIStart Component]]<br />
<br />
=== BCI2000UpdateState ===<br />
The component defines which state to update and when. It takes the following parameters:<br />
; State Name : The name of the state in BCI2000 to update.<br />
; Response Component Variable : The variable to which the state is be set OR the variable which contains the new value of the state. '''Note-''' the variable is written as ''$VariableName''. <br />
; Use Expression : If it is checked, the code written in 'Expression' is executed for each Frame and the variable specified is not used to update the state.<br />
; Expression : The code to execute for each Frame. It is given for the cases, where the variable is not available and the users want more control over how the state is updated. '''Note-''' the user would have to use commands like ''bci.Execute'' and ''SET STATE'' to update the state in such cases. See [[Programming Reference:BCI2000Remote Class]] and [[User Reference:Operator Module Scripting]] for more details.<br />
<br />
[[File:BCI2000UpdateState.png|alt="BCI2000 update state component image showing its parameters"|BCIUpdateStart Component]]<br />
<br />
== Integrating BCI2000 into PyschoPy ==<br />
Download the PsychoPy from the [https://www.psychopy.org/download.html PyschoPy] website. <br/><br />
Here is a picture of how PsychoPy looks before integrating BCI2000 in it. Notice that in the rightmost column, under '''Custom''' Components, there is no BCI2000 component.<br />
<br />
[[File:PsychoPyWithoutBCI.png|alt="PsychoPy Homepage without BCI2000 Components"|PsychoPy Homepage without BCI2000 Components]]<br />
<br />
<br />
=== Standalone version ===<br />
For Windows, Copy the folders '''BCIStart''' and '''BCIUpdateState''' from ''src/contrib/PsychoPy Components'' directory of your BCI2000 repository into the folder {$PsychoPyHome}\Lib\site-packages\psychopy\experiment\components folder.<br />
<br />
<br />
=== Developer version ===<br />
Copy the folders '''BCIStart''' and '''BCIUpdateState''' from ''src/contrib/PsychoPy Components'' directory of your BCI2000 repository into the folder {$PsychoPyHome}\psychopy\experiment\components.<br />
Open terminal and navigate to the PsychoPy home directory where ''setup.py'' resides.<br />
Run the following command in the terminal: <br/><br />
<code>pip install -e .</code> <br/><br/><br />
<br/><br/><br />
Start Psychopy application and in the builder view, under the '''Custom''' Components (in rightmost column), you should see the two new components - ''BCI2000Start'' and ''BCI2000UpdateState'' as shown in the figure below.<br />
<br />
[[File:PsychoPy_Start.png|alt="PsychoPy Homepage with BCI2000 Components"|PsychoPy Homepage with BCI2000 Components]]<br />
<br />
'''Note:''' Make sure you don't run the experiments on full screen if you are using a single screen. <br />
<br />
== Tutorial ==<br />
In this section, 2 examples are presented to help the user understand the working of the BCI2000 within PsychoPy. The examples modifies the demo stroopExtended (already provided by PsychoPy) and integrates BCI2000 within it. The stroopExtended demo asks user to press certain keys depending on the color shown on the screen and records the response time.<br />
<br />
=== Using Response Component Variable Option ===<br />
In this tutorial, we will add a new state called '''correctKey''' in BCI2000 using PsychoPy. This state will be changed to 1 if the key pressed by user is correct, otherwise 0.<br />
<ol><br />
<li><br />
Open the stroopExtended demo in PsychoPy. This is it should looks. <br/><br />
[[File:PsychoPyDemoStart.png|alt="PsychoPy Stroop Extended Demo"|PsychoPy Stroop Extended Demo]] <br />
</li><br />
<br />
<br/><br />
<li><br />
Start BCI2000 - With '''instruct''' routine on the screen, click on '''BCI2000Start''' and enter the path to the '''prog''' directory of BCI2000 (within which BCI2000Remote.py exists) in ''Path'' field and '''correctkey 0 1''' in the ''States'' field as shown in the image. '''correctKey''' is the name we want the new state to have in BCI2000, '''0''' is the default value the state should have and '''1''' is the maximum value the state can take in any case. <br/><br />
[[File:PsychoPyBciStart1.png|alt="PsychoPy - Add State into BCI2000"|PsychoPy - Add State into BCI2000]] <br />
</li><br />
<br/><br />
<li><br />
Update BCI2000 State - With '''trial''' routine on the screen, click on '''BCI2000UpdateState'''. Fill in the field ''State Name'' with '''$correctKey''' (BCI2000 state we want to update; '$' is used to indicate PsychoPy to treat it as a variable) and ''Response Component Variable'' with '''$resp.corr''' ('resp' is the name of the keyboard which takes the input and 'corr' is its property that stores the whether the key pressed is correct or not; you can see this variable being used in the program when you compile it to script) as shown in the image. This will essentially update the state 'correctKey' with the value of 'resp.corr'. <br/><br />
[[File:PsychoPyBciUpdateState1.png|alt="PsychoPy - Update State in BCI2000"|PsychoPy - Update State in BCI2000]]<br />
</li> <br />
<br/><br />
<li><br />
Run the experiment. BCI2000 will start. Add the newly created state to watch (on BCI2000 operator, click on View -> States and Events.., right click on correctKey and add to watch, click Ok on States and Events screen) and proceed as with your PsychoPy experiment. The output of this experiment would be similar to as shown below. '''Note:''' Make sure you don't run the experiments on full screen if you are using a single screen. <br/><br />
[[File:PsychoPyBciDemoRun1.png|alt="PsychoPy Stroop Extended Demo Run 1"|PsychoPy Stroop Extended Demo Run 1]] <br />
</li><br />
<br/><br />
</ol><br />
<br />
<br />
=== Using Use Expression Option ===<br />
In this tutorial, we will add a new state called '''responseTime''' in BCI2000 using PsychoPy. This state will represent the time the user takes to press the correct key in seconds(with no decimals).<br />
<ol><br />
<li><br />
Open the stroopExtended demo in PsychoPy. This is it should looks. <br/><br />
[[File:PsychoPyDemoStart.png|alt="PsychoPy Stroop Extended Demo"|PsychoPy Stroop Extended Demo]]<br />
</li><br />
<br/><br />
<li><br />
Start BCI2000 - With '''instruct''' routine on the screen, click on '''BCI2000Start''' and enter the path to the '''prog''' directory of BCI2000 (within which BCI2000Remote.py exists) in ''Path'' field and '''responseTime 0 600''' in the ''States'' field as shown in the image. '''responseTime''' is the name we want the new state to have in BCI2000, '''0''' is the default value the state should have and '''600''' is the maximum value the state can take in any case, i.e, the maximum response time could be 10 minutes.<br/><br />
[[File:PsychoPyBciStart2.png|alt="PsychoPy- Add State into BCI2000"|PsychoPy - Add State into BCI2000]]<br />
</li><br />
<br/><br />
<li><br />
Update BCI2000 State - With '''trial''' routine on the screen, click on '''BCI2000UpdateState'''. Check on the '''Use Expression''' option to run the expression that is written in '''Expression''' field. Write the lines of code in python language in '''Expression''' field as shown in the image. These lines first set the 'RUNNING' state of BCI2000 to 1 to make sure that BCI2000 is running. It then checks if the type of the 'resp.rt' is float, if yes that means 'resp.rt' stores the response time and sets the state 'responseTime' to the rounded value of 'resp.rt' ('resp' is the name of the keyboard which takes the input and 'rt' is its property that stores the time it took user to press the key; you can see this variable being used in the program when you compile it to script) using the bci.Execute and SET STATE command. <br/><br />
[[File:PsychoPyBciUpdateState2.png|alt="PsychoPy - Update State in BCI2000"|PsychoPy - Update State in BCI2000]]<br />
</li> <br />
<br/><br />
<li><br />
Run the experiment. BCI2000 will start. Add the newly created state to watch (on BCI2000 operator, click on View -> States and Events.., right click on responseTime and add to watch, click Ok on States and Events screen) and proceed as with your PsychoPy experiment. The output of this experiment would be similar to as shown below. '''Note:''' Make sure you don't run the experiments on full screen if you are using a single screen. <br/><br />
[[File:PsychoPyBciDemoRun2.png|alt="PsychoPy Stroop Extended Demo Run 2"|PsychoPy Stroop Extended Demo Run 2]]<br />
</li><br />
<br/><br />
</ol><br />
<br />
<br />
== References ==<br />
1. [https://www.psychopy.org/ PsychoPy site]<br />
<br />
== See Also ==<br />
* [[Programming Reference:BCI2000Remote Class]]<br />
* [[User Reference:Operator Module Scripting]]</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=File:PsychoPyBciUpdateState2.png&diff=8448File:PsychoPyBciUpdateState2.png2019-07-31T14:47:35Z<p>Dashmeetkaur: PsychoPy-Bci Strop Extended Update State with Use Expression Option</p>
<hr />
<div>PsychoPy-Bci Strop Extended Update State with Use Expression Option</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=File:PsychoPyBciUpdateState1.png&diff=8447File:PsychoPyBciUpdateState1.png2019-07-31T14:46:53Z<p>Dashmeetkaur: PsychoPy-Bci Update State with Response Component Variable Option</p>
<hr />
<div>PsychoPy-Bci Update State with Response Component Variable Option</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=File:PsychoPyBciStart2.png&diff=8446File:PsychoPyBciStart2.png2019-07-31T14:46:07Z<p>Dashmeetkaur: PsychoPy-Bci Stroop Extended Start with Use Expression Option</p>
<hr />
<div>PsychoPy-Bci Stroop Extended Start with Use Expression Option</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=File:PsychoPyBciStart1.png&diff=8445File:PsychoPyBciStart1.png2019-07-31T14:45:21Z<p>Dashmeetkaur: PsychoPy-Bci Stroop Extended Start with Response Component Variable Option</p>
<hr />
<div>PsychoPy-Bci Stroop Extended Start with Response Component Variable Option</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=File:PsychoPyBciDemoRun2.png&diff=8444File:PsychoPyBciDemoRun2.png2019-07-31T14:43:37Z<p>Dashmeetkaur: PsychoPy-Bci Stroop Extended Demo Run with Use Expression Option</p>
<hr />
<div>PsychoPy-Bci Stroop Extended Demo Run with Use Expression Option</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=File:PsychoPyBciDemoRun1.png&diff=8443File:PsychoPyBciDemoRun1.png2019-07-31T14:42:53Z<p>Dashmeetkaur: PsychoPy-Bci Stroop Extended Demo Run with Response Component Variable Option</p>
<hr />
<div>PsychoPy-Bci Stroop Extended Demo Run with Response Component Variable Option</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=File:PsychoPyDemoStart.png&diff=8442File:PsychoPyDemoStart.png2019-07-31T14:41:29Z<p>Dashmeetkaur: PsychoPy Stroop Extended Demo Start</p>
<hr />
<div>PsychoPy Stroop Extended Demo Start</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=PsychoPy&diff=8441PsychoPy2019-07-31T14:40:55Z<p>Dashmeetkaur: </p>
<hr />
<div>PsychoPy is an open-source application using which a large number of neuroscience, psychology and psychophysics experiments can be performed [1].<br />
The documentation first describes the two components that are developed to remotely start BCI2000 from the PsychoPy, then lists the steps to follow to add the new components in the PsychoPy application and finally goes over two tutorial examples.<br />
<br />
== Components ==<br />
<br />
=== BCI2000Start ===<br />
The component starts up the BCI2000 modules remotely. The component takes two parameters:<br />
; Path : Path to the BCI2000 ''prog'' directory which contains the ''BCI2000Remote.py'' file.<br />
; States : List of new states to add to the BCI2000. The states in the list are defined as follows: 'StateName defaultValue maxValue'. Eg: lastKey 0 255, correctKey 0 1.<br />
<br />
[[File:BCI2000Start.png|alt="BCI2000 start component image showing its parameters"|BCIStart Component]]<br />
<br />
=== BCI2000UpdateState ===<br />
The component defines which state to update and when. It takes the following parameters:<br />
; State Name : The name of the state in BCI2000 to update.<br />
; Response Component Variable : The variable to which the state is be set OR the variable which contains the new value of the state. '''Note-''' the variable is written as ''$VariableName''. <br />
; Use Expression : If it is checked, the code written in 'Expression' is executed for each Frame and the variable specified is not used to update the state.<br />
; Expression : The code to execute for each Frame. It is given for the cases, where the variable is not available and the users want more control over how the state is updated. '''Note-''' the user would have to use commands like ''bci.Execute'' and ''SET STATE'' to update the state in such cases. See [[Programming Reference:BCI2000Remote Class]] and [[User Reference:Operator Module Scripting]] for more details.<br />
<br />
[[File:BCI2000UpdateState.png|alt="BCI2000 update state component image showing its parameters"|BCIUpdateStart Component]]<br />
<br />
== Integrating BCI2000 into PyschoPy ==<br />
Download the PsychoPy from the [https://www.psychopy.org/download.html PyschoPy] website. <br/><br />
Here is a picture of how PsychoPy looks before integrating BCI2000 in it. Notice that in the rightmost column, under '''Custom''' Components, there is no BCI2000 component.<br />
<br />
[[File:PsychoPyWithoutBCI.png|alt="PsychoPy Homepage without BCI2000 Components"|PsychoPy Homepage without BCI2000 Components]]<br />
<br />
<br />
=== Standalone version ===<br />
For Windows, Copy the folders '''BCIStart''' and '''BCIUpdateState''' from ''src/contrib/PsychoPy Components'' directory of your BCI2000 repository into the folder {$PsychoPyHome}\Lib\site-packages\psychopy\experiment\components folder.<br />
<br />
<br />
=== Developer version ===<br />
Copy the folders '''BCIStart''' and '''BCIUpdateState''' from ''src/contrib/PsychoPy Components'' directory of your BCI2000 repository into the folder {$PsychoPyHome}\psychopy\experiment\components.<br />
Open terminal and navigate to the PsychoPy home directory where ''setup.py'' resides.<br />
Run the following command in the terminal: <br/><br />
<code>pip install -e .</code> <br/><br/><br />
<br/><br/><br />
Start Psychopy application and in the builder view, under the '''Custom''' Components (in rightmost column), you should see the two new components - ''BCI2000Start'' and ''BCI2000UpdateState'' as shown in the figure below.<br />
<br />
[[File:PsychoPy_Start.png|alt="PsychoPy Homepage with BCI2000 Components"|PsychoPy Homepage with BCI2000 Components]]<br />
<br />
'''Note:''' Make sure you don't run the experiments on full screen if you are using a single screen. <br />
<br />
== Tutorial ==<br />
In this section, 2 examples are presented to help the user understand the working of the BCI2000 within PsychoPy. The examples modifies the demo stroopExtended (already provided by PsychoPy) and integrates BCI2000 within it. The stroopExtended demo asks user to press certain keys depending on the color shown on the screen and records the response time.<br />
<br />
=== Using Response Component Variable Option ===<br />
In this tutorial, we will add a new state called '''correctKey''' in BCI2000 using PsychoPy. This state will be changed to 1 if the key pressed by user is correct, otherwise 0.<br />
<ol><br />
<li><br />
Open the stroopExtended demo in PsychoPy. This is it should looks.<br />
[[File:PsychoPy_Start.png|alt="PsychoPy Homepage with BCI2000 Components"|PsychoPy Homepage with BCI2000 Components]]<br />
</li><br />
<br />
<li><br />
Start BCI2000 - With '''instruct''' routine on the screen, click on '''BCI2000Start''' and enter the path to the '''prog''' directory of BCI2000 (within which BCI2000Remote.py exists) in ''Path'' field and '''correctkey 0 1''' in the ''States'' field as shown in the image. '''correctKey''' is the name we want the new state to have in BCI2000, '''0''' is the default value the state should have and '''1''' is the maximum value the state can take in any case.<br />
[[File:PsychoPy_Start.png|alt="PsychoPy Homepage with BCI2000 Components"|PsychoPy Homepage with BCI2000 Components]]<br />
</li><br />
<br />
<li><br />
Update BCI2000 State - With '''trial''' routine on the screen, click on '''BCI2000UpdateState'''. Fill in the field ''State Name'' with '''$correctKey''' (BCI2000 state we want to update; '$' is used to indicate PsychoPy to treat it as a variable) and ''Response Component Variable'' with '''$resp.corr''' ('resp' is the name of the keyboard which takes the input and 'corr' is its property that stores the whether the key pressed is correct or not; you can see this variable being used in the program when you compile it to script) as shown in the image. This will essentially update the state 'correctKey' with the value of 'resp.corr'. <br />
[[File:PsychoPy_Start.png|alt="PsychoPy Homepage with BCI2000 Components"|PsychoPy Homepage with BCI2000 Components]]<br />
</li> <br />
<br />
<li><br />
Run the experiment. BCI2000 will start. Add the newly created state to watch (on BCI2000 operator, click on View -> States and Events.., right click on correctKey and add to watch, click Ok on States and Events screen) and proceed as with your PsychoPy experiment. The output of this experiment would be similar to as shown below. '''Note:''' Make sure you don't run the experiments on full screen if you are using a single screen.<br />
[[File:PsychoPy_Start.png|alt="PsychoPy Homepage with BCI2000 Components"|PsychoPy Homepage with BCI2000 Components]]<br />
</li><br />
</ol><br />
<br />
=== Using Use Expression Option ===<br />
In this tutorial, we will add a new state called '''responseTime''' in BCI2000 using PsychoPy. This state will represent the time the user takes to press the correct key in seconds(with no decimals).<br />
<ol><br />
<li><br />
Open the stroopExtended demo in PsychoPy. This is it should looks.<br />
[[File:PsychoPy_Start.png|alt="PsychoPy Homepage with BCI2000 Components"|PsychoPy Homepage with BCI2000 Components]]<br />
</li><br />
<br />
<li><br />
Start BCI2000 - With '''instruct''' routine on the screen, click on '''BCI2000Start''' and enter the path to the '''prog''' directory of BCI2000 (within which BCI2000Remote.py exists) in ''Path'' field and '''responseTime 0 600''' in the ''States'' field as shown in the image. '''responseTime''' is the name we want the new state to have in BCI2000, '''0''' is the default value the state should have and '''600''' is the maximum value the state can take in any case, i.e, the maximum response time could be 10 minutes.<br />
[[File:PsychoPy_Start.png|alt="PsychoPy Homepage with BCI2000 Components"|PsychoPy Homepage with BCI2000 Components]]<br />
</li><br />
<br />
<li><br />
Update BCI2000 State - With '''trial''' routine on the screen, click on '''BCI2000UpdateState'''. Check on the '''Use Expression''' option to run the expression that is written in '''Expression''' field. Write the lines of code in python language in '''Expression''' field as shown in the image. These lines first set the 'RUNNING' state of BCI2000 to 1 to make sure that BCI2000 is running. It then checks if the type of the 'resp.rt' is float, if yes that means 'resp.rt' stores the response time and sets the state 'responseTime' to the rounded value of 'resp.rt' ('resp' is the name of the keyboard which takes the input and 'rt' is its property that stores the time it took user to press the key; you can see this variable being used in the program when you compile it to script) using the bci.SetState command. <br />
[[File:PsychoPy_Start.png|alt="PsychoPy Homepage with BCI2000 Components"|PsychoPy Homepage with BCI2000 Components]]<br />
</li> <br />
<br />
<li><br />
Run the experiment. BCI2000 will start. Add the newly created state to watch (on BCI2000 operator, click on View -> States and Events.., right click on responseTime and add to watch, click Ok on States and Events screen) and proceed as with your PsychoPy experiment. The output of this experiment would be similar to as shown below. '''Note:''' Make sure you don't run the experiments on full screen if you are using a single screen.<br />
[[File:PsychoPy_Start.png|alt="PsychoPy Homepage with BCI2000 Components"|PsychoPy Homepage with BCI2000 Components]]<br />
</li><br />
</ol><br />
<br />
<br />
== References ==<br />
1. [https://www.psychopy.org/ PsychoPy site]<br />
<br />
== See Also ==<br />
* [[Programming Reference:BCI2000Remote Class]]<br />
* [[User Reference:Operator Module Scripting]]</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=PsychoPy&diff=8440PsychoPy2019-07-30T20:37:17Z<p>Dashmeetkaur: </p>
<hr />
<div>PsychoPy is an open-source application using which a large number of neuroscience, psychology and psychophysics experiments can be performed [1].<br />
The documentation first describes the two components that are developed to remotely start BCI2000 from the PsychoPy, then lists the steps to follow to add the new components in the PsychoPy application and finally goes over two tutorial examples.<br />
<br />
== Components ==<br />
<br />
=== BCI2000Start ===<br />
The component starts up the BCI2000 modules remotely. The component takes two parameters:<br />
; Path : Path to the BCI2000 ''prog'' directory which contains the ''BCI2000Remote.py'' file.<br />
; States : List of new states to add to the BCI2000. The states in the list are defined as follows: 'StateName defaultValue maxValue'. Eg: lastKey 0 255, correctKey 0 1.<br />
<br />
[[File:BCI2000Start.png|alt="BCI2000 start component image showing its parameters"|BCIStart Component]]<br />
<br />
=== BCI2000UpdateState ===<br />
The component defines which state to update and when. It takes the following parameters:<br />
; State Name : The name of the state in BCI2000 to update.<br />
; Response Component Variable : The variable to which the state is be set OR the variable which contains the new value of the state. '''Note-''' the variable is written as ''$VariableName''. <br />
; Use Expression : If it is checked, the code written in 'Expression' is executed for each Frame and the variable specified is not used to update the state.<br />
; Expression : The code to execute for each Frame. It is given for the cases, where the variable is not available and the users want more control over how the state is updated. '''Note-''' the user would have to use commands like ''bci.Execute'' and ''SET STATE'' to update the state in such cases. See [[Programming Reference:BCI2000Remote Class]] and [[User Reference:Operator Module Scripting]] for more details.<br />
<br />
[[File:BCI2000UpdateState.png|alt="BCI2000 update state component image showing its parameters"|BCIUpdateStart Component]]<br />
<br />
== Integrating BCI2000 into PyschoPy ==<br />
Download the PsychoPy from the [https://www.psychopy.org/download.html PyschoPy] website. <br/><br />
Here is a picture of how PsychoPy looks before integrating BCI2000 in it. Notice that in the rightmost column, under '''Custom''' Components, there is no BCI2000 component.<br />
<br />
[[File:PsychoPyWithoutBCI.png|alt="PsychoPy Homepage without BCI2000 Components"|PsychoPy Homepage without BCI2000 Components]]<br />
<br />
<br />
=== Standalone version ===<br />
For Windows, Copy the folders '''BCIStart''' and '''BCIUpdateState''' from ''src/contrib/PsychoPy Components'' directory of your BCI2000 repository into the folder {$PsychoPyHome}\Lib\site-packages\psychopy\experiment\components folder.<br />
<br />
<br />
=== Developer version ===<br />
Copy the folders '''BCIStart''' and '''BCIUpdateState''' from ''src/contrib/PsychoPy Components'' directory of your BCI2000 repository into the folder {$PsychoPyHome}\psychopy\experiment\components.<br />
Open terminal and navigate to the PsychoPy home directory where ''setup.py'' resides.<br />
Run the following command in the terminal: <br/><br />
<code>pip install -e .</code> <br/><br/><br />
<br/><br/><br />
Start Psychopy application and in the builder view, under the '''Custom''' Components (in rightmost column), you should see the two new components - ''BCI2000Start'' and ''BCI2000UpdateState'' as shown in the figure below.<br />
<br />
[[File:PsychoPy_Start.png|alt="PsychoPy Homepage with BCI2000 Components"|PsychoPy Homepage with BCI2000 Components]]<br />
<br />
'''Note:''' Make sure you don't run the experiments on full screen if you are using a single screen. <br />
<br />
== Tutorial ==<br />
In this section, 2 examples are presented to help the user understand the working of the BCI2000 within PsychoPy. The examples modifies the demo stroopExtended (already provided by PsychoPy) and integrates BCI2000 within it. The stroopExtended demo asks user to press certain keys depending on the color shown on the screen and records the response time.<br />
<br />
=== Using Response Component Variable Option ===<br />
In this tutorial, we will add a new state called '''correctKey''' in BCI2000 using PsychoPy. This state will be changed to 1 if the key pressed by user is correct, otherwise 0.<br />
<ol><br />
<li><br />
Open the stroopExtended demo in PsychoPy. This is it should looks.<br />
[[File:PsychoPy_Start.png|alt="PsychoPy Homepage with BCI2000 Components"|PsychoPy Homepage with BCI2000 Components]]<br />
</li><br />
<br />
<li><br />
Start BCI2000 - With '''instruct''' routine on the screen, click on '''BCI2000Start''' and enter the path to the '''prog''' directory of BCI2000 (within which BCI2000Remote.py exists) in ''Path'' field and '''correctkey 0 1''' in the ''States'' field as shown in the image. '''correctKey''' is the name we want the new state to have in BCI2000, '''0''' is the default value the state should have and '''1''' is the maximum value the state can take in any case.<br />
[[File:PsychoPy_Start.png|alt="PsychoPy Homepage with BCI2000 Components"|PsychoPy Homepage with BCI2000 Components]]<br />
</li><br />
<br />
<li><br />
Update BCI2000 State - With '''trial''' routine on the screen, click on '''BCI2000UpdateState'''. Fill in the field ''State Name'' with '''$correctKey''' (BCI2000 state we want to update; '$' is used to indicate PsychoPy to treat it as a variable) and ''Response Component Variable'' with '''$resp.corr''' ('resp' is the name of the keyboard which takes the input and 'corr' is its property that stores the whether the key pressed is correct or not; you can see this variable being used in the program when you compile it to script) as shown in the image. This will essentially update the state 'correctKey' with the value of 'resp.corr'. <br />
[[File:PsychoPy_Start.png|alt="PsychoPy Homepage with BCI2000 Components"|PsychoPy Homepage with BCI2000 Components]]<br />
</li> <br />
<br />
<li><br />
Run the experiment. BCI2000 will start. Add the newly created state to watch (on BCI2000 operator, click on View -> States and Events.., right click on correctKey and add to watch, click Ok on States and Events screen) and proceed as with your PsychoPy experiment. The output of this experiment would be similar to as shown below. '''Note:''' Make sure you don't run the experiments on full screen if you are using a single screen.<br />
[[File:PsychoPy_Start.png|alt="PsychoPy Homepage with BCI2000 Components"|PsychoPy Homepage with BCI2000 Components]]<br />
</li><br />
</ol><br />
<br />
=== Using Use Expression Option ===<br />
In this tutorial, we will add a new state called '''responseTime''' in BCI2000 using PsychoPy. This state will represent the time the user takes to press a key in seconds(with no decimals).<br />
<ol><br />
<li><br />
Open the stroopExtended demo in PsychoPy. This is it should looks.<br />
[[File:PsychoPy_Start.png|alt="PsychoPy Homepage with BCI2000 Components"|PsychoPy Homepage with BCI2000 Components]]<br />
</li><br />
<br />
<li><br />
Start BCI2000 - With '''instruct''' routine on the screen, click on '''BCI2000Start''' and enter the path to the '''prog''' directory of BCI2000 (within which BCI2000Remote.py exists) in ''Path'' field and '''responseTime 0 600''' in the ''States'' field as shown in the image. '''responseTime''' is the name we want the new state to have in BCI2000, '''0''' is the default value the state should have and '''600''' is the maximum value the state can take in any case, i.e, the maximum response time could be 10 minutes.<br />
[[File:PsychoPy_Start.png|alt="PsychoPy Homepage with BCI2000 Components"|PsychoPy Homepage with BCI2000 Components]]<br />
</li><br />
<br />
<li><br />
Update BCI2000 State - With '''trial''' routine on the screen, click on '''BCI2000UpdateState'''. Check on the '''Use Expression''' option to run the expression that is written in '''Expression''' field. Write the lines of code in python language in '''Expression''' field as shown in the image. These lines set the state 'responseTime' to the integer value of 'resp.rt' ('resp' is the name of the keyboard which takes the input and 'rt' is its property that stores the time it took user to press the key; you can see this variable being used in the program when you compile it to script) using the bci.SetState command. <br />
[[File:PsychoPy_Start.png|alt="PsychoPy Homepage with BCI2000 Components"|PsychoPy Homepage with BCI2000 Components]]<br />
</li> <br />
<br />
<li><br />
Run the experiment. BCI2000 will start. Add the newly created state to watch (on BCI2000 operator, click on View -> States and Events.., right click on correctKey and add to watch, click Ok on States and Events screen) and proceed as with your PsychoPy experiment. The output of this experiment would be similar to as shown below. '''Note:''' Make sure you don't run the experiments on full screen if you are using a single screen.<br />
[[File:PsychoPy_Start.png|alt="PsychoPy Homepage with BCI2000 Components"|PsychoPy Homepage with BCI2000 Components]]<br />
</li><br />
</ol><br />
<br />
<br />
== References ==<br />
1. [https://www.psychopy.org/ PsychoPy site]<br />
<br />
== See Also ==<br />
* [[Programming Reference:BCI2000Remote Class]]<br />
* [[User Reference:Operator Module Scripting]]</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=PsychoPy&diff=8439PsychoPy2019-07-30T15:58:09Z<p>Dashmeetkaur: </p>
<hr />
<div>PsychoPy is an open-source application using which a large number of neuroscience, psychology and psychophysics experiments can be performed [1].<br />
This section first describes the two components that are developed to remotely start BCI2000 from the PsychoPy and the second section lists the steps to follow to add the new components in the PsychoPy application.<br />
<br />
== Components ==<br />
<br />
=== BCIStart ===<br />
The component starts up the BCI2000 modules remotely. The component takes two parameters:<br />
; Path : Path to the BCI2000 ''prog'' directory which contains the ''BCI2000Remote.py'' file.<br />
; States : List of new states to add to the BCI2000. The states in the list are defined as follows: 'StateName defaultValue maxValue'. Eg: lastKey 0 255, correctKey 0 1.<br />
<br />
[[File:BCI2000Start.png|alt="BCI2000 start component image showing its parameters"|BCIStart Component]]<br />
<br />
=== BCIUpdateState ===<br />
The component defines which state to update and when. It takes the following parameters:<br />
; State Name : The name of the state in BCI2000 to update.<br />
; Response Component Variable : The variable to which the state is be set OR the variable which contains the new value of the state. '''Note-''' the variable is written as ''$VariableName''. <br />
; Use Expression : If it is checked, the code written in 'Expression' is executed for each Frame and the variable specified is not used to update the state.<br />
; Expression : The code to execute for each Frame. It is given for the cases, where the variable is not available and the users want more control over how the state is updated. '''Note-''' the user would have to use commands like ''bci.Execute'' and ''SET STATE'' to update the state in such cases. See [[Programming Reference:BCI2000Remote Class]] and [[User Reference:Operator Module Scripting]] for more details.<br />
<br />
[[File:BCI2000UpdateState.png|alt="BCI2000 update state component image showing its parameters"|BCIUpdateStart Component]]<br />
<br />
== Integrating BCI2000 into PyschoPy ==<br />
Download the PsychoPy from the [https://www.psychopy.org/download.html PyschoPy] website. <br/><br />
Here is a picture of how PsychoPy looks before integrating BCI2000 in it. Notice that in the rightmost column, under '''Custom''' Components, there is no BCI2000 component.<br />
<br />
[[File:PsychoPyWithoutBCI.png|alt="PsychoPy Homepage without BCI2000 Components"|PsychoPy Homepage without BCI2000 Components]]<br />
<br />
<br />
=== Standalone version ===<br />
For Windows, Copy the folders '''BCIStart''' and '''BCIUpdateState''' from ''src/contrib/PsychoPy Components'' directory of your BCI2000 repository into the folder {$PsychoPyHome}\Lib\site-packages\psychopy\experiment\components folder.<br />
<br />
<br />
=== Developer version ===<br />
Copy the folders '''BCIStart''' and '''BCIUpdateState''' from ''src/contrib/PsychoPy Components'' directory of your BCI2000 repository into the folder {$PsychoPyHome}\psychopy\experiment\components.<br />
Open terminal and navigate to the PsychoPy home directory where ''setup.py'' resides.<br />
Run the following command in the terminal: <br/><br />
<code>pip install -e .</code> <br/><br/><br />
<br/><br/><br />
Start Psychopy application and in the builder view, under the '''Custom''' Components (in rightmost column), you should see the two new components - ''BCI2000Start'' and ''BCI2000UpdateState'' as shown in the figure below.<br />
<br />
[[File:PsychoPy_Start.png|alt="PsychoPy Homepage with BCI2000 Components"|PsychoPy Homepage with BCI2000 Components]]<br />
<br />
'''Note:''' Make sure you don't run the experiments on full screen if you are using a single screen. <br />
== References ==<br />
* 1. [https://www.psychopy.org/ PsychoPy site]<br />
<br />
== See Also ==<br />
* [[Programming Reference:BCI2000Remote Class]]<br />
* [[User Reference:Operator Module Scripting]]</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=PsychoPy&diff=8438PsychoPy2019-07-30T15:54:43Z<p>Dashmeetkaur: </p>
<hr />
<div>PsychoPy is an open-source application using which a large number of neuroscience, psychology and psychophysics experiments can be performed [1].<br />
This section first describes the two components that are developed to remotely start BCI2000 from the PsychoPy and the second section lists the steps to follow to add the new components in the PsychoPy application.<br />
<br />
== Components ==<br />
<br />
=== BCIStart ===<br />
The component starts up the BCI2000 modules remotely. The component takes two parameters:<br />
; Path : Path to the BCI2000 ''prog'' directory which contains the ''BCI2000Remote.py'' file.<br />
; States : List of new states to add to the BCI2000. The states in the list are defined as follows: 'StateName defaultValue maxValue'. Eg: lastKey 0 255, correctKey 0 1.<br />
<br />
[[File:BCI2000Start.png|alt="BCI2000 start component image showing its parameters"|BCIStart Component]]<br />
<br />
=== BCIUpdateState ===<br />
The component defines which state to update and when. It takes the following parameters:<br />
; State Name : The name of the state in BCI2000 to update.<br />
; Response Component Variable : The variable to which the state is be set OR the variable which contains the new value of the state. '''Note-''' the variable is written as ''$VariableName''. <br />
; Use Expression : If it is checked, the code written in 'Expression' is executed for each Frame and the variable specified is not used to update the state.<br />
; Expression : The code to execute for each Frame. It is given for the cases, where the variable is not available and the users want more control over how the state is updated. '''Note-''' the user would have to use commands like ''bci.Execute'' and ''SET STATE'' to update the state in such cases. See [[Programming Reference:BCI2000Remote Class]] and [[User Reference:Operator Module Scripting]] for more details.<br />
<br />
[[File:BCI2000UpdateState.png|alt="BCI2000 update state component image showing its parameters"|BCIUpdateStart Component]]<br />
<br />
== Integrating BCI2000 into PyschoPy ==<br />
Download the PsychoPy from the [https://www.psychopy.org/download.html PyschoPy] website. <br/><br />
<br />
<br />
=== Standalone version ===<br />
For Windows, Copy the folders '''BCIStart''' and '''BCIUpdateState''' from ''src/contrib/PsychoPy Components'' directory of your BCI2000 repository into the folder {$PsychoPyHome}\Lib\site-packages\psychopy\experiment\components folder.<br />
<br />
<br />
=== Developer version ===<br />
Here is a picture of how PsychoPy looks before integrating BCI2000 in it. Notice that in the rightmost column, under '''Custom''' Components, there is no BCI2000 component.<br />
[[File:PsychoPyWithoutBCI.png|alt="PsychoPy Homepage without BCI2000 Components"|PsychoPy Homepage without BCI2000 Components]]<br />
<br />
Copy the folders '''BCIStart''' and '''BCIUpdateState''' from ''src/contrib/PsychoPy Components'' directory of your BCI2000 repository into the folder {$PsychoPyHome}\psychopy\experiment\components.<br />
Open terminal and navigate to the PsychoPy home directory where ''setup.py'' resides.<br />
Run the following command in the terminal: <br/><br />
<code>pip install -e .</code> <br/><br/><br />
<br/><br/><br />
Start Psychopy application and in the builder view, under the '''Custom''' Components (in rightmost column), you should see the two new components - ''BCI2000Start'' and ''BCI2000UpdateState'' as shown in the figure below.<br />
<br />
[[File:PsychoPy_Start.png|alt="PsychoPy Homepage with BCI2000 Components"|PsychoPy Homepage with BCI2000 Components]]<br />
<br />
'''Note:''' Make sure you don't run the experiments on full screen if you are using a single screen. <br />
== References ==<br />
* 1. [https://www.psychopy.org/ PsychoPy site]<br />
<br />
== See Also ==<br />
* [[Programming Reference:BCI2000Remote Class]]<br />
* [[User Reference:Operator Module Scripting]]</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=File:PsychoPyWithoutBCI.png&diff=8437File:PsychoPyWithoutBCI.png2019-07-30T15:51:41Z<p>Dashmeetkaur: PsychoPy without BCI</p>
<hr />
<div>PsychoPy without BCI</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=Contributions:TBSIStimulator&diff=8433Contributions:TBSIStimulator2019-07-30T14:47:30Z<p>Dashmeetkaur: </p>
<hr />
<div>==Synopsis==<br />
The ''TBSIStimulatorFilter'' interacts with TBSI's USB-SPI wireless stimulator and dongle. The TBSI stimulator and dongle work in conjunction to administer pulses to different output channels on the stimulator. The type of pulses and interval at which these pulses are administered is customizable via the filter's parameters.<br />
<br />
To use this filter, a TBSI dongle must be connected to the computer via USB and the stimulator must be within range and charged.<br />
<br />
Tested with StimWare V1.7.22B67, dongle V0.25.0, and stimulator UID: FD, Type: E, Version: V0.40.10. Custom ''PI1'' and ''PD1'' parameters reverse engineered to work with these resources.<br />
<br />
==Location==<br />
http://{{SERVERNAME}}/svn/trunk/src/private/SignalProcessing/TBSIStimulator<br />
<br />
==Versioning==<br />
===Authors===<br />
Alex Belsten, Yichuan Wang<br />
<br />
===Source Code Revisions===<br />
*Initial development: 5799<br />
*Tested under: 5800<br />
*Known to compile under: 5802<br />
*Broken since: --<br />
<br />
==Known Issues==<br />
Connection to the dongle will sometimes stall during startup or the first few commands. Effort has been done to minimize this issue, but it's not completely solved. In case of a program stall, replug the dongle and rerun the program.<br />
<br />
==Parameters==<br />
<br />
===StimPattern===<br />
An encoded string that represents the type of pulse that is going to be administered. Currently, encoded strings obtained from TBSI's StimWare software are the only way to edit the pulse. To set a custom pulse,<br />
<br />
1. Install TBSI Stimware (install LabView if needed)<br />
<br />
2. Go to Stimware installation directory and search for "Dongle.ini"<br />
<br />
3. Open "Dongle.ini", change the value "Verbosity" from 0 to 1.<br />
<br />
4. Play with various button and observe the SPI command exchange happening in the bottom window. <br />
<br />
5. Copy the exact SPI message from the Stimware's bottom window into ''TBSIStimulator StimPattern'' parameter if you want to perform that exact same action. <br />
<br />
<br />
The default string is represented by the following settings in StimWare:<br />
<br />
{| class="wikitable"<br />
|-<br />
! Mux SubCh<br />
! ID<br />
! PI1<br />
! PD1<br />
! PI2<br />
! PD2<br />
! Invert<br />
! Train (Multiple Pulses)<br />
! Stimulus (Multiple Trains)<br />
|-<br />
| 1<br />
| 50 μs<br />
| 500 μA<br />
| 2,000 μs<br />
| 100 μA<br />
| 10,000 μs<br />
| Off<br />
| Off<br />
| Off<br />
|-<br />
|}<br />
<br />
===PI1===<br />
Custom initial stimulation value in μA.<br />
<br />
===PD1===<br />
Custom ''PI1'' duration in μs.<br />
<br />
===EditStimPattern===<br />
Allows for the editing of ''StimPattern'' based on the provided ''PI1'' and ''PD1'' values. If disabled, ''StimPattern'' will not be changed.<br />
===StimInterval===<br />
The interval in time in which the stimulus is administered. Reliability of connection with dongle and stimulator is compromised at values less than 3 seconds. <br />
<br />
===ExternalHWTrigger===<br />
Option to enable or disable external hardware triggers on TBSI dongle. Only enable if using external hardware triggers.<br />
<br />
==States==<br />
===StimState===<br />
Binary state that is set to 1 when a trigger command is sent. Otherwise, the state takes the value of 0. Useful for measuring the latency of software trigger commands. <br />
<br />
==See also==<br />
[[User Reference:Filters]], [[Contributions:SignalProcessing]]<br />
<br />
[[Category:Contributions]][[Category:Signal Processing]][[Category:Filters]]</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=Programming_Reference:NatusADC&diff=8432Programming Reference:NatusADC2019-07-29T20:59:21Z<p>Dashmeetkaur: /* NatusClient */</p>
<hr />
<div>NatusADC module has 3 main classes - NatusPackageInterface, NatusDataServer and NatusClient. The overview of the NatusADC working is shown in the image below.<br />
[[File:Prog_Ref_NatusADC_NatusWorking.png|center|800px|Overview of NatusADC working]]<br />
<br />
NatusDataServer processes and sends signal from the device to the client application. A project named XLDataExportClient reads signals from the device and calls the NatusDataServer's functions to send the signal to the client. NatusClient is the client application within the BCI2000 that receives the signals and does the initial processing. NatusPackageInterface contains the implementation of data transfer protocol between serve/device and client and is used by NatusClient and NatusDataServer to communicate with each other over TCP and UDP. NatusDataServer and NatusPackageInterface are independent of the BCI2000 where as NatusClient relies on BCI2000. <br />
<br />
<br />
The below image explains the context in which packet, blocks, samples and channels are used in this project. A packet may have one or block, a block may have one or more samples and a sample contains values for all the channels.<br />
[[File:NatusPacketImage.png|center|600px|Packet, block and samples relationship]]<br />
<br />
<br />
== NatusPackageInterface ==<br />
This class handles the communication between the server/device and the client. It should be included with both - NatusDataServer and NatusClient Class. The class performs the following functions -constructing TCP and UDP packets, calculating the CRC of a packet and checking the CRC on the receiving side, sending the packets over TCP/UDP port, receiving packets over TCP/UDP Port, reconstructing the data from the packets and listening for connections on device/server-side. ''Note - The file limits the maximum number of channels for a device (stored in MAX_NUM_CHANNELS in NatusPackageInterface.h) to 100.''<br />
<br/><br />
The format of the packets constructed along with each field size is as follows:<br />
[[File:Prog_Ref_NatusADC_Packet_format.png|center|600px|Packet format]]<br />
<br />
=== TCP Commands ===<br />
The commands through which the NatusDataServer and NatusClient communicate are as follows:<br />
; CMD_Ping : To check if the connection is successful and data can be sent and received.<br />
* Command Number: 0x01<br />
* Parameters/Payload: 0xff<br />
* Return Value: returns payload <br />
<br />
; CMD_GetInformation : To send the device information such as the number of channels and sampling rate to the client application.<br />
* Command Number: 0x02<br />
* Parameters/Payload: NULL <br />
* Return Value: struct NatusDeviceInformation which contains the number of channels, sampling rate, and device identifier.<br />
<br />
; CMD_GetChannelNames : To send the channel names as set by the device to the client application. If no channel names are set, NULL is sent.<br />
* Command Number: 0x03<br />
* Parameters/Payload: NULL <br />
* Return Value: struct NatusChannelInformation which contains all the channels and stream names.<br />
<br />
; CMD_StartStream : To start sending channel data over UDP port.<br />
* Command Number: 0x10<br />
* Parameters/Payload: NULL <br />
* Return Value: NULL<br />
<br />
; CMD_StopStream : To stop sending channel data<br />
* Command Number: 0x1F<br />
* Parameters/Payload: NULL <br />
* Return Value: NULL<br />
<br />
; CMD_SelectChannels : To send data only for the channels numbers mentioned in the payload. It corresponds to the SourceChList parameter.<br />
* Command Number: 0x20<br />
* Parameters/Payload: a list of channel numbers separated by space and stored in a string <br />
* Return Value: NULL<br />
<br />
; CMD_SetBlockSize : To set the number of blocks to send per packet. It corresponds to the SeverBlockSize parameter.<br />
* Command Number: 0x21<br />
* Parameters/Payload: number of blocks to send per packet stored in uint32_t datatype. <br />
* Return Value: NULL<br />
<br />
; CMD_GetDecimationFactor : To get the current decimation factor of the device/server.<br />
* Command Number: 0x22<br />
* Parameters/Payload: decimation factor stored in uint32_t datatype. <br />
* Return Value: NULL<br />
<br />
; CMD_SetDecimationFactor : To set the decimation factor of the device/server.<br />
* Command Number: 0x23<br />
* Parameters/Payload: NULL <br />
* Return Value: decimation factor stored in uint32_t datatype but casted into uint8_t datatype for transmission over TCP.<br />
<br />
; CMD_ERR : The command is sent if there is any type of error.<br />
* Command Number: 0xFF<br />
* Parameters/Payload: command which caused the error and the payload generated by the function handling the command.<br />
* Return Value: NULL<br />
<u>Note:</u> The packet format for this command is as follows: <br />
[[File:Prog_Ref_NatusADC_CMD_ERR.png|center|Command CMD_ERR packet format.]]<br />
<br />
=== UDP Commands ===<br />
; CMD_StreamPackage: The command is sent from the server/device to the client application when only 1 block per packet is sent.<br />
* Command Number: 0x11<br />
* Parameters/Payload: Channel data of 1 block<br />
* Return Value: NULL<br />
<br />
; CMD_VariableSizeStreamPackage: The command is sent from the server/device to the client application when more than 1 block per packet is sent.<br />
* Command Number: 0x12<br />
* Parameters/Payload: Channel data of more than 1 block (number of blocks as set by the CMD_SetBlockSize command)<br />
* Return Value: NULL<br />
<br />
=== Functions and Variables ===<br />
The public and protected functions and variables defined in this class are as follows: <br />
* '''void Poll ()''' - The function runs on server/device and continuously waits for any command from the NatusClient over the TCP protocol.<br />
* '''void send_data (uint8_t cmd, uint8_t* payload, uint32_t len_payload, bool isError=false, PackageType t = Control)''' - The function creates a packet using cmd (the command) and the payload. The default values for isError is false (i.e., no error) and PackageType is Control (TCP prototcol). The channel data is sent over Stream PackageType (i.e., UDP Protocol).<br />
* '''virtual void data_received (CmdStruct * payload) = 0''' - The function should be implemented in the child classes to ensure proper processing, in respect ot the child class, of the data recieved via TCP or UDP protocol is done.<br />
* '''void printMessage (std::string)''' - Print the string parameter on the warning window. <br />
* '''CmdStruct* getNextPackage ()''' - The function gets a TCP packet (from the server or from the Client, as the case may be) and store in struct CmdStruct. Definietion of CmdStruct can be found in ''NatusPackageInterface.h'' file.<br />
* '''CmdStruct* getNextUDPPackage ()''' - The function is same as CmdStruct* getNextPackage(), except that it received packet over UDP protocol. <br />
* '''void delete_cmdstruct (CmdStruct* )''' - The function frees the memory occupied by a CmdStruct pointer.<br />
* '''void initWSA ()''' - The function initializes the Winsock. <br />
* '''SOCKET connection''' - It stores the TCP socket connection, i.e, in server/device - the connection to the client and in client - the connection to the server/device.<br />
* '''SOCKET udpSocket''' - It stores the UDP socket connection.<br />
* '''sockaddr_in _udpReceiver''' - It stores the socket address for IPv4.<br />
<br />
== NatusDataServer ==<br />
This class handles the server-side processing. It performs the following functions - starts-up the TCP and UDP server, check for new connections, gracefully disconnects from the client, registers various callbacks on client connection and deregister the callbacks when the client disconnects and responds to the commands (described in the NatusPackageInterface section) from the client via TCP protocol.<br />
<br />
=== Functions and Variables ===<br />
The public and protected functions and variables defined in this class are as follows: <br />
* '''void Startup (std::uint16_t port)''' - The function starts up the server and listens for a TCP connection on the port number specified by ''port'' and a UDP connection on the port number ''port+1''.<br />
* '''void CheckForConnection ()''' - The function checks for a client connection request and accept it if there is one.<br />
* '''void RegisterDataStreamCallback (NatusDataStreamRequest, void*)''' - The function registers the callbacks to start & stop streams.<br />
* '''void RegisterInformationCallback (NatusInformationRequest, void*)''' - The function registers the callback to get the device information.<br />
* '''void RegisterChannelInformationCallback (NatusChannelInfoRequest, void*)''' - The function registers the callback to get the device's channels' names.<br />
* '''void RegisterErrorCallback (NatusResponse, void*)''' - The function registers the callback to call incase of any error.<br />
* '''void UnregisterCallbacks ()''' - The function deregisters all the callbacks. It is called before closing the connection with the client.<br />
* '''void SendStreamData (float* data, uint32_t numdata)''' - The function accepts the channel ''data'' and the number of channels ''numdata'' and prepares the data by decimating it (if decimation factor is set) and by making packets with required number of blocks which are then sent to the client. <br />
* '''void Disconnect ()''' - The function gracefully closes the UDP and TCP connection with the client.<br />
* '''bool HasClient ()''' - The function checks if there is a client connected to the server/device.<br />
* '''int _channelsToStream[MAX_NUM_CHANNELS]''' - It stores the channel numbers which are to be streamed. The end of the array is defined by storing the last element as -1.<br />
* '''int _numberOfChannelsToStream''' - It stores the number of channels to stream.<br />
* '''void data_received (CmdStruct *payload)''' - The function checks for the command received from the client and calls the appropriate function to fulfill the client's request.<br />
* '''void start_UDP_sever (std::uint16_t port)''' - The function opens up a UDP connection at the ''port''.<br />
<br />
== NatusClient ==<br />
This class handles the client-side processing. It connects with the server/device, gets data from the operator module of the NatusADC and sends it to the server/device. It uses various commands as described in the NatusDataServer to set different parameters. Another important function of this class 'interpolateMissingBlocks' linearly interpolates the missing UDP packets which contain the channel data values. Eg. <br/> <br />
Consider the scenario where for a single channel with 1 sample per block, 1 block per packet is sent with decimation factor is 1. Suppose we received packet 1 and 3, packet 2 was lost. Data for packet 2 is interpolated as follows: <br />
<br/> Interpolation formula<br />
''Interpolated Value = ((Current Packet value – Previous Packet value) / (Current Packet Number – Previous Packet Number)) * (Interpolated Packet Number – Previous Packet Number) + Previous Packet Value''<br />
[[File:Programming_Reference_NatusADC_Interpolation.png|center|500px|Linear Interpolation example]]<br />
<br />
=== Functions and Variables ===<br />
The public and protected functions and variables defined in this class are as follows: <br />
* '''NatusDeviceInformation GetInformation ()''' - The function sends a CMD_GetInformation command to the server/device over TCP to query the sampling rate and number of channels of the device. It stores the received information in the ''NatusDeviceInformation'' struct type variable.<br />
* '''void Connect (std::string server_name, int port)''' - The function establishes a TCP connection with the ''server_name'' server at port number ''port'' and calls the ''init_udp'' function to establish a UDP connection at port ''port+1''.<br />
* '''bool TryConnect (std::string server_name, int port)''' - The function tries to establish a TCP and UDP connection again with the ''server_name'' if the connection is lost and returns ''true'' if the connection is successful otherwise ''false''.<br />
* '''void Disconnect ()''' - The function gracefully closes the TCP and UDP connection with the server/device.<br />
* '''void StartStream ()''' - The function sends the CMD_StartStream command to the server/device to request the channel stream data, which the server/device sends over the UDP.<br />
* '''void StopStream ()''' - The function sends the CMD_StopStream command to the server/device. <br />
* '''uint8_t Ping (uint8_t ping)''' - The function sends a CMD_PING command to the sever/device with data stored in ''ping'' as payload.<br />
* '''NatusSampleBlock* ReadStream ()''' - The function gets channel data blocks from the server/device through a UDP protocol, calls the ''interpolateMissingBlocks'' if there is any missing blocks, adds the block to the ''_receivequeue'' and returns the first block from the ''_receivequeue''.<br />
* '''NatusSampleBlock* create_natus_sampleblock (uint8_t* payload)''' - The function creates and returns a NatusSampleBlock structure variable from the payload passes. NatusSampleBlock contains block number, number of samples, samples and a boolean specifying whether the block was recieved from the server/device or was interpolated.<br />
* '''void DeleteSampleBlock (NatusSampleBlock*)''' - The function free the space occupied by the NatusSampleBlock variable passed to it.<br />
* '''void SetSampleBlockSize (uint32_t blocksize)''' - The function sends CMD_SetBlockSize command to the server/device to set number of blocks to be sent in a packet as ''blocksize''.<br />
* '''void SetDecimationFactor (uint32_t decimationFactor)''' - The function sends CMD_SetDecimationFactor command to the server/device to set the decimation factor as ''decimationFactor''.<br />
* '''NatusChannelInformation GetChannelInfo ()''' - The function sends CMD_GetChannelNames command to the server/device to query the channel and stream names of the device and stores them in a NatusChannelInformation structure.<br />
* '''int GetDecimationFactor ()''' - The function queries from the server/device over TCP, the current decimation factor and returns it.<br />
* '''int SelectChannelsToStream (std::string channels)''' - The function sends CMD_SelectChannels command to the server/device along with the channels to stream stored in a space separated ''channels'' string.<br />
* '''int _channelsToStream[MAX_NUM_CHANNELS]''' - It stores the channel numbers which are to be streamed. <br />
* '''NatusChannelInformation channelInfo''' - The structure stores the channel and stream names of the device. The NatusChannelInformation structure definition can be found in ''NatusPackageInterface.h'' file.<br />
* '''void data_received (CmdStruct *payload)''' - The function checks if the data received from the server/device does not contain a CMD_ERR code.<br />
* '''CmdStruct* blockForPackage(uint32_t timeout)''' - The function waits to receive a TCP packet from server/device for the time specified by the ''timeout'' variable.<br />
* '''std::queue<NatusSampleBlock*> _receivequeue''' - The queue stores the blocks received for processing.<br />
* '''bool init_udp (int port)''' - The function creates and binds a UDP socket. If completed successfully, it returns ''true'', otherwise ''false''.<br />
* '''NatusSampleBlock _prevblock''' - It stores the last data block received from the server/device and is used to check if any block is lost in between, when the client receives a new data block. <br />
* '''void interpolateMissingBlocks (NatusSampleBlock*)''' - The function linearly interpolates any number of missing blocks between the current received data block and the last recieved data block.<br />
* '''void emptyReceiveQueue ()''' - The function frees the memory occupied by the queue ''_receivequeue'' whenever the connection is closed or restarted.<br />
<br />
== See also ==<br />
[[Contributions:NatusADC]], [[User Reference:DataIOFilter]], [[Programming Reference:GenericADC Class]]<br />
[[Category:Filters]][[Category:Data Acquisition]]</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=Contributions:NatusADC&diff=8431Contributions:NatusADC2019-07-29T20:57:15Z<p>Dashmeetkaur: </p>
<hr />
<div>== Function ==<br />
The NatusADC filter acquires raw data in real-time from Natus Headboxes over UDP connection for signal processing and visualizations. The overview of the NatusADC working is shown in the image below.<br />
[[File:Prog_Ref_NatusADC_NatusWorking.png|center|800px|Overview of NatusADC working]]<br />
<br />
NatusDataServer processes and sends signal from the device to the client application. A project named XLDataExportClient reads signals from the device and calls the NatusDataServer's functions to send the signal to the client. NatusClient is the client application within the BCI2000 that receives the signals and does the initial processing. NatusPackageInterface contains the implementation of data transfer protocol between serve/device and client and is used by NatusClient and NatusDataServer to communicate with each other over TCP and UDP. NatusDataServer and NatusPackageInterface are independent of the BCI2000 where as NatusClient relies on BCI2000. <br />
<br />
<br />
The below image explains the context in which packet, blocks, samples and channels are used in this project. A packet may have one or block, a block may have one or more samples and a sample contains values for all the channels.<br />
[[File:NatusPacketImage.png|center|600px|Packet, block and samples relationship]] <br />
<br />
=== Hardware ===<br />
In theory, the module should work fine with all of the following Natus Headboxes. <br />
# EEG32<br />
# EEG128, EEG128FS<br />
# Mobee32, Mobee32-02<br />
# Mobee-24<br />
# Connex/ Brain Monitor<br />
# Trex<br />
# EMU40<br />
# EEG32u<br />
# Quantum<br />
# NeuroLink IP<br />
# Bio-logic NetLink<br />
# Bio-logic Traveler<br />
<br />
==== Drivers ====<br />
<br />
== Parameters ==<br />
Parameters common to all source modules are described under [[User Reference:DataIOFilter]]. In addition, the following parameters are supported:<br />
<br />
=== SamplingRate ===<br />
The rate at which the device samples the data. The default value is the device's default sampling rate. <br />
<br />
=== SampleBlockSize ===<br />
The number of samples per block the output signal, created by the client application(NatusADC), should have. The default value is 20<br />
<br />
=== ServerBlockSize ===<br />
The number of blocks sent by the server/device in a single UDP Packet. The default value is 1.<br />
<br />
=== DecimationFactor ===<br />
The decimation factor. The factor by which to decimate/downsize the signal. The default value is 1. ''The SamplingRate is updated by dividing it by the DecimationFactor.'' <br />
'''Note:''' The SamplingRate should be an integral multiple of DecimationFactor.<br />
<br />
=== ServerIP ===<br />
The IPv4 address of the server/device.<br />
<br />
=== Port ===<br />
The port number of the server/device which on which TCP runs. UDP port number is assumed to be 1 + TCP port number.<br />
<br />
=== SourceCh ===<br />
The number of channels to be acquired from the device. If this is set to auto, all the available channels from the device will be acquired.<br />
<br />
=== SourceChGain ===<br />
SourceChGain should be left to auto. The default value is 0 for every channel.<br />
<br />
=== SourceChOffset ===<br />
SourceChOffset should be left to auto. The default value is 1 microVolt for every channel.<br />
<br />
=== SourceChList ===<br />
The list of channel numbers to be acquired from the device. The order of the numbers doesn't matter, i.e., '1 2 3 4' is same as '3 2 4 1'. Entering duplicate channels, eg. in '1 2 3 2' will result in an error. Entering an invalid channel number, i.e., a number greater than the maximum number of the channels will result in an error. If set to auto, all the device channels will be streamed.<br />
<br />
=== ChannelNames ===<br />
The user-preferred channel names. If set to auto, the channel names will be retrieved from the device. If the device doesn't have any specific channel names, the channel names will be set to 0 to SourceCh - 1. If set manually, names should be given for each channel in SourceChList<br />
<br />
== States ==<br />
<br />
=== Interpolated ===<br />
Interpolated is represented by 1 bit. The device sends data in packets over UDP connection which is not a reliable connection and hence may result in loss of some packets. The lost packets between two packets received from the device are linearly interpolated from the aforementioned two packets. The Interpolated state value is 1 if the packet is interpolated or 0 if the packet is received from the device. <br />
<br />
== Additional Info ==<br />
The module also contains a function called GetDecimationFactor to query the current Decimation Factor from the server/device. <br/><br />
More details from a programmer's perspective can be found here [[Programming_Reference:NatusADC]]<br />
<br />
== See also ==<br />
[[User Reference:DataIOFilter]], [[Programming Reference:GenericADC Class]]<br />
[[Category:Filters]][[Category:Data Acquisition]]</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=Programming_Reference:NatusADC&diff=8430Programming Reference:NatusADC2019-07-29T20:56:38Z<p>Dashmeetkaur: </p>
<hr />
<div>NatusADC module has 3 main classes - NatusPackageInterface, NatusDataServer and NatusClient. The overview of the NatusADC working is shown in the image below.<br />
[[File:Prog_Ref_NatusADC_NatusWorking.png|center|800px|Overview of NatusADC working]]<br />
<br />
NatusDataServer processes and sends signal from the device to the client application. A project named XLDataExportClient reads signals from the device and calls the NatusDataServer's functions to send the signal to the client. NatusClient is the client application within the BCI2000 that receives the signals and does the initial processing. NatusPackageInterface contains the implementation of data transfer protocol between serve/device and client and is used by NatusClient and NatusDataServer to communicate with each other over TCP and UDP. NatusDataServer and NatusPackageInterface are independent of the BCI2000 where as NatusClient relies on BCI2000. <br />
<br />
<br />
The below image explains the context in which packet, blocks, samples and channels are used in this project. A packet may have one or block, a block may have one or more samples and a sample contains values for all the channels.<br />
[[File:NatusPacketImage.png|center|600px|Packet, block and samples relationship]]<br />
<br />
<br />
== NatusPackageInterface ==<br />
This class handles the communication between the server/device and the client. It should be included with both - NatusDataServer and NatusClient Class. The class performs the following functions -constructing TCP and UDP packets, calculating the CRC of a packet and checking the CRC on the receiving side, sending the packets over TCP/UDP port, receiving packets over TCP/UDP Port, reconstructing the data from the packets and listening for connections on device/server-side. ''Note - The file limits the maximum number of channels for a device (stored in MAX_NUM_CHANNELS in NatusPackageInterface.h) to 100.''<br />
<br/><br />
The format of the packets constructed along with each field size is as follows:<br />
[[File:Prog_Ref_NatusADC_Packet_format.png|center|600px|Packet format]]<br />
<br />
=== TCP Commands ===<br />
The commands through which the NatusDataServer and NatusClient communicate are as follows:<br />
; CMD_Ping : To check if the connection is successful and data can be sent and received.<br />
* Command Number: 0x01<br />
* Parameters/Payload: 0xff<br />
* Return Value: returns payload <br />
<br />
; CMD_GetInformation : To send the device information such as the number of channels and sampling rate to the client application.<br />
* Command Number: 0x02<br />
* Parameters/Payload: NULL <br />
* Return Value: struct NatusDeviceInformation which contains the number of channels, sampling rate, and device identifier.<br />
<br />
; CMD_GetChannelNames : To send the channel names as set by the device to the client application. If no channel names are set, NULL is sent.<br />
* Command Number: 0x03<br />
* Parameters/Payload: NULL <br />
* Return Value: struct NatusChannelInformation which contains all the channels and stream names.<br />
<br />
; CMD_StartStream : To start sending channel data over UDP port.<br />
* Command Number: 0x10<br />
* Parameters/Payload: NULL <br />
* Return Value: NULL<br />
<br />
; CMD_StopStream : To stop sending channel data<br />
* Command Number: 0x1F<br />
* Parameters/Payload: NULL <br />
* Return Value: NULL<br />
<br />
; CMD_SelectChannels : To send data only for the channels numbers mentioned in the payload. It corresponds to the SourceChList parameter.<br />
* Command Number: 0x20<br />
* Parameters/Payload: a list of channel numbers separated by space and stored in a string <br />
* Return Value: NULL<br />
<br />
; CMD_SetBlockSize : To set the number of blocks to send per packet. It corresponds to the SeverBlockSize parameter.<br />
* Command Number: 0x21<br />
* Parameters/Payload: number of blocks to send per packet stored in uint32_t datatype. <br />
* Return Value: NULL<br />
<br />
; CMD_GetDecimationFactor : To get the current decimation factor of the device/server.<br />
* Command Number: 0x22<br />
* Parameters/Payload: decimation factor stored in uint32_t datatype. <br />
* Return Value: NULL<br />
<br />
; CMD_SetDecimationFactor : To set the decimation factor of the device/server.<br />
* Command Number: 0x23<br />
* Parameters/Payload: NULL <br />
* Return Value: decimation factor stored in uint32_t datatype but casted into uint8_t datatype for transmission over TCP.<br />
<br />
; CMD_ERR : The command is sent if there is any type of error.<br />
* Command Number: 0xFF<br />
* Parameters/Payload: command which caused the error and the payload generated by the function handling the command.<br />
* Return Value: NULL<br />
<u>Note:</u> The packet format for this command is as follows: <br />
[[File:Prog_Ref_NatusADC_CMD_ERR.png|center|Command CMD_ERR packet format.]]<br />
<br />
=== UDP Commands ===<br />
; CMD_StreamPackage: The command is sent from the server/device to the client application when only 1 block per packet is sent.<br />
* Command Number: 0x11<br />
* Parameters/Payload: Channel data of 1 block<br />
* Return Value: NULL<br />
<br />
; CMD_VariableSizeStreamPackage: The command is sent from the server/device to the client application when more than 1 block per packet is sent.<br />
* Command Number: 0x12<br />
* Parameters/Payload: Channel data of more than 1 block (number of blocks as set by the CMD_SetBlockSize command)<br />
* Return Value: NULL<br />
<br />
=== Functions and Variables ===<br />
The public and protected functions and variables defined in this class are as follows: <br />
* '''void Poll ()''' - The function runs on server/device and continuously waits for any command from the NatusClient over the TCP protocol.<br />
* '''void send_data (uint8_t cmd, uint8_t* payload, uint32_t len_payload, bool isError=false, PackageType t = Control)''' - The function creates a packet using cmd (the command) and the payload. The default values for isError is false (i.e., no error) and PackageType is Control (TCP prototcol). The channel data is sent over Stream PackageType (i.e., UDP Protocol).<br />
* '''virtual void data_received (CmdStruct * payload) = 0''' - The function should be implemented in the child classes to ensure proper processing, in respect ot the child class, of the data recieved via TCP or UDP protocol is done.<br />
* '''void printMessage (std::string)''' - Print the string parameter on the warning window. <br />
* '''CmdStruct* getNextPackage ()''' - The function gets a TCP packet (from the server or from the Client, as the case may be) and store in struct CmdStruct. Definietion of CmdStruct can be found in ''NatusPackageInterface.h'' file.<br />
* '''CmdStruct* getNextUDPPackage ()''' - The function is same as CmdStruct* getNextPackage(), except that it received packet over UDP protocol. <br />
* '''void delete_cmdstruct (CmdStruct* )''' - The function frees the memory occupied by a CmdStruct pointer.<br />
* '''void initWSA ()''' - The function initializes the Winsock. <br />
* '''SOCKET connection''' - It stores the TCP socket connection, i.e, in server/device - the connection to the client and in client - the connection to the server/device.<br />
* '''SOCKET udpSocket''' - It stores the UDP socket connection.<br />
* '''sockaddr_in _udpReceiver''' - It stores the socket address for IPv4.<br />
<br />
== NatusDataServer ==<br />
This class handles the server-side processing. It performs the following functions - starts-up the TCP and UDP server, check for new connections, gracefully disconnects from the client, registers various callbacks on client connection and deregister the callbacks when the client disconnects and responds to the commands (described in the NatusPackageInterface section) from the client via TCP protocol.<br />
<br />
=== Functions and Variables ===<br />
The public and protected functions and variables defined in this class are as follows: <br />
* '''void Startup (std::uint16_t port)''' - The function starts up the server and listens for a TCP connection on the port number specified by ''port'' and a UDP connection on the port number ''port+1''.<br />
* '''void CheckForConnection ()''' - The function checks for a client connection request and accept it if there is one.<br />
* '''void RegisterDataStreamCallback (NatusDataStreamRequest, void*)''' - The function registers the callbacks to start & stop streams.<br />
* '''void RegisterInformationCallback (NatusInformationRequest, void*)''' - The function registers the callback to get the device information.<br />
* '''void RegisterChannelInformationCallback (NatusChannelInfoRequest, void*)''' - The function registers the callback to get the device's channels' names.<br />
* '''void RegisterErrorCallback (NatusResponse, void*)''' - The function registers the callback to call incase of any error.<br />
* '''void UnregisterCallbacks ()''' - The function deregisters all the callbacks. It is called before closing the connection with the client.<br />
* '''void SendStreamData (float* data, uint32_t numdata)''' - The function accepts the channel ''data'' and the number of channels ''numdata'' and prepares the data by decimating it (if decimation factor is set) and by making packets with required number of blocks which are then sent to the client. <br />
* '''void Disconnect ()''' - The function gracefully closes the UDP and TCP connection with the client.<br />
* '''bool HasClient ()''' - The function checks if there is a client connected to the server/device.<br />
* '''int _channelsToStream[MAX_NUM_CHANNELS]''' - It stores the channel numbers which are to be streamed. The end of the array is defined by storing the last element as -1.<br />
* '''int _numberOfChannelsToStream''' - It stores the number of channels to stream.<br />
* '''void data_received (CmdStruct *payload)''' - The function checks for the command received from the client and calls the appropriate function to fulfill the client's request.<br />
* '''void start_UDP_sever (std::uint16_t port)''' - The function opens up a UDP connection at the ''port''.<br />
<br />
== NatusClient ==<br />
This class handles the client-side processing. It connects with the server/device, gets data from the operator module of the NatusADC and sends it to the server/device. It uses various commands as described in the NatusDataServer to set different parameters. Another important function of this class 'interpolateMissingBlocks' linearly interpolates the missing UDP packets which contain the channel data values. Eg. <br/> <br />
Consider the scenario where 1 block is sent per packet and decimation factor is 1. Suppose we received packet 1 and 3, packet 2 was lost. Data for packet 2 is interpolated as follows: <br />
<br/> Interpolation formula<br />
''Interpolated Value = ((Current Packet value – Previous Packet value) / (Current Packet Number – Previous Packet Number)) * (Interpolated Packet Number – Previous Packet Number) + Previous Packet Value''<br />
[[File:Programming_Reference_NatusADC_Interpolation.png|center|500px|Linear Interpolation example]]<br />
<br />
=== Functions and Variables ===<br />
The public and protected functions and variables defined in this class are as follows: <br />
* '''NatusDeviceInformation GetInformation ()''' - The function sends a CMD_GetInformation command to the server/device over TCP to query the sampling rate and number of channels of the device. It stores the received information in the ''NatusDeviceInformation'' struct type variable.<br />
* '''void Connect (std::string server_name, int port)''' - The function establishes a TCP connection with the ''server_name'' server at port number ''port'' and calls the ''init_udp'' function to establish a UDP connection at port ''port+1''.<br />
* '''bool TryConnect (std::string server_name, int port)''' - The function tries to establish a TCP and UDP connection again with the ''server_name'' if the connection is lost and returns ''true'' if the connection is successful otherwise ''false''.<br />
* '''void Disconnect ()''' - The function gracefully closes the TCP and UDP connection with the server/device.<br />
* '''void StartStream ()''' - The function sends the CMD_StartStream command to the server/device to request the channel stream data, which the server/device sends over the UDP.<br />
* '''void StopStream ()''' - The function sends the CMD_StopStream command to the server/device. <br />
* '''uint8_t Ping (uint8_t ping)''' - The function sends a CMD_PING command to the sever/device with data stored in ''ping'' as payload.<br />
* '''NatusSampleBlock* ReadStream ()''' - The function gets channel data blocks from the server/device through a UDP protocol, calls the ''interpolateMissingBlocks'' if there is any missing blocks, adds the block to the ''_receivequeue'' and returns the first block from the ''_receivequeue''.<br />
* '''NatusSampleBlock* create_natus_sampleblock (uint8_t* payload)''' - The function creates and returns a NatusSampleBlock structure variable from the payload passes. NatusSampleBlock contains block number, number of samples, samples and a boolean specifying whether the block was recieved from the server/device or was interpolated.<br />
* '''void DeleteSampleBlock (NatusSampleBlock*)''' - The function free the space occupied by the NatusSampleBlock variable passed to it.<br />
* '''void SetSampleBlockSize (uint32_t blocksize)''' - The function sends CMD_SetBlockSize command to the server/device to set number of blocks to be sent in a packet as ''blocksize''.<br />
* '''void SetDecimationFactor (uint32_t decimationFactor)''' - The function sends CMD_SetDecimationFactor command to the server/device to set the decimation factor as ''decimationFactor''.<br />
* '''NatusChannelInformation GetChannelInfo ()''' - The function sends CMD_GetChannelNames command to the server/device to query the channel and stream names of the device and stores them in a NatusChannelInformation structure.<br />
* '''int GetDecimationFactor ()''' - The function queries from the server/device over TCP, the current decimation factor and returns it.<br />
* '''int SelectChannelsToStream (std::string channels)''' - The function sends CMD_SelectChannels command to the server/device along with the channels to stream stored in a space separated ''channels'' string.<br />
* '''int _channelsToStream[MAX_NUM_CHANNELS]''' - It stores the channel numbers which are to be streamed. <br />
* '''NatusChannelInformation channelInfo''' - The structure stores the channel and stream names of the device. The NatusChannelInformation structure definition can be found in ''NatusPackageInterface.h'' file.<br />
* '''void data_received (CmdStruct *payload)''' - The function checks if the data received from the server/device does not contain a CMD_ERR code.<br />
* '''CmdStruct* blockForPackage(uint32_t timeout)''' - The function waits to receive a TCP packet from server/device for the time specified by the ''timeout'' variable.<br />
* '''std::queue<NatusSampleBlock*> _receivequeue''' - The queue stores the blocks received for processing.<br />
* '''bool init_udp (int port)''' - The function creates and binds a UDP socket. If completed successfully, it returns ''true'', otherwise ''false''.<br />
* '''NatusSampleBlock _prevblock''' - It stores the last data block received from the server/device and is used to check if any block is lost in between, when the client receives a new data block. <br />
* '''void interpolateMissingBlocks (NatusSampleBlock*)''' - The function linearly interpolates any number of missing blocks between the current received data block and the last recieved data block.<br />
* '''void emptyReceiveQueue ()''' - The function frees the memory occupied by the queue ''_receivequeue'' whenever the connection is closed or restarted.<br />
<br />
== See also ==<br />
[[Contributions:NatusADC]], [[User Reference:DataIOFilter]], [[Programming Reference:GenericADC Class]]<br />
[[Category:Filters]][[Category:Data Acquisition]]</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=File:NatusPacketImage.png&diff=8429File:NatusPacketImage.png2019-07-29T20:52:09Z<p>Dashmeetkaur: NatusPacketImage</p>
<hr />
<div>NatusPacketImage</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=Contributions:NatusADC&diff=8428Contributions:NatusADC2019-07-29T20:23:18Z<p>Dashmeetkaur: </p>
<hr />
<div>== Function ==<br />
The NatusADC filter acquires raw data in real-time from Natus Headboxes over UDP connection for signal processing and visualizations. <br />
<br />
=== Hardware ===<br />
In theory, the module should work fine with all of the following Natus Headboxes. <br />
# EEG32<br />
# EEG128, EEG128FS<br />
# Mobee32, Mobee32-02<br />
# Mobee-24<br />
# Connex/ Brain Monitor<br />
# Trex<br />
# EMU40<br />
# EEG32u<br />
# Quantum<br />
# NeuroLink IP<br />
# Bio-logic NetLink<br />
# Bio-logic Traveler<br />
<br />
==== Drivers ====<br />
<br />
== Parameters ==<br />
Parameters common to all source modules are described under [[User Reference:DataIOFilter]]. In addition, the following parameters are supported:<br />
<br />
=== SamplingRate ===<br />
The rate at which the device samples the data. The default value is the device's default sampling rate. <br />
<br />
=== SampleBlockSize ===<br />
The number of samples per block the output signal, created by the client application(NatusADC), should have. The default value is 20<br />
<br />
=== ServerBlockSize ===<br />
The number of blocks sent by the server/device in a single UDP Packet. The default value is 1.<br />
<br />
=== DecimationFactor ===<br />
The decimation factor. The factor by which to decimate/downsize the signal. The default value is 1. ''The SamplingRate is updated by dividing it by the DecimationFactor.'' <br />
'''Note:''' The SamplingRate should be an integral multiple of DecimationFactor.<br />
<br />
=== ServerIP ===<br />
The IPv4 address of the server/device.<br />
<br />
=== Port ===<br />
The port number of the server/device which on which TCP runs. UDP port number is assumed to be 1 + TCP port number.<br />
<br />
=== SourceCh ===<br />
The number of channels to be acquired from the device. If this is set to auto, all the available channels from the device will be acquired.<br />
<br />
=== SourceChGain ===<br />
SourceChGain should be left to auto. The default value is 0 for every channel.<br />
<br />
=== SourceChOffset ===<br />
SourceChOffset should be left to auto. The default value is 1 microVolt for every channel.<br />
<br />
=== SourceChList ===<br />
The list of channel numbers to be acquired from the device. The order of the numbers doesn't matter, i.e., '1 2 3 4' is same as '3 2 4 1'. Entering duplicate channels, eg. in '1 2 3 2' will result in an error. Entering an invalid channel number, i.e., a number greater than the maximum number of the channels will result in an error. If set to auto, all the device channels will be streamed.<br />
<br />
=== ChannelNames ===<br />
The user-preferred channel names. If set to auto, the channel names will be retrieved from the device. If the device doesn't have any specific channel names, the channel names will be set to 0 to SourceCh - 1. If set manually, names should be given for each channel in SourceChList<br />
<br />
== States ==<br />
<br />
=== Interpolated ===<br />
Interpolated is represented by 1 bit. The device sends data in packets over UDP connection which is not a reliable connection and hence may result in loss of some packets. The lost packets between two packets received from the device are linearly interpolated from the aforementioned two packets. The Interpolated state value is 1 if the packet is interpolated or 0 if the packet is received from the device. <br />
<br />
== Additional Info ==<br />
The module also contains a function called GetDecimationFactor to query the current Decimation Factor from the server/device. <br/><br />
More details from a programmer's perspective can be found here [[Programming_Reference:NatusADC]]<br />
<br />
== See also ==<br />
[[User Reference:DataIOFilter]], [[Programming Reference:GenericADC Class]]<br />
[[Category:Filters]][[Category:Data Acquisition]]</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=Programming_Reference:NatusADC&diff=8427Programming Reference:NatusADC2019-07-29T20:13:06Z<p>Dashmeetkaur: /* NatusPackageInterface */</p>
<hr />
<div>NatusADC module has 3 main classes - NatusPackageInterface, NatusDataServer and NatusClient. The overview of the NatusADC working is shown in the image below.<br />
[[File:Prog_Ref_NatusADC_NatusWorking.png|center|800px|Overview of NatusADC working]]<br />
<br />
NatusDataServer processes and sends signal from the device to the client application. A project named XLDataExportClient reads signals from the device and calls the NatusDataServer's functions to send the signal to the client. NatusClient is the client application within the BCI2000 that receives the signals and does the initial processing. NatusPackageInterface contains the implementation of data transfer protocol between serve/device and client and is used by NatusClient and NatusDataServer to communicate with each other over TCP and UDP. NatusDataServer and NatusPackageInterface are independent of the BCI2000 where as NatusClient relies on BCI2000. <br />
<br />
== NatusPackageInterface ==<br />
This class handles the communication between the server/device and the client. It should be included with both - NatusDataServer and NatusClient Class. The class performs the following functions -constructing TCP and UDP packets, calculating the CRC of a packet and checking the CRC on the receiving side, sending the packets over TCP/UDP port, receiving packets over TCP/UDP Port, reconstructing the data from the packets and listening for connections on device/server-side. ''Note - The file limits the maximum number of channels for a device (stored in MAX_NUM_CHANNELS in NatusPackageInterface.h) to 100.''<br />
<br/><br />
The format of the packets constructed along with each field size is as follows:<br />
[[File:Prog_Ref_NatusADC_Packet_format.png|center|600px|Packet format]]<br />
<br />
=== TCP Commands ===<br />
The commands through which the NatusDataServer and NatusClient communicate are as follows:<br />
; CMD_Ping : To check if the connection is successful and data can be sent and received.<br />
* Command Number: 0x01<br />
* Parameters/Payload: 0xff<br />
* Return Value: returns payload <br />
<br />
; CMD_GetInformation : To send the device information such as the number of channels and sampling rate to the client application.<br />
* Command Number: 0x02<br />
* Parameters/Payload: NULL <br />
* Return Value: struct NatusDeviceInformation which contains the number of channels, sampling rate, and device identifier.<br />
<br />
; CMD_GetChannelNames : To send the channel names as set by the device to the client application. If no channel names are set, NULL is sent.<br />
* Command Number: 0x03<br />
* Parameters/Payload: NULL <br />
* Return Value: struct NatusChannelInformation which contains all the channels and stream names.<br />
<br />
; CMD_StartStream : To start sending channel data over UDP port.<br />
* Command Number: 0x10<br />
* Parameters/Payload: NULL <br />
* Return Value: NULL<br />
<br />
; CMD_StopStream : To stop sending channel data<br />
* Command Number: 0x1F<br />
* Parameters/Payload: NULL <br />
* Return Value: NULL<br />
<br />
; CMD_SelectChannels : To send data only for the channels numbers mentioned in the payload. It corresponds to the SourceChList parameter.<br />
* Command Number: 0x20<br />
* Parameters/Payload: a list of channel numbers separated by space and stored in a string <br />
* Return Value: NULL<br />
<br />
; CMD_SetBlockSize : To set the number of blocks to send per packet. It corresponds to the SeverBlockSize parameter.<br />
* Command Number: 0x21<br />
* Parameters/Payload: number of blocks to send per packet stored in uint32_t datatype. <br />
* Return Value: NULL<br />
<br />
; CMD_GetDecimationFactor : To get the current decimation factor of the device/server.<br />
* Command Number: 0x22<br />
* Parameters/Payload: decimation factor stored in uint32_t datatype. <br />
* Return Value: NULL<br />
<br />
; CMD_SetDecimationFactor : To set the decimation factor of the device/server.<br />
* Command Number: 0x23<br />
* Parameters/Payload: NULL <br />
* Return Value: decimation factor stored in uint32_t datatype but casted into uint8_t datatype for transmission over TCP.<br />
<br />
; CMD_ERR : The command is sent if there is any type of error.<br />
* Command Number: 0xFF<br />
* Parameters/Payload: command which caused the error and the payload generated by the function handling the command.<br />
* Return Value: NULL<br />
<u>Note:</u> The packet format for this command is as follows: <br />
[[File:Prog_Ref_NatusADC_CMD_ERR.png|center|Command CMD_ERR packet format.]]<br />
<br />
=== UDP Commands ===<br />
; CMD_StreamPackage: The command is sent from the server/device to the client application when only 1 block per packet is sent.<br />
* Command Number: 0x11<br />
* Parameters/Payload: Channel data of 1 block<br />
* Return Value: NULL<br />
<br />
; CMD_VariableSizeStreamPackage: The command is sent from the server/device to the client application when more than 1 block per packet is sent.<br />
* Command Number: 0x12<br />
* Parameters/Payload: Channel data of more than 1 block (number of blocks as set by the CMD_SetBlockSize command)<br />
* Return Value: NULL<br />
<br />
=== Functions and Variables ===<br />
The public and protected functions and variables defined in this class are as follows: <br />
* '''void Poll ()''' - The function runs on server/device and continuously waits for any command from the NatusClient over the TCP protocol.<br />
* '''void send_data (uint8_t cmd, uint8_t* payload, uint32_t len_payload, bool isError=false, PackageType t = Control)''' - The function creates a packet using cmd (the command) and the payload. The default values for isError is false (i.e., no error) and PackageType is Control (TCP prototcol). The channel data is sent over Stream PackageType (i.e., UDP Protocol).<br />
* '''virtual void data_received (CmdStruct * payload) = 0''' - The function should be implemented in the child classes to ensure proper processing, in respect ot the child class, of the data recieved via TCP or UDP protocol is done.<br />
* '''void printMessage (std::string)''' - Print the string parameter on the warning window. <br />
* '''CmdStruct* getNextPackage ()''' - The function gets a TCP packet (from the server or from the Client, as the case may be) and store in struct CmdStruct. Definietion of CmdStruct can be found in ''NatusPackageInterface.h'' file.<br />
* '''CmdStruct* getNextUDPPackage ()''' - The function is same as CmdStruct* getNextPackage(), except that it received packet over UDP protocol. <br />
* '''void delete_cmdstruct (CmdStruct* )''' - The function frees the memory occupied by a CmdStruct pointer.<br />
* '''void initWSA ()''' - The function initializes the Winsock. <br />
* '''SOCKET connection''' - It stores the TCP socket connection, i.e, in server/device - the connection to the client and in client - the connection to the server/device.<br />
* '''SOCKET udpSocket''' - It stores the UDP socket connection.<br />
* '''sockaddr_in _udpReceiver''' - It stores the socket address for IPv4.<br />
<br />
== NatusDataServer ==<br />
This class handles the server-side processing. It performs the following functions - starts-up the TCP and UDP server, check for new connections, gracefully disconnects from the client, registers various callbacks on client connection and deregister the callbacks when the client disconnects and responds to the commands (described in the NatusPackageInterface section) from the client via TCP protocol.<br />
<br />
=== Functions and Variables ===<br />
The public and protected functions and variables defined in this class are as follows: <br />
* '''void Startup (std::uint16_t port)''' - The function starts up the server and listens for a TCP connection on the port number specified by ''port'' and a UDP connection on the port number ''port+1''.<br />
* '''void CheckForConnection ()''' - The function checks for a client connection request and accept it if there is one.<br />
* '''void RegisterDataStreamCallback (NatusDataStreamRequest, void*)''' - The function registers the callbacks to start & stop streams.<br />
* '''void RegisterInformationCallback (NatusInformationRequest, void*)''' - The function registers the callback to get the device information.<br />
* '''void RegisterChannelInformationCallback (NatusChannelInfoRequest, void*)''' - The function registers the callback to get the device's channels' names.<br />
* '''void RegisterErrorCallback (NatusResponse, void*)''' - The function registers the callback to call incase of any error.<br />
* '''void UnregisterCallbacks ()''' - The function deregisters all the callbacks. It is called before closing the connection with the client.<br />
* '''void SendStreamData (float* data, uint32_t numdata)''' - The function accepts the channel ''data'' and the number of channels ''numdata'' and prepares the data by decimating it (if decimation factor is set) and by making packets with required number of blocks which are then sent to the client. <br />
* '''void Disconnect ()''' - The function gracefully closes the UDP and TCP connection with the client.<br />
* '''bool HasClient ()''' - The function checks if there is a client connected to the server/device.<br />
* '''int _channelsToStream[MAX_NUM_CHANNELS]''' - It stores the channel numbers which are to be streamed. The end of the array is defined by storing the last element as -1.<br />
* '''int _numberOfChannelsToStream''' - It stores the number of channels to stream.<br />
* '''void data_received (CmdStruct *payload)''' - The function checks for the command received from the client and calls the appropriate function to fulfill the client's request.<br />
* '''void start_UDP_sever (std::uint16_t port)''' - The function opens up a UDP connection at the ''port''.<br />
<br />
== NatusClient ==<br />
This class handles the client-side processing. It connects with the server/device, gets data from the operator module of the NatusADC and sends it to the server/device. It uses various commands as described in the NatusDataServer to set different parameters. Another important function of this class 'interpolateMissingBlocks' linearly interpolates the missing UDP packets which contain the channel data values. Eg. <br/> <br />
Consider the scenario where 1 block is sent per packet and decimation factor is 1. Suppose we received packet 1 and 3, packet 2 was lost. Data for packet 2 is interpolated as follows: <br />
<br/> Interpolation formula<br />
''Interpolated Value = ((Current Packet value – Previous Packet value) / (Current Packet Number – Previous Packet Number)) * (Interpolated Packet Number – Previous Packet Number) + Previous Packet Value''<br />
[[File:Programming_Reference_NatusADC_Interpolation.png|center|500px|Linear Interpolation example]]<br />
<br />
=== Functions and Variables ===<br />
The public and protected functions and variables defined in this class are as follows: <br />
* '''NatusDeviceInformation GetInformation ()''' - The function sends a CMD_GetInformation command to the server/device over TCP to query the sampling rate and number of channels of the device. It stores the received information in the ''NatusDeviceInformation'' struct type variable.<br />
* '''void Connect (std::string server_name, int port)''' - The function establishes a TCP connection with the ''server_name'' server at port number ''port'' and calls the ''init_udp'' function to establish a UDP connection at port ''port+1''.<br />
* '''bool TryConnect (std::string server_name, int port)''' - The function tries to establish a TCP and UDP connection again with the ''server_name'' if the connection is lost and returns ''true'' if the connection is successful otherwise ''false''.<br />
* '''void Disconnect ()''' - The function gracefully closes the TCP and UDP connection with the server/device.<br />
* '''void StartStream ()''' - The function sends the CMD_StartStream command to the server/device to request the channel stream data, which the server/device sends over the UDP.<br />
* '''void StopStream ()''' - The function sends the CMD_StopStream command to the server/device. <br />
* '''uint8_t Ping (uint8_t ping)''' - The function sends a CMD_PING command to the sever/device with data stored in ''ping'' as payload.<br />
* '''NatusSampleBlock* ReadStream ()''' - The function gets channel data blocks from the server/device through a UDP protocol, calls the ''interpolateMissingBlocks'' if there is any missing blocks, adds the block to the ''_receivequeue'' and returns the first block from the ''_receivequeue''.<br />
* '''NatusSampleBlock* create_natus_sampleblock (uint8_t* payload)''' - The function creates and returns a NatusSampleBlock structure variable from the payload passes. NatusSampleBlock contains block number, number of samples, samples and a boolean specifying whether the block was recieved from the server/device or was interpolated.<br />
* '''void DeleteSampleBlock (NatusSampleBlock*)''' - The function free the space occupied by the NatusSampleBlock variable passed to it.<br />
* '''void SetSampleBlockSize (uint32_t blocksize)''' - The function sends CMD_SetBlockSize command to the server/device to set number of blocks to be sent in a packet as ''blocksize''.<br />
* '''void SetDecimationFactor (uint32_t decimationFactor)''' - The function sends CMD_SetDecimationFactor command to the server/device to set the decimation factor as ''decimationFactor''.<br />
* '''NatusChannelInformation GetChannelInfo ()''' - The function sends CMD_GetChannelNames command to the server/device to query the channel and stream names of the device and stores them in a NatusChannelInformation structure.<br />
* '''int GetDecimationFactor ()''' - The function queries from the server/device over TCP, the current decimation factor and returns it.<br />
* '''int SelectChannelsToStream (std::string channels)''' - The function sends CMD_SelectChannels command to the server/device along with the channels to stream stored in a space separated ''channels'' string.<br />
* '''int _channelsToStream[MAX_NUM_CHANNELS]''' - It stores the channel numbers which are to be streamed. <br />
* '''NatusChannelInformation channelInfo''' - The structure stores the channel and stream names of the device. The NatusChannelInformation structure definition can be found in ''NatusPackageInterface.h'' file.<br />
* '''void data_received (CmdStruct *payload)''' - The function checks if the data received from the server/device does not contain a CMD_ERR code.<br />
* '''CmdStruct* blockForPackage(uint32_t timeout)''' - The function waits to receive a TCP packet from server/device for the time specified by the ''timeout'' variable.<br />
* '''std::queue<NatusSampleBlock*> _receivequeue''' - The queue stores the blocks received for processing.<br />
* '''bool init_udp (int port)''' - The function creates and binds a UDP socket. If completed successfully, it returns ''true'', otherwise ''false''.<br />
* '''NatusSampleBlock _prevblock''' - It stores the last data block received from the server/device and is used to check if any block is lost in between, when the client receives a new data block. <br />
* '''void interpolateMissingBlocks (NatusSampleBlock*)''' - The function linearly interpolates any number of missing blocks between the current received data block and the last recieved data block.<br />
* '''void emptyReceiveQueue ()''' - The function frees the memory occupied by the queue ''_receivequeue'' whenever the connection is closed or restarted.<br />
<br />
== See also ==<br />
[[Contributions:NatusADC]], [[User Reference:DataIOFilter]], [[Programming Reference:GenericADC Class]]<br />
[[Category:Filters]][[Category:Data Acquisition]]</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=Programming_Reference:NatusADC&diff=8426Programming Reference:NatusADC2019-07-29T20:10:34Z<p>Dashmeetkaur: /* TCP Commands */</p>
<hr />
<div>NatusADC module has 3 main classes - NatusPackageInterface, NatusDataServer and NatusClient. The overview of the NatusADC working is shown in the image below.<br />
[[File:Prog_Ref_NatusADC_NatusWorking.png|center|800px|Overview of NatusADC working]]<br />
<br />
NatusDataServer processes and sends signal from the device to the client application. A project named XLDataExportClient reads signals from the device and calls the NatusDataServer's functions to send the signal to the client. NatusClient is the client application within the BCI2000 that receives the signals and does the initial processing. NatusPackageInterface contains the implementation of data transfer protocol between serve/device and client and is used by NatusClient and NatusDataServer to communicate with each other over TCP and UDP. NatusDataServer and NatusPackageInterface are independent of the BCI2000 where as NatusClient relies on BCI2000. <br />
<br />
== NatusPackageInterface ==<br />
This class handles the communication between the server/device and the client. It should be included with both - NatusDataServer and NatusClient Class. The class performs the following functions -constructing TCP and UDP packets, calculating the CRC of a packet and checking the CRC on the receiving side, sending the packets over TCP/UDP port, receiving packets over TCP/UDP Port, reconstructing the data from the packets and listening for connections on device/server-side. ''Note - The file limits the maximum number of channels for a device (stored in MAX_NUM_CHANNELS in NatusPackageInterface.h) to 100.''<br />
<br/><br />
The format of the packets constructed along with each field size is as follows:<br />
[[File:Prog_Ref_NatusADC_Packet_format.png|center|600px|Packet format]]<br />
<br />
=== TCP Commands ===<br />
The commands through which the NatusDataServer and NatusClient communicate are as follows:<br />
; CMD_Ping : To check if the connection is successful and data can be sent and received.<br />
* Command Number: 0x01<br />
* Parameters/Payload: 0xff<br />
* Return Value: returns payload <br />
<br />
; CMD_GetInformation : To send the device information such as the number of channels and sampling rate to the client.<br />
* Command Number: 0x02<br />
* Parameters/Payload: NULL <br />
* Return Value: struct NatusDeviceInformation which contains the number of channels, sampling rate, and device identifier.<br />
<br />
; CMD_GetChannelNames : To send the channel names as set by the device to the client. If no channel names are set, NULL is sent.<br />
* Command Number: 0x03<br />
* Parameters/Payload: NULL <br />
* Return Value: struct NatusChannelInformation which contains all the channels and stream names.<br />
<br />
; CMD_StartStream : To start sending channel data over UDP port.<br />
* Command Number: 0x10<br />
* Parameters/Payload: NULL <br />
* Return Value: NULL<br />
<br />
; CMD_StopStream : To stop sending channel data<br />
* Command Number: 0x1F<br />
* Parameters/Payload: NULL <br />
* Return Value: NULL<br />
<br />
; CMD_SelectChannels : To send data only for the channels numbers mentioned in the payload. It corresponds to the SourceChList parameter.<br />
* Command Number: 0x20<br />
* Parameters/Payload: a list of channel numbers separated by space and stored in a string <br />
* Return Value: NULL<br />
<br />
; CMD_SetBlockSize : To set the number of blocks to send per packet. It corresponds to the SeverBlockSize parameter.<br />
* Command Number: 0x21<br />
* Parameters/Payload: number of blocks to send per packet stored in uint32_t datatype. <br />
* Return Value: NULL<br />
<br />
; CMD_GetDecimationFactor : To get the current decimation factor of the device/server.<br />
* Command Number: 0x22<br />
* Parameters/Payload: decimation factor stored in uint32_t datatype. <br />
* Return Value: NULL<br />
<br />
; CMD_SetDecimationFactor : To set the decimation factor of the device/server.<br />
* Command Number: 0x23<br />
* Parameters/Payload: NULL <br />
* Return Value: decimation factor stored in uint32_t datatype but casted into uint8_t datatype for transmission over TCP.<br />
<br />
; CMD_ERR : The command is sent if there is any type of error.<br />
* Command Number: 0xFF<br />
* Parameters/Payload: command which caused the error and the payload generated by the function handling the command.<br />
* Return Value: NULL<br />
<u>Note:</u> The packet format for this command is as follows: <br />
[[File:Prog_Ref_NatusADC_CMD_ERR.png|center|Command CMD_ERR packet format.]]<br />
<br />
=== UDP Commands ===<br />
; CMD_StreamPackage: The command is sent from the server/device to the client when only 1 block per packet is sent.<br />
* Command Number: 0x11<br />
* Parameters/Payload: Channel data of 1 block<br />
* Return Value: NULL<br />
<br />
; CMD_VariableSizeStreamPackage: The command is sent from the server/device to the client when more than 1 block per packet is sent.<br />
* Command Number: 0x12<br />
* Parameters/Payload: Channel data of more than 1 block (number of blocks as set by the CMD_SetBlockSize command)<br />
* Return Value: NULL<br />
<br />
=== Functions and Variables ===<br />
The public and protected functions and variables defined in this class are as follows: <br />
* '''void Poll ()''' - The function runs on server/device and continuously waits for any command from the NatusClient over the TCP protocol.<br />
* '''void send_data (uint8_t cmd, uint8_t* payload, uint32_t len_payload, bool isError=false, PackageType t = Control)''' - The function creates a packet using cmd (the command) and the payload. The default values for isError is false (i.e., no error) and PackageType is Control (TCP prototcol). The channel data is sent over Stream PackageType (i.e., UDP Protocol).<br />
* '''virtual void data_received (CmdStruct * payload) = 0''' - The function should be implemented in the child classes to ensure proper processing, in respect ot the child class, of the data recieved via TCP or UDP protocol is done.<br />
* '''void printMessage (std::string)''' - Print the string parameter on the warning window. <br />
* '''CmdStruct* getNextPackage ()''' - The function gets a TCP packet (from the server or from the Client, as the case may be) and store in struct CmdStruct. Definietion of CmdStruct can be found in ''NatusPackageInterface.h'' file.<br />
* '''CmdStruct* getNextUDPPackage ()''' - The function is same as CmdStruct* getNextPackage(), except that it received packet over UDP protocol. <br />
* '''void delete_cmdstruct (CmdStruct* )''' - The function frees the memory occupied by a CmdStruct pointer.<br />
* '''void initWSA ()''' - The function initializes the Winsock. <br />
* '''SOCKET connection''' - It stores the TCP socket connection, i.e, in server/device - the connection to the client and in client - the connection to the server/device.<br />
* '''SOCKET udpSocket''' - It stores the UDP socket connection.<br />
* '''sockaddr_in _udpReceiver''' - It stores the socket address for IPv4.<br />
<br />
== NatusDataServer ==<br />
This class handles the server-side processing. It performs the following functions - starts-up the TCP and UDP server, check for new connections, gracefully disconnects from the client, registers various callbacks on client connection and deregister the callbacks when the client disconnects and responds to the commands (described in the NatusPackageInterface section) from the client via TCP protocol.<br />
<br />
=== Functions and Variables ===<br />
The public and protected functions and variables defined in this class are as follows: <br />
* '''void Startup (std::uint16_t port)''' - The function starts up the server and listens for a TCP connection on the port number specified by ''port'' and a UDP connection on the port number ''port+1''.<br />
* '''void CheckForConnection ()''' - The function checks for a client connection request and accept it if there is one.<br />
* '''void RegisterDataStreamCallback (NatusDataStreamRequest, void*)''' - The function registers the callbacks to start & stop streams.<br />
* '''void RegisterInformationCallback (NatusInformationRequest, void*)''' - The function registers the callback to get the device information.<br />
* '''void RegisterChannelInformationCallback (NatusChannelInfoRequest, void*)''' - The function registers the callback to get the device's channels' names.<br />
* '''void RegisterErrorCallback (NatusResponse, void*)''' - The function registers the callback to call incase of any error.<br />
* '''void UnregisterCallbacks ()''' - The function deregisters all the callbacks. It is called before closing the connection with the client.<br />
* '''void SendStreamData (float* data, uint32_t numdata)''' - The function accepts the channel ''data'' and the number of channels ''numdata'' and prepares the data by decimating it (if decimation factor is set) and by making packets with required number of blocks which are then sent to the client. <br />
* '''void Disconnect ()''' - The function gracefully closes the UDP and TCP connection with the client.<br />
* '''bool HasClient ()''' - The function checks if there is a client connected to the server/device.<br />
* '''int _channelsToStream[MAX_NUM_CHANNELS]''' - It stores the channel numbers which are to be streamed. The end of the array is defined by storing the last element as -1.<br />
* '''int _numberOfChannelsToStream''' - It stores the number of channels to stream.<br />
* '''void data_received (CmdStruct *payload)''' - The function checks for the command received from the client and calls the appropriate function to fulfill the client's request.<br />
* '''void start_UDP_sever (std::uint16_t port)''' - The function opens up a UDP connection at the ''port''.<br />
<br />
== NatusClient ==<br />
This class handles the client-side processing. It connects with the server/device, gets data from the operator module of the NatusADC and sends it to the server/device. It uses various commands as described in the NatusDataServer to set different parameters. Another important function of this class 'interpolateMissingBlocks' linearly interpolates the missing UDP packets which contain the channel data values. Eg. <br/> <br />
Consider the scenario where 1 block is sent per packet and decimation factor is 1. Suppose we received packet 1 and 3, packet 2 was lost. Data for packet 2 is interpolated as follows: <br />
<br/> Interpolation formula<br />
''Interpolated Value = ((Current Packet value – Previous Packet value) / (Current Packet Number – Previous Packet Number)) * (Interpolated Packet Number – Previous Packet Number) + Previous Packet Value''<br />
[[File:Programming_Reference_NatusADC_Interpolation.png|center|500px|Linear Interpolation example]]<br />
<br />
=== Functions and Variables ===<br />
The public and protected functions and variables defined in this class are as follows: <br />
* '''NatusDeviceInformation GetInformation ()''' - The function sends a CMD_GetInformation command to the server/device over TCP to query the sampling rate and number of channels of the device. It stores the received information in the ''NatusDeviceInformation'' struct type variable.<br />
* '''void Connect (std::string server_name, int port)''' - The function establishes a TCP connection with the ''server_name'' server at port number ''port'' and calls the ''init_udp'' function to establish a UDP connection at port ''port+1''.<br />
* '''bool TryConnect (std::string server_name, int port)''' - The function tries to establish a TCP and UDP connection again with the ''server_name'' if the connection is lost and returns ''true'' if the connection is successful otherwise ''false''.<br />
* '''void Disconnect ()''' - The function gracefully closes the TCP and UDP connection with the server/device.<br />
* '''void StartStream ()''' - The function sends the CMD_StartStream command to the server/device to request the channel stream data, which the server/device sends over the UDP.<br />
* '''void StopStream ()''' - The function sends the CMD_StopStream command to the server/device. <br />
* '''uint8_t Ping (uint8_t ping)''' - The function sends a CMD_PING command to the sever/device with data stored in ''ping'' as payload.<br />
* '''NatusSampleBlock* ReadStream ()''' - The function gets channel data blocks from the server/device through a UDP protocol, calls the ''interpolateMissingBlocks'' if there is any missing blocks, adds the block to the ''_receivequeue'' and returns the first block from the ''_receivequeue''.<br />
* '''NatusSampleBlock* create_natus_sampleblock (uint8_t* payload)''' - The function creates and returns a NatusSampleBlock structure variable from the payload passes. NatusSampleBlock contains block number, number of samples, samples and a boolean specifying whether the block was recieved from the server/device or was interpolated.<br />
* '''void DeleteSampleBlock (NatusSampleBlock*)''' - The function free the space occupied by the NatusSampleBlock variable passed to it.<br />
* '''void SetSampleBlockSize (uint32_t blocksize)''' - The function sends CMD_SetBlockSize command to the server/device to set number of blocks to be sent in a packet as ''blocksize''.<br />
* '''void SetDecimationFactor (uint32_t decimationFactor)''' - The function sends CMD_SetDecimationFactor command to the server/device to set the decimation factor as ''decimationFactor''.<br />
* '''NatusChannelInformation GetChannelInfo ()''' - The function sends CMD_GetChannelNames command to the server/device to query the channel and stream names of the device and stores them in a NatusChannelInformation structure.<br />
* '''int GetDecimationFactor ()''' - The function queries from the server/device over TCP, the current decimation factor and returns it.<br />
* '''int SelectChannelsToStream (std::string channels)''' - The function sends CMD_SelectChannels command to the server/device along with the channels to stream stored in a space separated ''channels'' string.<br />
* '''int _channelsToStream[MAX_NUM_CHANNELS]''' - It stores the channel numbers which are to be streamed. <br />
* '''NatusChannelInformation channelInfo''' - The structure stores the channel and stream names of the device. The NatusChannelInformation structure definition can be found in ''NatusPackageInterface.h'' file.<br />
* '''void data_received (CmdStruct *payload)''' - The function checks if the data received from the server/device does not contain a CMD_ERR code.<br />
* '''CmdStruct* blockForPackage(uint32_t timeout)''' - The function waits to receive a TCP packet from server/device for the time specified by the ''timeout'' variable.<br />
* '''std::queue<NatusSampleBlock*> _receivequeue''' - The queue stores the blocks received for processing.<br />
* '''bool init_udp (int port)''' - The function creates and binds a UDP socket. If completed successfully, it returns ''true'', otherwise ''false''.<br />
* '''NatusSampleBlock _prevblock''' - It stores the last data block received from the server/device and is used to check if any block is lost in between, when the client receives a new data block. <br />
* '''void interpolateMissingBlocks (NatusSampleBlock*)''' - The function linearly interpolates any number of missing blocks between the current received data block and the last recieved data block.<br />
* '''void emptyReceiveQueue ()''' - The function frees the memory occupied by the queue ''_receivequeue'' whenever the connection is closed or restarted.<br />
<br />
== See also ==<br />
[[Contributions:NatusADC]], [[User Reference:DataIOFilter]], [[Programming Reference:GenericADC Class]]<br />
[[Category:Filters]][[Category:Data Acquisition]]</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=Programming_Reference:NatusADC&diff=8425Programming Reference:NatusADC2019-07-29T20:08:15Z<p>Dashmeetkaur: /* TCP Commands */</p>
<hr />
<div>NatusADC module has 3 main classes - NatusPackageInterface, NatusDataServer and NatusClient. The overview of the NatusADC working is shown in the image below.<br />
[[File:Prog_Ref_NatusADC_NatusWorking.png|center|800px|Overview of NatusADC working]]<br />
<br />
NatusDataServer processes and sends signal from the device to the client application. A project named XLDataExportClient reads signals from the device and calls the NatusDataServer's functions to send the signal to the client. NatusClient is the client application within the BCI2000 that receives the signals and does the initial processing. NatusPackageInterface contains the implementation of data transfer protocol between serve/device and client and is used by NatusClient and NatusDataServer to communicate with each other over TCP and UDP. NatusDataServer and NatusPackageInterface are independent of the BCI2000 where as NatusClient relies on BCI2000. <br />
<br />
== NatusPackageInterface ==<br />
This class handles the communication between the server/device and the client. It should be included with both - NatusDataServer and NatusClient Class. The class performs the following functions -constructing TCP and UDP packets, calculating the CRC of a packet and checking the CRC on the receiving side, sending the packets over TCP/UDP port, receiving packets over TCP/UDP Port, reconstructing the data from the packets and listening for connections on device/server-side. ''Note - The file limits the maximum number of channels for a device (stored in MAX_NUM_CHANNELS in NatusPackageInterface.h) to 100.''<br />
<br/><br />
The format of the packets constructed along with each field size is as follows:<br />
[[File:Prog_Ref_NatusADC_Packet_format.png|center|600px|Packet format]]<br />
<br />
=== TCP Commands ===<br />
The commands through which the NatusDataServer and NatusClient communicate are as follows:<br />
; CMD_Ping : To check if the connection is successful and data can be sent and received.<br />
* Command Number: 0x01<br />
* Parameters/Payload: 0xff<br />
* Return Value: returns payload <br />
<br />
; CMD_GetInformation : To send the device information such as the number of channels and sampling rate to the client.<br />
* Command Number: 0x02<br />
* Parameters/Payload: NULL <br />
* Return Value: struct NatusDeviceInformation which contains the number of channels, sampling rate, and device identifier.<br />
<br />
; CMD_GetChannelNames : To send the channel names as set by the device to the client. If no channel names are set, NULL is sent.<br />
* Command Number: 0x03<br />
* Parameters/Payload: NULL <br />
* Return Value: struct NatusChannelInformation which contains all the channels and stream names.<br />
<br />
; CMD_StartStream : To start sending channel data over UDP port.<br />
* Command Number: 0x10<br />
* Parameters/Payload: NULL <br />
* Return Value: NULL<br />
<br />
; CMD_StopStream : To stop sending channel data<br />
* Command Number: 0x1F<br />
* Parameters/Payload: NULL <br />
* Return Value: NULL<br />
<br />
; CMD_SelectChannels : To send data only for the channels numbers mentioned in the payload<br />
* Command Number: 0x20<br />
* Parameters/Payload: a list of channel numbers separated by space and stored in a string <br />
* Return Value: NULL<br />
<br />
; CMD_SetBlockSize : To set the number of blocks to send per packet. It corresponds to the SeverBlockSize parameter.<br />
* Command Number: 0x21<br />
* Parameters/Payload: number of blocks to send per packet stored in uint32_t datatype. <br />
* Return Value: NULL<br />
<br />
; CMD_GetDecimationFactor : To get the current decimation factor of the device/server.<br />
* Command Number: 0x22<br />
* Parameters/Payload: decimation factor stored in uint32_t datatype. <br />
* Return Value: NULL<br />
<br />
; CMD_SetDecimationFactor : To set the decimation factor of the device/server.<br />
* Command Number: 0x23<br />
* Parameters/Payload: NULL <br />
* Return Value: decimation factor stored in uint32_t datatype but casted into uint8_t datatype for transmission over TCP.<br />
<br />
; CMD_ERR : The command is sent if there is any type of error.<br />
* Command Number: 0xFF<br />
* Parameters/Payload: command which caused the error and the payload generated by the function handling the command.<br />
* Return Value: NULL<br />
<u>Note:</u> The packet format for this command is as follows: <br />
[[File:Prog_Ref_NatusADC_CMD_ERR.png|center|Command CMD_ERR packet format.]]<br />
<br />
=== UDP Commands ===<br />
; CMD_StreamPackage: The command is sent from the server/device to the client when only 1 block per packet is sent.<br />
* Command Number: 0x11<br />
* Parameters/Payload: Channel data of 1 block<br />
* Return Value: NULL<br />
<br />
; CMD_VariableSizeStreamPackage: The command is sent from the server/device to the client when more than 1 block per packet is sent.<br />
* Command Number: 0x12<br />
* Parameters/Payload: Channel data of more than 1 block (number of blocks as set by the CMD_SetBlockSize command)<br />
* Return Value: NULL<br />
<br />
=== Functions and Variables ===<br />
The public and protected functions and variables defined in this class are as follows: <br />
* '''void Poll ()''' - The function runs on server/device and continuously waits for any command from the NatusClient over the TCP protocol.<br />
* '''void send_data (uint8_t cmd, uint8_t* payload, uint32_t len_payload, bool isError=false, PackageType t = Control)''' - The function creates a packet using cmd (the command) and the payload. The default values for isError is false (i.e., no error) and PackageType is Control (TCP prototcol). The channel data is sent over Stream PackageType (i.e., UDP Protocol).<br />
* '''virtual void data_received (CmdStruct * payload) = 0''' - The function should be implemented in the child classes to ensure proper processing, in respect ot the child class, of the data recieved via TCP or UDP protocol is done.<br />
* '''void printMessage (std::string)''' - Print the string parameter on the warning window. <br />
* '''CmdStruct* getNextPackage ()''' - The function gets a TCP packet (from the server or from the Client, as the case may be) and store in struct CmdStruct. Definietion of CmdStruct can be found in ''NatusPackageInterface.h'' file.<br />
* '''CmdStruct* getNextUDPPackage ()''' - The function is same as CmdStruct* getNextPackage(), except that it received packet over UDP protocol. <br />
* '''void delete_cmdstruct (CmdStruct* )''' - The function frees the memory occupied by a CmdStruct pointer.<br />
* '''void initWSA ()''' - The function initializes the Winsock. <br />
* '''SOCKET connection''' - It stores the TCP socket connection, i.e, in server/device - the connection to the client and in client - the connection to the server/device.<br />
* '''SOCKET udpSocket''' - It stores the UDP socket connection.<br />
* '''sockaddr_in _udpReceiver''' - It stores the socket address for IPv4.<br />
<br />
== NatusDataServer ==<br />
This class handles the server-side processing. It performs the following functions - starts-up the TCP and UDP server, check for new connections, gracefully disconnects from the client, registers various callbacks on client connection and deregister the callbacks when the client disconnects and responds to the commands (described in the NatusPackageInterface section) from the client via TCP protocol.<br />
<br />
=== Functions and Variables ===<br />
The public and protected functions and variables defined in this class are as follows: <br />
* '''void Startup (std::uint16_t port)''' - The function starts up the server and listens for a TCP connection on the port number specified by ''port'' and a UDP connection on the port number ''port+1''.<br />
* '''void CheckForConnection ()''' - The function checks for a client connection request and accept it if there is one.<br />
* '''void RegisterDataStreamCallback (NatusDataStreamRequest, void*)''' - The function registers the callbacks to start & stop streams.<br />
* '''void RegisterInformationCallback (NatusInformationRequest, void*)''' - The function registers the callback to get the device information.<br />
* '''void RegisterChannelInformationCallback (NatusChannelInfoRequest, void*)''' - The function registers the callback to get the device's channels' names.<br />
* '''void RegisterErrorCallback (NatusResponse, void*)''' - The function registers the callback to call incase of any error.<br />
* '''void UnregisterCallbacks ()''' - The function deregisters all the callbacks. It is called before closing the connection with the client.<br />
* '''void SendStreamData (float* data, uint32_t numdata)''' - The function accepts the channel ''data'' and the number of channels ''numdata'' and prepares the data by decimating it (if decimation factor is set) and by making packets with required number of blocks which are then sent to the client. <br />
* '''void Disconnect ()''' - The function gracefully closes the UDP and TCP connection with the client.<br />
* '''bool HasClient ()''' - The function checks if there is a client connected to the server/device.<br />
* '''int _channelsToStream[MAX_NUM_CHANNELS]''' - It stores the channel numbers which are to be streamed. The end of the array is defined by storing the last element as -1.<br />
* '''int _numberOfChannelsToStream''' - It stores the number of channels to stream.<br />
* '''void data_received (CmdStruct *payload)''' - The function checks for the command received from the client and calls the appropriate function to fulfill the client's request.<br />
* '''void start_UDP_sever (std::uint16_t port)''' - The function opens up a UDP connection at the ''port''.<br />
<br />
== NatusClient ==<br />
This class handles the client-side processing. It connects with the server/device, gets data from the operator module of the NatusADC and sends it to the server/device. It uses various commands as described in the NatusDataServer to set different parameters. Another important function of this class 'interpolateMissingBlocks' linearly interpolates the missing UDP packets which contain the channel data values. Eg. <br/> <br />
Consider the scenario where 1 block is sent per packet and decimation factor is 1. Suppose we received packet 1 and 3, packet 2 was lost. Data for packet 2 is interpolated as follows: <br />
<br/> Interpolation formula<br />
''Interpolated Value = ((Current Packet value – Previous Packet value) / (Current Packet Number – Previous Packet Number)) * (Interpolated Packet Number – Previous Packet Number) + Previous Packet Value''<br />
[[File:Programming_Reference_NatusADC_Interpolation.png|center|500px|Linear Interpolation example]]<br />
<br />
=== Functions and Variables ===<br />
The public and protected functions and variables defined in this class are as follows: <br />
* '''NatusDeviceInformation GetInformation ()''' - The function sends a CMD_GetInformation command to the server/device over TCP to query the sampling rate and number of channels of the device. It stores the received information in the ''NatusDeviceInformation'' struct type variable.<br />
* '''void Connect (std::string server_name, int port)''' - The function establishes a TCP connection with the ''server_name'' server at port number ''port'' and calls the ''init_udp'' function to establish a UDP connection at port ''port+1''.<br />
* '''bool TryConnect (std::string server_name, int port)''' - The function tries to establish a TCP and UDP connection again with the ''server_name'' if the connection is lost and returns ''true'' if the connection is successful otherwise ''false''.<br />
* '''void Disconnect ()''' - The function gracefully closes the TCP and UDP connection with the server/device.<br />
* '''void StartStream ()''' - The function sends the CMD_StartStream command to the server/device to request the channel stream data, which the server/device sends over the UDP.<br />
* '''void StopStream ()''' - The function sends the CMD_StopStream command to the server/device. <br />
* '''uint8_t Ping (uint8_t ping)''' - The function sends a CMD_PING command to the sever/device with data stored in ''ping'' as payload.<br />
* '''NatusSampleBlock* ReadStream ()''' - The function gets channel data blocks from the server/device through a UDP protocol, calls the ''interpolateMissingBlocks'' if there is any missing blocks, adds the block to the ''_receivequeue'' and returns the first block from the ''_receivequeue''.<br />
* '''NatusSampleBlock* create_natus_sampleblock (uint8_t* payload)''' - The function creates and returns a NatusSampleBlock structure variable from the payload passes. NatusSampleBlock contains block number, number of samples, samples and a boolean specifying whether the block was recieved from the server/device or was interpolated.<br />
* '''void DeleteSampleBlock (NatusSampleBlock*)''' - The function free the space occupied by the NatusSampleBlock variable passed to it.<br />
* '''void SetSampleBlockSize (uint32_t blocksize)''' - The function sends CMD_SetBlockSize command to the server/device to set number of blocks to be sent in a packet as ''blocksize''.<br />
* '''void SetDecimationFactor (uint32_t decimationFactor)''' - The function sends CMD_SetDecimationFactor command to the server/device to set the decimation factor as ''decimationFactor''.<br />
* '''NatusChannelInformation GetChannelInfo ()''' - The function sends CMD_GetChannelNames command to the server/device to query the channel and stream names of the device and stores them in a NatusChannelInformation structure.<br />
* '''int GetDecimationFactor ()''' - The function queries from the server/device over TCP, the current decimation factor and returns it.<br />
* '''int SelectChannelsToStream (std::string channels)''' - The function sends CMD_SelectChannels command to the server/device along with the channels to stream stored in a space separated ''channels'' string.<br />
* '''int _channelsToStream[MAX_NUM_CHANNELS]''' - It stores the channel numbers which are to be streamed. <br />
* '''NatusChannelInformation channelInfo''' - The structure stores the channel and stream names of the device. The NatusChannelInformation structure definition can be found in ''NatusPackageInterface.h'' file.<br />
* '''void data_received (CmdStruct *payload)''' - The function checks if the data received from the server/device does not contain a CMD_ERR code.<br />
* '''CmdStruct* blockForPackage(uint32_t timeout)''' - The function waits to receive a TCP packet from server/device for the time specified by the ''timeout'' variable.<br />
* '''std::queue<NatusSampleBlock*> _receivequeue''' - The queue stores the blocks received for processing.<br />
* '''bool init_udp (int port)''' - The function creates and binds a UDP socket. If completed successfully, it returns ''true'', otherwise ''false''.<br />
* '''NatusSampleBlock _prevblock''' - It stores the last data block received from the server/device and is used to check if any block is lost in between, when the client receives a new data block. <br />
* '''void interpolateMissingBlocks (NatusSampleBlock*)''' - The function linearly interpolates any number of missing blocks between the current received data block and the last recieved data block.<br />
* '''void emptyReceiveQueue ()''' - The function frees the memory occupied by the queue ''_receivequeue'' whenever the connection is closed or restarted.<br />
<br />
== See also ==<br />
[[Contributions:NatusADC]], [[User Reference:DataIOFilter]], [[Programming Reference:GenericADC Class]]<br />
[[Category:Filters]][[Category:Data Acquisition]]</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=Programming_Reference:NatusADC&diff=8424Programming Reference:NatusADC2019-07-29T19:58:10Z<p>Dashmeetkaur: </p>
<hr />
<div>NatusADC module has 3 main classes - NatusPackageInterface, NatusDataServer and NatusClient. The overview of the NatusADC working is shown in the image below.<br />
[[File:Prog_Ref_NatusADC_NatusWorking.png|center|800px|Overview of NatusADC working]]<br />
<br />
NatusDataServer processes and sends signal from the device to the client application. A project named XLDataExportClient reads signals from the device and calls the NatusDataServer's functions to send the signal to the client. NatusClient is the client application within the BCI2000 that receives the signals and does the initial processing. NatusPackageInterface contains the implementation of data transfer protocol between serve/device and client and is used by NatusClient and NatusDataServer to communicate with each other over TCP and UDP. NatusDataServer and NatusPackageInterface are independent of the BCI2000 where as NatusClient relies on BCI2000. <br />
<br />
== NatusPackageInterface ==<br />
This class handles the communication between the server/device and the client. It should be included with both - NatusDataServer and NatusClient Class. The class performs the following functions -constructing TCP and UDP packets, calculating the CRC of a packet and checking the CRC on the receiving side, sending the packets over TCP/UDP port, receiving packets over TCP/UDP Port, reconstructing the data from the packets and listening for connections on device/server-side. ''Note - The file limits the maximum number of channels for a device (stored in MAX_NUM_CHANNELS in NatusPackageInterface.h) to 100.''<br />
<br/><br />
The format of the packets constructed along with each field size is as follows:<br />
[[File:Prog_Ref_NatusADC_Packet_format.png|center|600px|Packet format]]<br />
<br />
=== TCP Commands ===<br />
The commands through which the NatusDataServer and NatusClient communicate are as follows:<br />
; CMD_Ping : To check if the connection is successful and data can be sent and received.<br />
* Command Number: 0x01<br />
* Parameters/Payload: 0xff<br />
* Return Value: returns payload <br />
<br />
; CMD_GetInformation : To send the device information such as the number of channels and sampling rate to the client.<br />
* Command Number: 0x02<br />
* Parameters/Payload: NULL <br />
* Return Value: struct NatusDeviceInformation which contains the number of channels, sampling rate, and device identifier.<br />
<br />
; CMD_GetChannelNames : To send the channel names as set by the device to the client. If no channel names are set, NULL is sent.<br />
* Command Number: 0x03<br />
* Parameters/Payload: NULL <br />
* Return Value: struct NatusChannelInformation which contains all the channels and stream names.<br />
<br />
; CMD_StartStream : To start sending channel data over UDP port.<br />
* Command Number: 0x10<br />
* Parameters/Payload: NULL <br />
* Return Value: NULL<br />
<br />
; CMD_StopStream : To stop sending channel data<br />
* Command Number: 0x1F<br />
* Parameters/Payload: NULL <br />
* Return Value: NULL<br />
<br />
; CMD_SelectChannels : To send data only for the channels numbers mentioned in the payload<br />
* Command Number: 0x20<br />
* Parameters/Payload: a list of channel numbers separated by space and stored in a string <br />
* Return Value: NULL<br />
<br />
; CMD_SetBlockSize : To set the number of blocks to send per packet.<br />
* Command Number: 0x21<br />
* Parameters/Payload: number of blocks to send per packet stored in uint32_t datatype. <br />
* Return Value: NULL<br />
<br />
; CMD_GetDecimationFactor : To get the current decimation factor of the device/server.<br />
* Command Number: 0x22<br />
* Parameters/Payload: decimation factor stored in uint32_t datatype. <br />
* Return Value: NULL<br />
<br />
; CMD_SetDecimationFactor : To set the decimation factor of the device/server.<br />
* Command Number: 0x23<br />
* Parameters/Payload: NULL <br />
* Return Value: decimation factor stored in uint32_t datatype but casted into uint8_t datatype for transmission over TCP.<br />
<br />
; CMD_ERR : The command is sent if there is any type of error.<br />
* Command Number: 0xFF<br />
* Parameters/Payload: command which caused the error and the payload generated by the function handling the command.<br />
* Return Value: NULL<br />
<u>Note:</u> The packet format for this command is as follows: <br />
[[File:Prog_Ref_NatusADC_CMD_ERR.png|center|Command CMD_ERR packet format.]]<br />
=== UDP Commands ===<br />
; CMD_StreamPackage: The command is sent from the server/device to the client when only 1 block per packet is sent.<br />
* Command Number: 0x11<br />
* Parameters/Payload: Channel data of 1 block<br />
* Return Value: NULL<br />
<br />
; CMD_VariableSizeStreamPackage: The command is sent from the server/device to the client when more than 1 block per packet is sent.<br />
* Command Number: 0x12<br />
* Parameters/Payload: Channel data of more than 1 block (number of blocks as set by the CMD_SetBlockSize command)<br />
* Return Value: NULL<br />
<br />
=== Functions and Variables ===<br />
The public and protected functions and variables defined in this class are as follows: <br />
* '''void Poll ()''' - The function runs on server/device and continuously waits for any command from the NatusClient over the TCP protocol.<br />
* '''void send_data (uint8_t cmd, uint8_t* payload, uint32_t len_payload, bool isError=false, PackageType t = Control)''' - The function creates a packet using cmd (the command) and the payload. The default values for isError is false (i.e., no error) and PackageType is Control (TCP prototcol). The channel data is sent over Stream PackageType (i.e., UDP Protocol).<br />
* '''virtual void data_received (CmdStruct * payload) = 0''' - The function should be implemented in the child classes to ensure proper processing, in respect ot the child class, of the data recieved via TCP or UDP protocol is done.<br />
* '''void printMessage (std::string)''' - Print the string parameter on the warning window. <br />
* '''CmdStruct* getNextPackage ()''' - The function gets a TCP packet (from the server or from the Client, as the case may be) and store in struct CmdStruct. Definietion of CmdStruct can be found in ''NatusPackageInterface.h'' file.<br />
* '''CmdStruct* getNextUDPPackage ()''' - The function is same as CmdStruct* getNextPackage(), except that it received packet over UDP protocol. <br />
* '''void delete_cmdstruct (CmdStruct* )''' - The function frees the memory occupied by a CmdStruct pointer.<br />
* '''void initWSA ()''' - The function initializes the Winsock. <br />
* '''SOCKET connection''' - It stores the TCP socket connection, i.e, in server/device - the connection to the client and in client - the connection to the server/device.<br />
* '''SOCKET udpSocket''' - It stores the UDP socket connection.<br />
* '''sockaddr_in _udpReceiver''' - It stores the socket address for IPv4.<br />
<br />
== NatusDataServer ==<br />
This class handles the server-side processing. It performs the following functions - starts-up the TCP and UDP server, check for new connections, gracefully disconnects from the client, registers various callbacks on client connection and deregister the callbacks when the client disconnects and responds to the commands (described in the NatusPackageInterface section) from the client via TCP protocol.<br />
<br />
=== Functions and Variables ===<br />
The public and protected functions and variables defined in this class are as follows: <br />
* '''void Startup (std::uint16_t port)''' - The function starts up the server and listens for a TCP connection on the port number specified by ''port'' and a UDP connection on the port number ''port+1''.<br />
* '''void CheckForConnection ()''' - The function checks for a client connection request and accept it if there is one.<br />
* '''void RegisterDataStreamCallback (NatusDataStreamRequest, void*)''' - The function registers the callbacks to start & stop streams.<br />
* '''void RegisterInformationCallback (NatusInformationRequest, void*)''' - The function registers the callback to get the device information.<br />
* '''void RegisterChannelInformationCallback (NatusChannelInfoRequest, void*)''' - The function registers the callback to get the device's channels' names.<br />
* '''void RegisterErrorCallback (NatusResponse, void*)''' - The function registers the callback to call incase of any error.<br />
* '''void UnregisterCallbacks ()''' - The function deregisters all the callbacks. It is called before closing the connection with the client.<br />
* '''void SendStreamData (float* data, uint32_t numdata)''' - The function accepts the channel ''data'' and the number of channels ''numdata'' and prepares the data by decimating it (if decimation factor is set) and by making packets with required number of blocks which are then sent to the client. <br />
* '''void Disconnect ()''' - The function gracefully closes the UDP and TCP connection with the client.<br />
* '''bool HasClient ()''' - The function checks if there is a client connected to the server/device.<br />
* '''int _channelsToStream[MAX_NUM_CHANNELS]''' - It stores the channel numbers which are to be streamed. The end of the array is defined by storing the last element as -1.<br />
* '''int _numberOfChannelsToStream''' - It stores the number of channels to stream.<br />
* '''void data_received (CmdStruct *payload)''' - The function checks for the command received from the client and calls the appropriate function to fulfill the client's request.<br />
* '''void start_UDP_sever (std::uint16_t port)''' - The function opens up a UDP connection at the ''port''.<br />
<br />
== NatusClient ==<br />
This class handles the client-side processing. It connects with the server/device, gets data from the operator module of the NatusADC and sends it to the server/device. It uses various commands as described in the NatusDataServer to set different parameters. Another important function of this class 'interpolateMissingBlocks' linearly interpolates the missing UDP packets which contain the channel data values. Eg. <br/> <br />
Consider the scenario where 1 block is sent per packet and decimation factor is 1. Suppose we received packet 1 and 3, packet 2 was lost. Data for packet 2 is interpolated as follows: <br />
<br/> Interpolation formula<br />
''Interpolated Value = ((Current Packet value – Previous Packet value) / (Current Packet Number – Previous Packet Number)) * (Interpolated Packet Number – Previous Packet Number) + Previous Packet Value''<br />
[[File:Programming_Reference_NatusADC_Interpolation.png|center|500px|Linear Interpolation example]]<br />
<br />
=== Functions and Variables ===<br />
The public and protected functions and variables defined in this class are as follows: <br />
* '''NatusDeviceInformation GetInformation ()''' - The function sends a CMD_GetInformation command to the server/device over TCP to query the sampling rate and number of channels of the device. It stores the received information in the ''NatusDeviceInformation'' struct type variable.<br />
* '''void Connect (std::string server_name, int port)''' - The function establishes a TCP connection with the ''server_name'' server at port number ''port'' and calls the ''init_udp'' function to establish a UDP connection at port ''port+1''.<br />
* '''bool TryConnect (std::string server_name, int port)''' - The function tries to establish a TCP and UDP connection again with the ''server_name'' if the connection is lost and returns ''true'' if the connection is successful otherwise ''false''.<br />
* '''void Disconnect ()''' - The function gracefully closes the TCP and UDP connection with the server/device.<br />
* '''void StartStream ()''' - The function sends the CMD_StartStream command to the server/device to request the channel stream data, which the server/device sends over the UDP.<br />
* '''void StopStream ()''' - The function sends the CMD_StopStream command to the server/device. <br />
* '''uint8_t Ping (uint8_t ping)''' - The function sends a CMD_PING command to the sever/device with data stored in ''ping'' as payload.<br />
* '''NatusSampleBlock* ReadStream ()''' - The function gets channel data blocks from the server/device through a UDP protocol, calls the ''interpolateMissingBlocks'' if there is any missing blocks, adds the block to the ''_receivequeue'' and returns the first block from the ''_receivequeue''.<br />
* '''NatusSampleBlock* create_natus_sampleblock (uint8_t* payload)''' - The function creates and returns a NatusSampleBlock structure variable from the payload passes. NatusSampleBlock contains block number, number of samples, samples and a boolean specifying whether the block was recieved from the server/device or was interpolated.<br />
* '''void DeleteSampleBlock (NatusSampleBlock*)''' - The function free the space occupied by the NatusSampleBlock variable passed to it.<br />
* '''void SetSampleBlockSize (uint32_t blocksize)''' - The function sends CMD_SetBlockSize command to the server/device to set number of blocks to be sent in a packet as ''blocksize''.<br />
* '''void SetDecimationFactor (uint32_t decimationFactor)''' - The function sends CMD_SetDecimationFactor command to the server/device to set the decimation factor as ''decimationFactor''.<br />
* '''NatusChannelInformation GetChannelInfo ()''' - The function sends CMD_GetChannelNames command to the server/device to query the channel and stream names of the device and stores them in a NatusChannelInformation structure.<br />
* '''int GetDecimationFactor ()''' - The function queries from the server/device over TCP, the current decimation factor and returns it.<br />
* '''int SelectChannelsToStream (std::string channels)''' - The function sends CMD_SelectChannels command to the server/device along with the channels to stream stored in a space separated ''channels'' string.<br />
* '''int _channelsToStream[MAX_NUM_CHANNELS]''' - It stores the channel numbers which are to be streamed. <br />
* '''NatusChannelInformation channelInfo''' - The structure stores the channel and stream names of the device. The NatusChannelInformation structure definition can be found in ''NatusPackageInterface.h'' file.<br />
* '''void data_received (CmdStruct *payload)''' - The function checks if the data received from the server/device does not contain a CMD_ERR code.<br />
* '''CmdStruct* blockForPackage(uint32_t timeout)''' - The function waits to receive a TCP packet from server/device for the time specified by the ''timeout'' variable.<br />
* '''std::queue<NatusSampleBlock*> _receivequeue''' - The queue stores the blocks received for processing.<br />
* '''bool init_udp (int port)''' - The function creates and binds a UDP socket. If completed successfully, it returns ''true'', otherwise ''false''.<br />
* '''NatusSampleBlock _prevblock''' - It stores the last data block received from the server/device and is used to check if any block is lost in between, when the client receives a new data block. <br />
* '''void interpolateMissingBlocks (NatusSampleBlock*)''' - The function linearly interpolates any number of missing blocks between the current received data block and the last recieved data block.<br />
* '''void emptyReceiveQueue ()''' - The function frees the memory occupied by the queue ''_receivequeue'' whenever the connection is closed or restarted.<br />
<br />
== See also ==<br />
[[Contributions:NatusADC]], [[User Reference:DataIOFilter]], [[Programming Reference:GenericADC Class]]<br />
[[Category:Filters]][[Category:Data Acquisition]]</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=PsychoPy&diff=8418PsychoPy2019-07-26T20:32:28Z<p>Dashmeetkaur: </p>
<hr />
<div>PsychoPy is an open-source application using which a large number of neuroscience, psychology and psychophysics experiments can be performed [1].<br />
This section first describes the two components that are developed to remotely start BCI2000 from the PsychoPy and the second section lists the steps to follow to add the new components in the PsychoPy application.<br />
<br />
== Components ==<br />
<br />
=== BCIStart ===<br />
The component starts up the BCI2000 modules remotely. The component takes two parameters:<br />
; Path : Path to the BCI2000 ''prog'' directory which contains the ''BCI2000Remote.py'' file.<br />
; States : List of new states to add to the BCI2000. The states in the list are defined as follows: 'StateName defaultValue maxValue'. Eg: lastKey 0 255, correctKey 0 1.<br />
<br />
[[File:BCI2000Start.png|alt="BCI2000 start component image showing its parameters"|BCIStart Component]]<br />
<br />
=== BCIUpdateState ===<br />
The component defines which state to update and when. It takes the following parameters:<br />
; State Name : The name of the state in BCI2000 to update.<br />
; Response Component Variable : The variable to which the state is be set OR the variable which contains the new value of the state. '''Note-''' the variable is written as ''$VariableName''. <br />
; Use Expression : If it is checked, the code written in 'Expression' is executed for each Frame and the variable specified is not used to update the state.<br />
; Expression : The code to execute for each Frame. It is given for the cases, where the variable is not available and the users want more control over how the state is updated. '''Note-''' the user would have to use commands like ''bci.Execute'' and ''SET STATE'' to update the state in such cases. See [[Programming Reference:BCI2000Remote Class]] and [[User Reference:Operator Module Scripting]] for more details.<br />
<br />
[[File:BCI2000UpdateState.png|alt="BCI2000 update state component image showing its parameters"|BCIUpdateStart Component]]<br />
<br />
== Integrating BCI2000 into PyschoPy ==<br />
Download the PsychoPy from the [https://www.psychopy.org/download.html PyschoPy] website. <br/><br />
<br />
<br />
=== Standalone version ===<br />
For Windows, Copy the folders '''BCIStart''' and '''BCIUpdateState''' from ''src/contrib/PsychoPy Components'' directory of your BCI2000 repository into the folder {$PsychoPyHome}\Lib\site-packages\psychopy\experiment\components folder.<br />
<br />
<br />
=== Developer version ===<br />
Copy the folders '''BCIStart''' and '''BCIUpdateState''' from ''src/contrib/PsychoPy Components'' directory of your BCI2000 repository into the folder {$PsychoPyHome}\psychopy\experiment\components.<br />
Open terminal and navigate to the PsychoPy home directory where ''setup.py'' resides.<br />
Run the following command in the terminal: <br/><br />
<code>pip install -e .</code> <br/><br/><br />
<br/><br/><br />
Start Psychopy application and in the builder view, under the Custom Components, you should see the two new components - ''BCI2000Start'' and ''BCI2000UpdateState'' as shown in the figure below.<br />
<br />
[[File:PsychoPy_Start.png|alt="PsychoPy Homepage with BCI2000 Components"|PsychoPy Homepage with BCI2000 Components]]<br />
<br />
'''Note:''' Make sure you don't run the experiments on full screen if you are using a single screen. <br />
== References ==<br />
* 1. [https://www.psychopy.org/ PsychoPy site]<br />
<br />
== See Also ==<br />
* [[Programming Reference:BCI2000Remote Class]]<br />
* [[User Reference:Operator Module Scripting]]</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=PsychoPy&diff=8417PsychoPy2019-07-26T19:38:13Z<p>Dashmeetkaur: </p>
<hr />
<div>PsychoPy is an open-source application using which a large number of neuroscience, psychology and psychophysics experiments can be performed [1].<br />
This section first describes the two components that are developed to remotely start BCI2000 from the PsychoPy and the second section lists the steps to follow to add the new components in the PsychoPy application.<br />
<br />
== Components ==<br />
<br />
=== BCIStart ===<br />
The component starts up the BCI2000 modules remotely. The component takes two parameters:<br />
; Path : Path to the BCI2000 ''prog'' directory which contains the ''BCI2000Remote.py'' file.<br />
; States : List of new states to add to the BCI2000. The states in the list are defined as follows: 'StateName defaultValue maxValue'. Eg: lastKey 0 255, correctKey 0 1.<br />
<br />
[[File:BCI2000Start.png|alt="BCI2000 start component image showing its parameters"|BCIStart Component]]<br />
<br />
=== BCIUpdateState ===<br />
The component defines which state to update and when. It takes the following parameters:<br />
; State Name : The name of the state in BCI2000 to update.<br />
; Response Component Variable : The variable to which the state is be set OR the variable which contains the new value of the state. '''Note-''' the variable is written as ''$VariableName''. <br />
; Use Expression : If it is checked, the code written in 'Expression' is executed for each Frame and the variable specified is not used to update the state.<br />
; Expression : The code to execute for each Frame. It is given for the cases, where the variable is not available and the users want more control over how the state is updated. '''Note-''' the user would have to use commands like ''bci.Execute'' and ''SET STATE'' to update the state in such cases. See [[Programming Reference:BCI2000Remote Class]] and [[User Reference:Operator Module Scripting]] for more details.<br />
<br />
[[File:BCI2000UpdateState.png|alt="BCI2000 update state component image showing its parameters"|BCIUpdateStart Component]]<br />
<br />
== Integrating BCI2000 into PyschoPy ==<br />
Download the PsychoPy from the [https://www.psychopy.org/download.html PyschoPy] website. <br/><br />
<br />
<br />
=== Standalone version ===<br />
For Windows, Copy the folders '''BCIStart''' and '''BCIUpdateState''' from ''src/contrib/PsychoPy Components'' directory of your BCI2000 repository into the folder {$PsychoPyHome}\Lib\site-packages\psychopy\experiment\components folder.<br />
<br />
<br />
=== Developer version ===<br />
Copy the folders '''BCIStart''' and '''BCIUpdateState''' from ''src/contrib/PsychoPy Components'' directory of your BCI2000 repository into the folder {$PsychoPyHome}\psychopy\experiment\components.<br />
Open terminal and navigate to the PsychoPy home directory where ''setup.py'' resides.<br />
Run the following command in the terminal: <br/><br />
<code>pip install -e .</code> <br/><br/><br />
<br/><br/><br />
Start Psychopy application and in the builder view, under the Custom Components, you should see the two new components - ''BCI2000Start'' and ''BCI2000UpdateState'' as shown in the figure below.<br />
<br />
[[File:PsychoPy_Start.png|alt="PsychoPy Homepage with BCI2000 Components"|PsychoPy Homepage with BCI2000 Components]]<br />
<br />
== References ==<br />
* 1. [https://www.psychopy.org/ PsychoPy site]<br />
<br />
== See Also ==<br />
* [[Programming Reference:BCI2000Remote Class]]<br />
* [[User Reference:Operator Module Scripting]]</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=PsychoPy&diff=8416PsychoPy2019-07-26T19:31:10Z<p>Dashmeetkaur: </p>
<hr />
<div>PsychoPy is an open-source application using which a large number of neuroscience, psychology and psychophysics experiments can be performed [1].<br />
This section first describes the two components that are developed to remotely start BCI2000 from the PsychoPy and the second section lists the steps to follow to add the new components in the PsychoPy application.<br />
<br />
== Components ==<br />
<br />
=== BCIStart ===<br />
The component starts up the BCI2000 modules remotely. The component takes two parameters:<br />
; Path : Path to the BCI2000 ''prog'' directory which contains the ''BCI2000Remote.py'' file.<br />
; States : List of new states to add to the BCI2000. The states in the list are defined as follows: 'StateName defaultValue maxValue'. Eg: lastKey 0 255, correctKey 0 1.<br />
<br />
[[File:BCI2000Start.png|alt="BCI2000 start component image showing its parameters"|BCIStart Component]]<br />
<br />
=== BCIUpdateState ===<br />
The component defines which state to update and when. It takes the following parameters:<br />
; State Name : The name of the state in BCI2000 to update.<br />
; Response Component Variable : The variable to which the state is be set OR the variable which contains the new value of the state. '''Note-''' the variable is written as ''$VariableName''. <br />
; Use Expression : If it is checked, the code written in 'Expression' is executed for each Frame and the variable specified is not used to update the state.<br />
; Expression : The code to execute for each Frame. It is given for the cases, where the variable is not available and the users want more control over how the state is updated. '''Note-''' the user would have to use commands like ''bci.Execute'' and ''SET STATE'' to update the state in such cases. See [[Programming Reference:BCI2000Remote Class]] and [[User Reference:Operator Module Scripting]] for more details.<br />
<br />
[[File:BCI2000UpdateState.png|alt="BCI2000 update state component image showing its parameters"|BCIUpdateStart Component]]<br />
<br />
== Integrating BCI2000 into PyschoPy ==<br />
Download the PsychoPy from the [https://www.psychopy.org/download.html PyschoPy] website. <br/><br />
Copy the folders '''BCIStart''' and '''BCIUpdateState''' from ''src/contrib/PsychoPy Components'' directory of your BCI2000 repository into the folder {$PsychoPyHome}\psychopy\experiment\components.<br />
Open terminal and navigate to the PsychoPy home directory where ''setup.py'' resides.<br />
Run the following command in the terminal: <br/><br />
<code>pip install -e .</code> <br/><br/><br />
Start Psychopy application and in the builder view, under the Custom Components, you should see the two new components - ''BCI2000Start'' and ''BCI2000UpdateState'' as shown in the figure below.<br />
<br />
[[File:PsychoPy_Start.png|alt="PsychoPy Homepage with BCI2000 Components"|PsychoPy Homepage with BCI2000 Components]]<br />
<br />
== References ==<br />
* 1. [https://www.psychopy.org/ PsychoPy site]<br />
<br />
== See Also ==<br />
* [[Programming Reference:BCI2000Remote Class]]<br />
* [[User Reference:Operator Module Scripting]]</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=PsychoPy&diff=8415PsychoPy2019-07-26T19:08:07Z<p>Dashmeetkaur: </p>
<hr />
<div>PsychoPy is an open-source application using which a large number of neuroscience, psychology and psychophysics experiments can be performed [1].<br />
This section first describes the two components that are developed to remotely start BCI2000 from the PsychoPy and the second section lists the steps to follow to add the new components in the PsychoPy application.<br />
<br />
== Components ==<br />
<br />
=== BCIStart ===<br />
The component starts up the BCI2000 modules remotely. The component takes two parameters:<br />
; Path : Path to the BCI2000 ''prog'' directory which contains the ''BCI2000Remote.py'' file.<br />
; States : List of new states to add to the BCI2000. The states in the list are defined as follows: 'StateName defaultValue maxValue'. Eg: lastKey 0 255, correctKey 0 1.<br />
<br />
[[File:BCI2000Start.png|alt="BCI2000 start component image showing its parameters"|BCIStart Component]]<br />
<br />
=== BCIUpdateState ===<br />
The component defines which state to update and when. It takes the following parameters:<br />
; State Name : The name of the state in BCI2000 to update.<br />
; Response Component Variable : The variable to which the state is be set OR the variable which contains the new value of the state. '''Note-''' the variable is written as ''$VariableName''. <br />
; Use Expression : If it is checked, the code written in 'Expression' is executed for each Frame and the variable specified is not used to update the state.<br />
; Expression : The code to execute for each Frame. It is given for the cases, where the variable is not available and the users want more control over how the state is updated. '''Note-''' the user would have to use commands like ''bci.Execute'' and ''SET STATE'' to update the state in such cases. See [[Programming Reference:BCI2000Remote Class]] and [[User Reference:Operator Module Scripting]] for more details.<br />
<br />
[[File:BCI2000UpdateState.png|alt="BCI2000 update state component image showing its parameters"|BCIUpdateStart Component]]<br />
<br />
== Integrating BCI2000 into PyschoPy ==<br />
Download the PsychoPy from the [https://www.psychopy.org/download.html PyschoPy] website. <br/><br />
Copy the following two folders '''BCIStart''' and '''BCIUpdateState''' in the folder {$PsychoPyHome}\psychopy\experiment\components.<br />
Open terminal and navigate to the PsychoPy home directory where ''setup.py'' resides.<br />
Run the following command in the terminal: <br/><br />
<code>pip install -e .</code> <br/><br/><br />
Start Psychopy application and in the builder view, under the Custom Components, you should see the two new components - ''BCI2000Start'' and ''BCI2000UpdateState'' as shown in the figure below.<br />
<br />
[[File:PsychoPy_Start.png|alt="PsychoPy Homepage with BCI2000 Components"|PsychoPy Homepage with BCI2000 Components]]<br />
<br />
== References ==<br />
* 1. [https://www.psychopy.org/ PsychoPy site]<br />
<br />
== See Also ==<br />
* [[Programming Reference:BCI2000Remote Class]]<br />
* [[User Reference:Operator Module Scripting]]</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=PsychoPy&diff=8414PsychoPy2019-07-26T18:57:41Z<p>Dashmeetkaur: </p>
<hr />
<div>PsychoPy is an open-source application using which a large number of neuroscience, psychology and psychophysics experiments can be performed.[1]<br />
This section first describes the two components that are developed to remotely start BCI2000 from the PsychoPy and the second section lists the steps to follow to add the new components in the PsychoPy application.<br />
<br />
== Components ==<br />
<br />
=== BCIStart ===<br />
The component starts up the BCI2000 modules remotely. The component takes two parameters:<br />
; Path : Path to the BCI2000 ''prog'' directory which contains the ''BCI2000Remote.py'' file.<br />
; States : List of new states to add to the BCI2000. The states in the list are defined as follows: 'StateName defaultValue maxValue'. Eg: lastKey 0 255, correctKey 0 1.<br />
<br />
[[File:BCI2000Start.png|alt="BCI2000 start component image showing its parameters"|BCIStart Component]]<br />
<br />
=== BCIUpdateState ===<br />
The component defines which state to update and when. It takes the following parameters:<br />
; State Name : The name of the state in BCI2000 to update.<br />
; Response Component Variable : The variable to which the state is be set OR the variable which contains the new value of the state. '''Note-''' the variable is written as ''$VariableName''. <br />
; Use Expression : If it is checked, the code written in 'Expression' is executed for each Frame and the variable specified is not used to update the state.<br />
; Expression : The code to execute for each Frame. It is given for the cases, where the variable is not available and the users want more control over how the state is updated. '''Note-''' the user would have to use commands like ''bci.Execute'' and ''SET STATE'' to update the state in such cases. See [[Programming Reference:BCI2000Remote Class]] and [[User Reference:Operator Module Scripting]] for more details.<br />
<br />
[[File:BCI2000UpdateState.png|alt="BCI2000 update state component image showing its parameters"|BCIUpdateStart Component]]<br />
<br />
== Integrating BCI2000 into PyschoPy ==<br />
Download the PsychoPy from the [https://www.psychopy.org/download.html PyschoPy] website. <br/><br />
Copy the following two folders '''BCIStart''' and '''BCIUpdateState''' in the folder {$PsychoPyHome}\psychopy\experiment\components.<br />
Open terminal and navigate to the PsychoPy home directory where ''setup.py'' resides.<br />
Run the following command in the terminal: <br/><br />
<code>pip install -e .</code> <br/><br/><br />
Start Psychopy application and in the builder view, under the Custom Components, you should see the two new components - ''BCI2000Start'' and ''BCI2000UpdateState'' as shown in the figure below.<br />
<br />
[[File:PsychoPy_Start.png|alt="PsychoPy Homepage with BCI2000 Components"|PsychoPy Homepage with BCI2000 Components]]<br />
<br />
== References ==<br />
* [https://www.psychopy.org/ PsychoPy site]<br />
<br />
== See Also ==<br />
* [[Programming Reference:BCI2000Remote Class]]<br />
* [[User Reference:Operator Module Scripting]]</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=File:BCI2000UpdateState.png&diff=8413File:BCI2000UpdateState.png2019-07-26T18:47:44Z<p>Dashmeetkaur: Dashmeetkaur uploaded a new version of File:BCI2000UpdateState.png</p>
<hr />
<div></div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=File:BCI2000Start.png&diff=8412File:BCI2000Start.png2019-07-26T18:47:10Z<p>Dashmeetkaur: Dashmeetkaur uploaded a new version of File:BCI2000Start.png</p>
<hr />
<div></div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=File:PsychoPy_Start.png&diff=8411File:PsychoPy Start.png2019-07-26T18:46:07Z<p>Dashmeetkaur: Dashmeetkaur uploaded a new version of File:PsychoPy Start.png</p>
<hr />
<div></div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=File:PsychoPy_Start.png&diff=8410File:PsychoPy Start.png2019-07-26T18:44:58Z<p>Dashmeetkaur: </p>
<hr />
<div></div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=File:BCI2000UpdateState.png&diff=8409File:BCI2000UpdateState.png2019-07-26T18:44:40Z<p>Dashmeetkaur: </p>
<hr />
<div></div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=File:BCI2000Start.png&diff=8408File:BCI2000Start.png2019-07-26T18:44:22Z<p>Dashmeetkaur: </p>
<hr />
<div></div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=PsychoPy&diff=8407PsychoPy2019-07-26T18:42:55Z<p>Dashmeetkaur: </p>
<hr />
<div>PsychoPy is an open-source application using which a large number of neuroscience, psychology and psychophysics experiments can be performed.[1]<br />
This section first describes the two components that are developed to remotely start BCI2000 from the PsychoPy and the second section lists the steps to follow to add the new components in the PsychoPy application.<br />
<br />
== Components ==<br />
<br />
=== BCIStart ===<br />
The component starts up the BCI2000 modules remotely. The component takes two parameters:<br />
; Path : Path to the BCI2000 ''prog'' directory which contains the ''BCI2000Remote.py'' file.<br />
; States : List of new states to add to the BCI2000. The states in the list are defined as follows: 'StateName defaultValue maxValue'. Eg: lastKey 0 255, correctKey 0 1.<br />
<br />
<br />
=== BCIUpdateState ===<br />
The component defines which state to update and when. It takes the following parameters:<br />
; State Name : The name of the state in BCI2000 to update.<br />
; Response Component Variable : The variable to which the state is be set OR the variable which contains the new value of the state. '''Note-''' the variable is written as ''$VariableName''. <br />
; Use Expression : If it is checked, the code written in 'Expression' is executed for each Frame and the variable specified is not used to update the state.<br />
; Expression : The code to execute for each Frame. It is given for the cases, where the variable is not available and the users want more control over how the state is updated. '''Note-''' the user would have to use commands like ''bci.Execute'' and ''SET STATE'' to update the state in such cases. See [[Programming Reference:BCI2000Remote Class]] and [[User Reference:Operator Module Scripting]] for more details.<br />
<br />
<br />
== Integrating BCI2000 into PyschoPy ==<br />
Download the PsychoPy from the [https://www.psychopy.org/download.html PyschoPy] website. <br/><br />
Copy the following two folders '''BCIStart''' and '''BCIUpdateState''' in the folder {$PsychoPyHome}\psychopy\experiment\components.<br />
Open terminal and navigate to the PsychoPy home directory where ''setup.py'' resides.<br />
Run the following command in the terminal: <br/><br />
<code>pip install -e .</code> <br/><br/><br />
Start Psychopy application and in the builder view, under the Custom Components, you should see the two new components - ''BCI2000Start'' and ''BCI2000UpdateState'' as shown in the figure below.<br />
<br />
== References ==<br />
* [https://www.psychopy.org/ PsychoPy site]</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=PsychoPy&diff=8406PsychoPy2019-07-26T18:39:13Z<p>Dashmeetkaur: </p>
<hr />
<div>PsychoPy is an open-source application using which a large number of neuroscience, psychology and psychophysics experiments can be performed.[1] This documentation described how to integrate BCI2000 in PsychoPy and its usage.<br />
<br />
== BCI2000 and PyschoPy ==<br />
This section first describes the two components that are developed to remotely start BCI2000 from the PsychoPy and the second section lists the steps to follow to add the new components in the PsychoPy application.<br />
<br />
=== Components ===<br />
<br />
==== BCIStart ====<br />
The component starts up the BCI2000 modules remotely. The component takes two parameters:<br />
; Path : Path to the BCI2000 ''prog'' directory which contains the ''BCI2000Remote.py'' file.<br />
; States : List of new states to add to the BCI2000. The states in the list are defined as follows: 'StateName defaultValue maxValue'. Eg: lastKey 0 255, correctKey 0 1.<br />
<br />
<br />
==== BCIUpdateState ====<br />
The component defines which state to update and when. It takes the following parameters:<br />
; State Name : The name of the state in BCI2000 to update.<br />
; Response Component Variable : The variable to which the state is be set OR the variable which contains the new value of the state. '''Note-''' the variable is written as ''$VariableName''. <br />
; Use Expression : If it is checked, the code written in 'Expression' is executed for each Frame and the variable specified is not used to update the state.<br />
; Expression : The code to execute for each Frame. It is given for the cases, where the variable is not available and the users want more control over how the state is updated. '''Note-''' the user would have to use commands like ''bci.Execute'' and ''SET STATE'' to update the state in such cases. See [[Programming Reference:BCI2000Remote Class]] and [[User Reference:Operator Module Scripting]] for more details.<br />
<br />
=== Integrating BCI2000 into PyschoPy ===<br />
Download the PsychoPy from the [https://www.psychopy.org/download.html PyschoPy] website. <br/><br />
Copy the following two folders '''BCIStart''' and '''BCIUpdateState''' in the folder {$PsychoPyHome}\psychopy\experiment\components.<br />
Open terminal and navigate to the PsychoPy home directory where ''setup.py'' resides.<br />
Run the following command in the terminal: <br/><br />
<code>pip install -e .</code> <br/><br/><br />
Start Psychopy application and in the builder view, under the Custom Components, you should see the two new components - ''BCI2000Start'' and ''BCI2000UpdateState'' as shown in the figure below.<br />
<br />
== References ==<br />
* [https://www.psychopy.org/ PsychoPy site]</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=PsychoPy&diff=8405PsychoPy2019-07-26T18:36:31Z<p>Dashmeetkaur: </p>
<hr />
<div>PsychoPy is an open-source application using which a large number of neuroscience, psychology and psychophysics experiments can be performed.[1] This documentation described how to integrate BCI2000 in PsychoPy and its usage.<br />
<br />
== BCI2000 and PyschoPy ==<br />
This section first describes the two components that are developed to remotely start BCI2000 from the PsychoPy and the second section lists the steps to follow to add the new components in the PsychoPy application.<br />
<br />
=== Components ===<br />
<br />
==== BCIStart ====<br />
The component starts up the BCI2000 modules remotely. The component takes two parameters:<br />
; Path : Path to the BCI2000 ''prog'' directory which contains the ''BCI2000Remote.py'' file.<br />
; States : List of new states to add to the BCI2000. The states in the list are defined as follows: 'StateName defaultValue maxValue'. Eg: lastKey 0 255, correctKey 0 1.<br />
<br />
<br />
==== BCIUpdateState ====<br />
The component defines which state to update and when. It takes the following parameters:<br />
; State Name : The name of the state in BCI2000 to update.<br />
; Response Component Variable : The variable to which the state is be set OR the variable which contains the new value of the state. '''Note-''' the variables are written as ''$VariableName''. <br />
; Use Expression : If it is checked, the code written in 'Expression' is executed for each Frame. <br />
; Expression : The code to execute for each Frame. It is given for the cases, where the variable is not available and the users want more control over how the state is updated. '''Note-''' the user would have to use commands like ''bci.Execute'' and ''SET STATE'' to update the state in such cases. See [[Programming Reference:BCI2000Remote Class]] and [[User Reference:Operator Module Scripting]] for more details.<br />
<br />
=== Integrating BCI2000 into PyschoPy ===<br />
Download the PsychoPy from the [https://www.psychopy.org/download.html PyschoPy] website. <br/><br />
Copy the following two folders '''BCIStart''' and '''BCIUpdateState''' in the folder {$PsychoPyHome}\psychopy\experiment\components.<br />
Open terminal and navigate to the PsychoPy home directory where ''setup.py'' resides.<br />
Run the following command in the terminal: <br/><br />
<code>pip install -e .</code> <br/><br/><br />
Start Psychopy application and in the builder view, under the Custom Components, you should see the two new components - ''BCI2000Start'' and ''BCI2000UpdateState'' as shown in the figure below.<br />
<br />
== References ==<br />
* [https://www.psychopy.org/ PsychoPy site]</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=PsychoPy&diff=8404PsychoPy2019-07-26T18:24:44Z<p>Dashmeetkaur: </p>
<hr />
<div>PsychoPy is an open-source application using which a large number of neuroscience, psychology and psychophysics experiments can be performed.[1] This documentation described how to integrate BCI2000 in PsychoPy and its usage.<br />
<br />
== BCI2000 and PyschoPy ==<br />
This section first describes the two components that are developed to remotely start BCI2000 from the PsychoPy and the second section lists the steps to follow to add the new components in the PsychoPy application.<br />
<br />
=== Components ===<br />
<br />
==== BCIStart ====<br />
The component starts up the BCI2000 modules remotely. The component takes two parameters:<br />
; Path : Path to the BCI2000 ''prog'' directory which contains the ''BCI2000Remote.py'' file.<br />
; States : List of new states to add to the BCI2000. The states in the list are defined as follows: 'StateName defaultValue maxValue'. Eg: lastKey 0 255, correctKey 0 1.<br />
<br />
<br />
==== BCIUpdateState ====<br />
The component defines which state to update and when. It takes the following parameters:<br />
; State Name : The name of the state in BCI2000 to update.<br />
; Response Component Variable : The variable to which the state is be set OR the variable which contains the new value of the state. Note - the variables are written as ''$VariableName''. <br />
; Use Expression : If it is checked, the code written in 'Expression' is executed for each Frame. <br />
; Expression : The code to execute for each Frame. It is given for the cases, where the variable is not available and the users want more control over how the state is updated. Note - the user would have to use commands like ''bci.Execute'' and ''SET STATE'' to update the state in such cases. See this for more details.<br />
<br />
=== Integrating BCI2000 into PyschoPy ===<br />
Download the PsychoPy from the [https://www.psychopy.org/download.html PyschoPy] website. <br/><br />
Copy the following two folders '''BCIStart''' and '''BCIUpdateState''' in the folder {$PsychoPyHome}\psychopy\experiment\components.<br />
Open terminal and navigate to the PsychoPy home directory where ''setup.py'' resides.<br />
Run the following command in the terminal: <br/><br />
<code>pip install -e .</code> <br/><br />
Start Psychopy application and in the builder view, under the Custom Components, you should see the two new components - ''BCI2000Start'' and ''BCI2000UpdateState'' as shown in the figure below.<br />
<br />
== Usage == <br />
<br />
<br />
== References ==<br />
* [https://www.psychopy.org/ PsychoPy site]</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=PsychoPy&diff=8403PsychoPy2019-07-26T18:18:28Z<p>Dashmeetkaur: </p>
<hr />
<div>PsychoPy is an open-source application using which a large number of neuroscience, psychology and psychophysics experiments can be performed.[1] This documentation described how to integrate BCI2000 in PsychoPy and its usage.<br />
<br />
== BCI2000 and PyschoPy ==<br />
This section first describes the two components that are developed to remotely start BCI2000 from the PsychoPy and the second section lists the steps to follow to add the new components in the PsychoPy application.<br />
<br />
=== Components ===<br />
<br />
==== BCIStart ====<br />
The component starts up the BCI2000 modules remotely. The component takes two parameters:<br />
; Path : Path to the BCI2000 ''prog'' directory which contains the ''BCI2000Remote.py'' file.<br />
; States : List of new states to add to the BCI2000. The states in the list are defined as follows: 'StateName defaultValue maxValue'. Eg: <br/> <br />
lastKey 0 255, correctKey 0 1.<br />
<br />
<br />
==== BCIUpdateState ====<br />
The component defines which state to update and when. It takes the following parameters:<br />
; State Name : The name of the state in BCI2000 to update.<br />
; Response Component Variable : The variable to which the state is be set OR the variable which contains the new value of the state.<br />
; Use Expression : If it is checked, the code written in 'Expression' is executed for each Frame. <br />
; Expression : The code to execute for each Frame. It is given for the cases, where the variable is not available and the users want more control over how the state is updated. <br />
<br />
=== Integrating BCI2000 into PyschoPy ===<br />
Download the PsychoPy from the [https://www.psychopy.org/download.html PyschoPy] website. <br/><br />
Copy the following two folders '''BCIStart''' and '''BCIUpdateState''' in the folder {$PsychoPyHome}\psychopy\experiment\components.<br />
Open terminal and navigate to the PsychoPy home directory where ''setup.py'' resides.<br />
Run the following command in the terminal: <br/><br />
<code>pip install -e .</code><br />
Start Psychopy application and in the builder view, under the Custom Components, you should see the two new components - ''BCI2000Start'' and ''BCI2000UpdateState'' as shown in the figure below.<br />
<br />
== Usage == <br />
<br />
<br />
== References ==<br />
* [https://www.psychopy.org/ PsychoPy site]</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=PsychoPy&diff=8402PsychoPy2019-07-26T17:36:54Z<p>Dashmeetkaur: </p>
<hr />
<div>PsychoPy is an open-source application using which a large number of neuroscience, psychology and psychophysics experiments can be performed.[1] This documentation described how to integrate BCI2000 in PsychoPy and its usage.<br />
<br />
== BCI2000 and PyschoPy ==<br />
This section first describes the two components that are developed to remotely start BCI2000 from the PsychoPy and the second section lists the steps to follow to add the new components in the PsychoPy application.<br />
<br />
=== Components ===<br />
<br />
==== BCIStart ====<br />
The component starts up the BCI2000 modules remotely. The component takes two parameters:<br />
; Path : Path to the BCI directory <br />
; States : States to add to the BCI2000<br />
<br />
<br />
==== BCIUpdateState ====<br />
<br />
=== Integrating BCI2000 into PyschoPy ===<br />
Download the PsychoPy from the [https://www.psychopy.org/download.html PyschoPy] website. <br/><br />
Copy the following two folders '''BCIStart''' and '''BCIUpdateState''' in the folder {$PsychoPyHome}\psychopy\experiment\components.<br />
Open terminal and navigate to the PsychoPy home directory where ''setup.py'' resides.<br />
Run the following command in the terminal: <br/><br />
<code>pip install -e .</code><br />
Start Psychopy application and in the builder view, under the Custom Components, you should see the two new components - ''BCI2000Start'' and ''BCI2000UpdateState'' as shown in the figure below.<br />
<br />
== Usage == <br />
<br />
<br />
== References ==<br />
* [https://www.psychopy.org/ PsychoPy site]</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=PsychoPy&diff=8401PsychoPy2019-07-26T17:06:58Z<p>Dashmeetkaur: </p>
<hr />
<div>PsychoPy is an open-source application using which a large number of neuroscience, psychology and psychophysics experiments can be performed.[1] This documentation described how to integrate BCI2000 in PsychoPy and its usage.<br />
<br />
== BCI2000 and PyschoPy ==<br />
This section first describes the two components that are developed to remotely start BCI2000 from the PsychoPy and the second section lists the steps to follow to add the new components in the PsychoPy application.<br />
<br />
=== Components ===<br />
==== BCIStart ====<br />
==== BCIUpdateState ====<br />
<br />
=== Integrating BCI2000 into PyschoPy ===<br />
Download the PsychoPy from the [https://www.psychopy.org/download.html PyschoPy] website. <br/><br />
Copy the following two folders '''BCIStart''' and '''BCIUpdateState''' in the folder {$PsychoPyHome}\psychopy\experiment\components.<br />
Open terminal and navigate to the PsychoPy home directory where ''setup.py'' resides.<br />
Run the following command in the terminal: <br/><br />
<code>pip install -e .</code><br />
Start Psychopy application and in the builder view, under the Custom Components, you should see the two new components - ''BCI2000Start'' and ''BCI2000UpdateState'' as shown in the figure below.<br />
<br />
== Usage == <br />
<br />
<br />
== References ==<br />
* [https://www.psychopy.org/ PsychoPy site]</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=PyschoPy&diff=8400PyschoPy2019-07-26T17:03:05Z<p>Dashmeetkaur: Blanked the page</p>
<hr />
<div></div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=Psychopy&diff=8399Psychopy2019-07-26T17:02:03Z<p>Dashmeetkaur: Dashmeetkaur moved page Psychopy to PsychoPy</p>
<hr />
<div>#REDIRECT [[PsychoPy]]</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=PsychoPy&diff=8398PsychoPy2019-07-26T17:02:03Z<p>Dashmeetkaur: Dashmeetkaur moved page Psychopy to PsychoPy</p>
<hr />
<div>PsychoPy is an open-source application using which a large number of neuroscience, psychology and psychophysics experiments can be performed.[1] This documentation described how to integrate BCI2000 in PsychoPy and its usage.<br />
<br />
== BCI2000 and PyschoPy ==<br />
This section first describes the two components that are developed to remotely start BCI2000 using the PsychoPy<br />
=== Components ===<br />
=== Integrating BCI2000 into PyschoPy ===<br />
Download the PsychoPy from the [https://www.psychopy.org/download.html PyschoPy] website. <br/><br />
Copy the following two folders '''BCIStart''' and '''BCIUpdateState''' in the folder {$PsychoPyHome}\psychopy\experiment\components.<br />
Open terminal and navigate to the PsychoPy home directory where ''setup.py'' resides.<br />
Run the following command in the terminal: <br/><br />
<code>pip install -e .</code><br />
Start Psychopy application and in the builder view, under the Custom Components, you should see the two new components - ''BCI2000Start'' and ''BCI2000UpdateState'' as shown in the figure below.<br />
<br />
== Usage == <br />
<br />
<br />
== References ==<br />
* [https://www.psychopy.org/ PsychoPy site]</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=PsychoPy&diff=8397PsychoPy2019-07-26T16:59:42Z<p>Dashmeetkaur: Created page with "PsychoPy is an open-source application using which a large number of neuroscience, psychology and psychophysics experiments can be performed.[1] This documentation described h..."</p>
<hr />
<div>PsychoPy is an open-source application using which a large number of neuroscience, psychology and psychophysics experiments can be performed.[1] This documentation described how to integrate BCI2000 in PsychoPy and its usage.<br />
<br />
== BCI2000 and PyschoPy ==<br />
This section first describes the two components that are developed to remotely start BCI2000 using the PsychoPy<br />
=== Components ===<br />
=== Integrating BCI2000 into PyschoPy ===<br />
Download the PsychoPy from the [https://www.psychopy.org/download.html PyschoPy] website. <br/><br />
Copy the following two folders '''BCIStart''' and '''BCIUpdateState''' in the folder {$PsychoPyHome}\psychopy\experiment\components.<br />
Open terminal and navigate to the PsychoPy home directory where ''setup.py'' resides.<br />
Run the following command in the terminal: <br/><br />
<code>pip install -e .</code><br />
Start Psychopy application and in the builder view, under the Custom Components, you should see the two new components - ''BCI2000Start'' and ''BCI2000UpdateState'' as shown in the figure below.<br />
<br />
== Usage == <br />
<br />
<br />
== References ==<br />
* [https://www.psychopy.org/ PsychoPy site]</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=PyschoPy&diff=8396PyschoPy2019-07-26T16:59:18Z<p>Dashmeetkaur: </p>
<hr />
<div>PsychoPy is an open-source application using which a large number of neuroscience, psychology and psychophysics experiments can be performed.[1] This documentation described how to integrate BCI2000 in PsychoPy and its usage.<br />
<br />
== BCI2000 and PyschoPy ==<br />
This section first describes the two components that are developed to remotely start BCI2000 using the PsychoPy<br />
=== Components ===<br />
=== Integrating BCI2000 into PyschoPy ===<br />
Download the PsychoPy from the [https://www.psychopy.org/download.html PyschoPy] website. <br/><br />
Copy the following two folders '''BCIStart''' and '''BCIUpdateState''' in the folder {$PsychoPyHome}\psychopy\experiment\components.<br />
Open terminal and navigate to the PsychoPy home directory where ''setup.py'' resides.<br />
Run the following command in the terminal: <br/><br />
<code>pip install -e .</code><br />
Start Psychopy application and in the builder view, under the Custom Components, you should see the two new components - ''BCI2000Start'' and ''BCI2000UpdateState'' as shown in the figure below.<br />
<br />
== Usage == <br />
<br />
<br />
== References ==<br />
* [https://www.psychopy.org/ PsychoPy site]</div>Dashmeetkaurhttps://www.bci2000.org/mediawiki/index.php?title=PyschoPy&diff=8395PyschoPy2019-07-26T16:54:12Z<p>Dashmeetkaur: </p>
<hr />
<div>PsychoPy is an open-source application using which a large number of neuroscience, psychology and psychophysics experiments can be performed.[1] This documentation described how to integrate BCI2000 in PyschoPy and its usage.<br />
<br />
== Integrating BCI2000 into PyschoPy ==<br />
Download the PyschoPy from the [https://www.psychopy.org/download.html PyschoPy] website. <br/><br />
Copy the following two folders '''BCIStart''' and '''BCIUpdateState''' in the folder {$PsychoPyHome}\psychopy\experiment\components.<br />
Open terminal and navigate to the PyschoPy home directory where ''setup.py'' resides.<br />
Run the following command in the terminal: <br/><br />
<code>pip install -e .</code><br />
<br />
Start Pyschopy application and in the builder view, under the Custom Components, you should see the two new components - ''BCI2000Start'' and ''BCI2000UpdateState''<br />
== Usage == <br />
<br />
<br />
== References ==<br />
* [https://www.psychopy.org/ PyschoPy site]</div>Dashmeetkaur