manualshive.com logo in svg

Kongsberg M3 Sonar API, Instruction Manual, Page: 36 / 58

Share
Download
Kongsberg M3 Sonar API Instruction Manual Download Page 36

34

922-20007052/1.2

Functions and dialog boxes

Topics

API functions, page 35

API responses, page 42

Data streaming, page 44

M3 Sonar API Testing software, page 46

M3 Sonar API Instruction Manual

Summary of Contents for M3 Sonar API

Page 1: ...Instruction Manual M3 Sonar API...

Page 2: ......

Page 3: ...922 20007052 1 2 May 2020 Kongsberg Mesotech Limited M3 Sonar API Instruction Manual Release 1 2 This manual provides the basic information required to get started with the M3 Sonar API...

Page 4: ...ntenance may cause damage to the equipment and or injury to personnel You must be familiar with the contents of the appropriate manuals before attempting to operate or work on the equipment Kongsberg...

Page 5: ...Windows regional format to English 18 Starting operation of the Sonar Head 19 Enabling the M3 Sonar API 20 Disabling the M3 Sonar API 21 OPERATING PROCEDURES 22 Testing the M3 Sonar API 23 Finding a...

Page 6: ...port 42 API responses 42 Data streaming 44 IMB streaming 44 ALL streaming 45 M3 Sonar API Testing software 46 M3 Sonar API Testing software dialog box Testing page 47 M3 Sonar API Testing software dia...

Page 7: ...the M3 Sonar system and updates are available free of charge and can be downloaded from http www kongsberg com mesotechsoftware Software version This M3 Sonar Instruction Manual complies with M3 soft...

Page 8: ...6 922 20007052 1 2 M3 Sonar Topics System description page 7 System diagram page 8 M3 Sonar API overview page 9 System units page 11 Support information page 13 M3 Sonar API Instruction Manual...

Page 9: ...determined by the length of time it took to receive the transmitted acoustic pulse By combining the high refresh rate of a conventional multibeam sonar with an image quality comparable to a single be...

Page 10: ...dentifies the main components of a basic M3 Sonar system Only the main connections between the units are shown Detailed interface capabilities and power cables are not shown A Sonar Processor B Power...

Page 11: ...pplication When the Command Server Object receives commands it will send the commands to a Command Processor Object which process the commands and makes the appropriate function calls The Command Serv...

Page 12: ...can create a batch file containing the command prompt text suitable for your application If you have more than one Sonar Head it is possible to run multiple instances of the M3 Sonar API IMB data is s...

Page 13: ...922 20007052 1 2 11 System units Topics Sonar Processor page 12 Power supply page 12 Sonar Head page 13 M3 Sonar...

Page 14: ...sor communicates with the sonar through a standard Ethernet cable If you purchase a computer locally make sure that the chosen model meets the functional and technical requirements The computer must b...

Page 15: ...ucer is delicate Always keep the Guard Ring and protective cover over the transducer during installation and storage Support information If you need technical support for your M3 Sonar you must contac...

Page 16: ...alling the M3 software page 16 Defining the IP address on the Sonar Processor network adapter page 17 Changing the Windows regional format to English page 18 Starting operation of the Sonar Head page...

Page 17: ...ngs link on the right side of the window Observe that the Power Options dialog box opens b In the menu on the left select Create a power plan c Select the High performance radio button d Give your new...

Page 18: ...2 Follow the installation wizard s instructions and select Standard Installation Note Use the Dual M3 on Same PC option only if you are using two M3 Sonars Selecting this option will install two separ...

Page 19: ...n your Sonar Processor you will only need to do this once Procedure 1 On the Sonar Processor close the M3 software 2 Open the Network Connections dialog box a In the bottom left corner of your desktop...

Page 20: ...rosoft 64 bit Windows 10 operating system It is assumed that you are familiar with the Windows operating systems computer technology and interface principles Procedure 1 In the bottom left corner of y...

Page 21: ...3 software uses the computer s time to set the Sonar Head clock Host mode You can change the time synchronization settings by clicking Setup System Configuration Sonar Setup Time Sync Mode 2 If you se...

Page 22: ...software will not be visible no_dm This switch disables the internal Display Manager for cases where low CPU usage is needed Use this switch if you don t need Display Manager functions Note Use the n...

Page 23: ...ites The M3 Sonar API must be enabled Procedure 1 In the bottom left corner of your desktop type cmd into the Windows search box then press Enter Observe that the Command Prompt window opens 2 Type th...

Page 24: ...ar API page 23 Finding a mode number page 26 Changing the IMB port number page 28 Streaming ALL data for profiling applications page 28 Running more than one Sonar Head page 30 Automatically enabling...

Page 25: ...se a conflict with unpredictable results Procedure 1 Navigate to C KML M3_V0240 API_TESTER 2 Open the M3 Sonar API Testing software by double clicking the M3_API_Tester exe file 3 Make sure that the I...

Page 26: ...that the Sonar Image window opens The window will be blank when the sonar is not running 5 Create and execute a Command Script a Click the Add button beside Connect b Click the Add button beside Get...

Page 27: ...ge 7 Observe the Test Execution Logs pane Make sure that the script executes as expected Make sure that you do not see any error messages such as FAIL BAD_CMD or UNKNOWN 8 Close the M3 Sonar API Testi...

Page 28: ...ech Make sure that the M3 software is closed or that the M3 Sonar API is disabled Tip If you wish to disable the M3 Sonar API without rebooting your PC type taskkill im m3 exe f at the command prompt...

