B&B Electronics Command Response Protocol HVD100A3 User manual

HDV100A3 Command & Response Manual-1306cr Cover Page
B&B Electronics -- 707 Dayton Rd. -- PO Box 1040 -- Ottawa, IL 61350
PH [phone] -- FAX [phone]
Model: HVD100A3
HDV100A3 Command
Response Protocol
Documentation Number: HDV100A3-4407CR
International Headquarters
B&B Electronics Mfg. Co. Inc.
707 Dayton Road -- P.O. Box 1040 -- Ottawa, IL 61350 USA
Phone [phone] -- General Fax [phone]
Home Page: www.bb-elec.com
Sales e-mail: [e-mail] -- Fax [phone]
Technical Support e-mail: [e-mail] -- Fax [phone]
©B&B Electronics -- November 2005

HDV100A3 Command & Response Manual-1306cr Table of Contents i
B&B Electronics -- 707 Dayton Rd. -- PO Box 1040 -- Ottawa, IL 61350
PH [phone] -- FAX [phone]
Table of Contents
INTRODUCTION........................................................................................ 1
Intelligent Mode Command Protocol..................................................... 2
Formatting the Control Bytes ................................................................ 3
DETAILED DESCRIPTION OF GENERAL FUNCTION CODES...... 4
Command Acknowledgement................................................................. 4
RS-232 Baud Rate Setup........................................................................ 5
Setting Baud 1, Baud 2........................................................................... 7
Baud Rate Example................................................................................ 8
Time Stamp Information ........................................................................ 9
Master Reset Command....................................................................... 11
Vendor Information.............................................................................. 11
J1708 COMMANDS.................................................................................. 12
Receiving Data from the J1708 Bus..................................................... 12
Transmitting Data to the J1708 Bus.................................................... 14
Set Filter Active.................................................................................... 16
Set Filter Off ........................................................................................ 16
Broadcast Message.............................................................................. 17
J1939 COMMANDS.................................................................................. 19
Start Receive on J1939 Bus.................................................................. 20
Stop Receive on J1939 Bus .................................................................. 20
Arbitration Field (Y1, Y2, Y3, Y4)........................................................ 21
Transmit Data to J1939 Bus ................................................................ 23
Set Mask............................................................................................... 23
Set Filter 1 to 4 .................................................................................... 24
J1939 Header Worksheet..................................................................... 26
ERROR CODES ........................................................................................ 27

ii HDV100A3 Command & Response Manual-1306cr
B&B Electronics -- 707 Dayton Rd. -- PO Box 1040 -- Ottawa, IL 61350
PH [phone] -- FAX [phone]
WARNING!
This Model HDV100A3 Converter Module allows
you to connect to active J1708 / J1939 networks.
It is possible that your transmissions through this
converter module could cause malfunction of the
network operation, damage to software or
equipment, or bodily harm.
Do Not Transmit Any Messages to the network
without a complete understanding
of the operation of the network.
B&B Electronics Mfg. Co. specifically disclaims
any responsibility for damage or injury to
software, hardware, equipment or persons as a
result of using this product.
WARNING!

HDV100A3 Command & Response Manual-1306cr 1
B&B Electronics -- 707 Dayton Rd. -- PO Box 1040 -- Ottawa, IL 61350
PH [phone] -- FAX [phone]
Introduction
The HDV100A3 adapter has two modes of operation: J1708 Intelligent and
J1939 Intelligent mode In Intelligent mode the HDV100A3 works with a
command protocol to control different operations of the HDV100A3.
The HDV100A3 performs several functions in the intelligent mode in order
to reduce the overhead and timing requirements of the host application when
communicating with the J1708 bus. The device handles collision detection
and retries with no additional interaction from the host application. This
greatly reduces the processor overhead required by the host in order to
communicate efficiently with the J1708 bus.
Note that the HDV100A3 is powered from the vehicle side of the interface.
If the device is to be used without a vehicle, it will be necessary to connect
power to the device through the 15-pin connector. Positive voltage is
connected on pin 8. Pin 7 is connected to ground.
Intelligent Mode Verification
To confirm that the HDV100A3 is in the Intelligent mode, set the host baud
rate to 115.2 KB 8,1,N. The host application can request the vendor number
from the HDV100A3 This is done by sending the following string in hex
from the host to the HDV100A3:
(01, 01, 05, 00, 07)
It will respond as follows:
Hex (01, 0B, 85, MM, DD, MA, M1, M2, MO, 00, VV, VV, 00, DB, CS)
An example of this command can be found on page 12 of this document.
The HDV100A3 does not need to be connected to a vehicle to respond,
however power must be supplied the HDV100A3.

