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)
 
(21 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
−
== What is the {{Protocol|SHIPBridge|SHIPBridge Protocol}}? ==
+
== What is the SHIPBridge Protocol? ==
 +
SHIPBridge is a comprehensive proprietary communications protocol available in SHIP Version 5.
  
−
SHIPBridge is a comprehensive proprietary communications protocol coming in SHIP Version 5 {{v5}} with the following high-level capabilities:
+
The SHIPBridge protocol enables over-the-wire access to files stored on the SIM/SCM, updates of firmware and GUI, as well as the exchange of typed data variables. SHIPBridge is intended to function over all available communication ports available on a module (i.e., USB, UART, SPI, TCP/IP, etc.), however USB and UART are currently the only validated interfaces on most modules. Future TCP/IP support will enable firmware updates, status and monitoring, and data exchange from cloud or server based entities to the modules.
−
* Robust bi-directional command-response architecture
 
−
** Physical layer support including UART, USB Device, and, in the future, SPI, Ethernet, WiFi, and Bluetooth
 
−
** Every packet is CRC'd for accuracy
 
−
* SIM system information and control
 
−
** Reboots, status checks, and more
 
−
* Complete and powerful data movement
 
−
** All SHIP-supported data types (Boolean, Byte, Short, Integer, Float, String)
 
−
** Prioritized poll or push-on-change per shared variable 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 has the following high-level capabilities:
 +
===Robust bidirectional command-response architecture===
 +
* Arbitrary physical layer support including UART, USB Device (future: SPI, Ethernet, WiFi, and Bluetooth)
 +
* Binary framed packet protocol with CRCs for message integrity
 +
* Multi-session: multiple controllers can simultaneously access a SIM over the same or a different physical interface
 +
 
 +
===SIM system information and control===
 +
* Reboots, status checks, firmware validation, and more
 +
 
 +
===Comprehensive and powerful data movement ===
 +
* Shared variable philosophy to exchange status and control data
 +
* All simple data types ({{DataType|Boolean}}, {{DataType|Byte}}, {{DataType|Short}}, {{DataType|Integer}}, {{DataType|Long}}, {{DataType|Float}}, {{DataType|Double}}, {{DataType|String}}, {{DataType|Buffer}})
 +
* Polled or Push data, on a per-variable basis
 +
* Able to prioritize run-time traffic for flexible bandwidth management
 +
* Fully bidirectional communication
 +
 
 +
===Completely Upgradable===
 +
* Over-the-wire updates for all firmware images (i.e., boot loaders, applications, GUI)
 +
 
 +
==Planned Future Features==
 +
 
 +
===Flexible over-the-wire file system access===
 +
* Read/write access to all removable and fixed storage media (USB Thumb drives, SDCards, on-board file systems)
 +
* Write firmware images to file system to allow background transfer of files and automatic upgrade on next boot
 +
 
 +
===Persistent variable storage===
 +
* Read/write access to persistent storage registry variable values
 +
 
 +
===Extensive debugging capabilities===
 +
* Breakpoint and step through GUI execution
 +
* Read/write access to GUI variables and node properties
 +
 
 +
SHIPBridge is currently used from [[SHIPTide]] over USB to update the firmware and GUI on SIMs.
  
 
== SHIPBridge Release Status ==
 
== SHIPBridge Release Status ==
  
−
The SHIPBridge protocol is currently in the late stages of development, and is pending release with v5.0.
+
SHIPBridge protocol core functionality has been in use since the release of v5. Features are continuously being refined and added throughout the v5 releases.
  
−
== SHIPBridge Host Reference Code ==
+
== SHIPBridge API ==
−
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.
+
The SHIPBridge API code has not yet been fully released, however it is available to registered SIM owners to use in conjunction with Serious products upon request. Customers are able to port the API to their own target environment for advanced communications and control of the SIM.
  
−
Reference code is currently planned for 2 initial development environments:
+
The SHIPBridge API code has been validated in the following environments:
−
# a PC-based MS Visual Studio project for custom PC connectivity to SIMs over USB and UART
+
# Renesas e2studio, GCC embedded C projects for RX, SH, and ARM Cortex-A9 MCU architectures, running on Micrium OS-III
−
# 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
+
# Eclipse IDE for C/C++, IAR embedded C project for ARM Cortex-M4 MCU architecture, running on FreeRTOS V7
 +
# QtCreator, GCC C++ project for x86, running on Windows 7 and greater
  
−
Serious is investigating providing C reference code for older "super loop" type host software implementations. Contact Serious for more information.
+
Currently, the SHIPBridge API code only supports being compiled for 32-bit output. SHIPBridge also requires OS features such as tasks and queues, Serious is investigating how best to provide a unified code base which supports OS-based implementations and "super loop" implementations. Contact Serious for more information on these developments.
  
 
== SHIPBridge Documentation and 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.
+
* [[SHIPBridge:Architectural Overview|SHIPBridge Architectural Overview]]
 +
* [[SHIPBridge:Architectural Specification|SHIPBridge Architectural Specification]]
  
−
Other documentation:
+
[[Category:Protocols]]
−
* [[SHIPBridge:Architectural Overview]]
 

Latest revision as of 23:17, 3 November 2016

What is the SHIPBridge Protocol?

SHIPBridge is a comprehensive proprietary communications protocol available in SHIP Version 5.

The SHIPBridge protocol enables over-the-wire access to files stored on the SIM/SCM, updates of firmware and GUI, as well as the exchange of typed data variables. SHIPBridge is intended to function over all available communication ports available on a module (i.e., USB, UART, SPI, TCP/IP, etc.), however USB and UART are currently the only validated interfaces on most modules. Future TCP/IP support will enable firmware updates, status and monitoring, and data exchange from cloud or server based entities to the modules.

SHIPBridge has the following high-level capabilities:

Robust bidirectional command-response architecture

  • Arbitrary physical layer support including UART, USB Device (future: SPI, Ethernet, WiFi, and Bluetooth)
  • Binary framed packet protocol with CRCs for message integrity
  • Multi-session: multiple controllers can simultaneously access a SIM over the same or a different physical interface

SIM system information and control

  • Reboots, status checks, firmware validation, and more

Comprehensive and powerful data movement

  • Shared variable philosophy to exchange status and control data
  • All simple data types (Boolean, Byte, Short, Integer, Long, Float, Double, String, Buffer)
  • Polled or Push data, on a per-variable basis
  • Able to prioritize run-time traffic for flexible bandwidth management
  • Fully bidirectional communication

Completely Upgradable

  • Over-the-wire updates for all firmware images (i.e., boot loaders, applications, GUI)

Planned Future Features

Flexible over-the-wire file system access

  • Read/write access to all removable and fixed storage media (USB Thumb drives, SDCards, on-board file systems)
  • Write firmware images to file system to allow background transfer of files and automatic upgrade on next boot

Persistent variable storage

  • Read/write access to persistent storage registry variable values

Extensive debugging capabilities

  • Breakpoint and step through GUI execution
  • Read/write access to GUI variables and node properties

SHIPBridge is currently used from SHIPTide over USB to update the firmware and GUI on SIMs.

SHIPBridge Release Status

SHIPBridge protocol core functionality has been in use since the release of v5. Features are continuously being refined and added throughout the v5 releases.

SHIPBridge API

The SHIPBridge API code has not yet been fully released, however it is available to registered SIM owners to use in conjunction with Serious products upon request. Customers are able to port the API to their own target environment for advanced communications and control of the SIM.

The SHIPBridge API code has been validated in the following environments:

  1. Renesas e2studio, GCC embedded C projects for RX, SH, and ARM Cortex-A9 MCU architectures, running on Micrium OS-III
  2. Eclipse IDE for C/C++, IAR embedded C project for ARM Cortex-M4 MCU architecture, running on FreeRTOS V7
  3. QtCreator, GCC C++ project for x86, running on Windows 7 and greater

Currently, the SHIPBridge API code only supports being compiled for 32-bit output. SHIPBridge also requires OS features such as tasks and queues, Serious is investigating how best to provide a unified code base which supports OS-based implementations and "super loop" implementations. Contact Serious for more information on these developments.

SHIPBridge Documentation and More Information

Retrieved from "https://techref.myserious.com/index.php?title=Protocol:SHIPBridge&oldid=6578"