LabLynx Commands

 -CreateHardwareSubSystem <Hardware Sub System Name> LabLynx <LabLynx 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 cannot be changed.  __prod_name will start with no hardware systems defined if this command is not used.

Example: -CreateHardwareSubSystem "AcqSystem1" LabLynx 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 LabLynx 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.
LabLynx IP Address The IP address of the LabLynx hardware.  Once this value is set, it cannot be modified. Only connections from the LabLynx device with this IP will be accepted.
Command Port Number The port number of the LabLynx hardware.  Once this value is set, it cannot be modified.
PC IP Address The IP address of the network card on the PC running __prod_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 For LabLynx systems, this value will always be LabLynx.
LabLynx IP Address The IP address of the LabLynx hardware.
Command Port Number The port number of the LabLynx hardware.
PC IP Address The IP address of the network card on the PC running __prod_name.
Data Port Number The port number that __prod_name will use to receive AD Records.

-GetUltrasonicMicrophoneEnabled <Hardware Sub System Name>
Retrieves the current enable state of the ultrasonic microphone. If the microphone is not present, this command will return false.

Example :   -GetUltrasonicMicrophoneEnabled "AcqSystem1"
Default: N/A
Usage: This command should only be used from a NetCom client application after a connection to a hardware device has been established.
Arguments
Hardware Sub System Name The name of the LabLynx hardware sub system with the microphone installed.
NetCom Reply
Error Code
If the command is successful, this value will be equal to 0.  Otherwise, the value will be equal to -1.
Enabled
  • True - Microphone is enabled.
  • False - Microphone is disabled.

 -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 or LabLynx or SAT2 system.
Arguments
Hardware Sub System Name The name of the hardware sub system to retrieve information from.
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 from.
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.

 -GetBatteryRemaining <Hardware Sub System Name>
Returns the remaining battery charge for the hardware sub system.

Example: -GetBatteryRemaining 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 LabLynx system.
Arguments
Hardware Sub System Name The name of the hardware sub system to retrieve information from.
NetCom Reply
Error Code
If the command is successful, this value will be equal to 0.  Otherwise, the value will be equal to -1.
Battery Remaining The remaining battery charge as a percentage of battery capacity.

 -GetCoreTemperature <Hardware Sub System Name>
Returns the core temperature for the hardware sub system.

Example: -GetCoreTemperature 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 LabLynx system.
Arguments
Hardware Sub System Name The name of the hardware sub system to retrieve information from.
NetCom Reply
Error Code
If the command is successful, this value will be equal to 0.  Otherwise, the value will be equal to -1.
Core Temperature The internal core temperature of the LabLynx hardware. This value is in Celsius.

-SetUltrasonicMicrophoneEnabled <Hardware Sub System Name> <Enabled>
Enables or disables the ultrasonic microphone installed on the LabLynx.

Example :   -SetUltrasonicMicrophoneEnabled "AcqSystem1" false
Default: Enabled defaults to false.
Usage: This command should only be used from a NetCom client application after a connection to a hardware device has been established.
Arguments
Hardware Sub System Name The name of the hardware sub system containing the IMU
Enabled
  • True - Enables the microphone. If the microphone is not present, this command will fail.
  • False - Disables the microphone. If the microphone is not present, this command will succeed.
NetCom Reply
Error Code
If the command is successful, this value will be equal to 0.  Otherwise, the value will be equal to -1.

 -SetRawDataFile <Hardware 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 or LabLynx or SAT2 system.
Arguments
Hardware 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.

-SetTransmittedChannels <Hardware Sub System Name> <Connector1, channels0-63 mask> <Connector2, channels0-63 mask> <Connector3, channels0-63 mask > <Connector4, channels0-63 mask<
Sets what channels are transmitting out of 256 possible channels

Example :    -SetTransmittedChannels AcqSystem1 "00000000FFFFFFFF 00000000FFFFFFFF 0000000000000000 0000000000000000 "
Channel 1-32 (connector 1 channels 0-31) are transmitting
Channel 33-64 (connector 1 channels 32-63) are ignored
Channel 65-96 (connector 2 channels 0-31) are transmitting
Channel 67-256 are ignored
Default: The default value of all transmitted channels are set to 1. All channels are transmitting.
Usage:  This Command can be used after the LabLynx Sub System has been created and the LabLynx is connected. The channel masks are the hexadecimal value that sets the logic level high or low for the 256 available channels on the LabLynx.
Channels 1-64 correspond to Headstage channels 0-63 connected to connector 1.
Channels 65-128 correspond to Headstage channels 0-63 connected to connector 2.
Channels 129-192 correspond to Headstage channels 0-63 connected to connector 3.
Channels 193-256 correspond to Headstage channels 0-63 connected to connector 4.
Transmitted channels concatenate to available CSC lines
Arguments
Hardware Sub System Name
The name of the sub system whose data will be written to the raw data file. 
Value
1 Channel transmitting
0 Channel ignored
-SetTransmittedChannels AcqSystem1 "FFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFF"
Connector 1 channels 1-32: 11111111 11111111 11111111 11111111
Connector 1 channels 33-64: 11111111 11111111 11111111 11111111
Connector 2 channels 65-96: 11111111 11111111 11111111 11111111
Connector 2 channels 97-128: 11111111 11111111 11111111 11111111
Connector 3 channels 129-160: 11111111 11111111 11111111 11111111
Connector 3 channels 161-192: 11111111 11111111 11111111 11111111
Connector 4 channels 193-224: 11111111 11111111 11111111 11111111
Connector 4 channels 225-256: 11111111 11111111 11111111 11111111


-SetTransmittedChannels AcqSystem1 "00000000 FFFFFFFF 00000000 FFFFFFFF 00000000 FFFFFFFF 00000000 FFFFFFFF"
Connector 1 channels 1-32: 11111111 11111111 11111111 11111111
Connector 1 channels 33-64: 00000000 00000000 00000000 00000000
Connector 2 channels 65-96: 11111111 11111111 11111111 11111111
Connector 2 channels 97-128: 00000000 00000000 00000000 00000000
Connector 3 channels 129-160: 11111111 11111111 11111111 11111111
Connector 3 channels 161-192: 00000000 00000000 00000000 00000000
Connector 4 channels 193-224: 11111111 11111111 11111111 11111111
Connector 4 channels 225-256: 00000000 00000000 00000000 00000000


Note: highlight color corresponds to connector color on LabLynx front panel. Spaces located between each 8 bits are for demonstration purposes. Final form of Netcom input should follow form of the example.