Response 6Eh, BREAKRET (Break sequence return)
Response Packet 6Eh is sent in response to the Command Packet 6Fh. Response Packet 6Eh returns the receivers' current serial port communication parameters, receiver version numbers and dates, and communication protocol settings when the remote device sends a 250 millisecond (minimum duration) break sequence.
Sending a break sequence
To initiate a break sequence return, the following events need to occur:
- The remote device sends a break sequence with a minimum duration of 250 milliseconds to the receiver. For example, pressing Ctrl + Break from an office computer is equivalent to sending a break sequence.
- The receiver detects the break signal and responds by setting the communication parameters for the serial port to 9600 baud, 8 data bits, no parity, and 1 stop bit.
- The receiver outputs an Identity Message through the serial port to the remote device.
The following table describes the structure of Report Packet 6Eh.
Byte |
Item |
Type |
Value |
Notes |
---|---|---|---|---|
0 |
STX |
1 (Char) |
|
Start transmission. |
1 |
STATUS |
1 (Char) |
See Receiver status byte. |
Receiver status indicator. |
2 |
PACKET TYPE |
1 (Char) |
6Eh |
Report Packet Type. |
3 |
LENGTH |
1 (Char) |
Data byte count. |
|
|
PRODUCT |
(Chars) |
Comma-delimited ASCII string |
Comma-delimited ASCII string indicating the receiver product family name. For more information, see Product. |
|
PORT SETTING |
(Chars) |
Comma-delimited ASCII string |
Comma-delimited ASCII string indicating the serial port settings and the break sequence acknowledgment code. For more information, see Port. |
|
PORT STATUS |
(Chars) |
“FIX” / “ADJ” |
FIX: Port settings cannot be changed. |
|
VERSION |
(Chars) |
Comma-delimited ASCII string |
Comma-delimited ASCII string indicating the software version number and version release date. For more information, see Version. |
|
COMM PROTOCOL |
(Chars) |
Comma-delimited ASCII string |
Comma-delimited ASCII string indicating the communication protocols supported on serial port. For more information, see Comm. |
|
SERIAL NUMBER |
(Chars) |
Comma-delimited ASCII string |
Comma-delimited ASCII string indicating the receiver serial number. |
|
NAME (optional) |
(Chars) |
Comma-delimited ASCII string |
Comma-delimited ASCII string indicating the receiver name and serial number. |
|
IP ADDRESS |
(Chars) |
Comma-delimited ASCII string |
Comma-delimited ASCII string indicating the IP address of the receiver. If no IP address is assigned or set, 0.0.0.0 is returned. |
|
WLANIP (optional) |
(Chars) |
Comma-delimited ASCII string |
Comma-delimited ASCII string indicating the receiver Wireless LAN IP address. If no IP address is assigned or set, 0.0.0.0 is returned. |
|
CORE VER |
(Chars) |
Comma-delimited ASCII string |
Comma-delimited ASCII string indicating the receiver firmware version number. |
|
CHECKSUM |
1 (Char) |
Checksum value. |
|
|
ETX |
1 (Char) |
03h |
End transmission. |
Identity message format
The following example shows the structure of an Identity Message:
<STX><0><0x6E><93>
PRODUCT,BD9xx;
PORT,1,38400,38400,8,1,N,F;
VERSION,4.70,12/20/12,,;
COMM,DCOL,NMEA;
SERIAL,1028014797;
NAME,BD920-W3G, 1028014797: Trimble BD920-W3G;
ETHIP,10.1.94.242;
WLANIP,192.168.142.1;
CORE_VER,4.70;
<CHECKSUM><ETX>
NOTE – The previous example shows the strings on separate lines for clarity, but the actual message is one continuous string of characters.
Detailed information about the four parameter strings is described in the following sections.
Product
For the receiver, the PRODUCT string is always set to BD9xx. The string always begins with the word PRODUCT, followed by a comma, followed by the word BD9xx, and terminated with a semicolon as in the following example:
PRODUCT,BD9xx;
Port
The PORT parameter is a comma-delimited string of ASCII characters describing the current input baud rate, output baud rate, data bits, stop bits, parity, and the break sequence status acknowledgment. The syntax of the comma delimited string is shown below:
PORT,input baud rate,output baud rate,data bits,stop bits, parity,boolean acknowledgement;
The string always begins with the word PORT, and the end of the string is always terminated with a semicolon character. Commas are used to delimit the other fields within the string.
The input and output protocols can be 2400, 4800, 9600, 19200, 38400, 57600, or 115k baud. The number of data bits is always set to 8, and the number of stop bits is always set to 1. The parity can be O (Odd), E (Even), or N (None). The string always identifies the current communication parameters defined for the port.
The final field in the string contains the boolean (T or F) code used to acknowledge the break sequence. A value of T (True) indicates that the communication parameters for the port are going to be set to 9600,8,N,1 for at least 5 seconds. A value of F (False) indicates that the receiver outputs the identity strings at 9600,8,N,1 and returns to the current port settings.
A sample string is shown below:
PORT,38400,38400,8,1,N,F;
Version
The VERSION parameter is a comma-delimited string of ASCII characters with the BD9xx firmware and hardware version numbers and release dates. The end of the string is terminated with a semicolon. The syntax of the comma-delimited ASCII string is shown below:
VERSION,software version number,version date,hardware version,version date;
The string always begins with the word VERSION, followed by the software version number and date and two commas ( , ). The slash character ( / ) is used to separate the month, day, and year in date fields. The string is always terminated with a semicolon character. The following example shows a sample string:
VERSION,0.81,5/20/11,,;
Comm
The COMM parameter is a comma-delimited string of communication protocols supported on the connected serial port. The string has the following syntax:
COMM,first protocol,...last protocol;
The string always begins with the word COMM and a comma, followed by the comma-delimited list of protocols. The string is terminated with a semicolon character. The following table identifies the ASCII codes assigned to the various protocols supported by the receiver:
Protocol |
Notes |
---|---|
DCOL |
Data Collector Format |
NMEA |
Outputs a subset of NMEA-0183 messages |
RTCM |
Radio Technical Commission for Maritime Services protocol specification RTCM SC-104 |
For example, the comma-delimited ASCII string for the connected serial port which supports DCOL and RTCM is shown below:
COMM,DCOL,RTCM;
Serial
The SERIAL parameter indicates the serial number of the unit.
Name
This is an optional parameter. If present, the NAME parameter indicates the model name of the unit and serial number.
ETHIP
The ETHIP parameter indicates the Ethernet IP address of the unit.
WLANIP
This is an optional parameter. If present, the WLANIP parameter indicates the Wi-Fi (or other Wireless LAN) IP address of the unit.
CORE_VER
The CORE_VER parameter indicates the version number of the firmware. For released firmware this will be the same as the VERSION parameter.