Copyright: © RD Instruments.  All rights reserved.
Citation: © RD Instruments.  All rights reserved.


Welcome

BBTalk is a dumb terminal emulator program.  This IBM-compatible program can capture raw data files and help troubleshoot configuration problems.  You can use BBTalk for serial or parallel communications in either an ASCII or Binary mode.  A binary-to-hexadecimal conversion feature lets you view and record the binary output data in a hexadecimal format.  A Log feature lets you record data to a disk file.

Help file revised January 24, 2005


Overview

	NOTE.  Move your cursor over sections of the graphic and click to go to the description.


Menus

File Menu	Use this menu to communicate with an ADCP and control the major functions of BBTalk.
Edit Menu	Use this menu to copy text from the Communication Window.  Highlight the text by clicking and dragging the mouse to select the text to be copied.  Click Edit, Copy.  The text will be copied to the Windows Clipboard.
View Menu	The View menu has controls to turn on or off the Tool Bar and the Status Bar.  You can select whether to view data in Hex or ASCII by clicking View, HEX/ASCII.  This will toggle between modes.  The Status Bar will show what mode BBTalk is in.
Transfer Menu	The Send Binary Command function only works when BBTalk is connected to a Narrowband ADCP.  The Command History function brings up a dialog box that allows you to view all of the commands that have been sent to the ADCP.  To resend a command, select the command from the scroll down list and click OK.  You may also use this dialog box to send a new command to the ADCP by typing a command in the Enter a Command window and pressing OK.   The PC Time function allows you to synchronize the ADCP time to the PC clock.   The Bytes in HEX Format allows you to send any character to the ADCP.  For example, if you type 4A in the dialog box, the "J" character will be transferred.
Tools Menu	The Tools, Options function configures the user preferences for BBTalk operation.


Tool Bar

The Tool Bar provides shortcuts to several options.

1.  New Connection

2.  Connect

3.  Disconnect

4.  Break

5.  Communication Properties

6.  Help


Communication Window

The Communication window shows the commands sent to the ADCP, and the ADCP's response.  If the text scrolls off the window, use the scroll bar on the right of the communication window to view the text.

You may enter any valid command at the ">" prompt.


Status Bar

The Status Bar tells you how the COM port is configured, whether the Script and Log functions are on or off, and whether BBTalk is in the ASCII or Hex mode.


Shortcut Keys

Key	Description
End	Sends a BREAK to the ADCP (wakes up the ADCP)
F1	Brings up the BBTalk Help file.
F2	Runs/Stops a script file.
F3	Starts/Stops recording data to a Log File.
F4	Switches between ASCII and Hex display
F5	Brings up the Communications Properties window
F8	This will connect the ADCP to the Com Port.
F9	This will disconnect the ADCP from the Com Port.
Ctrl+B	Sends binary data in a HEX format.  For example, typing "4142" and pressing enter sends the characters "AB" to the ADCP.
Ctrl+C	Copies content of the selected text in the communication windows
Ctrl+N	Connects to a new COM Port
Ctrl+PageDown	Recover the ADCP's internal recorder data.
Ctrl+T	Sends PC time to ADCP (synchronizes PC and ADCP clocks)
Ctrl+V	Sends clipboard content to the ADCP.
Up	Shows the command history window


Setup Communications With an ADCP

Before you can establish communications with the ADCP you must first configure BBTalk.

1.	At the Connect To screen, select the type of ADCP you are connecting to from the list.  Select the COM port the ADCP is connected to.  Click Next.

2.	On the Port Settings screen, select the baud rate, parity, and stop bits.  Click Next.

3.	On the Options screen, select the desired settings.

•	Send Break On New Connection – As soon as BBTalk starts, it will send the ADCP a Break.

•	Connect to Last Open Port On startup – BBTalk will immediately start without going through the configuration screens.

•	Overwrite Log Files When Opening – Log files with the same name will be overwritten.

•	Error Checking for Script Files – Check the Script file for errors before running.

