NSE-5000-013-E - NSE Embedded Protocol Description - Customer Version

NSE Embedded Protocol Description
Product:
NSE Downhole Products
NSE-5000-013
REV DATE DESCRIPTION PREP APPR COMPANY
D 10.01.2020 See doc. revision history section EHJ GLK NSE
E 12.05.2021 See doc. revision history section EHJ GLK NSE
PAGES DOCUMENT: 14
North Sea Electronics AS E-mail: [email protected]

Gravdalsveien 245, N-5165 Laksevaag, Norway Comp. Reg. No.: NO987774002MVA
Project: NSE Downhole Products Page: 2 of 14
Title: Embedded Protocol Description Date: 12.05.2021
Document No: NSE-5000-013 Revision E
Document revision history
REV A – 2017.06.27
- Initial – Replaces document NSE-500105-061 – Protocol Description
REV B – 2017.11.08
- Added Framing Scheme for RS485/UART TTL interface.
- Added Extended CAN ID Header description for CAN interface.
REV C – 2018.07.23
- pC1 - Corrected substitute characters in RS485/UART framing format.
- Removed misleading section header.
- Added CAN/UART Gateway description.
REV D – 2020.01.10
- Added LOG DATA message command/identifier description
REV E – 2021.05.12
- pE1 - Added PERIODIC B (one additional periodic message) message command/identifier
description.
- pE2 - Updated message command/identifier list with NSEE Log related command ids and
oscilloscope data identifier.
- pE3 - Updated message command/identifier list with NSEE internal broadcast id (0x08).

Table of Contents
1 ABBREVIATIONS ........................................................................................................................ 4
2 COMMUNICATION METHODOLOGY .................................................................................. 5
2.1 DATA AND CONTROL REGISTERS ............................................................................................. 5
2.2 COMMUNICATION INTERFACE (CAN, RS-485, TTL-UART) ................................................... 5
2.3 ADDRESSING OF UNITS ............................................................................................................. 5
2.4 PERIODIC STATUS ..................................................................................................................... 5
2.5 NON-VOLATILE/FLASH BASED REGISTERS ............................................................................... 5
3 PROTOCOL DESCRIPTION...................................................................................................... 6
3.1 MESSAGE COMMAND/IDENTIFIER ............................................................................................ 6
3.2 RS485/TTL-UART INTERFACE................................................................................................ 7
3.2.1 Message Format without Framing .................................................................................... 7
3.2.2 Typical Messages without Framing .................................................................................. 7
3.2.3 Message Format with Framing ......................................................................................... 8
3.2.4 Message Examples with Framing ..................................................................................... 9
3.3 CAN INTERFACE..................................................................................................................... 10
3.3.1 Message Format (Base ID, CAN 2.0A) ........................................................................... 10
3.3.2 CAN Header Description (Base ID, CAN 2.0A) ............................................................. 11
3.3.3 CAN Header Description (Extended ID, CAN 2.0B) ...................................................... 12
3.3.4 Typical Messages ............................................................................................................ 13
3.4 CAN/UART GATEWAY .......................................................................................................... 14
3.4.1 CAN/UART relation ........................................................................................................ 14

1 Abbreviations
NSE North Sea Electronics
bps Bit Per Second
CRC Cyclic Redundancy Check
UART Universal Asynchronous Receiver/Transmitter
TTL Transistor-Transistor Logic
CAN Controller Area Network
lsb Least Significant Byte
msb Most Significant Byte
SOF Start-Of-Frame
EOF End-Of-Frame
DLE Data-Link-Escape
DH Downhole
TS Topside

2 Communication Methodology
2.1 Data and Control Registers
The unit can be configured and controlled through several control registers. Measured data are
available through data registers. Each NSE product has its own “Register Description” document.
2.2 Communication Interface (CAN, RS-485, TTL-UART)

Depending on the hardware configuration, the registers can be accessed through CAN bus, RS485 bus
or TTL UART interface. All hardware configurations use the same communication methodology,
however, there are some differences in order to adapt to the physical level of the given interface.
2.3 Addressing of Units

