Kongsberg M3 Sonar API User manual

Instruction Manual
M3 Sonar® API

922-20007052/1.2
May2020©KongsbergMesotechLimited
M3SonarAPI
InstructionManual
Release1.2
Thismanualprovidesthebasicinformationrequiredtogetstarted
withtheM3SonarAPI.

KongsbergMesotechLimited
www.kongsberg.com
Documentinformation
•Product:KongsbergM3Sonar
•Document:InstructionManual
•Documentnumber:922-20007052
•Revision:1.2
•Dateofissue:22May2020
Copyright
TheinformationcontainedinthisdocumentremainsthesolepropertyofKongsbergMesotechLimited.No
partofthisdocumentmaybecopiedorreproducedinanyformorbyanymeans,andtheinformation
containedwithinitisnottobecommunicatedtoathirdparty,withoutthepriorwrittenconsentof
KongsbergMesotechLimited.
Warning
Theequipmenttowhichthismanualappliesmustonlybeusedforthepurposeforwhichitwas
designed.Improperuseormaintenancemaycausedamagetotheequipmentand/orinjurytopersonnel.
Youmustbefamiliarwiththecontentsoftheappropriatemanualsbeforeattemptingtooperate
orworkontheequipment.
KongsbergMesotechdisclaimsanyresponsibilityfordamageorinjurycausedbyimproperinstallation,
useormaintenanceoftheequipment.
Disclaimer
KongsbergMesotechLimitedendeavourstoensurethatallinformationinthisdocumentiscorrectand
fairlystated,butdoesnotacceptliabilityforanyerrorsoromissions.
Supportinformation
Ifyourequiremaintenanceorrepair,contactyourlocaldealer.Y oucancontactusbyphoneat
[phone],orbyemailat:[email protected].Ifyouneedinformation
aboutourotherproducts,visithttp://www.km.kongsberg.com/mesotech.Onourwebsiteyouwillalsond
alistofourdealersanddistributors.

922-20007052/1.23
Tableofcontents
ABOUTTHISMANUAL..............................................................5
M3SONAR...............................................................................6
Systemdescription.............................................................................................................7
Systemdiagram..................................................................................................................8
M3SonarAPIoverview....................................................................................................9
Systemunits.....................................................................................................................11
SonarProcessor......................................................................................................12
Powersupply..........................................................................................................12
SonarHead.............................................................................................................13
Supportinformation.........................................................................................................13
GETTINGSTARTED................................................................14
SettingtheSonarProcessortoHighPerformance...........................................................15
InstallingtheM3software...............................................................................................16
DeningtheIPaddressontheSonarProcessornetworkadapter...................................17
ChangingtheWindowsregionalformattoEnglish.........................................................18
StartingoperationoftheSonarHead...............................................................................19
EnablingtheM3SonarAPI.............................................................................................20
DisablingtheM3SonarAPI............................................................................................21
OPERATINGPROCEDURES.....................................................22
TestingtheM3SonarAPI................................................................................................23
Findingamodenumber...................................................................................................26
ChangingtheIMBportnumber.......................................................................................28
StreamingALLdataforprolingapplications................................................................28
RunningmorethanoneSonarHead................................................................................30
AutomaticallyenablingtheM3SonarAPIatbootup......................................................32
FUNCTIONSANDDIALOGBOXES...........................................34
APIfunctions...................................................................................................................35
M3SonarAPIoverview.........................................................................................35
Connect...................................................................................................................36
Disconnect..............................................................................................................36
GetStatus...............................................................................................................36
SetMode.................................................................................................................37
SetTVG..................................................................................................................38
StopPing................................................................................................................39
StartPing................................................................................................................39
StartRecord............................................................................................................40
StopRecord............................................................................................................40
InstructionManual

4922-20007052/1.2
StartExport.............................................................................................................41
StopExport.............................................................................................................42
APIresponses...................................................................................................................42
Datastreaming.................................................................................................................44
IMBstreaming........................................................................................................44
ALLstreaming.......................................................................................................45
M3SonarAPITestingsoftware.......................................................................................46
M3SonarAPITestingsoftwaredialogbox-Testingpage....................................47
M3SonarAPITestingsoftwaredialogbox-Congurationpage.........................49
M3SonarAPI

