===== Overview =====

configureSync is a command-line tool to query and configure Sync status and parameters.

==== System Requirements =====

configureSync is supported on all 64 bit versions of Windows10 and above.
Multiple RTX PRO Sync cards on a system are supported.


==== commands and options ====
Just Running the tool will display a list of available commands and options as below.

****Note: This tool requires admin privileges to work****

 HelpInfo:
     help          : Prints help information
     queryTopo     : Returns current Sync topology, VSYNC status and GRID topology
     queryCaps     : Returns capabilities of all RTX PRO Sync boards
     queryParams   : Returns current Sync control and status parameters
     queryAll      : Returns combined results of queryTopo, queryCaps and queryParams
     disable       : Disables Sync
     enable        : [server|client] [display=GPU,DISPLAY]|[grid=gridindex]
                     [source=VSYNC|HOUSESYNC] [grid=gridindex]
                     [syncDevId=0|1] [source=VSYNC|HOUSESYNC] [multiplier|divider=value]
                     [trigger=RISING|FALLING|BOTH] [interlaceMode=ON|OFF]
                     [syncDelay=<lines>,<pixels>] [bncOutput=ON|OFF]

                     Enables Sync, with the system being a server or client.

                     If setting as client, source cannot be updated, so specifying client is not possible.
                     Command Eg to set client : configureSync.exe enable client display=0,1 display=0,0 

                     If there are multiple GPUs/DISPLAYs, they can be specified with
                     integers starting at 0, e.g. display 0,1 specifies the second
                     display on the first GPU. (The default is display=0,0)
                     Multiple displays for the client can be specified like e.g.: display=0,0 display=0,1.

                     Server can also be set by specifying the currently active grids listed in the output of queryTopo command.
                     Command e.g. to set server with grids : configureSync.exe enable server grid=0 grid=1
                     Here one of the displays from grid 0 is set as server and other displays in grids 0 and 1 will be set as clients
                     When grid is specified along with display : configureSync.exe enable server display=0,0 display=0,1 grid=0
                     the displays are ignored and it behaves same as : configureSync.exe enable server grid=0

                     If setting the server, you can specify the source as either VSYNC or HOUSESYNC.
                     Command e.g to set server with source as Housesync: configureSync.exe enable server display=0,0 display=0,1 source=HOUSESYNC
                     Here display 0,0 is set as server and display 0,1 is set as client and source is set as Housesync

                     multiplier/divider value can be specified while setting server with source as Housesync to multiply/divide the incoming Housesync frequency
                     e.g: configureSync enable server source=HOUSESYNC multiplier=2, this command will multiply housesync frequency by 2.

                     syncDevId the Sync device id can optionally be provided as 0 or 1 while setting the server with control parameters, default value is 0
                     Command e.g to set server with syncDevId as 1 and source as Housesync: configureSync.exe enable server display=6,0 syncDevId=1 source=HOUSESYNC
                     This command will set display 6,0 as server and set source as Housesync on the 2nd RTX PRO Sync card.

                     trigger value sets trigger of the sync signal to rising edge, falling or both, it is only applicable with Housesync source,
                     trigger value can be set to BOTH only if syncType is TTL
                     Command e.g to set server with trigger as Rising edge: configureSync.exe enable server display=0,0 source=HOUSESYNC trigger=RISING

                     interlaceMode sets interlace mode for a Sync device, it is only applicable with Housesync source
                     Command e.g to set server with interlaceMode on : configureSync.exe enable server display=0,0 source=HOUSESYNC interlaceMode=ON

                     syncDelay sets the sync skew in number of lines and pixels, it is only applicable with Housesync source
                     Command e.g to set server with syncDelay : configureSync.exe enable server display=0,0 source=HOUSESYNC syncDelay=15,650

                     bncOutput sets the mode to enable/disable sync output on the BNC connector,
                     bncOuput cannot be set to 1 if source is specified as HOUSESYNC, both are mutually exclusive.
                     Command e.g to set server with bncOutput on : configureSync.exe enable server display=0,0 bncOutput=ON



////////////////////////////////////////////////////////////////////////////////
// Release History
////////////////////////////////////////////////////////////////////////////////

VERSION : 1.0

1. Initial release. Supported commands are:
     help
     queryTopo  
     queryCaps  
     queryParams
     queryAll
     enable     
     disable     


2. Command line utility to enable the creation of ultra-high resolution, perfectly synchronized displays to meet the visualization and presentation needs across industries.

3. The new version of the tool incorporates standardized and user-friendly command line syntax.

4. This tool can be used to enable SYNC, with the system being a server or client, and to disable SYNC.

5. When setting a server or client, all appropriate options should be included in the command line to configure the server/client.

6. This tool needs admin privileges to work.



DESCRIPTION:
configureSync is a command-line tool to query and configure sync status and parameters.


Use of this tool implies agreement with the "NVIDIA Driver License Agreement".
See the enclosed eula.txt document for the license text.