All units in a system must be given a unique address. The address of a unit can be found in the unit’s
ADDRESS register. All messages must include a destination address, a source address, length of the
message (in bytes) and a message command. Address 31 (0x1F) is reserved as broadcast address and
address 30 (0x1E) is reserved for bootloader purposes. Units must not be assigned these addresses.
Similarly, it is good practice to reserve address 0 (0x00) as topside GUI/PC address, thus it should not
be used as a node address.
The address of a unit can be changed by writing to the unit’s ADDRESS register. However, the ADDRESS
register is locked by an additional 4-byte key to protect it from unintentional write operations.
Whenever a write command is issued to the ADDRESS register, this key must also be included in the
command. The key is located at the end of the message. Refer the unit’s “Register description”
document for more information.
2.4 Periodic Status

If a unit has CAN bus interface, it can be setup to periodically transmit data registers. The setup should
include; a destination address, which registers to periodically transmit, and time between
transmissions. RS485 configuration does not support periodical messages, however, there is a “Poll
periodic messages” command which will provide similar functionality.
2.5 Non-volatile/Flash based Registers

Most configuration registers are non-volatile. These registers should only be written in relatively low
temperatures (<60 degC). Write operations above this temperature will be executed, but will not be
permanently stored in the flash memory. Non-volatile registers are labeled in the unit’s “Register
description” document.

3 Protocol Description
3.1 Message Command/Identifier
Standard NSEE protocol
Message/command name Cmd ID Description
Periodic status message 0x01 Periodically generated message containing register data (when in
RS485 configuration these messages will only occur as a response of a
0x28 command).
Read register response 0x02 Message containing requested register data.
Log data message 0x03 Log data message. Implemented to ease readout of log data.
Periodic status message B 0x04 Additional periodic message, if available on device. Periodically
generated message containing register data (when in RS485
configuration these messages will only occur as a response of a 0x28
command).
High res. buffered data 0x07 High resolution buffered data. Only supported by some device
(oscilloscope feature) families.
Internal broadcast 0x08 Broadcast message used for node-node communication. Typically,
used if a node needs to share some status information to other nodes
on the network e.g. output balancing of two DCDCs.
Write register 0x10 Write to addressed register.
Set register bit mask 0x14 Set all bit(s) determined by input bit mask e.g. 0x0001 will set bit 0.
Clear register bit mask 0x15 Clear all bit(s) determined by input bit mask e.g. 0x0001 will clear bit
0.
Write/verify register 0x18 Write to addressed register. Node will issue a read response of
addressed register.
Set bit mask/verify register 0x1C Set all bit(s) determined by input bit mask. Node will issue a read
response of addressed register.
Clear bit mask/verify register 0x1D Clear all bit(s) determined by input bit mask. Node will issue a read
response of addressed register.
Read register 0x20 Read request of addressed register.
Poll periodic messages(RS485 only) 0x28 Poll status registers defined in STATUS CONTROL register.
NSEE Log protocol
Message/command name Cmd ID Description
Trip counter read 0x44 Read request of a trip counter. Only supported by some device
families.
Trend graph read 0x45 Read request of a trend graph. Only supported by some device
families.
Histogram read 0x46 Read request of a histogram. Only supported by some device families.
Trip counter read response 0x64 Read response of a trip counter read request. Only supported by some
device families.
Trend graph read response 0x65 Read response of a trend graph read request. Only supported by some
device families.
Histogram read response 0x66 Read response of a histogram read request. Only supported by some
device families.

3.2 RS485/TTL-UART Interface

All messages must include destination address, source address, length of the message (in bytes),
message command and CRC value. In addition, most messages include a register address and data
field. The default baud rate is 38400 bps.
3.2.1 Message Format without Framing

Byte 0 Byte 1 Byte 2 Byte 3 Byte 4 Byte 5 Byte 6 … Byte Byte Byte n
n-2 n-1
dest. src. length cmd reg. lsb data … msb lsb msb
addr. addr. addr. data data crc crc
Byte 0 dest. addr. Address of receiving node
Byte 1 src. addr. Address of transmitting node
Byte 2 length Total number of bytes in messages, including CRC
Byte 3 cmd Message command/identifier
Byte 4 reg. addr. Address of register to access
Byte 5:(n-2) data Payload data, starting with least significant byte. Data
payload is typically 16 bits (2 bytes) or 32 bits (4 bytes).
Byte (n-1):n crc Cyclic redundancy check, CRC-CCITT (0xFFFF)
3.2.2 Typical Messages without Framing

