Difference between revisions of "Protocol:SHIPBridge"

From Serious Documentation
Jump to: navigation, search
(What is the {{Protocol|SHIPBridge|SHIPBridge Protocol}}?)
(SHIPBridge Documentation and More Information)
Line 44: Line 44:
  
 
Other documentation:
 
Other documentation:
* [[SHIPBridge:Architectural Overview]]
+
* [[SHIPBridge:Architectural Overview|SHIPBridge Architectural Overview]]

Revision as of 12:35, 9 February 2015

What is the SHIPBridge Protocol?

SHIPBridge is a comprehensive proprietary communications protocol in SHIP Version 5 Badge SHIPv5.gif.

The SHIPBridge protocol enables over-the-wire file access to the SIM, including firmware and GUI updates, as well as data exchange between the SIM and Host(s). Currently SHIPBridge functions over UART and USB, but future TCP/IP support will enable firmware updates, status and monitoring, and data exchange from cloud-based and server-based entities to the SIM.

SHIPBridge has the following high-level capabilities:

  • Robust bi-directional command-response architecture
    • Physical layer support including UART, USB Device, and, in the future, SPI, Ethernet, WiFi, and Bluetooth
    • Binary framed packet protocol with CRCs for message integrity
    • Multi-session: multiple hosts (or virtual hosts) can simultaneously access a SIM
  • SIM system information and control
    • Reboots, status checks, and more
  • Complete and powerful data movement
    • Shared variable philosophy to exchange status and control data
    • All SHIP-supported data types (Boolean, Byte, Short, Integer, Float, String)
    • Polled or Push data, on a per-variable basis
    • Prioritized traffic for flexible bandwidth management
    • Bidirectional (both SIM and Host can poll and push)
  • Flexible over-the-wire file system access
    • Over-the-wire updates for all files, including firmware, boot loaders, GUI files, and more
    • Abstracted remote file system access to all file systems on the SIM from an attached device
    • Access to removable and fixed media from the host (USB Thumb drives, SDCards, on-SIM flash file systems)

The SHIPBridge protocol is currently used from SHIPTide over USB to update the firmware and GUI on your SIM, where the PC is acting as the Host.

SHIPBridge Release Status

The SHIPBridge protocol is currently in the late stages of development, and is pending release with v5.0.

SHIPBridge Host Reference Code

Reference code is in development, and will be supplied on mySerious.com for registered SIM owners to download and use in conjunction with Serious products. You will be able to use and port this code on your own microcontroller for communications and control with the SIM of your choice running SHIPBridge.

Reference code is currently planned for 2 initial development environments:

  1. a PC-based MS Visual Studio project for custom PC connectivity to SIMs over USB and UART
  2. a Renesas RX111 e2studio project using Serious "SHIPWare" base-level infrastructure on Micrium uC/OS-III and FreeRTOS, for use directly on the SCM117 and upcoming SCM118 and for simple porting to other MCU architectures

Serious is investigating providing C reference code for older "super loop" type host software implementations. Contact Serious for more information.

SHIPBridge Documentation and More Information

Contact Serious for a copy of the SHIPBridge Architectural Specification under NDA. The specification will be non-NDA coincident with the v5.0 release.

Other documentation: