N3015 007 - Integrators Guide AD2CP - 0322
N3015 007 - Integrators Guide AD2CP - 0322
N3015 007 - Integrators Guide AD2CP - 0322
Table of Contents
Ch. 1 Introduction 6
Ch. 2 Basic interface concept 8
2.1 Modes .................................................................................................................................. 8
2.2 Break ................................................................................................................................... 9
2.3 Dual Processor ..................................................................................................................... 9
Ch. 3 Interfaces 10
3.1 Command interface ........................................................................................................... 10
3.2 Telemetry ........................................................................................................................... 10
3.3 Ethernet Operation ............................................................................................................. 11
Telnet Connection ....................................................................................................... 12
Raw Connections ......................................................................................................... 12
FTP .............................................................................................................................. 13
HTTP ............................................................................................................................ 13
UDP .............................................................................................................................. 13
PTP/NTP ...................................................................................................................... 14
3.4 Serial Operation ................................................................................................................ 14
3.5 Triggers .............................................................................................................................. 14
Ch. 5 Commands 27
5.1 List of Commands .............................................................................................................. 29
5.2 Wake processor from sleep mode ...................................................................................... 33
5.3 Instrument main settings .................................................................................................... 33
5.4 Clock settings ..................................................................................................................... 35
5.5 Clock settings as strings ..................................................................................................... 36
5.6 Deployment plan parameters ............................................................................................. 36
5.7 Average mode settings ...................................................................................................... 37
N3015-007
3
4 Integrator's Guide
© 2022 Nortek AS
Contents 5
N3015-007
5
6 Integrator's Guide
1 Introduction
The primary objective of this manual is to provide the information needed to control a Nortek product
that is based on the AD2CP hardware platform. This includes all instruments in the Signature series. It
is aimed at system integrators and engineers with interfacing experience, but it also includes examples
on how to configure and start the instrument for more inexperienced integrators. The document's scope
is limited to interfacing and does not address general performance issues of the instrument. For a more
thorough understanding of the principles, we recommend the Principles of Operation, and for information
about how to operate the instrument, we recommend the instrument-specific Operations Manual,
available for the 55/100 and the 250/500/1000.
The document is complete in the sense that it describes all available commands and modes of
communication. For most users, it will make sense to let the supplied Nortek software do most of the
hardware configuration and then let the controller limit its task to starting/stopping data collection.
Nortek online
At our website, www.nortekgroup.com, you will find technical support, user manuals, and the latest
software and firmware. General information, technical notes, and user experience can also be found
here.
Nortek FAQ
Our old forum where users from all over the world met to discuss and shared their experience with
Nortek instruments has been converted to an FAQ section. If you have comments, questions,
application tips, suggestions for improvements, or simply want to learn from others or share your own
experience, we encourage you to comment on the relevant FAQ or start a topic in our new forum.
Contact Information
We recommend first contacting your local sales representative before the Nortek main office. If you
need more information, support or other assistance, you are always welcome to contact us or any of our
subsidiaries by email, phone or fax.
Email: inquiry@nortekgroup.com (general inquiries), support@nortekgroup.com (technical support)
Phone: +47 67 17 45 00
Fax: +47 67 13 67 70
© 2022 Nortek AS
Introduction 7
© 2022 Nortek AS
8 Integrator's Guide
2.1 Modes
The current profiler operates in distinct modes. These modes have several explicit commands used to
control the instrument. The majority of the commands are initiated from the Command mode. The
possible modes for the instrument are:
· Command: Command and control
· Data Retrieval: Data download from recorder
· Measurement: Data collection mode
· Confirmation: Confirmation mode
Initializing communication with the instrument is performed by sending a <BREAK>, which is defined in
the next section. The <BREAK> will either set the instrument in Confirmation Mode or restart Command
Mode. The options for changing mode depends on the present mode of the instrument (see diagram
above for clarity). The timeout shown in the diagram occurs if no commands are received in the various
modes. A timer will then ensure that instrument operation continues. The timeout value in the
Confirmation and Data Retrieval Modes is 60 seconds. There is also a timeout in Command Mode when
© 2022 Nortek AS
Basic interface concept 9
operating over the serial interface. If no commands are received for 5 minutes, a break or a sequence of
@@@@@@ must be sent to wake up the processor.
2.2 Break
<BREAK> over the serial RS232/RS422 interface is defined as:
The @@@@@@ are used to wake up the processor when it is in sleep mode since the instrument will
only be able to monitor activity on the serial line when it sleeps. The second sequence of the actual
break characters is there to ensure that a break is detected even when the instrument is waking up due
to some other cause (e.g. alarm from the real time clock). This ensures that the processor will interpret
the following command correctly.
The figure and the table below show the specified timing of the <BREAK> sequence:
© 2022 Nortek AS
10 Integrator's Guide
3 Interfaces
In addition to the traditional serial port interface for real time data output there are several options for
communication over Ethernet. The Ethernet communication is handled by a dedicated processor in the
instrument. This network processor runs a Linux operating system, which makes it possible to connect
to the instrument via telnet, raw connections and FTP. The network processor mainly provides Ethernet
connectivity. The other processor in the instrument, called the Doppler processor, is where the
commands end up and where they are used to perform the measurements as specified.
The concept of a telemetry file has also been introduced which can be utilized in several ways
depending on the chosen interface. Below are some details:
3.2 Telemetry
Our use of the telemetry term implies a "subset transfer system", that is, storing a subset of data for
transfer over low-bandwidth links (for example over Iridium links, acoustic modems, etc.). The telemetry
file is typically used in cases where the integrator either does not have the processing power or
bandwidth (if only a low data rate serial port is available) to do the processing themselves.
For online data transmission a versatile scheme for telemetry options is available. The telemetry file can
be read out over the serial interface either in chunks or as a complete file while checksum or CRC on
the downloaded data can be applied in a configurable manner. This enables external controllers to
configure separate handling of all, or a subset, of the measured data. That means the file can be output
directly as they are ready, or the data can be stored to a telemetry file for later retrieval. The data format
can be selected from a number of formats, including both binary and ASCII data formats.
Since the instruments store individual ping data to file, the telemetry option can also be used to average
velocity data within the instrument. This averaged data can be immediately output via serial line or
stored for later retrieval in telemetry files. System integrators are able to regularly offload subsets of
data using FTP and telemetry files can be deleted after download.
© 2022 Nortek AS
Interfaces 11
Since the telemetry file can be retrieved also in Data Retrieval Mode, the instrument will continue
measuring after a timeout delay if the data transfer was interrupted. Erasing the telemetry file after data
retrieval will ensure that no data is lost if the transfer is interrupted.
The raw data, by design, is not supposed to be deleted from the disk. The raw data is collected and
saved continuously throughout the deployment and the configuration is supposed to be set up in such a
way that there is sufficient disk space to last for the whole deployment period (that is one of the factors
that the deployment software takes into account). The raw data is then taken off the disk after the
deployment and post-processed as required.
To FTP
The telemetry option implemented in the Doppler processor enables system integrators to regularly
offload subsets of the data by using FTP. When the network processor receives an incoming FTP
request, it will interrupt the Doppler processor by entering Data Retrieval Mode and mount the file
system of the recorder. The data files on the recorder can then be accessed over FTP. The telemetry
file can be deleted after it has been downloaded, which is particularly suitable for event driven data
downloads. If the instrument was started with the DEPLOY command, it will resynchronize to its
measurement time base after the FTP session has ended.
For an example on how to configure the instrument to output a telemetry file and download the file to
FTP, check out this section.
The password entry is ignored if password authentication, as shown in the web page configuration, is
disabled (so any input, including an empty password, is accepted). The command and data record
formats for the interfaces are the same as for the serial port.
Commands available in measurement mode should be preceded by the command BBPWAKEUP. This
ensures that the BBP is ready to process the command when it is received (see Checking instrument
state over Ethernet). In measurement mode, another BBPWAKEUP must be sent when more than 2
seconds has elapsed since the previous command.
If uncertain of the active mode it is good practice to send BBPWAKEUP before sending GETSTATE or
INQ.
© 2022 Nortek AS
12 Integrator's Guide
The interface is very similar to the direct serial interface over RS232/RS422 but some additions are
made to simplify the interfacing. Most notable is the ability to send a <BREAK> to the Doppler
processor just by using Ctrl-C (ASCII 0x03). The internal application takes care of waking up the
Doppler DSP and timing the delivery of the break string.
The telnet server is not configured to echo characters, so users wishing to see and/or edit commands
before sending them to the instrument should enable local echo and local line editing. If those features
are desired, a telnet client capable of supporting local echo and local line editing must be used (e.g.
PuTTY).
Port 9000 is dedicated for ASCII only communication whereas the ports described in the next section
provide the complete set of data, including binary output of the measurements. A telnet client should not
be used to access these ports. Read more about this in the next section.
© 2022 Nortek AS
Interfaces 13
· Port 9004 outputs ASCII data (no binary) that is configured for serial output. The instrument should be
configured to output a telemetry file with serial output enabled in ASCII format.
A telnet client should not be used to access these ports. Telnet incorporates its own binary protocol
which is neither interpreted nor sent via the raw connection. Using a telnet client on these ports will
result in extraneous characters being sent and certain binary characters being interpreted by the client.
3.3.3 FTP
The internal data recorder is accessed over Ethernet using a standard FTP (File Transfer Protocol)
client. Together with the various telemetry options, the FTP data download serves as a simple way to
download measured data at regular intervals if true real time operation is not required. Only the telemetry
file can be deleted using FTP.
When an FTP connection is active, the internal state of the machine is changed so that commands are
no longer processed (and an error is returned when commands are entered). Terminating the FTP
connection or sending a <BREAK> followed by the CO command will switch the instrument back to the
mode it was in before the FTP session began. If a break command is sent while an FTP transaction is
in progress, the FTP connection will be forcibly terminated.
If an FTP connection is done when the instrument is in Measurement Mode (see Modes diagram), the
FTP connection is made through Data Retrieval Mode. When the FTP connection is terminated, the
instrument will then return to Measurement Mode. If no data is transferred or no FTP commands sent for
120 seconds, the FTP connection will terminate and the instrument will return to Measurement Mode.
For an example on how to configure the instrument to output a telemetry file and download the file to
FTP, check out the User Cases.
3.3.4 HTTP
HTTP (Hypertext Transfer Protocol) can also be used for data transmission. For organizations with
strong security/firewall restrictions, FTP access to the instrument may not be permitted. For that
reason, a web page allowing individual data files to be downloaded has been implemented in the
Ethernet processor. The web page can be accessed by clicking on the “Data Download (HTTP)” link
from the main web page.
3.3.5 UDP
UDP (user datagram protocol) can also be used for data transmission. When using UDP, the data
collection software simply waits for data to be sent from the instrument without having to establish a
connection first. This may be useful for cases in which instrument power is intermittently interrupted and
re-connecting to the instrument is not desirable. One downside to UDP communications is that
transmission of the data is not guaranteed. On a noisy/error-prone connection, it is possible that the
occasional datagram may be dropped. If every data record must be received, then TCP is
recommended.
In order to use UDP in a power-safe configuration, the IP address of the data collection software and
port must first be configured using the web interface. The IP address identifies the client to which the
data is to be sent, and the port may be used to uniquely identify the instrument to the application. The
port must be between 9000 and 9500. The same port may be used for all instruments if the data
collection software examines the IP address of the received datagram to identify the instrument. Once
© 2022 Nortek AS
14 Integrator's Guide
this information has been configured, the Ethernet processor will automatically send real-time data
records to the configured address/port. An instrument in Measurement Mode re-enters Measurement
Mode shortly after a power-cycle, so the data collection software will immediately receive new data
without having to re-establish a connection.
3.3.6 PTP/NTP
Precision Time Protocol (IEEE-1588) is a standard used for distributing a high-resolution absolute time
throughout an Ethernet network. The Signature series instrument can be configured to act as a slave to
an existing PTP master clock (customer supplied) located in the same Ethernet LAN. The instrument
contains a high-resolution clock which is synchronized and conditioned using PTP when enabled. The
timestamps contained within the data records are then generated from this clock. When synchronized,
these timestamps are typically aligned to within ~10 microseconds.
The PTP master clock must use UDP (layer three) and be configured for two-step operation with an end-
to-end delay mode in order to be compatible with the Signature series PTP implementation. Using PTP
does not affect the choice of UDP or TCP for the transport of data.
Network Time Protocol provides time sync typically to within +-1 ms on a local area network and +-
10ms across a wide area network. The NTP Server IP address must be correctly configured for NTP to
operate.
PTP/NTP is enabled on the SEC processor from the Signature web interface.
Serial communication can only be achieved through commands, meaning that the GUI of the
SignatureDeployment software cannot be used. Instead, if you connect through a serial cable to
SignatureDeployment a terminal window will open. You can also connect to the Signature through any
other terminal.
3.5 Triggers
AD2CP offers four main types of triggers: Internal Sampling, TTL trigger, RS-485 trigger and trig on
command.
TTL Trigger
The AD2CP can trig on either Rising Edge, Falling Edge or Both Edges of a TTL Signal. When triggered
the instrument will perform a complete ping (Tx and Rx) before it goes back to monitoring the trigger.
Any triggers asserted during an ongoing ping will be ignored. The requirements for the TTL input is Vlow
<0.7V and Vhigh>2.5V. The TTL input tolerate voltages between 0-5.5 V. The pulse length should be
minimum 1 ms.
© 2022 Nortek AS
Interfaces 15
Trigger types
RS-485 Trigger
A RS-485 signal can be used to trig the AD2CP, either Rising Edge, Falling Edge or Both Edges of a
RS-485 Signal. The following figure shows the polarities of the differential RS-485 signal pair for the
trigger types. When triggered the instrument will perform a complete ping (Tx and Rx) before it goes
back to monitoring the trigger. Any triggers asserted during an ongoing ping will be ignored. The pulse
length should be minimum 1 ms.
Trig on Command
When the TRIG parameter of the SETTRIG command is set to “COMMAND” the AD2CP is trigged by
sending a “TRIG[CrLf]” command. The trigger time will be when the end of the [CrLf] is received.
© 2022 Nortek AS
16 Integrator's Guide
Comprehensive validation and error handling is implemented. The setup is verified when sending the
SAVE command. If there is anything wrong with the deployment plan, i.e. some of the parameters are
entered with values outside their specific range, an ERROR will be returned. The GETERROR command
will describe why. If SAVE is not used, the deployment plan will be validated when sending the START
or DEPLOY command. Note the difference between DEPLOY and START, the latter will immediately
start a measurement any time the instrument state returns to Measurement Mode such as by applying
power or timeout from Data Retrieval Mode. If DEPLOY is used, be aware that if the deployment time
has passed when the battery is connected, the instrument will resynchronize its data sampling
according to the deployment time and the instrument configuration. This means you may have to wait
for one average measurement interval or one burst measurement interval before the instrument starts to
ping.
Invalid configurations return the ERROR with limits directly, so that each subsequent error can be
handled until a valid configuration is achieved. Argument limits can be retrieved through commands. For
example, if entering SETPLAN,MIAVG=5000, you will receive an OK. But when saving or deploying,
you will receive an ERROR. When using GETERROR, you will receive the following:
134,"Invalid setting: Plan Profile Interval","GETPLANLIM,MIAVG=([1;3600])"
The measurement interval must be within 1:3600 seconds. The valid range for the various arguments
can also be verified by using the GETPLANLIM and GETAVGLIM commands.
4.1 GETALL
GETALL retrieves all relevant configuration information for the instrument. This information can either be
displayed on the command line or saved to a data file. For Nortek post-processing software to read a
valid .ad2cp file it must contain both the Header and Data Record. The Header information can be
obtained by using the command GETALL.
Argument Description
FN Write the output to this file
Example: The result from a GETALL command on a Signature1000 with a default Average plan.
Different plans, e.g. with a Burst measurement enabled, will produce different parameters from a
GETALL command. Calibration values are not modifiable.
© 2022 Nortek AS
Using the Command Interface 17
© 2022 Nortek AS
18 Integrator's Guide
© 2022 Nortek AS
Using the Command Interface 19
03,B3X=0.000000E+00,A1X=-3.905594E-05,A2X=-
2.741814E-06,A3X=0.000000E+00
AY=1.000000E+00,B0Y=-8.213488E-
03,B1Y=9.444051E-03,B2Y=1.928553E-
03,B3Y=0.000000E+00,A1Y=-3.572553E-
05,A2Y=2.868473E-06,A3Y=0.000000E+00
AZ=1.000000E+00,B0Z=1.251627E-
02,B1Z=8.488446E-05,B2Z=1.951933E-
03,B3Z=0.000000E+00,A1Z=8.686632E-
05,A2Z=2.995133E-06,A3Z=0.000000E+00
AX=1.092663E+00,B0X=-1.458604E-02,B1X=- Gyro calibration values
1.925275E-03,B2X=-5.933643E-
05,B3X=0.000000E+00,A1X=1.739189E-04,A2X=-
7.793307E-06,A3X=0.000000E+00
AY=1.086592E+00,B0Y=1.325879E-
02,B1Y=4.371032E-04,B2Y=3.761053E-
CALGYROGET
05,B3Y=0.000000E+00,A1Y=-2.659187E-
04,A2Y=2.339482E-06,A3Y=0.000000E+00
AZ=1.087252E+00,B0Z=-4.356480E-
02,B1Z=5.960464E-08,B2Z=1.316518E-
05,B3Z=0.000000E+00,A1Z=4.348904E-
05,A2Z=2.026558E-06,A3Z=0.000000E+00
MT=1,RREF=4.5300000000e+02,RB0=0.00000000 Pressure sensor calibration
00e+00,RB1=0.0000000000e+00,RB2=0.00000000 values
00e+00,RB3=0.0000000000e+00,T0=-
CALPRESSGET
3.7026600000e+03,T1=2.7309500000e+00,T2=-
6.8649568750e-04,T3=5.9816006250e-
08,ID="L0165"
A0=5.4010770000e+01,A1=-4.2163353130e- Pressure sensor calibration
02,A2=1.1131470000e-05,A3=-9.9709175000e- coefficient values
10,B0=-3.1236960000e+00,B1=2.9407478130e-
CALPRESSCOE 03,B2=-7.7748162500e-07,B3=6.8127600000e-11
FFGET C0=-7.5628700000e-03,C1=6.2269425000e-
06,C2=-1.6925208750e-09,C3=1.5250131250e-
13,D0=4.1404246880e-05,D1=-3.4084846880e-
08,D2=9.3360593750e-12,D3=-8.5032206250e-16
M11=0.99685,M12=- Accelerometer rotation matrix
CALROTACCLG 0.00455,M13=0.01998,M21=0.00674,M22=0.99572, values
ET M23=-0.00375,M31=-
0.02500,M32=0.00529,M33=0.99523
M11=1.00000,M12=-0.01459,M13=- Gyro rotation matrix values
CALROTGYRO
0.00088,M21=0.00841,M22=1.00000,M23=-
GET
0.01623,M31=-0.02101,M32=0.00059,M33=1.00000
CALECHOGET CHA0=0.00,CHB0=0.00,CHC0=0.00 Echosounder calibration values
© 2022 Nortek AS
20 Integrator's Guide
A typical sequence starts by wanting to know the state of the instrument before proceeding with either a
new measurement or data retrieval.
This indicates the instrument has been configured to deploy and has started its scheduled deployment
for 27521 seconds. See GETSTATE for more information.
Depending on the desired action, send Break usually followed by; either MC to enter command mode,
RM for data retrieval or START/DEPLOY/CO to start/schedule/continue a deployment.
Configuration example:
% Recommended starting point for configuration file
SETDEFAULT,CONFIG
$PNOR,OK*2B
© 2022 Nortek AS
Using the Command Interface 21
Go to ftp://your-IP-address to find the telemetry file (telemetryfile.bin). Here is part of the result from the
above configuration. Note that the data were collected in air.
$PNORI,4,Signature1000900002,4,11,0.20,1.00,0*1B
$PNORS,091715,143440,00000000,2A4C0000,14.3,1300.0,278.3,15.7,-33.0,0.000,-
262.45,0,0*65
$PNORC,091715,142440,1,0.24,-1.35,-2.21,-
1.69,1.37,169.7,C,79,84,67,102,11,13,8,11*2B
$PNORC,091715,142440,3,0.64,-0.28,-1.91,-
1.32,0.70,113.9,C,79,84,66,96,12,14,7,20*13
$PNORC,091715,142440,5,0.08,-0.50,-1.76,-
1.48,0.51,171.2,C,78,84,66,92,11,13,7,24*1D
$PNORC,091715,142440,7,-0.37,0.97,-1.02,-
1.07,1.04,339.0,C,78,84,66,67,11,14,10,10*21
$PNORC,091715,142440,9,-0.94,0.57,-0.76,-
1.11,1.10,301.1,C,78,83,65,69,12,15,9,10*10
$PNORC,091715,142440,11,-0.37,0.76,-0.95,-
1.06,0.85,334.0,C,78,83,65,66,13,15,8,8*14
$PNORC,091715,142440,13,0.05,-0.25,-1.64,-
1.36,0.26,168.4,C,78,84,66,82,11,14,9,33*2F
$PNORC,091715,142440,15,-0.20,0.20,-1.36,-
1.32,0.28,314.6,C,78,84,66,67,11,13,9,7*16
$PNORC,091715,142440,17,0.19,0.17,-1.47,-
1.13,0.25,48.0,C,78,84,65,69,12,16,9,2*0D
$PNORC,091715,142440,19,-0.91,0.45,-0.90,-
1.19,1.02,296.5,C,78,84,65,66,12,14,10,8*27
$PNORC,091715,142440,21,-0.49,0.66,-1.00,-
1.11,0.82,323.1,C,78,84,65,67,12,14,11,10*13
After downloading the telemetry file, erase it either via FTP or commands. Only the telemetry file can be
deleted using FTP.
© 2022 Nortek AS
22 Integrator's Guide
CO
$PNOR,OK*2B
Note that the instrument does not process wave data internally (read more about this in the Operations
Manual, if interested), thus only current data will be output in the telemetry file.
For use with external controller it can be interesting to note the following: if the instrument is started at
e.g. 12:00, the first current profile is finished at 12:02 (120 seconds) and the next starts about 12:10.
That leaves us with 8 minutes to download the telemetry file to FTP before next current profile starts.
The clock drifts with about 1 sec/week. Since DEPLOY was used the measurement intervals will
resynchronize according to the deployment time and the instrument configuration (see DEPLOY for
more information), thus is should be easier to schedule automatic data download as the window 12:02 to
12:10 remains.
% Send Break
CONFIRM
OK
% Outputting the telemetry file over serial port in 4096 byte chunks
DOWNLOADTM,0,4096,CKS=1
[OUTPUT]
$PNOR,OK*2B
© 2022 Nortek AS
Using the Command Interface 23
Copy the returned text and paste to file, or check "Record to file" before retrieving the file and the file will
appear by default in: C:\Users\xxxx\Documents\Nortek\Deployment\Online.
Parameters can be added to the DOWNLOADTM command to set start address, length of file, etc. (see
section DOWNLOADTM).
In this example: Signature55, configured to alternate between fine and coarse current profiles (3:1). In
this case the user wanted to download the averaged fine profile upon request.
Configuration example:
% Recommended starting point for configuration file
SETDEFAULT,CONFIG
$PNOR,OK*2B
© 2022 Nortek AS
24 Integrator's Guide
SETAVG,NC=109,CS=5,BD=2,CY="ENU",PL=-
6,AI=180,VR=1,DF=3,NPING=137,NB=3,CH=0,MUX=0,BW="BROAD",ALTI=0,BT=0,ICE=0
$PNOR,OK*2B
% Setting the telemetry file to average the "Fine" profile over the
averaging interval
SETTMAVG,EN=1,CD=1,PD=1,AVG=180,TV=1,TA=1,TC=1,CY="ENU",FO=1,SO=0,DF=100
$PNOR,OK*2B
SAVE,CONFIG
$PNOR,ERROR*77
Note that SETTMAVG,AVG must equal the AI set by SETAVG,AI. To set telemetry averaging for the
alternate plan use SETTMAVG1, note that these will be recorded to the same telemetryfile.bin file.
© 2022 Nortek AS
Using the Command Interface 25
% Upload prepared .deploy file to the instrument via the Terminal Window.
The file is read in line-by-line.
$PNOR,SETDEFAULT,ALL*4B
$PNOR,SETPLAN,MIAVG=60,AVG=1,DIAVG=0,VD=0,MV=10,SA=35,BURST=1,MIBURST=1200,
DIBURST=0,SV=0,FN="Data.ad2cp",SO=0,FREQ=1000,NSTT=0*42
$PNOR,SETAVG,NC=21,CS=1,BD=0.2,CY="ENU",PL=0,AI=10,VR=2.5,DF=3,NPING=13,NB=
4,CH=0,MUX=0,BW="BROAD",ALTI=0,BT=0,ICE=0,ALTISTART=0.1,ALTIEND=30,RAWALTI=
1*0B
$PNOR,SETBURST,NC=13,NB=4,CS=1,BD=9.5,CY="BEAM",PL=0,SR=4,NS=4096,VR=2.5,DF
=3,NPING=1,CH=0,VR5=2.5,ALTI=1,BT=0,DISV=0,ECHO=0,RAWALTI=1,ALTISTART=6.9,A
LTIEND=33.1,HR=0,HR5=0*3C
$PNOR,SETTMAVG,EN=0,CD=1,PD=1,AVG=10,TV=1,TA=1,TC=1,CY="ENU",FO=0,SO=1,DF=1
00,DISTILT=0,TPG=0,MAPBINS=0*6D
$PNOR,SAVE,ALL*43
$PNOR,OK*2B
$PNOR,OK*2B
$PNOR,OK*2B
$PNOR,OK*2B
$PNOR,OK*2B
$PNOR,OK*2B
% Configure to measure with just 3 beams, and specify which ones to use.
SETBURST,NB=3,CH=234
$PNOR,OK*2B
% Upload prepared .deploy file to the instrument via the Terminal Window.
The file is read in line-by-line.
$PNOR,SETDEFAULT,ALL*4B
$PNOR,SETPLAN,MIAVG=60,AVG=1,DIAVG=0,VD=0,MV=10,SA=35,BURST=1,MIBURST=1200,
DIBURST=0,SV=0,FN="Data.ad2cp",SO=0,FREQ=1000,NSTT=0*42
$PNOR,SETAVG,NC=21,CS=1,BD=0.2,CY="ENU",PL=0,AI=10,VR=2.5,DF=3,NPING=13,NB=
4,CH=0,MUX=0,BW="BROAD",ALTI=0,BT=0,ICE=0,ALTISTART=0.1,ALTIEND=30,RAWALTI=
1*0B
$PNOR,SETBURST,NC=13,NB=4,CS=1,BD=9.5,CY="BEAM",PL=0,SR=4,NS=4096,VR=2.5,DF
© 2022 Nortek AS
26 Integrator's Guide
=3,NPING=1,CH=0,VR5=2.5,ALTI=1,BT=0,DISV=0,ECHO=0,RAWALTI=1,ALTISTART=6.9,A
LTIEND=33.1,HR=0,HR5=0*3C
$PNOR,SETTMAVG,EN=0,CD=1,PD=1,AVG=10,TV=1,TA=1,TC=1,CY="ENU",FO=0,SO=1,DF=1
00,DISTILT=0,TPG=0,MAPBINS=0*6D
$PNOR,SAVE,ALL*43
$PNOR,OK*2B
$PNOR,OK*2B
$PNOR,OK*2B
$PNOR,OK*2B
$PNOR,OK*2B
$PNOR,OK*2B
% Modify SETTMAVG line; enable telemetry, enable file output. Serial output
is already enabled (SO=1).
SETTMAVG,EN=1,FO=1*26
$PNOR,OK*2B
% The instrument is now measuring, and you will see data start to come
through the connection.
© 2022 Nortek AS
Commands 27
5 Commands
This chapter covers the commands that can be used to control an AD2CP instrument. Not every
command will be appropriate for every instrument.
Some pointers:
· A configuration of the instrument should always start with setting the default configuration,
e.g.:
SETDEFAULT,CONFIG
OK
· Sometimes you may get an ERROR response after tying to save the configuration or start/deploy
the instrument. This doesn't necessarily mean that something is wrong with the instrument, but
is most often a sign that the configuration isn't going to work. Any ERROR response can be
interrogated with GETERROR, e.g.:
SAVE,CONFIG
ERROR
GETERROR
GETERROR,NUM=56,STR="Invalid setting: Avg Average Interval too
low for the configured number of pings and profiling
distance",LIM="GETAVG1LIM,AI=([360;1800])"
OK
Here, the instrument is reporting that we have set the average interval to be too short, and it
provides the limits for the AI that are allowed if we are going to keep the same number of pings
and profiling distance. You could increase the average interval, decrease the number of pings,
or decrease the profiling distance (i.e. number/size of cells) to fix the error.
© 2022 Nortek AS
28 Integrator's Guide
([1300.00;1700.00];0.0) – Floating point value, valid values are 0.0 and the range from 1300.00 to
1700.00.
(['0';'9'];['a';'z'];['A';'Z'];'.') – String argument with valid characters being . and the character ranges
a-z, A-Z, 0-9 .
("BEAM") – String argument with BEAM being the only valid string.
(0;1) – Integer value with two valid values, 0 and 1.
© 2022 Nortek AS
Commands 29
© 2022 Nortek AS
30 Integrator's Guide
© 2022 Nortek AS
Commands 31
RETRIEVAL
INQ Inquires the instrument state COMMAND
CONFIRMATION
RETRIEVAL
MEASUREMENT
GETSTATE Returns information about the current COMMAND
operational state of the instrument CONFIRMATION
MEASUREMENT
RETRIEVAL
GETERROR Returns a full description of the last error COMMAND
condition to occur CONFIRMATION
MEASUREMENT
RETRIEVAL
GETALL Retrieves all relevant configuration information COMMAND
for the instrument
RECSTAT Return recorder statistics COMMAND
RETRIEVAL
GETMISCLIM This command returns configuration limits that COMMAND
cannot be returned through the relevant
commands
GETXFAVG Returns the "Beam to XYZ" transfer matrix for COMMAND
average measurements
GETXFBURST Returns the "Beam to XYZ" transfer matrix for COMMAND
burst measurements
SETTMAVG Set averaging mode telemetry settings COMMAND
GETTMAVG Get averaging mode telemetry settings COMMAND
GETTMAVGLIM Get instrument averaging mode limits COMMAND
SETTMBURST Set burst mode telemetry settings COMMAND
GETTMBURST Get burst mode telemetry settings COMMAND
GETTMBURSTLIM Get instrument burst mode limits COMMAND
SETTMALTI Set altimeter telemetry settings COMMAND
GETTMALTI Get altimeter telemetry settings COMMAND
GETTMALTILIM Get instrument altimeter limits COMMAND
SETTMBT Set bottom track telemetry settings COMMAND
GETTMBT Get bottom track telemetry settings COMMAND
GETTMBTLIM Get instrument bottom track limits COMMAND
TMSTAT Returns the length of the telemetry file COMMAND
RETRIEVAL
DOWNLOADTM Read telemetry file data COMMAND
© 2022 Nortek AS
32 Integrator's Guide
RETRIEVAL
STOREHEADERTM Stores the GETALL to the telemetry file COMMAND
ERASETM Erase the telemetry file COMMAND
RETRIEVAL
TAG Write a Tag to output file and data output COMMAND
CONFIRMATION
MEASUREMENT
RETRIEVAL
SETUSERECHO- Set calibration values for major beam angle COMMAND
MAJORANGLE
GETUSERECHO- Get calibration values for major beam angle COMMAND
MAJORANGLE
GETUSERECHO- Get limits for calibration values for major beam COMMAND
MAJORANGLELIM angle
SETUSERECHO- Set calibration values for major beam angle offset COMMAND
MAJOROFFSET
GETUSERECHO- Get calibration values for major beam angle COMMAND
MAJOROFFSET offset
GETUSERECHO- Get limits for calibration values for major beam COMMAND
MAJOROFFSETLIM angle offset
SETUSERECHO- Set calibration values for minor beam angle COMMAND
MINORANGLE
GETUSERECHO- Get calibration values for minor beam angle COMMAND
MINORANGLE
GETUSERECHO- Get limits for calibration values for minor beam COMMAND
MINORANGLELIM angle
SETUSERECHO- Set calibration values for minor beam angle offset COMMAND
MINOROFFSET
GETUSERECHO- Get calibration values for minor beam angle COMMAND
MINOROFFSET offset
GETUSERECHO- Get limits for calibration values for minor beam COMMAND
MINOROFFSETLIM angle offset
SETUSERECHOGAIN Set calibration values for gain COMMAND
GETUSERECHOGAIN Get calibration values for gain COMMAND
GETUSERECHOGAINLIM Get limits for calibration values for gain COMMAND
SETUSERECHO- Set calibration values for two way beam angle COMMAND
TWOWAYANGLE
GETUSERECHO- Get calibration values for two way beam angle COMMAND
TWOWAYANGLE
© 2022 Nortek AS
Commands 33
GETUSERECHO- Get limits for calibration values for two way beam COMMAND
TWOWAYANGLELIM angle
PTPSET Set precision time protocol parameters COMMAND
PTPGET Get precision time protocol parameters COMMAND
BBPWAKEUP Wakes up the Doppler processor (ethernet COMMAND
interface only) CONFIRMATION
MEASUREMENT
RETRIEVAL
GETHW Returns hardware specifications COMMAND
CONFIRMATION
MEASUREMENT
RETRIEVAL
ADDLICENSE Add license key COMMAND
DELETELICENSE Delete license key COMMAND
LISTLICENSE Lists all license keys in instrument COMMAND
The @@@@@@ are used to wake up the processor when it is in sleep mode since the instrument
will only be able to monitor activity on the serial line when it sleeps. The second sequence of the
actual break characters is there to ensure that a break is detected even when the instrument is
waking up due to some other cause (e.g. alarm from the real time clock). This ensures that the
processor will interpret the following command correctly.
Example:
@@@@@@ <delay 100milliseconds> K1W%!Q <delay 300milliseconds> K1W
%!Q
5.3 Instrument main settings
Commands: SETINST, GETINST, GETINSTLIM
Command type: CONFIGURATION
Mode: COMMAND
Argument Description
BR Baud Rate
© 2022 Nortek AS
34 Integrator's Guide
300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200, 230400,
460800, 625000, 1250000
Unit: [bit/s]
RS Serial protocol
232, 422
LED Enable/disable LED blink in head.
When set to "ON24H" the LED will illuminate the first 24 hours of the
measurement.
"OFF": Turn LED Off
"ON": Turn LED On
"ON24H": Turn LED On for 24 hours
ORIENT Sets the instrument orientation.
Not used for DVL.
"AUTOXUPDOWN": Auto X up/down
"AUTOYUPDOWN": Auto Y up/down
"AUTOZUPDOWN": Auto Z up/down
"ZUP": Z up
"ZDOWN": Z down
"XUP": X up
"XDOWN": X down
"YUP": Y up
"YDOWN": Y down
"AUTO3D": Auto 3D
"AHRS3D": AHRS 3D
CMTOUT Command mode timeout
Unit: [s]
DMTOUT Data retrieval mode timeout
Unit: [s]
CFMTOUT Confirmation mode timeout
Unit: [s]
SETINST
Example:
SETINST,BR=57600
GETINST
Example:
GETINST,BR=460800,RS=232,LED="ON",ORIENT="AUTOZUPDOWN",CMTOUT=300,D
MTOUT=60,CFMTOUT=60
© 2022 Nortek AS
Commands 35
GETINSTLIM
Argument Description
YEAR The year, e.g. 2020
Valid Range [0,9999]
MONTH The number of month 1-12 (Jan = 1)
Valid Range [1,12]
DAY The number day of month 1-31
Valid Range [1,31]
HOUR The hour of day 0-23
Valid Range [0,23]
MINUTE The minute of hour 0-59
Valid Range [0,59]
SECOND The second of minute 0-59
Valid Range [0,59]
Note: Note that all parameters must be set when using the set command
SETCLOCK
Example:
SETCLOCK,YEAR=2020,MONTH=11,DAY=28,HOUR=13,MINUTE:15,SECOND=45
GETCLOCK
Example:
GETCLOCK
© 2022 Nortek AS
36 Integrator's Guide
Set or retrieve the Real Time Clock using a string. Must use the format as shown: yyyy-MM-dd
HH:mm:ss
Argument Description
TIME Text string with this format yyyy-MM-dd HH:mm:ss (use UTC)
SETCLOCKSTR
Example:
SETCLOCKSTR,TIME="2020-11-12 14:27:42"
GETCLOCKSTR
Example:
GETCLOCKSTR
GETCLOCKSTR, TIME = "2014-11-12 14:27:42"
Argument Description
MIAVG Averaging measurements interval
Unit: [s]
AVG Enable averaging measurements
VD Vertical direction
SA Salinity.
Unit: [ppt]
BURST Enable(1)/disable(0) burst measurements.
MIBURST Burst measurements interval.
Unit: [s]
© 2022 Nortek AS
Commands 37
Note: The valid range for the various arguments should be verified using the GETPLANLIM
command, as the values listed here may change with firmware versions and instrument
frequencies.
SETPLAN
Example:
SETPLAN,FREQ=75
GETPLAN
GETPLANLIM
Argument Description
NC Number of cells
CS Cell size
© 2022 Nortek AS
38 Integrator's Guide
Unit: [m]
BD Blanking distance
Unit: [m]
DF Data format
0: AD2CP format 1
1: Legacy AquaPro format
2: AD2CP format 2
3: AD2CP format 3
CY Co-ordinate system
BEAM, XYZ, ENU
PL Power level (range -20.0 dB to 0.0 dB, -100 dB to switch off transmit).
Unit: [dB]
AI Average interval
Unit: [s]
VR Velocity range along beam
Unit: [m/s]
NPING Number of pings
NB Number of beams
© 2022 Nortek AS
Commands 39
Note: The actual valid range for the various parameters for the firmware version is used can be
found by using the GETAVGLIM command. This command has the same arguments as the
SETAVG/GETAVG commands shown in the list above. The output format for limits is described in
Data Limit Formats
SETAVG
Example:
SETAVG,ALTIEND=20
GETAVG
GETAVGLIM
Argument Description
NC Number of cells.
NB Number of beams.
CS Cell size.
Unit: [m]
BD Blanking distance.
Unit: [m]
DF Data format.
0: AD2CP format 1
1: Legacy AquaPro format
2: AD2CP format 2
3: AD2CP format 3
CY Co-ordinate System.
BEAM, XYZ, ENU
© 2022 Nortek AS
40 Integrator's Guide
PL Power level (range -20.0 dB to 0.0 dB, -100 dB to switch off transmit).
This parameter is instrument dependent and dependent on the power
consumption of the deployment as a whole.
Unit: [dB]
SR Sampling rate.
Unit: [Hz]
NS Number of samples.
Note: The actual valid range for the various parameters for the firmware version is used can be
found by using the GETBURSTLIM command. This command has the same arguments as the
SETBURST/GETBURST commands shown in the list above. The output format for limits is described
in Data Limit Formats.
SETBURST
Example:
SETBURST,HR=1
GETBURST
© 2022 Nortek AS
Commands 41
GETBURSTLIM
Argument Description
PROC Input to processing the HR profile.
0: Pulse Coherent Processing using a single ambiguity.
1: Pulse Coherent Processing with Extended Velocity Range (EVR).
LAG Distance between two transmit pulses on the slanted beams.
Unit: [m]
LAG5 Distance between two transmit pulses on vertical beam.
Unit: [m]
SCORR Number of ambiguities (side correlators) to resolve when using
Extended Velocity Range (EVR).
NC Number of cells.
CS Cell size.
Unit: [m]
BD Blanking distance.
Unit: [m]
PL Power level (range -20.0 dB to 0.0 dB, -100 dB to switch off transmit).
This parameter is instrument dependent and dependent on the power
consumption of the deployment as a whole.
Unit: [dB]
SETBURSTHR
Example:
SETBURSTHR,BD=3
© 2022 Nortek AS
42 Integrator's Guide
GETBURSTHR
GETBURSTHRLIM
Argument Description
NC Number of cells
© 2022 Nortek AS
Commands 43
CH1 Frequency 1 channel beam selection. E.g. CH=123 will enable beams 1, 2
and 3.
RAW1 Frequency 1 raw echo data recording interval.
FREQ2 Enable and set frequency 2 of echogram.
Unit: [kHz]
NBINF2 Used only on the Signature100 which supports up to 5 packages pr
frequency index. Processing is then done on the different frequency
bands.
For other instruments it must be set to 1.
XMIT2 Transmission length on frequency 2.
Unit: [msec]
PL2 Power level on frequency 2 (range -20.0 dB to 0.0 dB, -100 dB to switch
off transmit). This parameter is instrument dependent and dependent
on the power consumption of the deployment as a whole.
Unit: [dB]
PULSECOMP2 Enable/disable pulse compression on frequency 2.
CH2 Frequency 2 channel beam selection. E.g. CH=123 will enable beams 1, 2
and 3.
RAW2 Frequency 2 raw echo data recording interval.
FREQ3 Enable and set frequency 3 of echogram.
Unit: [kHz]
NBINF3 Used only on the Signature100 which supports up to 5 packages pr
frequency index. Processing is then done on the different frequency
bands.
For other instruments it must be set to 1.
XMIT3 Transmission length on frequency 3.
Unit: [msec]
PL3 Power level on frequency 3 (range -20.0 dB to 0.0 dB, -100 dB to switch
off transmit). This parameter is instrument dependent and dependent
on the power consumption of the deployment as a whole.
Unit: [dB]
PULSECOMP3 Enable/disable pulse compression on frequency 3.
CH3 Frequency 3 channel beam selection. E.g. CH=123 will enable beams 1, 2
and 3.
RAW3 Frequency 3 raw echo data recording interval.
Note: Note that Pulse Compression may only be enabled for one echogram.
SETECHO
© 2022 Nortek AS
44 Integrator's Guide
Example:
SETECHO,NC=30,BINSIZE=1
GETECHO
GETECHOLIM
Argument Description
RANGE Maximum depth
Unit: [m]
VR Max velocity expected in the water column during deployment.
Velocity range spans from -VR to +VR.
Unit: [m/s]
NB Number of beams used to calculate bottom track.
CH Beam selection. E.g. CH=123 will enable beams 1, 2 and 3.
DF Data format
0: AD2CP format 1
1: Legacy AquaPro format
2: AD2CP format 2
3: AD2CP format 3
PL Power level (range -20.0 dB to 0.0 dB, -100 dB to switch off transmit).
This parameter is instrument dependent and dependent on the power
consumption of the deployment as a whole.
Unit: [dB]
SETBT
Example:
© 2022 Nortek AS
Commands 45
SETBT,VR=10,CH=1234
GETBT
GETBTLIM
The valid range for the various arguments should be verified using the GETALTERNATELIM
command. The values listed here may change with firmware versions and instrument frequencies.
Argument Description
EN Enable or disable the alternate configuration mode
PLAN Primary configuration run time
Unit: [s]
IDLE Primary configuration idle time
Unit: [s]
PLAN1 Alternate configuration run time
Unit: [s]
IDLE1 Alternate configuration idle time
Unit: [s]
Note: The actual valid range for the various parameters for the firmware version is used can be
found by using the GETAVGLIM command. This command has the same arguments as the
SETAVG/GETAVG commands shown in the list above. The output format for limits is described in
Data Limit Formats.
SETALTERNATE
© 2022 Nortek AS
46 Integrator's Guide
Example:
SETALTERNATE,EN=1,PLAN=60,IDLE=60,PLAN1=60,IDLE1=60
GETALTERNATE
GETALTERNATELIM
Returns the amount of memory that will be stored on the recorder per hour for the burst and
average data as well as the combined plan value. Alternate mode values is also supported.
Argument Description
PLAN Combined burst and average memory usage for primary plan
Unit: [MB/h]
BURST Burst memory usage for primary plan
Unit: [MB/h]
AVG Average data memory usage for primary plan
Unit: [MB/h]
PLAN1 Combined burst and average memory usage for secondary plan
Unit: [MB/h]
BURST1 Burst memory usage for secondary plan
Unit: [MB/h]
AVG1 Average data memory usage for secondary plan
Unit: [MB/h]
TOTAL Total memory usage
Unit: [MB/h]
Example:
GETMEM,TOTAL
© 2022 Nortek AS
Commands 47
The parameters and limits for Trigger. The available trigger types will depend on the
harness/cable used with the instrument.
TTL Trigger. The AD2CP can trig on either Rising Edge, Falling Edge or Both Edges of a TTL Signal.
The requirements for the TTL input is Vlow < 0.7V and Vhigh > 2.5V. The TTL input tolerate voltages
between 0-5.5 V.
A RS-485 signal can be used to trig the AD2CP, either Rising Edge, Falling Edge or Both Edges of a
RS-485 Signal. The following figure shows the polarities of the differential RS-485 signal pair for
the trigger types.
When triggered the instrument will perform a complete ping (Tx and Rx) before it goes back to
monitoring the trigger. Any triggers asserted during an ongoing ping will be ignored. There are no
specific requirements for pulse length. The unit triggers on the edge(s) of the trigger signal and
can be triggered on rising, falling or both edges. The pulse length should be minimum 1 ms.
Argument Description
EN Enable/disable trigger functionality
TRIG Specifies trigger type and are given as counting numbers.
The available trigger types will depend on the harness/cable used with
the instrument.
"INSTR": Internal Sampling is available with rates from 1 to 8 Hz. For
long ranges the maximum sampling rate is reduced.
"TTLEDGES": Trigger on both rising- and falling edge of a TTL signal.
"TTLRISE": Trigger on rising edge of a TTL signal.
"TTLFALL": Trigger on falling edge of a TTL signal.
"RS485EDGES": Trigger on both edges of a RS-485 signal.
"RS485RISE": Trigger on rising edge of a RS-485 signal.
"RS485FALL": Trigger on falling edge of a RS-485 signal.
"COMMAND": Trigger on Command. When the TRIG parameter of the
SETTRIG command is set to "COMMAND" the AD2CP is trigged by
sending a "TRIG[CrLf]" command. The trigger time will be when the end
of the [CrLf] is received
TRIGOUTPUT TRIGOUTPUT=1 enables master trig output. RS485EDGE trigger must be
used with this option.
SETTRIG
Example:
SETTRIG,EN=1,TRIG="COMMAND",TRIGOUTPUT=1
© 2022 Nortek AS
48 Integrator's Guide
GETTRIG
GETTRIGLIM
The parameters and limits for trigger for secondary plan. The available trigger types will depend
on the harness/cable used with the instrument.
Argument Description
EN Enable/disable trigger functionality
TRIG Specifies trigger type and are given as counting numbers.
The available trigger types will depend on the harness/cable used with
the instrument.
"INSTR": Internal Sampling is available with rates from 1 to 8 Hz. For
long ranges the maximum sampling rate is reduced.
"TTLEDGES": Trigger on both rising- and falling edge of a TTL signal.
"TTLRISE": Trigger on rising edge of a TTL signal.
"TTLFALL": Trigger on falling edge of a TTL signal.
"RS485EDGES": Trigger on both edges of a RS-485 signal.
"RS485RISE": Trigger on rising edge of a RS-485 signal.
"RS485FALL": Trigger on falling edge of a RS-485 signal.
"COMMAND": Trigger on Command. When the TRIG parameter of the
SETTRIG1 command is set to "COMMAND" the AD2CP is trigged by
sending a "TRIG[CrLf]" command. The trigger time will be when the end
of the [CrLf] is received
TRIGOUTPUT TRIGOUTPUT=1 enables master trig output. RS485EDGE trigger must be
used with this option.
SETTRIG1
Example:
SETTRIG1,EN=1,TRIG="COMMAND",TRIGOUTPUT=1
© 2022 Nortek AS
Commands 49
GETTRIG1
GETTRIGLIM1
Command used for trigging measurement when Trigger is enabled and trigger type equals
"COMMAND".
Argument Description
ID Counting number
Example:
TRIG,ID=123
5.17 Get power use
Command: GETPWR
Command type: INFO
Mode: COMMAND
Returns the power consumption in milliWatts for the various measurements enabled as well as
the overall value. The plan values include the sleep mode power consumption in addition to the
sum of average and burst mode values. The reported values are adjusted according to the input
voltage to the system when the command is executed.
Argument Description
PLAN Combined power use on both burst and average sampling for primary
plan
Unit: [mW]
BURST Power use on burst data sampling for primary plan
Unit: [mW]
AVG Power use on average data sampling for primary plan
Unit: [mW]
© 2022 Nortek AS
50 Integrator's Guide
PLAN Combined power use on both burst and average sampling for secondary
plan
Unit: [mW]
BURST Power use on burst data sampling for secondary plan
Unit: [mW]
AVG Power use on average data sampling for secondary plan
Unit: [mW]
TOTAL Total power use
Unit: [mW]
Example:
GETPWR,TOTAL
5.18 Get measured precision
Commands: GETPRECISION, GETPRECISION1
Command type: INFO
Mode: COMMAND
Returns the precision in the horizontal plane and along the beam in cm/s for the various
measurement modes.
Argument Description
AVGHORZ Precision in the horizontal plane in average mode
Unit: [cm/s]
BURSTHORZ Precision in the horizontal plane in burst mode
Unit: [cm/s]
BEAM5 Precision in the vertical plane (beam 5) in burst mode
Unit: [cm/s]
AVGBEAM Precision along beam in average mode
Unit: [cm/s]
BURSTBEAM Precision along beam in burst mode
Unit: [cm/s]
GETPRECISION
Example:
GETPRECISION,AVGHORZ
GETPRECISION1
© 2022 Nortek AS
Commands 51
Example:
GETPRECISION1,AVGHORZ
Argument Description
POFF Set the offset value of the pressure sensor.
Unit: [dbar] | Valid Range: [0,11]
DECL Magnetic declination.
Unit: [degrees]
HX Hard iron x-component.
Unit: [Gauss]
HY Hard iron y-component.
Unit: [Gauss]
HZ Hard iron z-component.
Unit: [Gauss]
SETUSER
Example:
SETUSER,POFF=4.5,DECL=1.4,HX=100,HY=100,HZ=100
OK
SAVEUSER
OK
GETUSER
GETUSERLIM
© 2022 Nortek AS
52 Integrator's Guide
Argument Description
SN Serial number
Valid Range [0,2147483647]
STR Instrument name
Example:
ID
"Signature1000",900002
ID,STR
"Signature1000"
5.21 Reload default settings
Command: SETDEFAULT
Command type: ACTION
Mode: COMMAND
Argument Description
CONFIG Restore all settings below except USER and INST to default values.
Legacy argument ALL acts as CONFIG.
AVG Restore average mode settings to default.
INST Restore instrument main settings to default.
TMAVG Restore telemetry average settings to default.
PLAN Restore plan settings to default.
BURST Restore burst settings to default.
PTP Restore precision time protocol to default.
BT Restore bottom track settings to default.
USER Restore user calibration to default.
TMBURST Restore telemetry burst to default.
TMALTI Restore altimeter telemetry settings to default.
DVL Restore DVL settings to default.
© 2022 Nortek AS
Commands 53
Example:
SETDEFAULT,CONFIG
5.22 Save settings
Command: SAVE
Command type: ACTION
Mode: COMMAND
Save current settings for next measurement. At least one argument must be specified for the
SAVE command.
Argument Description
CONFIG Save all settings except INST and USER settings.
Legacy argument ALL acts as CONFIG.
AVG Save AVG settings.
INST Save INST settings.
TMAVG Save telemetry average settings.
PLAN Save plan settings.
BURST Save burst settings.
PTP Save precision time protocol settings.
TMBT Save telemetry bottom track settings.
USER Save user instrument settings.
TMBURST Save telemetry burst settings.
TMALTI Save altimeter telemetry settings.
DVL Save DVL settings.
Example:
SAVE,CONFIG
5.23 Deploy instrument
Command: DEPLOY
Command type: ACTION
Mode: COMMAND
Deploy the instrument. Start the measurement at the time specified in the string argument. The
format must be exactly as shown. If no time value is passed, the deployment will start
immediately.
The DEPLOY command will save the configuration as well as deploying the instrument, as if a
SAVE,CONFIG command were sent.
© 2022 Nortek AS
54 Integrator's Guide
Argument Description
TIME yyyy-MM-dd HH:mm:ss
Note: The difference between DEPLOY and START is that the latter will immediately start a
measurement any time the instrument state returns to Measurement mode such as by applying
power or timeout from Data Retrieval Mode. If DEPLOY is used, be aware that if the deployment
time has passed when the battery is connected, the instrument will resynchronize its data
sampling according to the deployment time and the instrument configuration. This means you
may have to wait for one average measurement interval or one burst measurement interval
before the instrument starts to ping.
Example:
DEPLOY,TIME="2020-12-18 15:30:00"
592
OK
5.24 Start instrument
Command: START
Command type: ACTION
Mode: COMMAND
Start the instrument (go in measurement mode). Specify the order of the alternating plans by
using the PLAN argument.
Note that the START command will save the configuration as well as starting the measurement, as
if a SAVE,CONFIG command were sent.
Argument Description
PLAN Select plan to start
0: Plan
1: Plan1
Example:
START,PLAN=0
5.25 Enter command mode
Command: MC
Command type: ACTION
Mode: CONFIRMATION
Example:
MC
© 2022 Nortek AS
Commands 55
Go into data retrieval mode from confirmation mode and access the instruments recorder.
Example:
RM
5.27 Enter measurement mode
Command: CO
Command type: ACTION
Mode: CONFIRMATION, RETRIEVAL
Continue in measurement mode from confirmation mode or data retrieval mode. Instrument
returns to collecting data according to the current configuration.
Example:
CO
5.28 Write to file
Command: FWRITE
Command type: ACTION
Mode: COMMAND, CONFIRMATION, RETRIEVAL
Argument Description
FNUM File identifier for telling which file the info is written to. Default is 0.
0: File defined in the PLAN command
1: Telemetry file
ID Identifier. Tell the parser how to interpret the string. Default value: 0
0: Comment
1: Dive location
2: Surface location
Default: 0
STR String.
Example:
FWRITE,FNUM=1,STR="ABCDEF"
© 2022 Nortek AS
56 Integrator's Guide
Example:
POWERDOWN
5.30 Erase files on recorder
Command: ERASE
Command type: ACTION
Mode: COMMAND
Argument Description
CODE Code should be 9999
9999
Example:
ERASE,CODE=9999
5.31 Format recorder
Command: FORMAT
Command type: ACTION
Mode: COMMAND
Format the recorder. Note that this can take minutes depending on the recorder size.
Argument Description
CODE Code should be 9999
9999
Example:
FORMAT,CODE=9999
5.32 SEC reboot
Command: SECREBOOT
Command type: ACTION
Mode: COMMAND
© 2022 Nortek AS
Commands 57
Reboots the SEC (Interface processor). This command makes it possible to reboot the SEC without
going via the web interface.
Argument Description
CODE Code should be 9999
9999
Example:
SECREBOOT,CODE=9999
5.33 List files
Command: LISTFILES
Command type: INFO
Mode: COMMAND, RETRIEVAL
Argument Description
OPT Amount of file information to list.
"normal": Normal file info.
"la": Lists extended information.
Example:
LISTFILES,OPT="NORMAL"
5.34 Download
Command: DOWNLOAD
Command type: ACTION
Mode: COMMAND, RETRIEVAL
This command reads a file from the recorder to the terminal window.
Argument Description
FN Filename
SA Start address (offset) of the first byte to be returned
LEN Number of bytes to be downloaded
CRC Use Cyclic redundancy check
CKS Use Checksum
Note: If no parameters other than the file name are sent with the DOWNLOAD command, the
complete file is directly returned, without the number of bytes to follow. The end of the file can
then be detected by parsing the OK<CR><LF>.
© 2022 Nortek AS
58 Integrator's Guide
The parameters can be used to download the file in several pieces. The number of bytes to follow
will then be returned in ASCII format and terminated with <CR><LF> before the data is output. The
end of the file stream is terminated with OK<CR><LF>. A cyclic redundancy check or a checksum
will then be added to verify data integrity during download. The complete file can also be
downloaded in this way by specifying SA=0 and a large value for LEN. The actual file size is then
returned before the data follows.
Example:
DOWNLOAD,FN="TestFile.ad2cp",SA=0,LEN=4096,CRC=1,CKS=0
4096
<binary or ASCII data>
23432
OK
5.35 Inquire state
Command: INQ
Command type: INFO
Mode: COMMAND, CONFIRMATION, RETRIEVAL, MEASUREMENT
The INQ command queries the instrument state. Note that when operating over RS232 or RS422
serial lines, it should be preceded with @@@@@@ <delay 400ms> and a flush of the input buffer
in case the instrument is in power down or in a low power mode taking measurements.
0001: Measurement
0002: Command
0005: Confirmation
0006: FTP-mode
Example:
(In command mode)
INQ
0002
(In measurement mode)
INQ
0001
(In confirmation mode)
INQ
0005
© 2022 Nortek AS
Commands 59
Argument Description
MODE Current instrument state.
1: Measurement (START command received).
2: In command mode.
3: DEPLOY command received and deployment running.
4: Data retrieval.
5: Confirmation.
6: Network FTP.
8: DEPLOY command received, but deployment has not, yet started.
9: Confirmation in measurement mode.
10: Confirmation in deploy mode.
11: Confirmation in pre-deploy mode.
12: internal processing in progress.
DEPTIME Seconds since deployment:
0 – DEPLOY command has not been received.
< 0 – Number of seconds until deployment starts.
> 0 – Number of seconds that deployment has been running.
Unit: [s]
MEASTIME Seconds with measurements:
0 – START command has not been received.
> 0 – Number of seconds that measurement has been running.
Unit: [s]
CURRTIME The current instrument time.
Time format is "YYYY-MM-DD HH:MM:SS"
Unit: [Time]
WAKEUP Reason for instrument wakeup.
0: Last startup/reboot caused by loss/low voltage.
1: Last startup/reboot caused by power on.
2: Last startup/reboot caused by BREAK command.
3: Last startup/reboot caused by Wakeup by Real time clock.
4: Last startup/reboot caused by WatchDog
INTPROC Internal processing Active
© 2022 Nortek AS
60 Integrator's Guide
Example:
GETSTATE,WAKEUP,CURRTIME
5.37 Get error
Command: GETERROR
Command type: INFO
Mode: COMMAND, CONFIRMATION, MEASUREMENT, RETRIEVAL
GETERROR retrieves a full description of the last error condition to occur. The error number is
returned first followed by a string with the text description of the last error condition. A second
string is also returned which contains information on the valid range of the failing argument.
Argument Description
NUM Integer error value
STR Text description
Example:
SETAVG,CS=2.5
OK
SAVE,CONFIG
ERROR
GETERROR
40,"Invalid setting: Avg Cell Size","GETAVGLIM,CS=([0.20;2.00])"
OK
5.38 Get all
Command: GETALL
Command type: INFO
Mode: COMMAND
GETALL retrieves all relevant configuration information for the instrument. This information can
either be displayed on the command line or saved to a data file on the instrument. For the Nortek
post-processing software to read a valid .ad2cp file it must contain both the Header and Data
Record. The Header information can be obtained by using the command GETALL.
Argument Description
FN Write the output to this file saved on instrument
Example:
GETALL
GETPLAN,600,1,0,0,10,0.0,1,0,0,1500,"",1
GETAVG,20,1.00,0.30,"BEAM",-12.0,1,0.000,1.29,3,1,0,0
GETBURST,50,4,0.400,0.200,"BEAM",0.0,1,1024,4.00,0.000,0,1,0
GETUSER,0.00,0.00,0,0,0
© 2022 Nortek AS
Commands 61
GETINST,9600,232,1
BEAMCFGLIST,1,10.00,20.00,1000,500,1,1
BEAMCFGLIST,2,10.00,20.00,1000,500,1,2
BEAMCFGLIST,3,10.00,20.00,1000,500,1,3
BEAMCFGLIST,4,10.00,20.00,1000,500,1,4
OK
5.39 Get recorder statistics
Command: RECSTAT
Command type: INFO
Mode: COMMAND, RETRIEVAL
Argument Description
SS Number of bytes in a sector.
Unit: [bytes]
CS Number of bytes in one cluster.
Unit: [bytes]
FC Number of bytes in free clusters.
Unit: [bytes]
TC Total number of bytes in clusters.
Unit: [bytes]
VS Volume Size in bytes.
Unit: [bytes]
Example:
RECSTAT,VS
5.40 Get configuration limits
Command: GETMISCLIM
Command type: INFO
Mode: COMMAND
Argument Description
AVGPR Returns the total profiling range for averaged measurements (SETAVG)
Unit: [m]
BURSTPR Returns the total profiling range for burst profile measurements
(SETBURST)
Unit: [m]
BURSTHRPR Returns the total profiling range for burst HR profile measurements
(SETBURSTHR)
Unit: [m]
© 2022 Nortek AS
62 Integrator's Guide
Note: The output format for limits is described in Data Limit Formats
Example:
GETMISCLIM,BURSTPR
5.41 Get transfer matrices
Commands: GETXFAVG, GETXFBURST
Command type: INFO
Mode: COMMAND
Returns the "Beam to XYZ" transfer matrix for the current setup. If the number of beams is 1 or 2,
only ROWS and COLS are returned.
Argument Description
ROWS Number of rows
COLS Number of rows
M11
M12
M13
M14
M21
M22
M23
M24
M31
M32
M33
M34
Cell indexes are: first number for row and second index for column.
GETXFAVG
Example:
GETXFAVG
© 2022 Nortek AS
Commands 63
GETXFBURST
Example:
GETXFBURST
GETXFBURST,ROWS=4,COLS=4,M11=1.183,M12=0.000,M13=-
1.183,M14=0.000,M21=0.000,M22=1.183,M23=0.000,M24=-
1.183,M31=0.552,M32=0.000,M33=0.552,M34=0.000,M41=0.000,M42=0.552,M
43=0.000,M44=0.552
GETXFAVG,ROWS=3,COLS=3,M11=1.183,M12=0.000,M13=-
1.183,M21=1.183,M22=-2.366,M23=1.183,M31=0.552,M32=0.000,M33=0.552
Argument Description
EN Enable averaging mode telemetry.
CD Cells divisor.
PD Packets divisor.
AVG Average telemetry data.
Unit: [s]
TV Store velocity.
TA Store amplitude.
TC Store correlation.
CY Co-ordinate system.
BEAM, XYZ, ENU
FO Enable file output.
SO Enable serial output.
DF Data format.
0: AD2CP format 1
1: Legacy AquaPro format
2: AD2CP format 2
3: AD2CP format 3
DISTILT Disable tilt.
TPG Stores the value of Percentage Good Data in supported data formats.
MAPBINS Enable vertical bin mapping.
© 2022 Nortek AS
64 Integrator's Guide
The actual valid range for the various parameters for the firmware version is used can be found by
using the GETTMAVGLIM command. This command has the same arguments as the
SETTMAVG/GETTMAVG commands shown in the list above. The output format for limits is
described in Data Limit Formats.
SETTMAVG
Example:
SETTMAVG,EN=1,AVG=30
GETTMAVG
GETTMAVGLIM
Argument Description
EN Enable burst telemetry
NS Number of burst samples to save
0: Save all burst samples
1: BURST.NS
CY Co-ordinate System
BEAM, XYZ, ENU
FO Enable file output
SO Enable serial output
DF Data format
0: AD2CP format 1
1: Legacy AquaPro format
2: AD2CP format 2
© 2022 Nortek AS
Commands 65
3: AD2CP format 3
ENAVG Enables averaging over the number of samples (NS) value
MAPBINS Enable vertical bin mapping
Note: The actual valid range for the various parameters for the firmware version is used can be
found by using the GETTMBURSTLIM command. This command has the same arguments as the
SETTMBURST/GETTMBURST commands shown in the list above. The output format for limits is
described in Data Limit Formats.
SETTMBURST
Example:
SETTMBURST,EN=1,NS=0
GETTMBURST
GETTMBURSTLIM
Argument Description
EN Enable altimeter telemetry.
TS Include time stamp.
TQ Include quality parameter.
FO Enable file output.
SO Enable serial output.
DF Altimeter telemetry format.
200: NMEA (PNORA) format without tags.
201: NMEA (PNORA) format with tags.
© 2022 Nortek AS
66 Integrator's Guide
TPR Enable(0) / disable(1) output of pitch and roll (in DF200/201 data
format).
SETTMALTI
Example:
SETTMALTI,EN=1,TS=1,TQ=1
GETTMALTI
GETTMALTILIM
Argument Description
EN Enable burst telemetry.
CY Co-ordinate system.
BEAM, XYZ, ENU
FO Enable file output.
SO Enable serial output.
DF Data format.
300: NMEA without tags.
301: NMEA with tags.
302: NMEA without tags and Sensor Data.
303: NMEA with tags and Sensor Data.
NPING Number of pings.
FOMTH Figure of merit threshold.
SETTMBT
© 2022 Nortek AS
Commands 67
Example:
SETTMBT,EN=1,FO=1,SO=1,DF=301
GETTMBT
GETTMBTLIM
Example:
TMSTAT
13500
OK
5.47 Download telemetry
Command: DOWNLOADTM
Command type: ACTION
Mode: COMMAND, RETRIEVAL
This command enables reading the telemetry file which can be created during measurement by
using the appropriate SETTMxxx commands. The formats are described in the section detailing
Data Formats.
Argument Description
SA Start address (offset) of the first byte to be returned.
LEN Number of bytes to be downloaded.
CRC Use Cyclic redundancy check.
CRC=1 enables CRC. CRC cannot be enabled when CKS=1.
CKS Use Checksum.
CKS=1 enables checksum. CKS cannot be enabled when CRC=1.
© 2022 Nortek AS
68 Integrator's Guide
Note: If no parameters are sent with the DOWNLOADTM command the complete file is directly
returned, without the number of bytes to follow. The end of the file can then be detected by
parsing the OK<CR><LF>.
The parameters can be used to download the telemetry file in several pieces. The number of
bytes to follow will then be returned in ASCII format and terminated with <CR><LF> before the
data is output. The end of telemetry stream is terminated with OK<CR><LF>. A cyclic redundancy
check or a checksum will then be added to be able to verify data integrity during download. The
complete file can also be downloaded in this way by specifying SA=0 and a large value for LEN. The
actual file size is then returned before the data follows. See also TMSTAT for retrieving file
information.
Example:
DOWNLOADTM,SA=0,LEN=4096,CRC=1,CKS=0
<binary or ASCII data>
23432 (checksum/crc value)
OK
5.48 Save configuration to file
Command: STOREHEADERTM
Command type: ACTION
Mode: COMMAND
This command stores the GETALL (complete configuration) to the telemetry file.
Example:
STOREHEADERTM
5.49 Erase telemetry file
Command: ERASETM
Command type: ACTION
Mode: COMMAND, RETRIEVAL
Argument Description
CODE Code should be 9999
9999
Example:
ERASETM,CODE=9999
© 2022 Nortek AS
Commands 69
The TAG command adds a tag to the both the output file and the output data, if enabled. The
output is a String Record as defined in the FWRITE command. The ID of the String Record Data
packet is 19dec.
Argument Description
STR Tag string. Maximum 200 bytes.
CLK Add clock in tag.
Note: Remember to use the BBPWAKEUP command when sending commands to an instrument in
Measurement mode, when using Ethernet.
Example:
TAG,STR="This is a test tag.",CLK=1
a5 0a a0 10 2f 00 42 8c 42 5d 13 32 // Binary header
30 31 37 2d 30 31 2d 32 34 20 30 38 // String Record ID = 19dec
3a 34 32 3a 35 37 2e 34 34 39 20 2d // "2017-01-24 08:42"
20 54 68 69 73 20 69 73 20 61 20 74 // ":57.449 - This i"
65 73 74 20 74 61 67 2e 00 // "s is a test tag."
OK
5.51 Major beam angle calibration
Commands: SETUSERECHOMAJORANGLE, GETUSERECHOMAJORANGLE,
GETUSERECHOMAJORANGLELIM
Command type: CONFIGURATION
Mode: COMMAND
Commands that enable storing echosounder calibration values. The Signature echosounder does
not use any of these values in its processing, but they provide users a way to store their
calibration values together with the measure data. So these only serve as an option for storing
calibration data in the instrument which are then output in the data file header.
These commands allow fifth order polynomials with individual enable. The scheme is to calculate
the polynomial over the frequency range of the transducer, using the center frequency from the
beam list as origin.
Argument Description
EN Enable storing calibration values
P0 Constant
© 2022 Nortek AS
70 Integrator's Guide
SETUSERECHOMAJORANGLE
Example:
SETUSERECHOMAJORANGLE,EN=1,P0=0.123,P1=1.23,P2=12.3
GETUSERECHOMAJORANGLE
GETUSERECHOMAJORANGLELIM
Commands that enable storing echosounder calibration values. The Signature echosounder does
not use any of these values in its processing, but they provide users a way to store their
calibration values together with the measure data. So these only serve as an option for storing
calibration data in the instrument which are then output in the data file header.
These commands allow fifth order polynomials with individual enable. The scheme is to calculate
the polynomial over the frequency range of the transducer, using the center frequency from the
beam list as origin.
Argument Description
EN Enable storing calibration values
P0 Constant
P1 First order polynomial
© 2022 Nortek AS
Commands 71
SETUSERECHOMAJOROFFSET
Example:
SETUSERECHOMAJOROFFSET,EN=1,P0=0.123,P1=1.23,P2=12.3
GETUSERECHOMAJOROFFSET
GETUSERECHOMAJOROFFSETLIM
Get limits for calibration values for major beam angle offset
Commands that enable storing echosounder calibration values. The Signature echosounder does
not use any of these values in its processing, but they provide users a way to store their
calibration values together with the measure data. So these only serve as an option for storing
calibration data in the instrument which are then output in the data file header.
These commands allow fifth order polynomials with individual enable. The scheme is to calculate
the polynomial over the frequency range of the transducer, using the center frequency from the
beam list as origin.
Argument Description
EN Enable storing calibration values
P0 Constant
P1 First order polynomial
P2 Second order polynomial
© 2022 Nortek AS
72 Integrator's Guide
SETUSERECHOMINORANGLE
Example:
SETUSERECHOMINORANGLE,EN=1,P0=0.123,P1=1.23,P2=12.3
GETUSERECHOMINORANGLE
GETUSERECHOMINORANGLELIM
Commands that enable storing echosounder calibration values. The Signature echosounder does
not use any of these values in its processing, but they provide users a way to store their
calibration values together with the measure data. So these only serve as an option for storing
calibration data in the instrument which are then output in the data file header.
These commands allow fifth order polynomials with individual enable. The scheme is to calculate
the polynomial over the frequency range of the transducer, using the center frequency from the
beam list as origin.
Argument Description
EN Enable storing calibration values
P0 Constant
P1 First order polynomial
P2 Second order polynomial
P3 Third order polynomial
© 2022 Nortek AS
Commands 73
SETUSERECHOMINOROFFSET
Example:
SETUSERECHOMINOROFFSET,EN=1,P0=0.123,P1=1.23,P2=12.3
GETUSERECHOMINOROFFSET
GETUSERECHOMINOROFFSETLIM
Get limits for calibration values for minor beam angle offset
Commands that enable storing echosounder calibration values. The Signature echosounder does
not use any of these values in its processing, but they provide users a way to store their
calibration values together with the measure data. So these only serve as an option for storing
calibration data in the instrument which are then output in the data file header.
These commands allow fifth order polynomials with individual enable. The scheme is to calculate
the polynomial over the frequency range of the transducer, using the center frequency from the
beam list as origin.
Argument Description
EN Enable storing calibration values
P0 Constant
P1 First order polynomial
P2 Second order polynomial
P3 Third order polynomial
P4 Forth order polynomial
P5 Fifth order polynomial
© 2022 Nortek AS
74 Integrator's Guide
SETUSERECHOGAIN
Example:
SETUSERECHOGAIN,EN=1,P0=0.123,P1=1.23,P2=12.3
GETUSERECHOGAIN
GETUSERECHOGAINLIM
Commands that enable storing echosounder calibration values. The Signature echosounder does
not use any of these values in its processing, but they provide users a way to store their
calibration values together with the measure data. So these only serve as an option for storing
calibration data in the instrument which are then output in the data file header.
© 2022 Nortek AS
Commands 75
These commands allow fifth order polynomials with individual enable. The scheme is to calculate
the polynomial over the frequency range of the transducer, using the center frequency from the
beam list as origin.
Argument Description
EN Enable storing calibration values
P0 Constant
P1 First order polynomial
P2 Second order polynomial
P3 Third order polynomial
P4 Forth order polynomial
P5 Fifth order polynomial
SETUSERECHOTWOWAYANGLE
Example:
SETUSERECHOTWOWAYANGLE,EN=1,P0=0.123,P1=1.23,P2=12.3
GETUSERECHOTWOWAYANGLE
GETUSERECHOTWOWAYANGLELIM
Get limits for calibration values for two way beam angle
Argument Description
EN Choose a time protocol.
0: Time protocol disabled.
1: Use precision time protocol (PTP).
2: Use network time protocol (NTP).
© 2022 Nortek AS
76 Integrator's Guide
OFFSET Offset
Unit: [µs]
CL Time value representing the number of seconds elapsed since 00:00
hours, Jan 1, 1970 UTC
Unit: [s]
IP The numeric IP address of the NTP server to use for syncing
Note: For the case of NTP, the instrument is not capable of DNS name resolution. In order to
retrieve the IP address associated with a name, use the "nslookup" tool from the computer
command line
PTPSET
Example:
PTPSET,EN=0,OFFSET=0,CL=1609193402
OK
PTPSET,EN=2,IP="129.240.3.3"
OK
PTPGET
Example:
PTPGET,EN,OFFSET,CL
If uncertain of the active mode it is good practice to send BBPWAKEUP before sending GETSTATE
or INQ.
Example:
BBPWAKEUP
© 2022 Nortek AS
Commands 77
Argument Description
FW Running DSP FW version
FWMINOR Running DSP FW version (minor part)
FPGA Running FPGA FW version
BOOT DSP bootloader FW Version
DIGITAL Board revision. Example: C-0
INTERFACE Board revision. Example: C-0
ANALOG Board revision. Example: C-0
ANALOG2 Board 2 revision. Example: C-0
SENSOR Board revision. Example: C-0
Example:
GETHW,FW,MINOR
5.60 Add license
Command: ADDLICENSE
Command type: PRODUCTION
Access: User
Mode: COMMAND
Reads a license key and checks it against the instrument serial number before adding it to the
license key flash.
Argument Description
KEY The license key to add
Example:
ADDLICENSE,KEY="9H3F5PE47HUUB"
OK
5.61 Delete license
Command: DELETELICENSE
Command type: PRODUCTION
Access: User
© 2022 Nortek AS
78 Integrator's Guide
Mode: COMMAND
Argument Description
KEY The license key to delete
Example:
DELETELICENSE,KEY="9H3F5PE47HUUB"
OK
5.62 Lists license keys
Command: LISTLICENSE
Command type: INFO
Access: User
Mode: COMMAND
Lists all license keys contained in the license key flash along with a description of the functionality
enabled by the key and the variant number of the license.
Example:
LISTLICENSE
LISTLICENSE,"K28FDJF7RPNUB","All features",0
LISTLICENSE,"4X218TRTRPNUB","High Resolution",4
LISTLICENSE,"JKHHFNH3RPNUB","Wave Mode",6
LISTLICENSE,"WF3CJR6PRPNUB","Current Profiler",1
OK
$PNOR,LISTLICENSE*76
$PNOR,LISTLICENSE,KEY="K28FDJF7RPNUB",DESC="All features",TYPE=0*4C
$PNOR,LISTLICENSE,KEY="4X218TRTRPNUB",DESC="High
Resolution",TYPE=4*73
$PNOR,LISTLICENSE,KEY="JKHHFNH3RPNUB",DESC="Wave Mode",TYPE=6*00
$PNOR,LISTLICENSE,KEY="WF3CJR6PRPNUB",DESC="Current
Profiler",TYPE=1*1C
$PNOR,OK*2B
6 Data Formats
This chapter describes the Nortek AD2CP binary data formats for sensor output. Note that the
binary data formats all use a common header that specifies how the rest of the data block should
be interpreted. A data block is the data from and including one header to the next. Binary data are
always sent as Little Endian.
© 2022 Nortek AS
Data Formats 79
Figure: Show ing how com m on data fields (gray for header and blue for other com m on's) the sensor data
relate to the sensor specific data fields (green). Note that w e use a leading underscore (_) to em phasize that
this is not a sensor data form at but is com m on and used by tw o or m ore data form ats.
© 2022 Nortek AS
80 Integrator's Guide
6.1 _HeaderData
The header definition for binary data formats. Note that the header may be verified without
reading the rest of the data block since it has its own checksum.
© 2022 Nortek AS
Data Formats 81
6.2 _CommonData
Used By: CurrentProfileDataV3, DF20BottomTrack
Common data definitions for parsing AD2CP V3 average- and echosounder data.
© 2022 Nortek AS
82 Integrator's Guide
© 2022 Nortek AS
Data Formats 83
Name Description
54/56 The status field is at 54 or 56 depending on wether the ambiguity velocity is
16bit or 32bit long.
56/58 The status field is at 56 or 58 depending on wether the ambiguity velocity is
16bit or 32bit long.
58/60 The status field is at 56 or 58 depending on wether the ambiguity velocity is
16bit or 32bit long.
59/61 The status field is at 59 or 61 depending on wether the ambiguity velocity is
16bit or 32bit long.
© 2022 Nortek AS
84 Integrator's Guide
6.3 _CurrentProfileDataV3
Extends: CommonData
Used By: EchosounderDataV3, VelocityDataV3, SpectrumDataV3
Data definitions for parsing AD2CP V3 average data.
© 2022 Nortek AS
86 Integrator's Guide
© 2022 Nortek AS
Data Formats 87
6.4 EchosounderDataV3
Extends: CurrentProfileDataV3
ID: 0x1c
Data definitions for parsing AD2CP V3 echosounder data.
Name Description
NC Number of echosounder cells given at position 30 in this dataset.
© 2022 Nortek AS
88 Integrator's Guide
OFFSET Offset of data given at position 1 in this dataset. Number of bytes from start
of record to start of data.
6.5 VelocityDataV3
Extends: CurrentProfileDataV3
ID: 0x15
Data definitions for parsing AD2CP V3 average data.
© 2022 Nortek AS
Data Formats 89
© 2022 Nortek AS
90 Integrator's Guide
Name Description
VEL_NB Primary dimension of velocity data is number of beams. Length 0 if
correlation data in configuration bit map is false.
VEL_NC Second dimension of velocity data is number of cells pr beam. Length 0 if
correlation data in configuration bit map is false.
OFFSET Offset of data given at position 1 in this dataset. Number of bytes from start
of record to start of data.
AMP_NB Primary dimension of amplitude data is number of beams. Length 0 if
correlation data in configuration bit map is false.
AMP_NC Second dimension of amplitude data is number of cells pr beam. Length 0 if
correlation data in configuration bit map is false.
AMP_POS Correlation data starts after the amplitude data.
CORR_NB Primary dimension of correlation data is number of beams. Length 0 if
correlation data in configuration bit map is false.
© 2022 Nortek AS
Data Formats 91
© 2022 Nortek AS
92 Integrator's Guide
6.6 SpectrumDataV3
Extends: CurrentProfileDataV3
ID: 0x20
Data definitions for parsing AD2CP V3 amplitude spectrum data.
Name Description
© 2022 Nortek AS
Data Formats 93
6.7 _DF20BottomTrack
Extends: CommonData
Used By: DF20BottomTrackV1, DF20BottomTrackV9
Data definitions for parsing bottom track
© 2022 Nortek AS
94 Integrator's Guide
Beams, coords and 30 Bit 9-0 (10 bits) represent the number of cells (NC).
cells.Number of uint16
cells
Blanking 34 Distance from instrument to first data point on the
uint16 beam.
Raw data given as mm
Unit: [m]
Ambiguity velocity 52 Ambiguity velocity, corrected for sound velocity,
uint32 scaled according to Velocity scaling.
10^(Velocity scaling) m/s
Status 68/70 Status bit mask
32 bits Object reference given in table below
Velocity data OFFSET This field exists if the Velocity data included bit of
int32 the Config byte is set.
*VELOCITY_LENGTH Data scaled as product of 10^(Velocity Scaling)
Unit: [m/s]
Distance data DISTANCE_START This field exists if the Distance data included bit of
int32 *DIST_LENGTH the Config byte is set.
Unit: [m]
Name Description
68/70 The status field is at 68 or 70 depending on wether the ambiguity velocity is
16bit or 32bit long.
VELOCITY_LENGTH If velocity data in the configuration map is true, the velocity data is
numberOfBeams long. Else 0.
OFFSET Offset of data given at position 1 in this dataset. Number of bytes from start
of record to start of data.
DIST_LENGTH If distance data in the configuration map is true, the distance data is
numberOfBeams long. Else 0.
DISTANCE_START AHRS data starts after the velocity data. If there is no velocity data, the
distance data starts at offset to data.
© 2022 Nortek AS
Data Formats 95
6.8 DF20BottomTrackV1
Extends: DF20BottomTrack
ID: 0x17
Data definitions for parsing bottom track version 1. In the Signature integrators manual this is
referred to as DF20.
© 2022 Nortek AS
96 Integrator's Guide
Name Description
NB Figure of merit is of length numberOfBeams. That is, one figure of merit pr
beam. If the figure merit configuration bit is false, length is 0.
BT_START The start position of bottom track data is calculated from OFFSET, adding
velocityDataLength (if any) and distanceDataLength (if any).
AHRS_LENGTH AHRS data length is 16 floats. That is 64 bytes.
AHRS_START AHRS data starts after the bottom track data and the figure of merit data if
they are included.
6.9 DF20BottomTrackV9
Extends: DF20BottomTrack
ID: 0x17
Data definitions for parsing bottom track version 9.
© 2022 Nortek AS
Data Formats 97
Name Description
BT_START The start position of bottom track data is calculated from OFFSET, adding
velocityDataLength (if any) and distanceDataLength (if any).
NB Primary dimension of amplitude data is number of beams. Length 0 if
amplitude data in configuration bit map is false.
© 2022 Nortek AS
98 Integrator's Guide
Quality flags: If the instrument flags any velocity data, this will be displayed in the telemetry output as -
32.767 m/s (46.34 m/s speed, 225° direction).
© 2022 Nortek AS
Telemetry Data Formats 99
© 2022 Nortek AS
100 Integrator's Guide
1 Instrument type N, 4
4=Signature
2 Head ID SignatureFFF Signature100
FNNNNNN 0900002
3 Number of beams N 4
4 Number of cells N 20
5 Blanking (m) dd.dd 0.20
6 Cell size (m) dd.dd 1.00
7 Coordinate system N, 0
ENU=0,XYZ=
1,BEAM=2
8 Checksum *hh 2E
© 2022 Nortek AS
Telemetry Data Formats 101
Example (DF=100):
$PNORS,102115,090715,00000000,2A480000,14.4,1523.0,275.9,15.7,2.3,0.000,22.
45,0,0*1C
© 2022 Nortek AS
102 Integrator's Guide
19 Checksum *hh 22
Note that the amplitude can be converted to a dB scale by multiplying by 0.50 dB/count.
Information Data:
Identifier:
PNORI1 for DF = 101 (without tags)
PNORI2 for DF = 102 (with tags)
3 Number of NB N NB=3
Beams
Example (DF=101):
$PNORI1,4,123456,3,30,1.00,5.00,BEAM*5B
Example (DF=102):
$PNORI2,IT=4,SN=123456,NB=3,NC=30,BD=1.00,CS=5.00,CY=BEAM*68
Sensors Data:
Identifier:
PNORS1 for DF = 101 (without tags)
PNORS2 for DF = 102 (with tags)
© 2022 Nortek AS
Telemetry Data Formats 103
Example (DF=101):
$PNORS1,083013,132455,0,34000034,23.9,1500.0,0.02,123.4,45.6,0.02,R=23.4,0.
02,123.456,0.02,24.56*39
Example (DF=102):
$PNORS2,DATE=083013,TIME=132455,EC=0,SC=34000034,BV=23.9,SS=1500.0,HSD=0.02
,H=123.4,PI=45.6,PISD=0.02,R=23.4,RSD=0.02,P=123.456,PSD=0.02,T=24.56*3F
Averaged Data:
Identifier:
PNORC1 for DF = 101 (without tags)
PNORC2 for DF = 102 (with tags)
© 2022 Nortek AS
104 Integrator's Guide
© 2022 Nortek AS
Telemetry Data Formats 105
© 2022 Nortek AS
106 Integrator's Guide
Example (DF=103):
$PNORH3,DATE=141112,TIME=081946,EC=0,SC=2A4C0000*5F
Example (DF=104):
$PNORH4,141112,083149,0,2A4C0000*4A68
Sensors Data:
Identifier:
PNORS3 for DF = 103 (with tags)
PNORS4 for DF = 104 (without tags)
Example (DF=103):
$PNORS3,BV=33.0,SS=1546.1,H=151.1,PI=-12.0,R=-5.2,P=705.669,T=24.96*7A
Example (DF=104):
$PNORS4,33.0,1546.1,151.2,-11.9,-5.3,705.658,24.95*5A
Averaged Data:
Identifier:
PNORC3 for DF = 103 (with tags)
PNORC4 for DF = 104 (without tags)
© 2022 Nortek AS
Telemetry Data Formats 107
4 Averaged AC N AC=5
Correlation
5 Averaged AA N AA=28
Amplitude
Example (DF=103):
$PNORC3,CP=4.5,SP=3.519,DIR=110.9,AC=6,AA=28*3B
Example (DF=104):
$PNORC4,27.5,1.815,322.6,4,28*70
© 2022 Nortek AS
108 Integrator's Guide
7.2 Burst
The telemetry of the BURST mode is controlled by the SET/GETTMBURST command. The DF
parameter of this command sets the data format.
3 Number of NB N NB=3
Beams
4 Number of Cells NC N NC=30
Example (DF=101):
$PNORI1,4,1234,1,54,0.50,1.00,BEAM*58
Example (DF=102):
$PNORI2,IT=4,SN=1234,NB=1,NC=54,BD=0.50,CS=1.00,CY=BEAM*68
Sensors Data:
Identifier:
PNORS1 for DF = 101 (without tags)
PNORS2 for DF = 102 (with tags)
© 2022 Nortek AS
Telemetry Data Formats 109
Example (DF=101):
$PNORS1,083013,132455,0,34000034,23.9,1500.0,0.02,123.4,45.6,0.02,R=23.4,0.
02,123.456,0.02,24.56*39
Example (DF=102):
$PNORS2,DATE=083013,TIME=132455,EC=0,SC=34000034,BV=23.9,SS=1500.0,HSD=0.02
,H=123.4,PI=45.6,PISD=0.02,R=23.4,RSD=0.02,P=123.456,PSD=0.02,T=24.56*3F
© 2022 Nortek AS
110 Integrator's Guide
© 2022 Nortek AS
Telemetry Data Formats 111
© 2022 Nortek AS
112 Integrator's Guide
7.3 Altimeter
The telemetry for the Altimeter is controlled by the SET/GETTMALTI command. The DF parameter of
this command sets the data format. Individually telemetered altimeter data is always derived from the
Leading Edge algorithm.
Data format (DF) Description
200 NMEA (PNORA) format without Tags.
201 NMEA (PNORA) format with Tags.
Example (DF=200):
$PNORA,190902,122341,0.000,24.274,13068,08,-2.6,-0.8*7E
Example (DF=201):
$PNORA,DATE=190902,TIME=122341,P=0.000,A=24.274,Q=13068,ST=08,PI=-2.6,R=-
0.8*72
© 2022 Nortek AS
Telemetry Data Formats 113
Example (DF=300):
$PNORBT,3,112813,072228.2345,0.1234,0.1234,1.11111,122.2,36.66,2.22222,0*7A
Example (DF=301):
$PNORBT,BEAM=3,DATE=112813,TIME=072228.2345,DT1=0.1234,DT2=0.1234,BV=1.1111
1,FM=122.2,DIST=36.66,WV=2.22222,STAT=0*75
Example (DF=302):
$PNORBT,1,022621,080141.0010,0.0000,0.0000,-3.65949,6553.5,-
0.87,0.00000,00*09
$PNORBT,2,022621,080141.0010,0.0000,0.0000,8.32654,6553.5,-
0.87,0.00000,00*2D
$PNORBT,3,022621,080141.0010,0.0000,0.0000,-0.79181,6553.5,-
0.87,0.00000,00*09
© 2022 Nortek AS
114 Integrator's Guide
$PNORBT,4,022621,080141.0010,0.0000,0.0000,-0.79390,6553.5,-
0.87,0.00000,00*0C
$PNORS,022621,080141,00000000,28480002,15.5,1300.0,67.4,-13.0,84.9,0.000,-
86.04,0,0*64
Example (DF=303):
$PNORBT,BEAM=1,DATE=022621,TIME=080904.0010,DT1=0.0000,DT2=0.0000,BV=3.1428
0,FM=657.6,DIST=502.81,WV=0.00000,STAT=00*34
$PNORBT,BEAM=2,DATE=022621,TIME=080904.0010,DT1=0.0000,DT2=0.0000,BV=9.7591
8,FM=6553.5,DIST=-0.87,WV=0.00000,STAT=00*2E
$PNORBT,BEAM=3,DATE=022621,TIME=080904.0010,DT1=0.0000,DT2=0.0000,BV=-
2.13519,FM=6553.5,DIST=-0.87,WV=0.00000,STAT=00*04
$PNORBT,BEAM=4,DATE=022621,TIME=080904.0010,DT1=0.0000,DT2=0.0000,BV=-
2.34760,FM=6553.5,DIST=-0.87,WV=0.00000,STAT=00*0A
$PNORS,022621,080904,00000000,28480002,15.5,1300.0,67.7,-13.1,85.1,0.000,-
85.68,0,0*6F
Example (DF=304):
$PNORBT3,SP=9.094,DIR=336.3,FOM=6553,D1=-0.9,D2=-0.9,D3=-0.9,D4=-0.9*2F
Example (DF=305):
© 2022 Nortek AS
Telemetry Data Formats 115
$PNORBT4,1.787,330.1,2071,498.4,483.3,-0.9,501.8*24
© 2022 Nortek AS
116 Integrator's Guide
8 Appendix
8.1 Echosounder equations
F = frequency in kHz
Fc = center frequency in kHz, given by the FREQ parameter for the last beam, typically
BEAMCFGLIST,BEAM=5,FREQ
MajorAxis3dBBeamAngle:
GETUSERECHOMAJORANGLE values when EN=1:
MajorAxis3dBBeamAngleOffset:
GETUSERECHOMAJOROFFSET values when EN=1:
MinorAxis3dBBeamAngle:
GETUSERECHOMINORANGLE values when EN=1:
MinorAxis3dBBeamAngleOffset:
GETUSERECHOMINOROFFSET values when EN=1:
TwoWayBeamAngle:
GETUSERECHOTWOWAYANGLE values when EN=1:
Gain:
GETUSERECHOGAIN polynomial values when EN=1. When pulse compression is enabled the
polynomial expression shall define the gain over the bandwidth given by:
The bandwidth is given in % by the BW parameter for the last beam, typically
BEAMCFGLIST,BEAM=5,BW
© 2022 Nortek AS
Appendix 117
© 2022 Nortek AS