Read register response 16-bit (outgoing)
Byte 0 Byte 1 Byte 2 Byte 3 Byte 4 Byte 5 Byte 6 Byte 7 Byte 8
dest. src. 9 0x02 reg. lsb msb lsb msb

Byte 0 Byte 1 Byte 2 Byte 3 Byte 4 Byte 5 Byte 6 Byte 7 Byte 8 Byte 9 Byte 10
dest. src. 11 0x02 reg. lsb data data msb lsb msb
Write register command 16-bit (incoming)

Byte 0 Byte 1 Byte 2 Byte 3 Byte 4 Byte 5 Byte 6 Byte 7 Byte8

Byte 0 Byte 1 Byte 2 Byte 3 Byte 4 Byte 5 Byte 6 Byte 7 Byte 8 Byte 9 Byte 10
dest. src. 11 0x10 reg. lsb data data msb lsb msb
Read register command (incoming)

Byte 0 Byte 1 Byte 2 Byte 3 Byte 4 Byte 5 Byte 6
dest. src. 7 0x20 reg. lsb msb
addr. addr. addr. crc crc

3.2.3 Message Format with Framing

Refer to the unit’s Register Description document to see if unit supports framing.
In some cases framing the message with SOF/EOF characters can be an advantage. This is typically the
case when data is going via a modem, where a single message can be divided by a time gap. The
protocol is of binary type i.e. any byte value can occur at any time in the data field of a message, thus
an escape character (DLE) is also introduced in the framing scheme. Whenever a data byte which has
the same binary value as SOF/EOF character occurs in the data stream, it is substituted by two
character i.e. DLE character and the SOF/EOF substitute character. Similarly, when a data byte which
has the same binary value as a DLE character is present in the data flow, it also needs to be substituted
in order not to be interpreted as a DLE character by the receiver. By following this framing scheme the
message will only include SOF character in the start of the message and EOF at the end of the message.
Data substitution:
Hex Value Substitute
SOF 0x02 DLE 0x12
EOF 0x03 DLE 0x13
DLE 0x10 DLE 0x10
Byte 0 Byte 1 Byte 2 Byte 3 Byte 4 Byte 5 Byte 6 Byte 7 … Byte Byte Byte Byte n
n-3 n-2 n-1
SOF dest src. length cmd reg. lsb data … msb lsb msb EOF
Byte location may vary, depending on number of DLE character(s) in the message.
Byte 0 SOF Start-Of-Frame. Hex value 0x02
Byte 1 dest. addr. Address of receiving node
Byte 2 src. addr. Address of transmitting node
Byte 3 length Total number of bytes in messages, including CRC
Byte 6:(n-3) data Payload data, starting with least significant byte. Data
payload is typically 16 bits (2 bytes) or 32 bits (4 bytes).
Byte (n-2): (n-1) crc Cyclic redundancy check, CRC-CCITT (0xFFFF)
Byte n EOF End-Of-Frame. Hex value 0x03

3.2.4 Message Examples with Framing

Without Framing
Byte Byte Byte Byte Byte Byte Byte Byte Byte
0 1 2 3 4 5 6 7 8
With Framing
Byte Byte Byte Byte Byte Byte Byte Byte Byte Byte Byte Byte
0 11 21 3 42 52 61 71 81 91 101 11
SOF dest. src. 9 DLE 0x12 reg. lsb msb lsb msb EOF
1) The byte does not have the value 0x02 (SOF), 0x03 (EOF) or 0x10 (DLE)
2) Part of 0x02(SOF) substitution

