__lynxsx_hardware_name Commands

-CreateHardwareSubSystem <Hardware Sub System Name> <Sub System Type> <Sample Frequency> <Hardware IP Address> <Command Port Number> <PC IP Address> <Data Port Number>

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 "AcqSystem1" ATLASDigitalLynxSX 32000 192.168.3.10 26011 192.168.3.100 26090 Default:  This command is an action, there is no default value. Usage:  This command can only be used when __prod_name is idle. Note:   This version of the command has parameters specific to __lynxsx_hardware_name creation.

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: DigitalLynxSX:   ATLAS:   Creates an __lynxsx_hardware_name acquisition system for use with __prod_name. 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. Sample Frequency The sample frequency of the __lynxsx_hardware_name hardware.  This value must be between 16000 and 40000 Hz in increments of 2000 Hz.  The value 32768 Hz is also valid.  Once this value is set, it cannot be modified. Hardware IP Address The IP address of the __lynxsx_hardware_name hardware.  Once this value is set, it cannot be modified. Command Port Number The port number of the __lynxsx_hardware_name hardware.  Once this value is set, it cannot be modified. PC IP Address The IP address of the PC network card that __prod_name will use to connect to the __lynxsx_hardware_name. Once this value is set, it cannot be modified. Data Port Number The port number that __prod_name will use to receive AD Records.  Once this value is set, it cannot be modified.

- GetHardwareSubSystemInformation  < Hardware Sub System Name >

Retrieves property information for the HWSS that was used to create the HWSS. Example :   -GetHardwareSubSystemInformation "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. Sub System Type Specifies the type of hardware sub system that was created.  This value must be one of the following types: __lynxsx_hardware_name:   An __lynxsx_hardware_name acquisition system is being used with __prod_name. RawDataFile:   A pre-recorded raw data file is being used as the data source for __prod_name. Sample Frequency The sample frequency of the __lynxsx_hardware_name hardware.  This value must be between 16000 and 40000 Hz in increments of 2000 Hz.  The value 32768 Hz is also valid. Hardware IP Address The IP address of the __lynxsx_hardware_name hardware. Command Port Number The port number of the __lynxsx_hardware_name hardware. PC IP Address The IP address of the PC network card that __prod_name will use to connect to the __lynxsx_hardware_name. Data Port Number The port number that __prod_name will use to receive AD Records.

-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.

-GetRawDataFile < Hardware Sub System Name >

Returns the raw data file name and location for data recording. Example :   -GetRawDataFile 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.  The specified sub system must be a __lynxsx_hardware_name system.

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. File Name The name of the raw data file currently in use by the specified hardware sub system.  If a raw data file has not been set, this parameter will be empty.

-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.

-SetInputCalibrationOffset <Sub System Name>  <Offset Value(s)>

Sets the DC offset values for A/D channels in a HWSS.  An independent value can be specified for each AD channel in the system starting with channel 0.  The user may specify any number of offset values.  If the number of values is less than the AD channel count, then the remaining AD channel offsets will go unchanged.  If the number of offset values is greater than the AD channel count, the additional values will be discarded.  Offset values will be subtracted from the AD value prior to being gain adjusted, output to the Raw Data file and DSP filtered.  Example :   -SetInputCalibrationOffset AcqSystem1 32 33 23 32 43 24 43 32 24 41 21 23 54 32 32 12  Default: The default offset for each AD channel is 0. Usage:  This command can be used at any time.

Arguments

Sub System Name The name of the sub system which will be modified. Offset Value(s) List of integer values to be used as offsets when processing data coming from the hardware.

-SetInputCalibrationGain <Sub System Name>  <Gain Value(s)>

Sets the gain values for A/D channels in a HWSS.  An independent value can be specified for each AD channel in the system starting with channel 0.  The user may specify any number of gain values.  If the number of values is less than the AD channel count, then the remaining AD channel gains will go unchanged.  If the number of gain values is greater than the AD channel count, the additional values will be discarded.  Gain values will be multiplied against the AD value after the Input Calibration Offset has been subtracted but prior being output to the Raw Data file and DSP filtered.  Example :   -SetInputCalibrationGain AcqSystem1 3.4 3.2 3.5 3.2 4.0 3.9 3.7 4.1 3.8  Default: The default gain for each AD channel is 1.0. Usage:  This command can be used at any time.

Arguments

Sub System Name The name of the sub system which will be modified. Gain Value(s) List of decimal values to be used as multipliers when processing data coming from the hardware.

-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.  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 "RawData.nrd" Default: __prod_name will not use a raw data file unless this command is specified. Usage:  This command can be used at any time.  The specified sub system must be a __lynxsx_hardware_name 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.