922-20007052/1.25
Aboutthismanual
ThismanualprovidestheinformationandproceduresrequiredtousetheM3SonarAPI.
Targetaudience
ThismanualisintendedforallusersoftheM3Sonar.
Agoodunderstandingofsystemfunctionsandcontrolsisessentialtofullytake
advantageofthefunctionalityprovided.Acarefulstudyoftheinformationinthis
manualishighlyrecommended,preferablywhileexploringtheM3Sonarfunctionality.
WeassumethatyouarefamiliarwiththebasicsetupandoperationoftheM3Sonar.We
alsoexpectthatyouhavesomeexperiencewithsonaroperation.
Licenseinformation
TheM3SoftwareisincludedwiththeM3Sonarsystemandupdatesareavailablefreeof
chargeandcanbedownloadedfrom:http://www.kongsberg.com/mesotechsoftware.
Softwareversion
ThisM3SonarInstructionManualcomplieswithM3softwareversion2.4.
Registeredtrademarks
Observetheregisteredtrademarksthatapply.
Windows®isaregisteredtrademarkofMicrosoftCorporationintheUnitedStatesand
othercountries.
M3Sonar®isaregisteredtrademarkofKongsbergMesotechLimitedintheUnited
Statesandothercountries.
Wewantyourfeedback
WewanttoimproveM3Sonarcontinuously.Wealsowantourend-userdocumentation
tobecomprehensiveandrelevant.Youcanhelp.Pleaseprovidecomments,suggestions
orconstructivecriticismtooursupportofce.Youcancontactusbyphoneat
[phone],orbyemailat:[email protected].
Aboutthismanual

6922-20007052/1.2
M3Sonar
Topics
Systemdescription,page7
Systemdiagram,page8
M3SonarAPIoverview,page9
Systemunits,page11
Supportinformation,page13
M3SonarAPIInstructionManual

922-20007052/1.27
Systemdescription
TheKongsbergMesotechM3Sonarisacompact,versatilemultibeamsonar.
Multibeamsonarshaveanarrayoftransducersthat
simultaneouslytransmitspings(soundpulses)at
aspeciedfrequencytocoveralargeareainless
timethanasingle-beamtransducer.Togenerate
data,computersoftwareassignsacolourrange
correspondingtotheamountofsoundreectedoffa
target.Thedistancetothetargetisdeterminedbythe
lengthoftimeittooktoreceivethetransmittedacoustic
pulse.
Bycombiningthehighrefreshrateofaconventionalmultibeamsonarwithanimage
qualitycomparabletoasingle-beamsonar,theM3Sonarprovideshigh-resolution
imagesthatareeasytointerpret.TheM3Sonardetectsobjectsoutto150metresandhas
a120°to140°eldofview,allowingyoutoseethefullunderwaterpictureinreal-time.
TheM3Sonarprovideswide-anglefull-rangesituationalawarenessandconcurrent
ultra-shortrangeimagingwithdynamicfocusing.Foroptimizedobstacleavoidance,the
M3Sonarusesvariableverticalbeamwidth.
M3Sonar

8922-20007052/1.2
Systemdiagram
ThesystemdiagramidentiesthemaincomponentsofabasicM3Sonarsystem.Only
themainconnectionsbetweentheunitsareshown.Detailedinterfacecapabilitiesand
powercablesarenotshown.
ASonarProcessor
BPowersupply
CM3SonarHead
M3SonarAPIInstructionManual

922-20007052/1.29
M3SonarAPIoverview
TheM3SonarAPIallowsyoutocontrolanM3SonarviaremoteTCP/IPcommands
andwithoutthegraphicaluserinterface.
WhentheM3SonarAPIisenabled,youcanuseyourcustomapplication(TCPclient)
toissuecommandstotheM3Sonar.Y oucanwriteM3SonarAPIcommandsinXML
format.
TheCommand-ServerObjectlistensonaportforTCP/IPcommandsissuedbyyour
application.WhentheCommand-ServerObjectreceivescommands,itwillsendthe
commandstoaCommand-ProcessorObject,whichprocessthecommandsandmakes
theappropriatefunctioncalls.TheCommand-ServerObjectreplieswitharesponse
stringthatisreceivedbyyourTCPclient.Y oucanreadtheseresponsestounderstand
theresultofthelastAPIcommandsenttotheserver.
YoucanusetheM3SonarAPITestingsoftwaretotesttheM3SonarAPIfunctionality.
YoucanalsousetheM3DatabaseEditorsoftwaretovieworeditallthesonar
applications(operationalmodes)availablefortheM3Sonar.
M3Sonar

10922-20007052/1.2
TheM3SonarAPIisenabledthroughtheWindowscommandprompt.Forimaging
applicationswherelowCPUusageisrequired,youcandisabletheDisplayManager
withacommand-promptswitch.
TostarttheM3SonarAPIautomaticallywhenyourcomputerbootsup,youcancreatea
batchlecontainingthecommand-prompttextsuitableforyourapplication.Ifyouhave
morethanoneSonarHead,itispossibletorunmultipleinstancesoftheM3SonarAPI.
IMBdataisstreamedautomaticallyeverytimeyourTCPclientconnectstotheIMB
portoftheM3SonarAPI.Y oucanalsostreamALLdatabyissuingAPIcommandsto
startandstopthedataexport.ALLdatacanbeexportedtothird-partysoftware,suchas
Hypack.
M3SonarAPIInstructionManual