Without Framing
Byte Byte Byte Byte Byte Byte Byte Byte Byte
0 1 2 3 4 5 6 7 8
With Framing
Byte Byte Byte Byte Byte Byte Byte Byte Byte Byte Byte Byte
0 11 21 3 42 52 61 71 81 91 101 11
SOF dest. src. 9 DLE 0x10 reg. lsb msb lsb msb EOF
1) The byte does not have the value 0x02 (SOF), 0x03 (EOF) or 0x10 (DLE)
2) Part of 0x10(DLE) substitution

3.3 CAN Interface

All units with CAN bus option supports standard/base identifier messages (CAN 2.0A). Refer to the
unit’s Register Description document to see if unit supports extended identifier messages (CAN
2.0B). If extended identifier messages are not supported, any extended identifier message on the
CAN bus will simply be ignored by the unit. For a CAN bus message destination address, source
address and message length are included in the CAN ID. The default bit rate is 125000 bps.
3.3.1 Message Format (Base ID, CAN 2.0A)

CAN Header Byte 0 Byte 1 Byte 2 Byte 3 … Byte Byte n CRC/ack/eof
(n-1)
p ddddd sssss r i a llll cmd reg. lsb data data … data msb crc/ack/eof
addr. data data
CAN Header can id, rtr, ide, r0, dlc p Part of CAN ID, don’t care
ddddd Part of CAN ID, 5-bits dest. address (address of
receiving node)
sssss Part of CAN ID, 5-bits source address (address of
transmitting node)
r RTR bit
i IDE bit
a R0 bit
llll Data length code (number of bytes of data)
Byte 2:n data Payload data, starting with least significant byte.
CRC/ack/eof crc, ack, eof Cyclic redundancy check, acknowledge and end of
frame bits (most CAN controllers will handle this part
automatically).

3.3.2 CAN Header Description (Base ID, CAN 2.0A)

Bit 23 Bit 22 Bit 21 Bit 20 Bit 19 Bit 18 Bit 17 Bit 16
priority dest. addr.

dest. addr. dest. addr. dest. addr. dest. addr. source addr. source addr. source addr. source addr.

source addr. 0 (RTR) 0 (IDE) 0 (R0) DLC DLC DLC DLC
Bit 17 Priority (part of CAN id) Don’t care. However setting bit to 1 will lower the
message priority on the CAN bus.
Bit 16:12 Dest. address (part of CAN id) 5-bits destination address field.
Bit 11:7 Src. address (part of CAN id) 5-bits source address field.
Bit 6 RTR Remote transmission request. Should always be 0.
Bit 5 IDE Identifier extension bit. Selects if standard/base frame

or extended frame CAN format is used. Must be 0
(dominant) for standard/base ID frame format.
Bit 4 R0 Reserved bit. Should always be 0.
Bit 3:0 DLC Data length code. Total number of payload bytes in the
CAN message.

3.3.3 CAN Header Description (Extended ID, CAN 2.0B)

priority priority priority msg. id. msg. id. msg. id.

msg. id. msg. id. msg. id. msg. id. msg. id. 1 (SRR) 1 (IDE) msg. id.

msg. id. dest. addr. dest. addr. dest. addr. dest. addr. dest. addr. dest. addr. dest. addr.

dest. addr. source addr. source addr. source addr. source addr. source addr. source addr. source addr.

source addr. 0 (RTR) 0 (R1) 0 (R0) DLC DLC DLC DLC
Bit 37:35 Priority (part of CAN id) Don’t care. However, higher values will lower the
message priority on the CAN bus.
Bit 34:27 Message identifier(part of CAN id) Don’t care. However, can be used as an additional
message identifier.
Bit 26 Substitute Remote Request Must be 1 (recessive).
Bit 25 IDE Identifier extension bit. Selects if standard/base frame

or extended frame CAN format is used. Must be 1
(recessive) for extended ID frame format.
Bit 24:23 Message identifier(part of CAN id) Don’t care. However, can be used as an additional
message identifier.
Bit 22:15 Dest. address (part of CAN id) 8-bits destination address field.
Bit 14:7 Source address (part of CAN id) 8-bits source address field.
Bit 6 RTR Remote transmission request. Should always be 0

(dominant) for data frames.
Bit 3:0 DLC Data length code. Total number of payload bytes in the
CAN message.