2 HDV100A3 Command & Response Manual-1306cr
B&B Electronics -- 707 Dayton Rd. -- PO Box 1040 -- Ottawa, IL 61350
PH [phone] -- FAX [phone]
Intelligent Mode Command Protocol
The HDV100A3 uses a simple protocol to communicate to vehicle bus. The
protocol is divided into four parts:
Start Of Frame (SOF)
Control Field (shown in light gray)
Data Field (shown in dark gray)
Checksum (CS)
Intelligent Mode Message Structure
SOF Number of
Control Bytes Control Bytes Number of Data Bytes Data Bytes CS
1 byte 1 byte 1 to 20 bytes 1 byte 1 to 100 bytes 1 byte
The Start of Frame byte is the first byte in a valid frame and is
always 01 hex.
The Control Field sets up the function and control of the
HDV100A3 hardware and is formatted as shown below.
Control Field Structure
Number of Control
Bytes to Follow ID Byte Function Byte Control Data Bytes
1 byte 1 byte 1 byte Up to 20 bytes
The first byte of the Control Field is the number of control bytes in
the message. This value indicates the number of control bytes, excluding
itself, to follow. If the message doesn’t contain any control bytes, the
Number of Control Bytes value will be set to 00 hex as a placeholder.
The next part of the message frame is the data field. The data field
is preceded by the number of data bytes, excluding itself, to follow and is set
to 00 hex if no data is present in the message. The data field is reserved for
data that is to be communicated to the vehicle bus.
Data Field Structure
Number of
Data Bytes Data Bytes
1 byte Up to 100 bytes
The last element of a valid message is the checksum. The checksum
is calculated by adding ALL bytes from the Start of Frame (inclusive) to the
last data byte and using the last 8 bits as a checksum.

HDV100A3 Command & Response Manual-1306cr 3
B&B Electronics -- 707 Dayton Rd. -- PO Box 1040 -- Ottawa, IL 61350
PH [phone] -- FAX [phone]
Formatting the Control Bytes
The 2nd byte is “Number of Control Bytes” to follow and always
precedes the control field. The third byte is the ID byte. This byte tells the
hardware where to direct the message. Valid entries for functions are:
ID Codes
=01 Message for J1708
=02 Message for J1939
=08 General message (for control of the HDV100A3 device)
=05 Device identification (reverse compatible)
The fourth byte is the function byte. The functions that are
supported are listed below. Note that some of the function codes are
followed by additional bytes of information. These bytes must be included in
the control byte count.
Valid General Function Codes
Function codes
=01 change PC baud rate, followed by 3 bytes (UB3, Baud1, Baud2)
=02 send time stamp
=04 hardware handshaking
=08 reset converter, followed by 2 bytes (01,and 02)
=10 time stamp off
=20 time stamp on
Valid Entries for J1708 Functions
Function codes = 07 set broadcast message
= X8 set filter X off
= X9 set filter X on
= 11 Sync with J1708 bus and start reception
= 10 Stop reception
= 12 Transmit to J1708 bus
Valid Entries for J1939 Functions
Function codes =00 Receive off
=01 Receive on
=02 Transmit message
=08Setmask
=X8 set filter X off
=X9 set filter X on

4 HDV100A3 Command & Response Manual-1306cr
B&B Electronics -- 707 Dayton Rd. -- PO Box 1040 -- Ottawa, IL 61350
PH [phone] -- FAX [phone]
Detailed Description of General Function Codes
Command Acknowledgement
All commands sent to the device will be acknowledged. If no error occurs an
ACK will be sent with the ID byte that accompanied the command. If an
error occurred, a NACK will be sent with the ID byte that accompanied the
command as well as a Function code of $05 and the Error Code. The
responses will not be shown for each command since it is the same for
almost all commands. Below is the format of the ACK/NACK response. If
an ACK/NACK response is different for a particular command, it will be
specified.
ACK/NACK Format:
Byte
Number Byte Value Function
1 01 Start of frame
2 01 or 03 Number of control bytes = 1 for ACK, 3 for NACK
3 aa ID byte 08 = internal command
4 bb Function code 02 = send time stamp
5 cc
6 00 Number data bytes
7 CS Checksum
aa – ID Byte
$01 = J1708 Interface
$02 = J1939 Interface
$05 = Device Id
$08 = RS-232 Interface
$09 = Message Xmit OK Response
bb – FC Byte
None = Command Received and Valid
$05 = A error was detected, NACK
cc – CD Byte
None = No Error Condition
Error Code = See Section 5.10

