Raw Data File Commands

These commands setup a raw data file recording for any of the hardware systems, and for playing recorded raw data files back through __prod_name.

-CreateHardwareSubSystem <Hardware Sub System Name> <Sub System Type> <Raw Data File>

This command is used to tell __prod_name what type of acquisition hardware you are using with your system.  Once a system is created, it cannot be removed, and the name and system type cannot be changed.  __prod_name will start with no hardware systems defined if this command is not used. Example :   -CreateHardwareSubSystem "MyAcqSystem" RawDataFile "C:\MyData\example.nrd" Default: tyle="font-weight: bold;"> Default:  This command is an action, there is no default value. Usage:  This command can only be used when __prod_name is idle.

Arguments

Hardware Sub System Name The name of the hardware sub system you wish to create.  This name must be unique throughout the __prod_name system. Sub System Type Specifies the type of hardware sub system you wish to create.  This value must be one of the following types: RawDataFile:   Creates an acquisition system that will use a pre-recorded raw data file.  The Raw Data File argument is required when creating a system of this type. Raw Data File This argument is only valid if you are creating a RawDataFile type hardware subsystem.   If no file name is specified, then __prod_name will display a file dialog allowing you to browse for a raw data file.  Command processing will halt until the file dialog is closed. Sets the file to use for raw data file playback for this system.  Once set, this file cannot be changed.  If only a filename is specified, __prod_name will look for the file in the current data directory.   Example :   -CreateHardwareSubSystem "My DataPlayback" AcqSystem1 MyData.nrd If a complete path is specified, __prod_name will use the file in the specified location.   Example : -CreateHardwareSubSystem "My DataPlayback" AcqSystem1 "C:\Data Directory\MyData.nrd" The file C:\Data Directory\MyData.nrd must exist or this command will fail.

-GetMinMaxInputRange < Hardware Sub System Name >

Returns the minimum and maximum input range value that can be used for the hardware sub system. Example :   -GetMinMaxInputRange AcqSystem1 Default:  N/A Usage:  This command should only be used from a NetCom client application after a connection to a server has been established.

Arguments

Hardware Sub System Name The name of the hardware sub system to retrieve information for.

NetCom Reply

Error Code If the command is successful, this value will be equal to 0.  Otherwise, the value will be equal to -1. Min Input Range The minimum input range value allowed for the hardware sub system. Max Input Range The maximum input range value allowed for the hardware sub system.

-GetSampleFrequency < Hardware Sub System Name >

Returns the sample frequency of the hardware sub system. Example :   -GetSampleFrequency AcqSystem1 Default:  N/A Usage:  This command should only be used from a NetCom client application after a connection to a server has been established.  It may be used for any hardware sub system at any time.

Arguments

Hardware Sub System Name The name of the hardware sub system to retrieve information for.

NetCom Reply

Error Code If the command is successful, this value will be equal to 0.  Otherwise, the value will be equal to -1. Sample Frequency The sample frequency for the specified hardware sub system.  This value is in hertz.

-SetContinuousRawDataFilePlayback <Sub System Name> <Value>

Sets the sub system to automatically restart acquisition from the beginning of the file once the end of the file is reached. Example :   -SetContinuousRawDataFilePlayback AcqSystem1 On Default: __prod_name will start with continuous playback Off. Usage:  This command can only be used when __prod_name is idle. This command is only valid with the RawDataFile sub system.

Arguments

Sub System Name The name of the sub system whose playback mode you wish to modify. Value Continuous playback can be in either of the following states: On:  Sets __prod_name to continually loop the current raw data file.  Once __prod_name is done processing the file, it will immediately restart the same file from the beginning.  This setting is mainly used for presentation or testing purposes.  It is not intended for data collection use.   Off:   __prod_name will process all the data from the current raw data file once, and then turn off  acquisition and recording.   The file can be restarted by starting acquisition again.

-SetDmaBuffers <Sub System Name>  <Buffer Count> <Buffer Size>

Creates DMA (Direct Memory Access) buffers to be used to store AD (Analog to Digital) data from a hardware sub system.  The DMA buffers are the first set of buffers used in processing data from a sub system.  Once a buffer is full, the buffer is processed and sent to be filtered.  The buffer size and number of buffers effects the overall performance of the system.  Smaller buffer sizes will allow data to be moved through the system with a lower latency, but will also increase the possibility of overrunning a buffer.  If a buffer is overrun, then all the data in that buffer is lost and cannot be reclaimed.  If latency is not an issue, it recommended that larger buffer sizes are used to improve the overall efficiency of the system. Example :   -SetDmaBuffers AcqSystem1 128 5 Default: The default buffer count value is 64 and the default buffer size is 2 ms Usage:  This command can only be used when __prod_name is idle. Note: This command will affect the playback speed for the raw data file sub system.

Arguments

Sub System Name The name of the sub system which will be modified. Buffer Count The number of dma buffers to create. Valid range: 32..256. Buffer Size The size of each buffer.  This is in milliseconds. Valid range: 1..50.

-SetRawDataFile <Sub System Name> <File Name>

This will set the raw data file name and location for data recording.  It will also enable raw data output to the file.  Once this command is issued, there is no way to disable output to the raw data file.  A raw data file will contain all samples from all A/D channels before any digital filtering is applied to the signal.  These files are useful for recording all information for later analysis.  This file is recorded in addition to the normal __prod_name data files.  __prod_name is able to play back raw data files by creating a raw data file playback hardware subsystem. Example :   -SetRawDataFile AcqSystem1 "__prod_nameRawData.nrd" Default: __prod_name will not use a raw data file unless this command is specified. Usage:  This command can only be used when __prod_name is idle.  The specified sub system must be a DigitalLynx, __prod_name64 or __prod_name160 system.

Arguments

Sub System Name The name of the sub system whose data will be written to the raw data file.   File Name Sets the file to use for raw data output. The raw data file normally uses a .NRD extension.  If only a filename is specified, __prod_name will create the file in the current data directory.   Example :  -SetRawDataFile AcqSystem1 "RawData.nrd" If a complete path is specified, __prod_name will create the file in the specified location.   Example :-SetRawDataFile AcqSystem1 "C:\Raw Files\RawData.nrd" The directory C:\Raw Files must exist or this command will fail.

-SetRawDataFilePlaybackTimestamp <Sub System Name>  <Timestamp>

Sets the timestamp that the raw data file will start playback at the next time acquisition is started. Example :   -SetRawDataFilePlaybackTimestamp AcqSystem1 128523423434 Default: The default value will be the first timestamp in the file . Usage:  This command can only be used when __prod_name is idle.

Arguments

Sub System Name The name of the sub system which will be modified. Timestamp Start timestamp for the raw data file the next time acquisition is started.  This value must be in microseconds and be within the timestamp range of the loaded raw data file.