922-20007052/1.211
Systemunits
Topics
SonarProcessor,page12
Powersupply,page12
SonarHead,page13
M3Sonar

12922-20007052/1.2
SonarProcessor
Inthispublication,thecomputerisreferredtoastheSonarProcessor.TheSonar
Processorcontainstheoperationalsoftware,andofferstheuserinterfacethatallowsyou
tocontroltheM3Sonar.ItisavitalpartoftheM3SonarMultibeamsonar.
TheSonarProcessorrunstheM3softwarethatmanages
communicationwiththeSonarHead,performsall
beamformingandimageprocessingandpresentsthe
sonarimagery.TheSonarProcessorcommunicates
withthesonarthroughastandardEthernetcable.
Ifyoupurchaseacomputerlocally,makesurethat
thechosenmodelmeetsthefunctionalandtechnical
requirements.Thecomputermustbedesignedfor
ruggeduse,andtheconstructionmustbeableto
withstandthevibrationsandmovementsofavessel.
Powersupply
TheSonarHeadrequiresaDCpowersupplytorun.
Normally,theDCvoltageissuppliedinthelocationwheretheSonarHeadismounted,
suchasonaremotelyoperatedvehicle(ROV).Atestcableandpowersupplyisavailable
fororderasanaccessory.Thetestpowersupplyusesa24VDCswitchingpowersupply.
M3SonarAPIInstructionManual

922-20007052/1.213
SonarHead
TheSonarHeadtransmitsandreceivesanacousticpulsewhendeployedunderwater.
TheSonarHeadincludestransmitandreceivetransducersandtheelectronicstogenerate
thetransmitpulseanddigitizethereceivedsignal.ThesonardataissenttotheSonar
ProcessorusingastandardEthernetlink.
Note
TheM3SonarHead’ sblackpolyurethanetransducerisdelicate.AlwayskeeptheGuard
Ringandprotectivecoveroverthetransducerduringinstallationandstorage.
Supportinformation
IfyouneedtechnicalsupportforyourM3Sonaryoumustcontactyourlocaldealer,or
oursupportdepartment.
Ifyourequiremaintenanceorrepair,contactyourlocaldealer.Youcancontactusby
phoneat+16044648144,orbyemailat:[email protected]g.com.
Ifyouneedinformationaboutourotherproducts,visithttp://www.km.kongs-
berg.com/mesotech.Onourwebsiteyouwillalsondalistofourdealersand
distributors.
M3Sonar

14922-20007052/1.2
Gettingstarted
Topics
SettingtheSonarProcessortoHighPerformance,page15
InstallingtheM3software,page16
DeningtheIPaddressontheSonarProcessornetworkadapter,page17
ChangingtheWindowsregionalformattoEnglish,page18
StartingoperationoftheSonarHead,page19
EnablingtheM3SonarAPI,page20
DisablingtheM3SonarAPI,page21
M3SonarAPIInstructionManual

922-20007052/1.215
SettingtheSonarProcessortoHigh
Performance
Toavoidslowdownsordisruptionswhilerunningthesonar,ensureyourSonarProcessor
isusingallofitsprocessingpoweranddoesnotgotosleep.
Prerequisites
ThisprocedureismadefortheMicrosoft®64-bitWindows10operatingsystem.
Procedure
1Inthebottom-leftcornerofyourdesktop,selecttheWindows®Startbutton.
2Onthemenu,selectSettings.
ObservethattheSettingswindowopens.
3SelectSystem.
4Inthemenuontheleft,selectPower&sleep.
5MakesurethattheSonarProcessorwillnevergotosleepwhenpluggedin.
aClicktheAdditionalpowersettingslinkontherightsideofthewindow.
ObservethatthePowerOptionsdialogboxopens.
bInthemenuontheleft,selectCreateapowerplan.
cSelecttheHighperformanceradiobutton.
dGiveyournewcustomplananame,thenclickNext.
eSelectNeverforbothTurnoffthedisplayandPutthecomputertosleepwhen
pluggedin.
fClickCreate.
Tip
Onceyouhavecreatedacustomplan,youcanadjustsomemoreadvancedsettings.
Youmay,forexample,wishtokeepanysecondarydisplaysonwhenthelaptoplid
isclosed.ClickChangeplansettingsnexttoyourcustomplan.ClicktheChange
advancedpowersettingslink.ObservethatthePowerOptionsdialogboxopens.
Clickthe“+”toexpandthesubmenus,thenselectthedesiredoptionsfromthe
drop-downlists.Atthebottomofthedialogbox,selectApplytosaveyoursettings.
Gettingstarted