HDV100A3 Command & Response Manual-1306cr 5
B&B Electronics -- 707 Dayton Rd. -- PO Box 1040 -- Ottawa, IL 61350
PH [phone] -- FAX [phone]
RS-232 Baud Rate Setup
To set the baud rate for the RS-232 port, set a general command code of 08.
Set the function code to 01. Then set 3 control bytes as follows.
Function Start
of
Frame
Control
Bytes Command Code Function Code UB3 Baud 1 Baud 2 Data Bytes Check Sum
Byte # 1 2 3 4 5 6 8 9 10
Value 01 05 08 01 00
Setting UB3
Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0
Divisor
Latch Set Break Set Parity Even Parity Parity Enable Stop Bits Word Length 1 Word Length 0
Bit 7 = 1 allows baud rate divisor to be changed. 0 baud rate change is
blocked. Bit 7 should not be set. The setting and resetting of this bit is
handled internally.
Bit 6 = 1 forces the transmitter output to a logic 0 for alerting the remote
receiver to a line break. 0 indicates no break condition.
Bit 5, 4 and 3 work together to set parity
Bit 5 Bit 4 Bit 3 Parity Selection
* * 0 No parity (default)
0 0 1 Odd parity
0 1 1 Even parity
1 0 1 Force parity “1”
1 1 1 Force parity “0”
*Don’t care state.
Bit 2, stop bit, works in conjunction with bits 1 and bit 0
Bit 2 Word Length (bits) Stop Bit Length
0 5,6,7,8 1 (default)
1 5 1½
1 6,7,8 2

6 HDV100A3 Command & Response Manual-1306cr
B&B Electronics -- 707 Dayton Rd. -- PO Box 1040 -- Ottawa, IL 61350
PH [phone] -- FAX [phone]
Bits 1 and 0 set the word length
Bit 0 Bit 1 Word Length
0 0 5
0 1 6
1 0 7
1 1 8 (default)
Default value. The HDV100A3 should always be set to 8-bit word length.

HDV100A3 Command & Response Manual-1306cr 7
B&B Electronics -- 707 Dayton Rd. -- PO Box 1040 -- Ottawa, IL 61350
PH [phone] -- FAX [phone]
Setting Baud 1, Baud 2
Baud Rate Setup Table
Baud
Rate Decimal Divisor Hex Divisor MSB (Baud 2) Hex Divisor LSB (Baud 1)
9600 48 $00 (default) $30 (default)
14400 32 $00 $20
19200 24 $00 $18
38,400 12 $00 $0C
57,600 8 $00 $08
115,200 4 $00 $04
230,400 2 $00 $02
460,800 1 $00 $01
All baud rates are entered as hex numbers. To calculate your own
decimal divisor use the following formula. The decimal number must be
converted to hexadecimal before entering the number. Baud rates below
9,600 are not recommended because of the difference in speed between the
vehicle bus and PC serial port. Additionally, baud rates faster than 115,200
baud are not supported.
The UART clock = 7,372,800 Hz
Decimal Divisor = Clock frequency ( 7,372,800)
Baud output x 16
If you want a baud rate of 9,600 baud
Decimal Divisor = 7,372,800
9,600 x 16
Decimal Divisor = 48 = 30 hex
Baud 1= 30
Baud 2= 00

8 HDV100A3 Command & Response Manual-1306cr
B&B Electronics -- 707 Dayton Rd. -- PO Box 1040 -- Ottawa, IL 61350
PH [phone] -- FAX [phone]
Baud Rate Example
To set the PC baud rate to 57,600 baud, N,8,1, format the message as
follows.
Byte
Number Byte Value
Hex
Byte Function
1 01 Start of frame
2 05 Number of control bytes
3 08 Command byte (08 = internal command)
4 01 Function Bbte (01 = change baud)
5 03 UB3
6 08 Baud 1
7 00 Baud 2
8 00 Number of data bytes
9 1A Checksum
The first byte is the start of frame and always 01. Next is the
number of control bytes (05). There are 5 bytes in the control section (in
gray). Byte number 3 sets the HDV100A3 to an internal operation (08). Byte
4 is the internal function to be executed; (01) is the change baud command.
Bytes 5, 6, and 7 set the baud rate, parity, stop bits and word length. Next is
the number of data bytes, in this case there are no data bytes. Last is the
checksum, the value is the 8 bit addition of bytes 1 to 8.