3.3.4 Typical Messages

Read register response16-bit (base ID)
CAN Header Byte 0 Byte 1 Byte 2 Byte 3 CRC/ack/eof
p ddddd sssss 000 0100 0x02 reg lsb msb Crc/ack/eof
addr data data data
Read register response 32-bit (base ID)

CAN Header Byte 0 Byte 1 Byte 2 Byte 3 Byte 4 Byte 5 CRC/ack/eof
p ddddd sssss 000 0110 0x02 reg lsb data data msb Crc/ack/eof
addr data data data
Write register command 16-bit (base ID)

CAN Header Byte 0 Byte 1 Byte 2 Byte 3 1
Byte 4 1
Byte 5 1
Byte 6 1
Byte 7 CRC/ack/eof
p ddddd sssss 000 0100 0x10 reg lsb msb lsb key key msb Crc/ack/eof
addr data data key key data
1) A key needs to be provided for some registers. In this case the DLC part of the CAN header should be changed to
‘1000’.
Write register command 32-bit (base ID)

p ddddd sssss 000 0110 0x10 reg lsb data data msb Crc/ack/eof
addr data data data
Read register command (base ID)

CAN Header Byte 0 Byte 1 CRC/ack/eof
p ddddd sssss 000 0010 0x20 reg Crc/ack/eof
addr data
Write register command 32-bit (extended ID)

ppp iiiiiiii 11 ii dddddddd 0x10 reg lsb data data msb Crc/ack/eof
ssssssss 000 0110 addr data data data
p – Don’t care/priority bit, where low value gives high priority.

i – Don’t care/additional message identifier.
d – Destination address field.
s – Source address field.

3.4 CAN/UART Gateway

Some systems may require having a CAN/UART gateway i.e. CAN messages will be translated to
UART messages and vice versa. Typically, this is systems which consist of a DH telemetry unit and a
CAN node network. The DH telemetry unit receives TS messages in UART format. These messages
must be translated to CAN format to be forwarded onto the CAN bus network. Similarly, CAN
messages which is addressed to TS must be converted to UART messages to send them over the
wireline. The following section describe how the NSE Embedded protocol handles this gateway
functionality.
3.4.1 CAN/UART relation

CAN base format:
CAN BASE/STD FRAME MESSAGE

CAN HEADER DATA0:7 CRC/ACK/EOF
CAN ID CAN ID RTR/ REG. PARAM. PARAM. PARAM. PARAM. PARAM. PARAM.
DLC CMD
10:5 4:0 IDE/R0 ADDR. 0 1 2 3 4 5
DEST. SRC. REG. PARAM. PARAM. PARAM. PARAM. PARAM. PARAM. CRC CRC
SOF LENGTH CMD EOF
ADDR. ADDR. ADDR. 0 1 2 3 4 5 CCITT-16 CCITT-16
UART MESSAGE
CAN extended format:
CAN EXTENDED FRAME MESSAGE

CAN HEADER DATA0:7 CRC/ACK/EOF
CAN ID CAN ID CAN ID RTR/ REG. PARAM. PARAM. PARAM. PARAM. PARAM. PARAM.
DLC CMD
28:15 14:8 7:0 R0/R1 ADDR. 0 1 2 3 4 5
DEST. SRC. REG. PARAM. PARAM. PARAM. PARAM. PARAM. PARAM. CRC CRC
SOF LENGTH CMD EOF
ADDR. ADDR. ADDR. 0 1 2 3 4 5 CCITT-16 CCITT-16
UART MESSAGE
DLC/LENGTH: DLC (data length code) field represents number of data byte in CAN message. LENGTH
byte in UART message represent total number of bytes in UART message, excluding SOF/EOF/DLE
characters.
DESTINATION ADDRESS: To distinguish an extended format CAN message from a base format CAN
message on the UART side, the most significant bit in the DESTINATION ADDRESS byte in the UART
message is used. If this bit is ‘1’, the message originates from an extended CAN message. Similarly, to
make a UART message translate to an extended frame CAN message, the most significant bit in the
DESTINATION ADDRESS byte must be set to ‘1’.
DESTINATION ADDRESS
CAN BASE/
EXTENDED
ADDRESS
ADDRESS
ADDRESS
ADDRESS
ADDRESS
ADDRESS
ADDRESS
BIT 6
BIT 5
BIT 4
BIT 3
BIT 2
BIT 1
BIT 0
CAN ID 28:15: Extended CAN messages which uses CAN ID 28:15 bits is not supported i.e. these CAN
ID bits will not be visible on the UART side.


