Difference between revisions of "Protocols - Overview"

From Serious Documentation
Jump to: navigation, search
(Created page with "<onlyinclude>A ''protocol'' describes the packetization and method for moving data back and forth across that physical layer. SHIP supports three protocols, though not all pr...")
 
Line 1: Line 1:
 
<onlyinclude>A ''protocol'' describes the packetization and method for moving data back and forth across that physical layer.  SHIP supports three protocols, though not all protocols are supported across all available physical layers on a SIM:
 
<onlyinclude>A ''protocol'' describes the packetization and method for moving data back and forth across that physical layer.  SHIP supports three protocols, though not all protocols are supported across all available physical layers on a SIM:
* the new [[SHIP:Raw|Raw protocol]] starting in SHIP v5.0.126 {{v5}}
+
* the new {{Protocol|Raw}} starting in SHIP v5.0.126 {{v5}}
* the [[SHIP:Modbus|Modbus protocol]], including Modbus RTU and ASCII, Master and Slave
+
* the {{Protocol|Modbus}}, including {{Protocol|Modbus|RTU and ASCII}}, {{Protocol|Modbus|Master and Slave}}
* the upcoming [[SHIP:Bridge|SHIPBridge protocol]] in SHIP v5.0.200 {{v5}}</onlyinclude>
+
* the upcoming {{Protocol|SHIPBridge}} in SHIP v5.0.200 {{v5}}</onlyinclude>
  
=== [[SHIP:Raw|Raw Protocol]] ===
+
=== {{Protocol|Raw|Raw Protocol}} ===
The [[SHIP:Raw|Raw protocol]] was made available starting in SHIP v5.0.126 {{v5}}, and enables simple movement of the following data types:
+
The {{Protocol|Raw}} was made available starting in SHIP v5.0.126 {{v5}}, and enables simple movement of the following data types:
 
* Boolean (as Byte 0x00 or 0x01)
 
* Boolean (as Byte 0x00 or 0x01)
 
* Byte
 
* Byte
Line 16: Line 16:
  
 
'''Resources:'''
 
'''Resources:'''
 +
* {{Protocol|Raw}} detailed description
 
* [[AN0504_-_The_Raw_Communications_Protocol|AN0504 - The Raw Communications Protocol]] (video application note)
 
* [[AN0504_-_The_Raw_Communications_Protocol|AN0504 - The Raw Communications Protocol]] (video application note)
* [[SHIP:Raw|Raw protocol]] detailed description
 
  
=== [[SHIP:Modbus|Modbus Protocol]] ===
+
=== {{Protocol|Modbus|Modbus Protocol}}===
=== [[SHIP:Bridge|SHIPBridge protocol]] ==
+
=== {{Protocol|Bridge|Bridge Protocol}} ===

Revision as of 04:43, 21 September 2014

A protocol describes the packetization and method for moving data back and forth across that physical layer. SHIP supports three protocols, though not all protocols are supported across all available physical layers on a SIM:

Raw Protocol

The Raw protocol was made available starting in SHIP v5.0.126 Badge SHIPv5.gif, and enables simple movement of the following data types:

  • Boolean (as Byte 0x00 or 0x01)
  • Byte
  • Short (16-bit)
  • Integer (32-bit)
  • Float (single precision, 32-bit)
  • String (null terminated)

There is no packetization, framing, or checksums/CRC calculations performed on the data. The protocol, therefore, is very simple to interpret and generate on an attached device, however is susceptible to errors and misalignment over time and should only be used in some applications.

Resources:

Modbus Protocol

Bridge Protocol