•	Send CK On Baud Rate Change (CB Command) – Automatically sends a CK command to WorkHorse and BroadBand ADCPs to save the baud rate after the baud rate has been changed using the CB command.

4.	Click Finish.

	NOTE. Select Connect to Last Open Port on Startup to skip the setup wizard and start BBTalk using the last communication parameters.  Use the Tools, Options menu to bring up the Options screen if you want to make changes while BBTalk is running.


Use Direct Commands to Deploy the ADCP

RDI recommends that you use our software programs WinSC, VmDas, or WinRiver, etc. as your primary method of deployment.  If this is not possible in your deployment then we strongly recommend that the commands shown in the Table below be the minimum commands you send to the instrument.

	CAUTION.  RDI does not recommend the use of direct commands as your primary way of deploying ADCPs as any incorrect command setting can have severe consequences to your data collection.   See the WorkHorse Commands and Output Data Format Guide for information on each command setting.
ADCP Minimum Required Commands for Deployments

Command	Description
CR1	This command will set your ADCP to a known factory default setting and must be your first command
CFxxxxx	This command will set your ADCP collection mode; binary, recorder, etc.
EAxxxxx	This command will set your magnetic compass offset for true north
EDxxx	This command will set your ADCP depth
ESxx	This command will set your ADCP’s expected salinity
EXxxxxx	This command will set your ADCP’s coordinate system; earth, beam, etc.
EZxxxxxxx	This command will set what sensors will be used by your ADCP; heading, pitch, roll, temp, etc.
WNxx	This command will set the number of depth cells to collect
WPxx	This command will set the number of pings to average
WSxxxx	This command will set the depth cell size to use
TExxxxxxxx	This command will set the time between ensembles
TPxxxxxx	This command will set the time between pings
CK	This command will save your setup to the internal RAM and must be your second to last command
CS	This command will start your deployment and must be your last command
	CAUTION.  Although these are our recommended minimum commands, they may not be the only commands you need for your deployment to be successful!
	NOTE.  Your deployment may require additional commands and these commands can be sent any time after the CR1 command but must before the CK command.


Wakeup the ADCP

Wakeup is the process of establishing communication with the ADCP.  Immediately after you apply power to the ADCP, it enters the Standby mode.  Sending a BREAK signal from a BBTalk awakens the ADCP.  When the ADCP receives a BREAK signal, it responds with the wake-up message.  The ADCP is now ready to accept commands at the ">" prompt.

1.	Click File, Send a Break to send the wakeup command (BREAK) to the ADCP.

2.	The ADCP wake-up (copyright) message should appear.

xxxxxx ADCP Version x.xx

RD Instruments (c) xxxx

All rights reserved.

>

3.	If there is no response from the ADCP, click File, Properties to check the communications setup.  Both the ADCP (see the technical manual for communication settings) and BBTalk must be using the same communication settings.

	NOTE.  Pressing End or using the "B" button on the tool bar also sends a break. If the display shows "garbage" text when a break is sent, this indicates a baud mismatch.  If there is no response when a break is sent, this indicates a problem with the setup (i.e., cable problem, COM port, or ADCP.).
 See Also

Shortcut Keys


Run a Script File

1.	On the File menu, click Send Script File.

2.	At the Recent Files dialog box, select the script file to run from the scroll down list or use the button to the right of the file select box and browse for a script file to open.

3.	Click OK.

	NOTE. Pressing F2 also runs a script file.
 See Also

Shortcut Keys


Create a Script File

You can control what BBTalk sends and captures by writing BBTalk script files.  Script files are simply ASCII files produced by ASCII editors such as MS-DOS EDIT, NotePad, or EDLIN.  In general, they contain ASCII characters that are sent out through the serial port.  In addition, BBTalk script files can contain embedded commands that control the behavior of BBTalk as it interprets the script file:

•	All lines in the script file except those beginning with a ‘$’ or a ‘;’ character are sent out through the serial port delimited with a Carriage Return <CR> (A line feed character <LF> = ASCII 10 decimal is NOT sent).

