; sonar_cli.ini ; ; Copyright (c) 2012, EdgeTech ; ; QVCS Info ; $Header: sonar_cli.ini Revision:1.4 Fri Aug 03 10:19:36 2012 mps $ ; ; EdgeTech Sonar Command-Line Interface (CLI) initialization parameters ; ; This file has example values only. You must edit these values for ; your particular configuration. Do not edit the keywords (e.g. "IP Address", ; "Command Port Number", or "Range0"). If you change the keywords, the ; associated parameter value will be bypassed, thus you are encouraged to ; make a backup copy of this file before editing so that you will always ; have a copy of proper keyword names available. ; ; Not all parameters may be relevant for a particular configuration. For ; example, for a sub-bottom only system, all side-scan parameters will be ; ignored. ; ; You may insert as many comment lines as you like by using a leading semi- ; colon as shown here. You may also add a comment following a live entry by ; using a semi-colon as shown in the IP Address example below. Blank lines ; and white space may also be inserted at will and are ignored. ; ; ---------------------------------------------------------------------------- ; IP Address - The IP address of sonar. ; Default value: 192.9.0.101 ; Valid inputs: Any valid IP address. During testing, if sonar is located ; on the local machine then 127.0.0.1 (local loopback) is used. ; Uncomment one of the following lines (or add your own): IP Address 127.0.0.1 ; Local loopback ; IP Address 192.168.3.105 ; My alternate sonar IP address ; IP Address 192.9.0.1 ; Default sonar IP address ; Command Port Number ; The TCP/IP port number of the command channel. ; Default value: 1700 ; Specify 1900 when using Discover as an intermediary to Sonar ; Valid inputs: [1024 to 65535] Command Port Number 1700 ; Connecting directly to Sonar ; Command Port Number 1900 ; Connecting to Sonar through Discover ; Data Port Number ; The TCP/IP port number of the data channel. ; Default value: 1701 ; Specify 1901 when using Discover as an intermediary to Sonar ; Valid inputs: [1024 to 65535] Data Port Number 1701 ; Connecting directly to Sonar ; Command Port Number 1901 ; Connecting to Sonar through Discover ; ---------------------------------------------------------------------------- ; RangeX specifies the range for subsystem X in meters where X = 0, 20, or 21. ; Note: The range determines the ping rate assuming subsystem X is ; declared Master or is allowed to run independently (trigger mode = 0). ; The ping rate is determined by the formula: ; ; Ping Rate (Hz) = 735/(Range in meters) ; ; where 735 = c/2 and ; c = 1470 m/sec = Approx. average speed of sound in seawater ; T = 5 deg. Celsius, salinity = 35 PPM ; ; Range0 - Double precision value ; Range0 is the range for Sub-Bottom. ; Range0 valid inputs: [1.0 to 1000.0] meters ; Examples: ; Range0 250.123 ; Range = 250.123 meters ; Range0 250 ; Range = 250 meters - Note decimal point not necessary Range0 500 ; 500 meters ; Range20 - Double precision value: [1.0 to 1000.0] ; Range20 is the range for Side-Scan Low frequency (SSL). ; It has the same format and limits as Range0. Range20 735 ; meters ; Range21 - Double precision value: [1.0 to 1000.0] ; Range21 is the range for Side-Scan High frequency (SSH). ; It has the same format and limits as Range0. Range21 367.5 ; meters ; ---------------------------------------------------------------------------- ; The ReturnActivePingData flag tells Sonar to return active ping data for the ; subsystem involved. ; ; Important Note: NO PING DATA IS RETURNED UNLESS THE FLAG IS SET TO 1. ; ; ReturnActivePingData0 - [0,1] ; Return active ping data for Sub-Bottom ; Valid Inputs: 0 for Off; 1 for On ReturnActivePingData0 1 ; ReturnActivePingData20 - [0,1] ; Return active ping data for Side Scan Low ; Valid Inputs: 0 for Off; 1 for On ReturnActivePingData20 1 ; ReturnActivePingData21 - [0,1] ; Return active ping data for Side Scan High ; Valid Inputs: 0 for Off; 1 for On ReturnActivePingData21 1 ; ---------------------------------------------------------------------------- ; Master Subsystem and trigger parameters ; Note: If you are using just one subsystem (e.g. sub-bottom only) ; then specify that system using these entries. ; Master Subsystem - [0; 20; 21] ; Valid Inputs: 0 for Sub-Bottom; 20 for SSL; 21 for SSH Master Subsystem 21 ; ; Trigger Mode - [0;1] ; Set trigger for internal(0), external(1) ; Valid Inputs: 0 for Internal; 1 for External Trigger Mode 0 ; ; Trigger Divisor - Positive integer ; Trigger on every Nth event ; Valid inputs: Any integer greater than zero Trigger Divisor 1 ; ; Trigger Delay in microseconds - Positive integer ; Trigger N microseconds after event ; Valid inputs: Any non-negative integer Trigger Delay 0 ; ---------------------------------------------------------------------------- ; Slave Subsystem #1 Ping Coupling Parameters ; Note 1: If there are no other systems besides Master or you are using ; only one system then set Slave_1 Subsystem to -1 and this section ; will be ignored. ; Note 2: If the Trigger Mode for this subsystem is set to 0 then ; it will be free running and is no longer a slave. Free ; running means the subsystem will ping on its own independent ; of any other system at a ping rate determined by ; the range specified for this subsystem. ; Note 3: If the Trigger Mode is set to 2 then this subsystem becomes ; coupled (i.e. slave) to another subsystem. The controlling ; subsystem is specified by "Trigger_1 Source". The slave ; subsystem will ping based on the trigger provided by the ; Trigger_1 Source modified by the Trigger_1 Delay and ; Trigger_1 Divisor. ; ; Slave_1 Subsystem - [0; 20; 21; -1] ; Valid Inputs: 0 for Sub-Bottom; 20 for SSL; 21 for SSH ; -1 to ignore this section. Slave_1 Subsystem 20 ; ; Trigger Mode - [0;2] ; Set trigger for internal(0), or coupled(2) ; Valid Inputs: 0 for Internal; 2 for Coupled Trigger_1 Mode 2 ; ; Trigger Source - [0; 20; 21] ; If Trigger_1 Mode is set to 2 then a source must be specified. ; If Trigger_1 Mode is set 0 then the source is ignored. Trigger_1 Source 21 ; ; Trigger Divisor - Positive integer ; Trigger on every Nth event from the source ; Valid inputs: Any integer greater than zero Trigger_1 Divisor 2 ; ; Trigger Delay in microseconds - Non-negative integer ; Trigger N microseconds after event ; Valid inputs: Any non-negative integer Trigger_1 Delay 0 ; ---------------------------------------------------------------------------- ; Slave System #2 Ping Coupling Parameters ; Note 1: If there are only two systems present or you are using only two ; subsystems then set Slave_2 Subsystem to -1 and this section will ; be ignored. ; Note 2: If the Trigger Mode for this subsystem is set to 0 then ; it will be free running and is no longer a slave. Free ; running means the subsystem will ping on its own independent ; of any other system at a ping rate determined by ; the range specified for this subsystem. ; Note 3: If the Trigger Mode is set to 2 then this subsystem becomes ; coupled (i.e. slave) to another subsystem. The controlling ; subsystem is specified by "Trigger_2 Source". The slave ; subsystem will ping based on the trigger provided by the ; Trigger_2 Source modified by the Trigger_2 Delay and ; Trigger_2 Divisor. ; Note 4: You can daisy-chain the three subsystems (although this should ; be done with caution). For example, Slave 1 can trigger off the ; Master while Slave 2 can trigger off of Slave 1. ; Note 5: The two slave subsystems can trigger off the same source (i.e. ; the Master). ; ; Slave_2 Subsystem - [0; 20; 21; -1] ; Valid Inputs: 0 for Sub-Bottom; 20 for SSL; 21 for SSH ; -1 to ignore this section. Slave_2 Subsystem -1 ; ; Trigger Mode - [0;2] ; Set trigger for internal(0), or coupled(2) ; Coupled mode causes this subsystem to be triggered by the ; subsystem specified by Trigger_2 Source. ; Valid Inputs: 0 for Internal; 2 for Coupled Trigger_2 Mode 2 ; ; Trigger Source - [0; 20; 21] ; If Trigger_1 Mode is set to 2 then a source must be specified. ; If Trigger_1 Mode is set 0 then the source is ignored. Trigger_2 Source 0 ; ; Trigger Divisor - Positive integer ; Trigger on every Nth event ; Valid inputs: Any integer greater than zero Trigger_2 Divisor 1 ; ; Trigger Delay in microseconds - Non-negative integer ; Trigger N microseconds after event ; Valid inputs: Any non-negative integer Trigger_2 Delay 0 ; ---------------------------------------------------------------------------- ; Power0 - [0,1] ; Sub-Bottom power level ; Valid Inputs: 0 for Off; 1 for 100 percent power Power0 1 ; Power20 - [0,1] ; SSL power level ; Valid Inputs: 0 for Off; 1 for 100 percent power Power20 1 ; Power21 - [0,1] ; SSH power level ; Valid Inputs: 0 for Off; 1 for 100 percent power Power21 1 ; ---------------------------------------------------------------------------- ; Set Time Method - [0,1] ; Specifies the time synchronization method used ; Valid Inputs: ; 0 for using time sync message via RS-232 (No action required) ; 1 for Ethernet Time Set + 1 PPS (send time set messages from host PC clock) Set Time Method 1 ; ---------------------------------------------------------------------------- ; Help Info Section ; Note: Do not delete this section. It is used to drive the help command-line ; option. ; Note 2: You can add your own Help Info lines and they will show up whenever ; you invoke the help command-line option! Just be sure each line has ; the "Help Info> " keyword prefix. ; Help Info> Command-Line Options Help Info> h or help or ?: Display this help menu and quit. Help Info> i or ini: Display the ini file parameter values and quit. Help Info> -f : Specify alternate filename as the ini file. Help Info> p or pulselist: Display Sonar's pulselist and quit. Help Info> s or system: Display Sonar's system type and quit. Help Info> v or version: Display version info and quit. Help Info> 0, 1, 2, 3, 4, 5: Control amount of output, 0:min, 5:max, 4:default Help Info> Help Info> Run-time single-keystroke commands Help Info> Q - Close-out communications with Sonar and quit. Help Info> P - Start pinging. Help Info> S - Stop pinging.