Kongsberg M3 Sonar API Instruction Manual
  1. Manuals
  2. Brands
  3. Kongsberg Manuals
  4. Marine Equipment
  5. M3 Sonar API
  6. Instruction manual

Kongsberg M3 Sonar API Instruction Manual

Hide thumbs Also See for M3 Sonar API:
Table of Contents

Advertisement

Quick Links

Download this manual
Instruction Manual
M3 Sonar
API
®

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the M3 Sonar API and is the answer not in the manual?

Questions and answers

Related Manuals for Kongsberg M3 Sonar API

Summary of Contents for Kongsberg M3 Sonar API

  • Page 1 Instruction Manual M3 Sonar ®...
  • Page 3 M3 Sonar API Instruction Manual Release 1.2 This manual provides the basic information required to get started with the M3 Sonar API. 922-20007052/1.2 May 2020 © Kongsberg Mesotech Limited...
  • Page 4 Date of issue Copyright The information contained in this document remains the sole property of Kongsberg Mesotech Limited. No part of this document may be copied or reproduced in any form or by any means, and the information contained within it is not to be communicated to a third party, without the prior written consent of Kongsberg Mesotech Limited.

  • Page 5: Table Of Contents

    Finding a mode number ....................26 Changing the IMB port number..................28 Streaming ALL data for profiling applications..............28 Running more than one Sonar Head ................30 Automatically enabling the M3 Sonar API at bootup............32 FUNCTIONS AND DIALOG BOXES........... 34 API functions ........................35 M3 Sonar API overview..................35 Connect........................36...
  • Page 6 Start Export......................41 Stop Export......................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 dialog box - Configuration page ......49 922-20007052/1.2...

  • Page 7: About This Manual

    About this manual About this manual This manual provides the information and procedures required to use the M3 Sonar API. Target audience This manual is intended for all users of the M3 Sonar. A good understanding of system functions and controls is essential to fully take advantage of the functionality provided.

  • Page 8: M3 Sonar

    M3 Sonar API Instruction Manual 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 922-20007052/1.2...

  • Page 9: System Description

    M3 Sonar System description The Kongsberg Mesotech M3 Sonar is a compact, versatile multibeam sonar. Multibeam sonars have an array of transducers that simultaneously transmits pings (sound pulses) at a specified frequency to cover a large area in less time than a single-beam transducer. To generate...

  • Page 10: System Diagram

    M3 Sonar API Instruction Manual System diagram The system diagram identifies 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. Sonar Processor...

  • Page 11: M3 Sonar Api Overview

    When the M3 Sonar API is enabled, you can use your custom application (TCP client) to issue commands to the M3 Sonar. You can write M3 Sonar API commands in XML format. The Command-Server Object listens on a port for TCP/IP commands issued by your application.
  • Page 12 If you have more than one Sonar Head, it is possible to run multiple instances of the M3 Sonar API. IMB data is streamed automatically every time your TCP client connects to the IMB port of the M3 Sonar API.

  • Page 13: System Units

    M3 Sonar System units Topics Sonar Processor, page 12 Power supply, page 12 Sonar Head, page 13 922-20007052/1.2...

  • Page 14: Sonar Processor

    M3 Sonar API Instruction Manual Sonar Processor In this publication, the computer is referred to as the Sonar Processor. The Sonar Processor contains the operational software, and offers the user interface that allows you to control the M3 Sonar. It is a vital part of the M3 Sonar Multibeam sonar.

  • Page 15: Sonar Head

    If you need technical support for your M3 Sonar you must contact your local dealer, or our support department. If you require maintenance or repair, contact your local dealer. You can contact us by phone at +1 604 464 8144, or by email at: km.support.vancouver@km.kongsberg.com. If you need information about our other products, visit http://www.km.kongs- berg.com/mesotech.

  • Page 16: Getting Started

    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 19 Enabling the M3 Sonar API, page 20 Disabling the M3 Sonar API, page 21 922-20007052/1.2...

  • Page 17: Setting The Sonar Processor To High Performance

    Getting started Setting the Sonar Processor to High Performance To avoid slowdowns or disruptions while running the sonar, ensure your Sonar Processor is using all of its processing power and does not go to sleep. Prerequisites This procedure is made for the Microsoft ®...

  • Page 18: Installing The M3 Software

    We recommended installing the latest M3 software on your Sonar Processor. Prerequisites • You will need the Kongsberg USB drive included with the system or download the latest M3 software release from: http://www.kongsberg.com/mesotechsoftware. • If you are installing a new software version, uninstall the previous version of the M3 software before proceeding.

  • Page 19: Defining The Ip Address On The Sonar Processor Network Adapter

    Getting started Defining the IP address on the Sonar Processor network adapter The communication between the Sonar Processor and the Sonar Head is made using a high-speed Ethernet cable. If a Sonar Processor is not configured to connect to the sonar, you must define which IP Address and Subnet mask the Ethernet adapter in the Sonar Processor shall use for this communication.

  • Page 20: Changing The Windows Regional Format To English

    M3 Sonar API Instruction Manual Changing the Windows regional format to English If your local Windows settings uses commas for decimal points, the M3 Database Editor will not function properly. To handle the database values properly, you will need to change the Windows regional format to English.

  • Page 21: Starting Operation Of The Sonar Head

    Getting started Starting operation of the Sonar Head To start operation of the M3 Sonar sonar, you may need to make sure that the Sonar Head has been discovered. Prerequisites • The M3 software must be running. • The sound speed has been entered in →...

  • Page 22: Enabling The M3 Sonar Api

    • You must have discovered your Sonar Head using the M3 software. • The M3 software should not be running. Caution Do not run the M3 software and the M3 Sonar API at the same time. Running both may cause a conflict with unpredictable results. Context The following command-prompt switches can be used when enabling the M3 Sonar API.

  • Page 23: Disabling The M3 Sonar Api

    Observe that a success message appears in the window. Command Prompt Close the window. Command Prompt If you need to disable the M3 Sonar API often, create a batch file (such as “M3Stop.bat”) with the line “taskkill /im m3.exe /f”. 922-20007052/1.2...

  • Page 24: Operating Procedures

    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 the M3 Sonar API at bootup, page 32 922-20007052/1.2...

  • Page 25: Testing The M3 Sonar Api

    • You must have discovered your Sonar Head using the M3 software. • The M3 Sonar API must be enabled through the command prompt. Caution Do not run the M3 software and the M3 Sonar API at the same time. Running both may cause a conflict with unpredictable results. Procedure...
  • Page 26 M3 Sonar API Instruction Manual Prepare the software for an API test. Click the tab. Testing Make sure that the box is checked. Display Sonar Image Click the button beside the checkbox. Connect Display Sonar Image Observe that the window opens. The window will be blank when Sonar Image the sonar is not running.
  • Page 27 Make sure that the script executes as expected. Make sure that you do not see any error messages, such as , or FAIL BAD_CMD UNKNOWN Close the M3 Sonar API Testing software. Related topics M3 Sonar API Testing software dialog box - Testing page, page 47 922-20007052/1.2...

  • Page 28: Finding A Mode Number

    You can obtain the M3 Database Editor software from Kongsberg Mesotech. • Make sure that the M3 software is closed or that the M3 Sonar API is disabled. 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 Operating procedures Click the “+” button to the left of a mode to expand a sub-list (B) showing the mode numbers (PRI Sequence IDs). Note The only valid mode numbers are contained in the expanded sub-list (B) of standard applications. The numbers in the main “root” list (A) are not mode numbers and will not work.

  • Page 30: Changing The Imb Port Number

    XML files that will cause the M3 Sonar API to crash. Context You can stream IMB data from the M3 Sonar API once it is connected to the Sonar Head, and the head is running. As soon as your TCP/IP client connects to the IMB port of the API, the IMB data will start streaming back to the client.
  • Page 31 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. Context Data is exported through the UDP port to an external server. You must enter the IP address of this external server into the <DataExport_Dest_IPAddr>...

  • Page 32: Running More Than One Sonar Head

    Make one copy for each Sonar Head that you have. For example, “M3_V0240_1”, “M3_V0240_2”, “M3_V0240_3”, etc. Each “M3_V0240” folder represents one instance of the M3 Sonar API. For each instance of the M3 Sonar API, configure each Sonar Head’s IP address and assign unique port numbers. Navigate to C:\KML\M3_V0240_1\BIN\SETTINGS (Replace “M3_V0240_1”...
  • Page 33 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_V0240_2 (and so on). Using the same port numbers for all instances of the M3 Sonar API will cause a conflict. → Click , then close your XML file editor.

  • Page 34: Automatically Enabling The M3 Sonar Api At Bootup

    M3 Sonar API Instruction Manual You can use the M3 Sonar API Testing software to send commands to different ports. Click the tab, then enter the port into the field. Configuration Commands Port # Automatically enabling the M3 Sonar API at...
  • Page 35 Drag the M3Start.bat file into your Startup folder. Reboot your computer. The batch file should run at bootup. You can test the M3 Sonar API functionality in the M3 Sonar API Testing software. Related topics Enabling the M3 Sonar API, page 20...

  • Page 36: Functions And Dialog Boxes

    M3 Sonar API Instruction Manual Functions and dialog boxes Topics API functions, page 35 API responses, page 42 Data streaming, page 44 M3 Sonar API Testing software, page 46 922-20007052/1.2...

  • Page 37: Api Functions

    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 software, then you can write an XML test script file with a list of commands that are executed sequentially.

  • Page 38: Connect

    M3 Sonar API Instruction Manual Connect function establishes communication between the M3 software and Sonar Connect Head, then starts “pinging”. Description → In the M3 software, clicking Setup Connect enables the function. Connect Details Connect API <Command> <Operation>Connect</Operation> </Command> Disconnect function stops operation of the Sonar Head.

  • Page 39: Set Mode

    Functions and dialog boxes Details Get Status API <Command> <Operation>Get_Status</Operation> </Command> Get Status API response <Response> <Operation>Get_Status</Operation> <Status>OK</Status> <Message>Pinging</Message> <Version>2.1.0</Version> <Time>2016-09-13 15:22:21</Time> </Response> Set Mode function allows you to set the optimal operating mode for your application. Set Mode Each mode has its own pre-defined characteristics, such as differing ranges, angular resolutions, and pulse types.

  • Page 40: Set Tvg

    M3 Sonar API Instruction Manual Set TVG When an acoustic pulse is sent through the water, it will gradually lose its energy. The greater the distance between the Sonar Head and the target(s), the greater the loss of energy. (Time Variable Gain) compensates for the loss of acoustic energy due to geometric spread and absorption.

  • Page 41: Stop Ping

    Functions and dialog boxes Stop Ping If the Sonar Head is running, the function pauses operation of the head. Stop Ping Description When you want to stop operation of the Sonar Head, use the API command. Disconnect function stops communication with the Sonar Head. The Disconnect Stop Ping command, however, pauses operation of the Sonar Head without disconnecting from...

  • Page 42: Start Record

    M3 Sonar API Instruction Manual In the M3 software, the function is the equivalent of the command. Resume Start Ping Click the circular icon in the top-right corner of the sonar view to open the Menu Widget Then, click Resume...

  • Page 43: Start Export

    Export UDP port. Description Sonar data is exported using the “.ALL” format, which is a proprietary Kongsberg EM-series datagram format. In the M3 software, the function can be found in the .

  • Page 44: Stop Export

    M3 Sonar API Instruction Manual Stop Export If you are exporting data, the API command will stop the export. Stop Export Description In the M3 software, the function can be found in the . Click Stop Exporting Menu Widget the circular icon in the top-right corner of the sonar view to open the...
  • Page 45 Functions and dialog boxes Details This response indicates that the command request was successfully completed. <Response> <Operation>Connect</Operation> <Status>OK</Status> <Message>Connected to 11120091</Message> <Time>2016-09-13 15:22:21</Time> </Response> FAIL This response indicates that the command was valid, but could not be completed. <Response> <Operation>Connect</Operation> <Status>FAIL</Status>...

  • Page 46: Data Streaming

    IMB streaming, page 44 ALL streaming, page 45 IMB streaming You can stream IMB data from the M3 Sonar API once it is connected to the Sonar Head, and the head is running. Description IMB streaming differs from ALL streaming in the following way.

  • Page 47: All Streaming

    Start Export Description ALL streaming differs from IMB streaming in the following way. • : The M3 Sonar API acts as the server which sends data to an external IMB streaming client. • : The M3 Sonar API acts as the client and sends data to an ALL streaming external server.

  • Page 48: M3 Sonar Api Testing Software

    M3 Sonar API Testing software Note You may use the source code of the M3 Sonar API Testing 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.

  • Page 49: M3 Sonar Api Testing Software Dialog Box - Testing Page

    M3 Sonar API Testing software. Testing Description page allows you to make sure the M3 Sonar API is working as expected. Testing You can also save any script you create so that you can run the same test at a later date.
  • Page 50 M3 Sonar API Instruction Manual Details Connect function establishes communication between the M3 software and Connect Sonar Head, then starts “pinging”. Click the button to add this command to your script. Disconnect function stops operation of the Sonar Head. Click the...

  • Page 51: M3 Sonar Api Testing Software Dialog Box - Configuration Page

    This feature is useful in the event that new API commands are supported in the M3 Sonar API, but you are still running an old version of the M3 Sonar API Testing software. Adding the new command to an XML file will allow you to test it. The “Commands”...
  • Page 52 Details IP Address for M3 Sonar API If the M3 Sonar API is running on the same computer as the 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.
  • Page 53 Functions and dialog boxes IMB Port # The IMB Port sends data to the M3 Sonar API Testing software. IP/Port# Configuration File Click the button to choose a Configuration File to load. Click the button Open Save to save the IP Address and Commands Port parameters into a new or existing Configuration File.
  • Page 54 IMB port number ........28 M3 Sonar API ..........21 Windows regional format....... 18 Disconnect Commands Port # M3 Sonar API Testing software dialog box ..48 M3 Sonar API Testing software dialog box ..50 Disconnect function comments description ..........36 send us............
  • Page 55 Index finding M3 Sonar API Testing software dialog box ..51 mode number ..........26 function ALL streaming description ......45 API response description ....... 42 Kongsberg Mesotech Connect function description......36 support ............ 13 Disconnect function description ....... 36 IMB streaming description ......
  • Page 56 M3 Sonar API Instruction Manual M3 Sonar API Testing software dialog box ..49 license ............5 Open Custom Command version............5 M3 Sonar API Testing software dialog box ..49 sonar head operational software connecting ..........19 installation ..........16...
  • Page 57 Index version software ............ 5 Windows regional format changing........... 18 922-20007052/1.2...
  • Page 58 ©2020 Kongsberg Mesotech...

Table of Contents