NSE-5000-013-E - NSE Embedded Protocol Description - Customer Version

Uploaded by

Copyright:

Available Formats

NSE-5000-013-E - NSE Embedded Protocol Description - Customer Version

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

NSE-5000-013-E - NSE Embedded Protocol Description - Customer Version

Uploaded by

Copyright:

Available Formats

NSE Embedded Protocol Description

NSE Downhole Products

REV DATE DESCRIPTION PREP APPR COMPANY

D 10.01.2020 See doc. revision history section EHJ GLK NSE

E 12.05.2021 See doc. revision history section EHJ GLK NSE

North Sea Electronics AS E-mail: [email protected]

Document revision history

North Sea Electronics AS E-mail: [email protected]

North Sea Electronics AS E-mail: [email protected]

North Sea Electronics AS E-mail: [email protected]

2.2 Communication Interface (CAN, RS-485, TTL-UART)

2.3 Addressing of Units

2.4 Periodic Status

2.5 Non-volatile/Flash based Registers

North Sea Electronics AS E-mail: [email protected]

North Sea Electronics AS E-mail: [email protected]

3.2 RS485/TTL-UART Interface

3.2.1 Message Format without Framing

Byte 0 dest. addr. Address of receiving node

Byte 1 src. addr. Address of transmitting node

Byte 2 length Total number of bytes in messages, including CRC

Byte 3 cmd Message command/identifier

Byte 4 reg. addr. Address of register to access

Byte (n-1):n crc Cyclic redundancy check, CRC-CCITT (0xFFFF)

3.2.2 Typical Messages without Framing

Read register response 32-bit (outgoing)

Write register command 16-bit (incoming)

Write register command 32-bit (incoming)

Read register command (incoming)

North Sea Electronics AS E-mail: [email protected]

3.2.3 Message Format with Framing

Byte 0 SOF Start-Of-Frame. Hex value 0x02

Byte 1 dest. addr. Address of receiving node

Byte 2 src. addr. Address of transmitting node

Byte 3 length Total number of bytes in messages, including CRC

Byte 4 cmd Message command/identifier

Byte 5 reg. addr. Address of register to access

Byte (n-2): (n-1) crc Cyclic redundancy check, CRC-CCITT (0xFFFF)

Byte n EOF End-Of-Frame. Hex value 0x03

North Sea Electronics AS E-mail: [email protected]

3.2.4 Message Examples with Framing

Write register command 16-bit (incoming)

North Sea Electronics AS E-mail: [email protected]

3.3 CAN Interface

3.3.1 Message Format (Base ID, CAN 2.0A)

Byte 0 cmd Message command/identifier

Byte 1 reg. addr. Address of register to access

North Sea Electronics AS E-mail: [email protected]

3.3.2 CAN Header Description (Base ID, CAN 2.0A)

Bit 15 Bit 14 Bit 13 Bit 12 Bit 11 Bit 10 Bit 9 Bit 8

Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0

Bit 6 RTR Remote transmission request. Should always be 0.

Bit 5 IDE Identifier extension bit. Selects if standard/base frame

Bit 4 R0 Reserved bit. Should always be 0.

North Sea Electronics AS E-mail: [email protected]

3.3.3 CAN Header Description (Extended ID, CAN 2.0B)

Bit 31 Bit 30 Bit 29 Bit 28 Bit 27 Bit 26 Bit 25 Bit 24

Bit 23 Bit 22 Bit 21 Bit 20 Bit 19 Bit 18 Bit 17 Bit 16

Bit 15 Bit 14 Bit 13 Bit 12 Bit 11 Bit 10 Bit 9 Bit 8

Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0