HDV100A3 Command & Response Manual-1306cr 9
B&B Electronics -- 707 Dayton Rd. -- PO Box 1040 -- Ottawa, IL 61350
PH [phone] -- FAX [phone]
Time Stamp Information
The HDV100A3 supports a four-byte rolling time stamp with a
resolution of 1.5 microseconds per bit. The maximum time stamp value is
6,442.45 seconds before roll over. The 4-byte time stamp will be added to all
transmission from the bus. The time stamp will be added to the transmission
confirmation message.
The host application can request that the HDV100A3 send a time
stamp, formatted as follows.
Byte
Number Byte Value Function
1 01 Start of frame
2 02 Number of control bytes
3 08 ID byte 08 = internal command
4 02 Function code 02 = send time stamp
5 00 Number data bytes
6 0D Checksum
Reply from HDV100A3
Byte
Number Byte Value Function
1 01 Start of frame
2 05 Number of control bytes
3 0A ID 0A = time stamp
4 XX Time msb
5 XX Time msb-1
6 XX Time msb – 2
7 XX Time lsb
8 00 Data bytes 00
9 CS Checksum
The time stamp is attached to all messages received from the
vehicle bus as part of the control header. After the start of frame byte, the
number of control bytes, ID byte and the next 4 bytes are the time stamp.
The fourth byte is the MSB the seventh byte is the LSB.
Message time stamping is the default condition when the
HDV100A3 is placed in the smart mode. To stop the time stamp from being
added to the J1708 message, send the following command to the
HDV100A3.

10 HDV100A3 Command & Response Manual-1306cr
B&B Electronics -- 707 Dayton Rd. -- PO Box 1040 -- Ottawa, IL 61350
PH [phone] -- FAX [phone]
Byte
Number Byte Value Function
1 01 Start of frame
2 02 Number of control bytes
3 08 ID byte 08 = internal command
4 20 Function code 20 = stop time stamping
5 00 Number data bytes
6 2B Checksum
To resume time stamping send the following command:
Byte
Number Byte Value Function
1 01 Start of frame
2 02 Number of control bytes
3 08 ID byte 08 = internal command
4 10 Function code 10 = resume time stamping
5 00 Number data bytes
6 1B Checksum
Time stamping will resume after reset.

HDV100A3 Command & Response Manual-1306cr 11
B&B Electronics -- 707 Dayton Rd. -- PO Box 1040 -- Ottawa, IL 61350
PH [phone] -- FAX [phone]
Master Reset Command
The master reset command allows the HDV100A3 to be reset from the PC.
Sending this command resets the HDV100A3 to the default start-up state.
You will lose all setting sent in the smart mode.
Byte
Number Byte Value Function
1 01 Start of frame
2 04 Number of control bytes
3 08 ID byte 08 = internal command
4 08 Function code 08= master reset
5 01 Check byte
6 02 Check byte
7 00 Number data bytes
8 18 Checksum
Note: after sending a master reset the baud rate is 115,2k (default).
Vendor Information
To receive the vendor information from the HDV100A3 send hex (01, 01,
05, 00, 07) to the device. It will respond as follows:
Hex (01, 0B, 85, MM, DD, MA, M1, M2, MO, 00, VV, VV, 00, DB, CS)
0B = Number of control bytes
85 = Compatibility with other models
MM = Month firmware was created
DD = Day firmware was created
MA = Major firmware revision number
M1 = MSB of minor firmware revision
M2 = LSB of firmware revision
MO = Model
VV = Customer code 1
VV = Customer code 2
DB = Number of data bytes
CS = Checksum

12 HDV100A3 Command & Response Manual-1306cr
B&B Electronics -- 707 Dayton Rd. -- PO Box 1040 -- Ottawa, IL 61350
PH [phone] -- FAX [phone]
J1708 Commands
Receiving Data from the J1708 Bus
After the HDV100A3 is set into its Intelligent mode of operation
and the RS-232 data rate is configured, you are now ready to communicate
with the J1708 bus. A receive command must be sent to the HDV100A3
before attempting to transmit to the bus. The receive message synchronizes
the HDV100A3 with the bus. To start receiving J1708 bus data, send the
following to the HDV100A3.
Byte
Number Byte Value (hex) Byte Function
1 01 Start of frame
2 02 The number of control bytes
3 01 ID byte 01= J1708
4 11 Function code 11 hex start receive
5 00 Number of data bytes (00 place holder)
6 15 Checksum (bytes 1 through 5 added together)
After sending this command to the device, the device will respond
with a confirmation message. The message confirms that the command was
received by the HDV100A3 and the checksum verified correctly. The reply
from the device is formatted as follows:
Byte
Number Byte Value (hex) Byte Function
1 01 Start of frame byte
2 01 Control byte
3 01 ID byte (ID of the sent message)
4 00 Number of data bytes
5 03 Checksum
The confirmation message is sent in response to a command sent to
the device. The ID byte and the check-sum will change with different
commands but the format will remain the same. If the checksum is not
correct an error message is sent. Its format is covered at the end of this
document.
To stop receiving data from the J1708 bus send the following
command to the HDV100A3.

