Option String

You can set RTG's option string within the GUI or through the command line for RTG’s API. Inputting an option string override is optional. You can specify and set parameters similar to that of an INI file.

Use option strings when you need to override specific parameters that are not applicable for your system in the default INI file.

The system automatically reads the INI file from the default location, however, the option string can be used to point to a custom location for an INI file. You can specify a custom INI file within the option string to bypass overriding certain configuration manually using the string. This can allow for switching between multiple INI files, each with different configurations. This could help simplify the option string when using RTG in different modes.

Table 33. DriverSetup Section Key
Key Use Default Value Required?
INIPath The path to override the default configuration INI file. C:\Users\Public\Documents\National Instruments\RTG\ Optional

The format for setting these parameters is as follows: 

Section1=Key_1A:Value_1A;Key_1B:Value_1B,Section2=Key_2A:Value_2A;Key_2B:Value_2B,

Note that there are no spaces between properties or key-value pairs.

The following is an example of a basic option string for configuring the RTG: 

APISetup=ClassName:NI-RTG gRPC Client,DriverSetup=IPAddress:12.34.56.78;Port:50052;Timeout:100;personality:pulse aware;INIPath:<path-to-override-ini>,6594_0=bitfile_path:C:\Program Files\National Instruments\LabVIEW 2023\examples\RTG\Coprocessor\Passthrough\NI 6594\CLIP 8 SPC (-00)\FPGA Bitfiles\rtg-passthrough-template-ni6594-00.lvbitx;min_latency:3.008E-6;timeout:15,CalibrationSetup=5841_0:19;5841_1:0
Note RTG ships with an Option String Builder for LabVIEW users to simplify the process of creating an option string.

Refer to RTG Configuration Sections and Keys for information about updating the option string for different system configurations.