•	Lines containing a semi-colon ‘;’ = ASCII 59.  If the first character of a line containing a semi-colon is not a '$' character, then all characters preceding the semi-colon are sent followed by a <CR>.  All characters following the semi-colon (including the semi-colon) are ignored.  This feature is to provide file comments that the user may insert for script file clarity.

•	Lines beginning with a dollar sign ‘$’ = ASCII 36 decimal are script file control commands.

To write your own script file, do the following.

1.	Create an ASCII text file.  Use a text editor such as NotePad.  Use the *.rds extension when saving the file.

2.	To send a command to the ADCP, use one command per line.  BBTalk will automatically add a carriage return after the command is sent.

3.	To add comments to your script file, add a semicolon to the beginning of the line.  BBTalk will ignore all comments.

4.	To use a BBTalk script file command, add one command per line.

 See Also

Script File Commands

Example Script File


Script File Commands

The following are legal script commands:

$A	Switch to ASCII display.
$B	Sends a <BREAK>.
$COM:bbbbb,p,d,s	Sets up BBTALK communication parameters: bbbbb = baud rate (1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200) p = parity (N = none, E = even, O = odd) d = number of data bits (7 or 8) s = number of stop bits (1 or 2)
$Dnnnn	Delays nnnn seconds.  For example, $D0.5 will delay 0.5 seconds.
$F	Finds the correct COM Port settings of the ADCP.
$H	Switch to HEX display.
$Lfilename.ext	Toggle logging.  If the file name is missing and logging is to be turned on, then a window pops up asking for the log file name.  Type in the file name and press the enter key to continue.  If the file already exists, data will be overwritten.
$lfilename.ext	Same as above, except a lower case "L" is used.  If the file already exists, data will be appended.
$Ptext to screen	Prints "[ext to screen]" on the screen and also in log file if logging (useful for comments).
$N	Allows you to send Narrowband binary command syntax.
$R	Repeats script file (remainder of script file is ignored.
$Sxx	Send binary data (in HEX format).  For example, $S41 will send "A" to the ADCP.
$T	Sets the ADCP clock to the PC clock time.
$tcccc	Sends any text after the "$" and a CR/LF.  For example, $t$GGA will send $GGA and a CR/LF to the ADCP.
$Wddd,nnn	Wait for character ddd ASCII (Decimal representation).  If nnn is missing, it waits forever.  $W62 means wait for the  ">" prompt forever.
$W"c",nnn	The same as above, but "c" is represented as a character.  $W">",2 means wait for the prompt for a maximum of two seconds and than continue.
$X	Exits BBTalk.


Example Script File

The following example is a printout of the script file testWH.rds (see Test an ADCP).

;-------------------------------------------------------------------------

;                                TESTWH.RDS

;                Script file for testing RD Instruments WorkHorse

;                        ADCP with the BBTalk program

;         Copyright (C) 2001 by RD Instruments - All rights reserved

;       Licensed for exclusive use with RD Instruments products or data

;-------------------------------------------------------------------------

;-------------------------------------------------------------------------

; RDI - WH ADCP testing script file:

; FILE name = "TESTWH.RDS"

; 1 November 2001

; Modified by RDI on:

; none

$LWH_TESTS.TXT

$P =======================================================================

; Print the following lines.

$P WH ADCP Test

$P *************

$P

$P The following tests are basic tests which will confirm that your system

$P is ready for use.  Some tests will need to be run with the system in

$P water.  You will be prompted when this is necessary.

$P

$P Connect the WH ADCP to power and the PC as described in the manual.

$P Turn on power to the WH ADCP.

$P

$P The results of all tests will be printed to the screen and saved to the

$P log file WH_TESTS.TXT.   A file called WH_TESTS.TXT with the results of

$P this test will be created in the same directory as the BBTalk program

$P is running from.

$P

$P             The following tests will be performed:

$P

$P              PA    Basic Internal System Tests

$P              PC2   Sensor Verification Test

$P              PC1   Beam Continuity Test

$P

$P Program is delaying 20 seconds before continuing.

$P Press <Enter> to continue.

$W62,20

$P =======================================================================

$P

$P PA -- Basic Internal System Tests

$P The following tests will verify that the internal electronics are

$P performing correctly.  These tests are best run when the transducer

$P face is submerged in water.  A bucket of water deep enough to cover

$P the transducer beams is all that is needed.  If done in air some tests

$P may fail.

$P

$P Program is delaying 10 seconds before continuing.

$P Press <Enter> to continue.

$W62,20

$P =======================================================================

$P

$P Sending a break to Wake Up the System

$B

$D2

$P =======================================================================

$P

$P Restoring factory defaults into temporary memory for TEST.

$P

CR1

$D1

$P =======================================================================

$P

$P Collecting system specific data.

TS?

$D1

PS0

$D1

PS3

$D1

$P =======================================================================

$P

$P Starting the Automated Tests.

PA

$W62,100

$P

$P All of the above tests should have passed. Review the file WH_TESTS.TXT

$P to verify your tests results.  Remember that some tests will fail

$P unless the transducer is immersed in water.  Consult your Technical

$P Manual for trouble shooting tips if this test did not pass.

$P

$P

$P Program is delaying 15 seconds before continuing.

$P Press <Enter> to continue.

$W62,15

$P =======================================================================

$P

$P PC2 -- Sensor Verification Test

$P The following test will confirm that your heading, pitch, roll,

$P temperature, orientation sensor, and pressure sensor (if installed) are

$P operating.   You should turn and tilt the ADCP and confirm that changes

$P occur in the heading, pitch, and roll.  Verify that the Up/Down setting

$P agrees with the direction of your ADCP transducer.  Verify that the

$P ambient temperature and pressure are reasonable values.

$P

$P This test in itself does not calibrate or confirm the accuracy of the

$P sensors.  However, if you turn and till the ADCP while comparing the

$P output to a known reference then you can confirm the accuracy.

$P

$P The following test is best run when the transducer face is in air and

$P the transducer is pointing the direction you intend to deploy the

$P instrument.

$P

$P This test will continue to run until you stop the test.

$P

$P Program is delaying 20 seconds before continuing.

$P Press <Enter> to continue.

$W62,20

$P =======================================================================

$P

$P Sending a break to Wake Up the System

$B

$D2

$P =======================================================================

$P

PC2

$W62,1000

$P

$P The Sensor test is complete.  The heading, pitch, roll sensors should

$P have changed as you turned and tilted the system.  The Up/Down setting

$P should have agreed with the direction of your ADCP transducer. The

$P ambient temperature and pressure (if installed) should have been

$P reasonable values.

$P

$P All of the above tests should have passed. Review the file WH_TESTS.TXT

$P to verify your tests results.  Consult your Technical Manual for trouble

$P shooting tips if this test did not pass.

$P

$P Program is delaying 10 seconds before continuing.

$P Press <Enter> to continue.

$W62,10

$P

$P =======================================================================

$P

$P PC1 -- Beam Continuity Test

$P The following test will confirm that each of the beams on your

$P transducer is capable of receiving signals.  This test must be run in

$P air and free of external interference to pass.

$P

$P This test will require you to rub each of the beams on the transducer.

$P This is done with quick rubbing movements across each of the urethane

$P faces.

$P

$P Program is delaying 25 seconds before continuing.

$P Press <Enter> to continue.

$W62,25

$P =======================================================================

$P

$P Sending a break to Wake Up the System

$B

$D2

$P =======================================================================

$P

PC1

$W62,1000

$P

$P The Beam Continuity test is complete.  Each of the beams should have

$P passed.  Review the file WH_TESTS.TXT to verify your tests results.

$P Consult your Technical Manual for trouble-shooting tips if this test

$P did not pass.

$P

$P =======================================================================

$P All tests have been run and if passed your system is ready for

$P deployment.

$L


Test an ADCP

1.	Connect the ADCP to the computer as described in the ADCP Technical Manual.

2.	Setup the communication parameters between BBTalk and the ADCP.

3.	Click File, Send a Break to send the wakeup command (BREAK) to the ADCP

4.	On the File menu, click Send Script File.  Click the Browse button.

5.	Select a script file from the table below.  The results of the tests will be saved to a log file.

Script File Name	ADCP Type	Results Saved to
TestBB.rds	Broadband	BB_TESTS.txt
TestOS.rds	Ocean Surveyor	OS_TESTS.txt
TestWH.rds	Workhorse	WH_TESTS.txt
6.	Follow the prompts on the screen.

7.	To review the test results, open the corresponding results log file.

 See Also

Shortcut Keys


Create a Log File

The Log feature lets you record data to a disk file.  You can enable logging at any time.  The Status Bar shows the Log status.  To use Log, do the following steps.

1.	On the File menu, click Log to File.

2.	Select a Log file to open, or use the button to the right of the file select box and browse for a Log file to open.  If you want to create a new Log file, type in a file name and click Save.

3.	If the file already exists, the program asks you if you want to overwrite the existing file.  Click Yes if you want to overwrite the file, otherwise click No and select another Log file name.

4.	The Log indicator on the Status Bar will indicate F3: Log On and start flashing.  All data sent to the screen will now be written to the file you specified.  You can enable the Log feature at any time, even if the ADCP is already sending data.

5.	Select File, End File Logging to stop writing to the Log file.  The Log indicator on the Status Bar will indicate F3: Log Off and stop flashing.

 See Also

Shortcut Keys


Send Commands to the ADCP

1.	Setup the communication parameters between BBTalk and the ADCP.

2.	Wake-up the ADCP by pressing End.

3.	At the ">" prompt in the communication window, enter the direct command you wish to send to the ADCP and then press the Enter key.  Refer to the ADCP Technical Manual for a listing of all direct commands and their format.

 See Also

Setup Communications with an ADCP

Wakeup the ADCP

View the Command History


Send Binary Commands to a NarrowBand ADCP

1.	Setup the communication parameters between BBTalk and a Narrowband ADCP.

2.	Wake-up the ADCP by pressing End.

3.	On the Transfer menu, select Send Binary Command.  Enter the binary command you wish to send to the ADCP and then press the Enter key.  Refer to the Technical Manual for a listing of all direct commands and their format.


View the Command History

1.	On the Transfer menu, click Command History.

2.	Use the scroll bar to view all of the commands sent to the ADCP.

3.	To resend a command, click a command in the list and click OK.

4.	To send a new command, type the command in the window and click OK.


Recover Data from the ADCP

1.	On the File menu, click Recover Recorder.

	NOTE. This option is available for WorkHorse and BroadBand ADCPs only.

2.	 Enter the directory where the files will be downloaded.  Click OK.

3.	 Select the file to recover by clicking on the file name or check the Select All Files box to recover all of the files.  Click OK.

4.	BBTalk displays current protocol status, filename being received, total size of receiving file and current number of bytes received.   To speed up data recovery, check the Disable Window Output box.


Recover Data from the Loop Recorder

1.	On the File menu, click Recover Loop Recorder.

	NOTE. This option is available for Channel Master ADCPs only.
2.	Enter the directory where the files will be downloaded.  Click OK.

3.	BBTalk displays current protocol status, filename being received, total size of receiving file and current number of bytes received.


Customize BBTalk

Click Tools, Options.  Select which of the following options you want BBTalk to do when the program is run.

•	Send Break On New Connection – As soon as BBTalk starts, it will send the ADCP a Break.

•	Use Software Break (= = =) with Radio Modems – When BBTalk is instructed to send a Break, the "= = = " is sent instead.

•	Connect to Last Open Port On startup – BBTalk will immediately start without going through the configuration screens.

•	Overwrite Log Files When Opening – Log files with the same name will be overwritten.

•	Error Checking for Script Files – Check the Script file for errors before running.

•	Send CK On Baud Rate Change (CB Command) – Automatically sends a CK command to WorkHorse and BroadBand ADCPs to save the baud rate after the baud rate has been changed using the CB command.

•	Echo Characters – BBTalk will echo typed characters on the screen.