diff --git a/README.md b/README.md index ee51c65..c00c98c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ OpenSesame Plugin: Parallel Port Trigger ========== -*An OpenSesame Plugin for sending stimulus synchronization triggers through the parallel port to data acquisition systems.* +*An OpenSesame Plug-in for sending stimulus synchronization triggers through the parallel port to data acquisition systems.* Copyright, 2013, Bob Rosbag @@ -10,12 +10,15 @@ Contributions: Code is based on the work of Per Sederberg. Debugged and polished 1. About -------- -In EEG/ ERP studies it is common to send triggers to mark the time of significant events (e.g., the onset of a trial, presentation of a particular stimulus, etc.). Triggers are typically bytes that are sent via the parallel port to the EEG apparatus. This can be done with the parallel port trigger plugin which works in Linux and Windows. For Windows the `DLPortIO.dll` driver is used to access the parallel port. +In EEG/ERP studies it is common to send triggers to mark the timestamp for significant events (e.g., the onset of a trial, presentation of a particular stimulus, etc.). Triggers are typically bytes that are sent via the parallel port to data acquisition systems. -The plugin has three input boxes: -- Value ranges between 0-255 -- Duration in ms -- Parallel port adress has to be specified manually (Windows only) +The plug-in has three options: +- *Value* is a positive integer between 0-255 and specifies the trigger byte +- *Duration* (ms) is a positive integer, 'keypress', or 'mouseclick', to wait respectively for a specified interval in milliseconds, until a key has been pressed, or until a mouse button has been clicked. It specifies the time the trigger is active. +- *Port adress (Windows only)* is the hexadecimal value of the parallel port in Windows. This setting is ignored in Linux. + + +Linux and Windows are supported (possible also OSX, not tested). For Windows the `DLPortIO.dll` driver is used to access the parallel port. Install options are listed below. Installation instructions: diff --git a/parallel_port_trigger/parallel_port_trigger.html b/parallel_port_trigger/parallel_port_trigger.html deleted file mode 100644 index 9bb18b5..0000000 --- a/parallel_port_trigger/parallel_port_trigger.html +++ /dev/null @@ -1,39 +0,0 @@ - - - - - - - - - - - - -

Parallel Port Trigger

-

The Parallel Port Trigger plugin allows you to send signals out - a parallel port. This allows you to, for example, send - synchronization TTL pulses to an EEG amplifier during your experiment..

-

The following options are available:

- - - diff --git a/parallel_port_trigger/parallel_port_trigger.md b/parallel_port_trigger/parallel_port_trigger.md index 299743e..c00c98c 100644 --- a/parallel_port_trigger/parallel_port_trigger.md +++ b/parallel_port_trigger/parallel_port_trigger.md @@ -1,3 +1,43 @@ -# Auto_example +OpenSesame Plugin: Parallel Port Trigger +========== -You can define your help files in [Markdown syntax](http://daringfireball.net/projects/markdown/syntax). \ No newline at end of file +*An OpenSesame Plug-in for sending stimulus synchronization triggers through the parallel port to data acquisition systems.* + +Copyright, 2013, Bob Rosbag + +Contributions: Code is based on the work of Per Sederberg. Debugged and polished by Edwin Dalmaijer. + +1. About +-------- + +In EEG/ERP studies it is common to send triggers to mark the timestamp for significant events (e.g., the onset of a trial, presentation of a particular stimulus, etc.). Triggers are typically bytes that are sent via the parallel port to data acquisition systems. + +The plug-in has three options: +- *Value* is a positive integer between 0-255 and specifies the trigger byte +- *Duration* (ms) is a positive integer, 'keypress', or 'mouseclick', to wait respectively for a specified interval in milliseconds, until a key has been pressed, or until a mouse button has been clicked. It specifies the time the trigger is active. +- *Port adress (Windows only)* is the hexadecimal value of the parallel port in Windows. This setting is ignored in Linux. + + +Linux and Windows are supported (possible also OSX, not tested). For Windows the `DLPortIO.dll` driver is used to access the parallel port. Install options are listed below. + + +Installation instructions: + + +2. LICENSE +---------- + +Parallel Port Trigger is distributed under the terms of the GNU General Public License 3. +The full license should be included in the file COPYING, or can be obtained from + +- + +Parallel Port Trigger contains works of others. For the full license information, please +refer to `debian/copyright`. + +3. Documentation +---------------- + +Installation instructions and documentation on OpenSesame are available on the documentation website: + +-