16922-20007052/1.2
InstallingtheM3software
IfyoursystemisprovidedwithaSonarProcessor,theM3softwarehasalreadybeen
installed.Ifyouintendtouseyourowncomputer,youmustinstallthesoftwareyourself.
WerecommendedinstallingthelatestM3softwareonyourSonarProcessor.
Prerequisites
•YouwillneedtheKongsbergUSBdriveincludedwiththesystemordownloadthe
latestM3softwarereleasefrom:http://www.kongsberg.com/mesotechsoftware.
•Ifyouareinstallinganewsoftwareversion,uninstallthepreviousversionofthe
M3softwarebeforeproceeding.
Note
WhenrunningtheM3softwareforthersttime,aWindowsFirewalldialogboxmay
appear.Allowaccessforallnetworks.
Procedure
1LaunchtheinstallerM3_V0240Setup.exe.
2Followtheinstallationwizard’sinstructionsandselectStandardInstallation.
Note
UsetheDual-M3onSamePCoptiononlyifyouareusingtwoM3Sonars.Selecting
thisoptionwillinstalltwoseparatecopiesofthesoftware,witheachcopyhaving
itsownsettings.Youcanidentifywhichcopyyouareusingbyobservingthetop
headerofthesoftwarepresentation.Theheaderwillreadeither“M3-Master
Head”or“M3-SlaveHead”.
3UsethedefaultfolderlocationandcheckCreateadesktopicon,thenclickNext.
4ClickY estoinstalltheKMLUSBConverterwhenpromptedandfollowthe
instructionstonishtheinstallationprocess.
5PintheM3softwareicontotheWindowsTaskbar.
aRightclickontheM3softwareicon.
bClickPintotaskbar.
6TesttheM3softwarestartup.
aDoubleclicktheM3icononthedesktoptoruntheM3software.
bConrmthesoftwarenisheslaunchingwithoutanyerrorwindowsappearing.
M3SonarAPIInstructionManual

922-20007052/1.217
DeningtheIPaddressontheSonar
Processornetworkadapter
ThecommunicationbetweentheSonarProcessorandtheSonarHeadismadeusinga
high-speedEthernetcable.IfaSonarProcessorisnotconguredtoconnecttothesonar,
youmustdenewhichIPAddressandSubnetmasktheEthernetadapterintheSonar
Processorshalluseforthiscommunication.
Prerequisites
ThisprocedureismadefortheMicrosoft®64-bitWindows10operatingsystem.It
isassumedthatyouarefamiliarwiththeWindows®operatingsystems,computer
technology,andinterfaceprinciples.
Context
AslongasyoudonotchangetheSonarProcessortoanothercomputer,orreplacethe
networkadapterinyourSonarProcessor,youwillonlyneedtodothisonce.
Procedure
1OntheSonarProcessor,closetheM3software.
2OpentheNetworkConnectionsdialogbox.
aInthebottom-leftcornerofyourdesktop,selecttheWindows®Startbutton.
bOnthemenu,selectSettings.
cObservethattheWindowsSettingsdialogboxopens.
dSelectNetwork&Internet.
eSelectChangeadapteroptions.
fSelectthenetworkadapteryouaregoingtouse;thenright-clickandselect
Propertiesontheshort-cutmenu.
gOnthelistofconnections,selectInternetProtocol4(TCP/IPv4),andthen
Properties.
3SelectUsethefollowingIPaddress,andtypetheIPaddressandnetworkmask.
IPAddress:192.168.001.N("N"canbeanynumberfrom1to254,except234,
whichistheSonarHeaddefault.)
Subnetmask:255.255.255.0
YoucanleaveDefaultGatewayblank.
4SelectOKtosavethesettings,thencloseallthedialogboxes.
Gettingstarted

18922-20007052/1.2
ChangingtheWindowsregionalformatto
English
IfyourlocalWindowssettingsusescommasfordecimalpoints,theM3DatabaseEditor
willnotfunctionproperly.Tohandlethedatabasevaluesproperly,youwillneedto
changetheWindowsregionalformattoEnglish.
Prerequisites
ThisprocedureismadefortheMicrosoft®64-bitWindows10operatingsystem.It
isassumedthatyouarefamiliarwiththeWindows®operatingsystems,computer
technology,andinterfaceprinciples.
Procedure
1Inthebottom-leftcornerofyourdesktop,selecttheWindows®Startbutton.
2Onthemenu,selectSettings.
ObservethattheWindowsSettingsdialogboxopens.
3SelectTime&Language.
4SelectRegion.
5SelectEnglish(UnitedStates)fromtheRegionalformatdrop-downlist.
6Closethedialogboxbyselecting[X]intheupper-rightcorner.
M3SonarAPIInstructionManual