Page 29: ...ations The numbers in the main root list A are not mode numbers and will not work Also any mode numbers listed under test applications will not work Do not expand any modes in the main list with Test...

Page 30: ...rt of the API the IMB data will start streaming back to the client Procedure 1 Navigate to C KML M3_V0240 BIN SETTINGS 2 Right click on the file UsersInfo xml Observe that a context menu opens 3 Selec...

Page 31: ...mage and Profile or Profile Only Also click File Exporting Format and make sure that Profile Point all is selected a Navigate to C KML M3_V0240 BIN SETTINGS b Right click on the file UsersInfo xml Obs...

Page 32: ...ad and install a free XML file editor such as Notepad Note Avoid using the default Notepad editor in Windows as it may insert hidden characters into XML files that will cause the M3 Sonar API to crash...

Page 33: ...port_IMB_Port DataExport_DotALL_Port Note Use any free numbers not used in other instances For example if M3_V0240_1 s range of ports is 20000 20001 and 20002 then use 20010 20011 and 20012 for M3_V02...

Page 34: ...your Sonar Head using the M3 software Procedure 1 Create a batch file a In the bottom left corner of your desktop type notepad into the Windows search box then press Enter Observe that a new text docu...

Page 35: ...n press Enter Observe that the Run dialog box opens b Type the following into the Open field shell startup c Click OK Observe that the Startup folder opens d Drag the M3Start bat file into your Startu...

Page 36: ...34 922 20007052 1 2 Functions and dialog boxes Topics API functions page 35 API responses page 42 Data streaming page 44 M3 Sonar API Testing software page 46 M3 Sonar API Instruction Manual...

Page 37: ...You can write any API command in either a string or byte array in ASCII through your TCP client The commands require a newline character after each node If you are using the M3 Sonar API Testing softw...

Page 38: ...on only works if the Sonar Head is running Attempting to execute this command when the Sonar Head is not running will elicit a FAIL response Details Disconnect API Command Operation Disconnect Operati...

Page 39: ...for your application Each mode has its own pre defined characteristics such as differing ranges angular resolutions and pulse types Description In the M3 software the operating mode is set using the...

Page 40: ...onar application has its own TVG profile If you wish to change the TVG profile for a specific application issue the Set Mode API command before the Set TVG command Otherwise the Set TVG command will c...

Page 41: ...d Click the circular icon in the top right corner of the sonar view to open the Menu Widget Then click Pause Details Stop Ping API Command Operation Stop_Ping Operation Command Start Ping If the Sonar...

Page 42: ...records a sonar data sequence and saves it in a time stamped digital format Your recording will be saved under the folder C KML M3_V0240 Recordings by default In the M3 software the Record function c...

Page 43: ...pen the Menu Widget A flashing red dot with EXP next to it will appear when exporting profile data Note You can only export data in a profiling mode using one of the Profiling sonar applications You c...

Page 44: ...response string to be received by the TCP client You can read these responses to understand the result of the last API command sent to the server Description All API commands received will be acknowl...

Page 45: ...ssage Timed out attempting to connect to 11120091 Message Time 2016 09 13 15 22 21 Time Response BAD_CMD This response indicates that the command itself was not valid Response Operation Unknown Operat...

Page 46: ...UsersInfo xml file and finding the DataExport_IMB_Port XML tag No API commands are needed for the IMB data to start streaming As soon as your TCP IP client connects to the IMB port of the API the IMB...

Page 47: ...s data to an external client ALL streaming The M3 Sonar API acts as the client and sends data to an external server You must enter the IP address of this external server into the DataExport_Dest_IPAdd...

Page 48: ...software as an example to help you create your own custom application You can view the source code by navigating to C KML M3_V0240 API_TESTER Topics M3 Sonar API Testing software dialog box Testing pa...

Page 49: ...any script you create so that you can run the same test at a later date To delete a command select the command in the Command Script pane then click Delete Clicking Delete All will remove all command...

Page 50: ...tics such as differing ranges angular resolutions and pulse types This API command requires a mode number PRI Sequence ID You can find a list of mode numbers in the M3 Database Editor software Enter a...

Page 51: ...lick the Add button to browse for an XML file that you can add to the Command Script pane Save Command Script Click the Save button to create an XML commands file that you can run later Open Command S...

Page 52: ...M3 Sonar API Testing software leave the IP Address as 127 0 0 1 127 0 0 1 is a loopback address localhost This address establishes an IP connection to the same computer that you are using If the M3 So...

Page 53: ...ton to choose a Configuration File to load Click the Save button to save the IP Address and Commands Port parameters into a new or existing Configuration File Log Folder Click the Open button to choos...

Page 54: ...47 50 Set Mode function 37 Set TVG function 38 Start Export function 41 Start Ping function 39 Start Record function 40 Status function 36 Stop Export function 42 Stop Ping function 39 Stop Record fu...

Page 55: ...ing software dialog box 50 IMB port number changing 28 IMB streaming description 44 details 44 information support 13 installation software 16 introduction power supply 12 Sonar Head 13 Sonar Processo...

Page 56: ...Sonar API Testing software dialog box 48 Set Mode function description 37 details 37 Set TVG M3 Sonar API Testing software dialog box 48 Set TVG function description 38 details 38 software installati...

Page 57: ...922 20007052 1 2 55 V version software 5 W Windows regional format changing 18 Index...

Page 58: ...2020 Kongsberg Mesotech...

Reviews:

No comments