Editing Configuration Files

Sometimes it is necessary to actually get into the configuration files and make changes.  Maybe you need a customized electrode configuration or just simply want to change your electrode configuration.  Familiarize yourself with the __prod_name commands before you start editing files.  Some of these are summarized below in the "Command Rules" section.  Otherwise it could lead to an afternoon of debugging configuration files, which can be time consuming.  If you have any questions, please email Neuralynx Support, support@neuralynx.com.

Configuration File Rules

The following rules apply to configuration files. All of the rules listed for __prod_name commands are also applicable and listed below under "Command Rules".

1. There can only be one command per line.  Commands begin with a hyphen (-). 
   

   • correct:	-StartAcquisition
     	-StopAcquisition

     
     
   • incorrect:  -StartAcquisition -StopAcquisition
     
     
2. All objects must be created before they are used.
   
   • For example, you must create the Hardware System before you can create any Acquisition Entities in it:
       -CreateHardwareSubSystem AcqSystem1 ATLASDigitalLynxSX must be called before  -CreateCscAcqEnt CSC1 AcqSytem1
     
     
3. Objects can only be created once.
   

   • correct:	-CreatePlotWindow Time "Time Window 1"
     	-CreatePlotWindow Time "Time Window 2"

   • incorrect:	-CreatePlotWindow Time "Time Window 1"
     	-CreatePlotWindow Time "Time Window 1"

     
     
     
4. The pound sign (#) indicates a comment.  Any text in a configuration file that follows a pound sign (#) is ignored.
   • #-Break will ignore the Break command.   -Break # this text is ignored will process the Break command, and ignore the rest of the line.
   
   
5. Configuration files are in ASCII format.  Do not edit them in any program (i.e. Word) that saves formatting information to the file.  Notepad and Notepad++ are safe programs to use for editing.
   

Command Rules

All of the __prod_name commands obey some common rules.  If a command deviates from these rules, the description of the command will let you know.  Actual commands will appear in italics .  When using commands in configuration files, there are additional rules.

1. Commands begin with a hyphen (-).
   • correct:   -StartAcquisition    
   • incorrect:   StartAcquisition  
     
     
2. Commands and arguments are not case sensitive.
   • -processconfigurationfile test.cfg and -ProcessConfigurationFile Test.cfg are identical.
     
     
3. Commands must be spelled correctly, there are no abbreviations.
   • correct:   -StartAcquisition    
   • incorrect:   -StartAcq  
     
     
4. All command arguments are separated by a space.
   • -SetSpikeThreshold SC1 200 has two arguments, SC1 and 200.
     
     
5. If any command or argument contains a space, it must be surrounded by double quotes (" ").
   • -CreatePlotWindow  Spike "Spike Window 1" will create a Spike plot window named Spike Window 1.
     
     
6. All objects must be created before they are used.
   • For example, you must create the Hardware System before you can create any Acquisition Entities in it:
       -CreateHardwareSubSystem AcqSystem1 ATLASDigitalLynxSX must be called before  -CreateCscAcqEnt CSC1 AcqSytem1
     
     
7. All command arguments are required unless otherwise stated in the command documentation.

Changing Your Electrode Configuration using __prod_name.cfg

__prod_name.cfg  is the starting point for configuring the __prod_name software.  This file is responsible for setting up all hardware, displays and electrode configurations after __prod_name is installed.  Changing your electrode configuration is the most common reason for editing this file, so that is what will be covered here.

1. Open __prod_name.cfg from your Configuration directory using Notepad or Notepad++.
   
2. Find the section of the file titled "“######### ELECTRODE CONFIGURATIONS"
   
3. Put a comment (#) in front of the only uncommented line in this section.  After your first __prod_name installation, this line is usually -ProcessConfigurationFile 32csc.cfg
   
4. Remove the comment (#) in front of one and only one of the other -ProcessConfigurationFile lines.  The generic configuration files are named using the number and type of spike channels and the number of CSC channels.
   
5. Save the file as __prod_name.cfg and close Notepad.  You may need to use the drop down menu to select "All files (*.*)" by "Save as type:" to enter the .cfg file extension
   
6. The next time you start __prod_name, click the Use the Following File button on the  Startup Configuration Selection.