FreeLynx Commands

-CreateHardwareSubSystem <Hardware Sub System Name> FreeLynx <FreeLynx 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" FreeLynx 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 FreeLynx 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. FreeLynx IP Address The IP address of the FreeLynx hardware.  Once this value is set, it cannot be modified. Only connections from the FreeLynx device with this IP will be accepted. Command Port Number The port number of the FreeLynx 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 FreeLynx systems, this value will always be FreeLynx. FreeLynx IP Address The IP address of the FreeLynx hardware. Command Port Number The port number of the FreeLynx 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.

-GetIMUEnabled <Hardware Sub System Name> <IMU ID>

Retrieves the current enable state of a specified IMU. If the specified IMU ID is not present, this command will return false. Example :   -GetIMUEnabled "AcqSystem1" Base 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 containing the IMU IMU ID The ID of the IMU you want to change: AFE Base

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 - Transmission of IMU data is enabled. False - Transmission of IMU data is disabled.

-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 FreeLynx 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 FreeLynx 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 FreeLynx 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 FreeLynx 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 FreeLynx hardware. This value is in Celsius.

-GetDataTransmissionEnabled <Hardware Sub System Name>

Returns the state for data transmission of the hardware sub system. Example: -GetDataTransmissionEnabled 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 FreeLynx 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. Data Transmission Enabled True - FreeLynx device will transmit data to the DAS. False - FreeLynx device will not transmit data to the DAS.

-GetSDCardWritingEnabled <Hardware Sub System Name>

This returns the FreeLynx hardware state for recording to the SD Card on the device. Example: -GetSDCardWritingEnabled 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 FreeLynx 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. SD Card Writing Enabled True - FreeLynx device will record to the SD Card. False - FreeLynx device will not record to the SD Card.

-SetBatteryType <Hardware Sub System Name> <Battery Type>

This will set the battery type for the FreeLynx hardware. Example: -SetBatteryType AcqSystem1 "A" Default: N/A Usage: This command can be used at any time. The specified sub system must be a FreeLynx system.

Arguments

Hardware Sub System Name The name of the hardware sub system used to modify the battery type.   Battery Type The value should be set to match the battery type being used to power the FreeLynx hardware. Typically, one of the classifications will be marked on the battery. Contact Neuralynx Support if you are unable to find the classification marking. This value must be a single letter or the command will fail.

-SetDataTransmissionEnabled <Hardware Sub System Name> <Data Transmission Enabled>

This will set whether the FreeLynx hardware should transmit data to the DAS. Example: -SetDataTransmissionEnabled AcqSystem1 "True" Default: N/A Usage: This command can be used at any time. The specified sub system must be a FreeLynx system.

Arguments

Hardware Sub System Name The name of the hardware sub system used to modify the data transmission feature.   Data Transmission Enabled Only the options below are valid: True:  The FreeLynx device will transmit data to the DAS. False:  The FreeLynx device will not transmit data to the DAS.

-SetSDCardWritingEnabled <Hardware Sub System Name> <SD Card Writing Enabled>

This will set whether the FreeLynx hardware should record to the SD Card on the device. Example: -SetSDCardWritingEnabled AcqSystem1 "True" Default: N/A Usage: This command can be used at any time. The specified sub system must be a FreeLynx system.

Arguments

Hardware Sub System Name The name of the hardware sub system used to modify the SD Card recording feature.   SD Card Writing Enabled Only the options below are valid: True:  The FreeLynx device will record to the SD Card. False:  The FreeLynx device will not record to the SD Card.

-SetFreeLynxTrackingLED <Hardware Sub System Name> <Value>

This will enable or disable the tracking LED on the FreeLynx hardware. When the tracking LEDs are on, the power LED is off. Example: -SetFreeLynxTrackingLED AcqSystem1 "on" Default: N/A Usage:  This command can be used at any time once connected to a FreeLynx.

Arguments

Hardware Sub System Name The name of the hardware sub system used to modify the tracking LED state.   Value Only the options below are valid: On:  Turns the tracking LEDs on and the power LED off. Off:  Turns the tracking LEDs off and the power LED on.

-SetIMUEnabled <Hardware Sub System Name> <IMU ID> <Enabled>

Enables or disables the transmission of data for the specified IMU. Example :   -SetIMUEnabled "AcqSystem1" AFE false Default: Enabled defaults to false. Usage: This command can be used at any time.

Arguments

Hardware Sub System Name The name of the hardware sub system containing the IMU IMU ID The ID of the IMU you want to change: AFE Base Enabled True - Enables transmission of IMU data. If the specified IMU is not present, this command will fail. False - Disables transmission of IMU data. If the specified IMU 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.

-SetUltrasonicMicrophoneEnabled <Hardware Sub System Name> <Enabled>

Enables or disables the ultrasonic microphone installed on the FreeLynx. 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 FreeLynx 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.