HDV100A3 Command & Response Manual-1306cr 13
B&B Electronics -- 707 Dayton Rd. -- PO Box 1040 -- Ottawa, IL 61350
PH [phone] -- FAX [phone]
Byte
number Byte value (hex) Byte Function
1 01 Start of frame
2 02 The number of control bytes
3 01 ID byte 01= J1708
4 10 Function code 10 hex stop receive
5 00 Number of data bytes (00 place holder)
6 14 Checksum (bytes 1 through 5 added
together)
After sending this command to the device, the device will respond
with a confirmation message and data will cease. Note that there is the
possibility of an incomplete message being sent to the PC after sending this
command. Use the check-sum to verify all messages.
To restart reception, send the (01, 02, 01, 11, 00, 15) command to
the HDV.

14 HDV100A3 Command & Response Manual-1306cr
B&B Electronics -- 707 Dayton Rd. -- PO Box 1040 -- Ottawa, IL 61350
PH [phone] -- FAX [phone]
Transmitting Data to the J1708 Bus
The HDV100A3 supports standard J1708 commands of up to 21
bytes. Additionally the HDV100A3 can send messages up to 100 bytes to
the J1708 bus. It is the responsibility of the sending software to check for
“ignition off” before using the J1708 bus to send messages with more than
21 bytes to the bus. Failure to check for a “quiet bus” condition before
transmitting a long message may cause erratic bus operation. The format to
send information to the J1708 bus is shown below:
Byte
Number Byte Value
(hex)
Byte Function
1 01 Start of frame
2 03 Number of control bytes
3 01 ID bytes 1= J1708
4 12 Function code 12 (hex) transmit to J1708 bus
5 02 Priority byte 00000010 set bit 0 to 7 see below
6 XX Number of data bytes to follow (excludes checksum byte)
YY Data bytes up to 100 bytes
CS Checksum
Set the priority bit using the chart below.
Priority Byte Value Binary Value Hex Value
1 00000001 01
2 00000010 02
3 00000100 04
4 00001000 08
5 00010000 10
6 00100000 20
7 01000000 40
8 10000000 80

HDV100A3 Command & Response Manual-1306cr 15
B&B Electronics -- 707 Dayton Rd. -- PO Box 1040 -- Ottawa, IL 61350
PH [phone] -- FAX [phone]
After sending a transmit message to the HDV100A3 you will get
the confirmation message if the checksum is correct. A transmit complete
message is sent to the PC after the device successfully transmits the message
to the J1708 bus. A second message should not be sent to the device before
confirming that the first message has been sent. The transmit confirmation is
formatted as follows:
Byte
Number Byte Value (hex) Byte Function
1 01 Start of frame
2 01 Number of control bytes
3 09 ID bytes 9 = transmit OK
8 00 Number of data bytes
9 0B Checksum

16 HDV100A3 Command & Response Manual-1306cr
B&B Electronics -- 707 Dayton Rd. -- PO Box 1040 -- Ottawa, IL 61350
PH [phone] -- FAX [phone]
J1708 Message Filter
The J1708 message filter will operate on 4 different MID’s. Only messages
with the same MID as set in the filter will be sent to the PC. The filters will
be OR’ed together so that multiple MID’s can be filtered, MID1 or MID2 or
MID3. The format for the setting of J1708 filtering is as follows:
Set Filter Active
Byte
Number Byte Value Function
1 01 Start of frame
2 03 Control bytes
3 01 ID byte 1 = J1708 message
4 X9 Set filter 9 = Set filter active X = filter number 1 to 4
5 XX Value of MID to filter On
6 00 Data bytes
7 CS Checksum
Set Filter Off
Byte
Number Byte Value Function
1 01 Start of frame
2 02 Control bytes
3 01 ID byte 1 = J1708 message
4 X8 Set filter 8 = Set filter inactive X = filter number 1 to 4
6 00 Data bytes
7 CS Checksum
Setting all filters off will stop all data from the J1708 bus. When all filters
are set off you must send the receive J1708 command to start receiving all
bus messages.