Difference between revisions of "SHIP Version 5"

From Serious Documentation
Jump to: navigation, search
(Redirected page to SHIPv5)
 
(17 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<onlyinclude>
+
#REDIRECT [[SHIPv5]]
[[SHIP Version 5]] (SHIPv5) was released in 2014 and includes an array of exciting new capabilities:
 
* Over-the-wire updates (SPI/UART/USB) via built-in bootloader
 
* Major communications enhancements, including the SHIPBridge Protocol with firmware updates and data movement over USB/SPI/UART
 
* Larger font support and enhanced text placement with "textframe" objects
 
* [[SHIP:Language_and_Translation_Management_(Version_5)|Language translation manager]], including MS Excel translation import/export
 
* Build configuration manager for single project/multiple output
 
* Improved scripting performance, floating point support, and numerous new functions
 
* Runtime drawing on "canvas" objects
 
 
 
 
 
'''SHIP Version 4 (SHIPv5)''' was released in 2014 and works well with many applications.
 
</onlyinclude>
 
== The SHIPBridge Protocol ==
 
SHIP Version 4 had various Modbus protocols included for basic data exchange between the host and the SIM.  This protocol was available over SPI and USB. A proprietary protocol over USB enabled updating of the GUI Cargo from SHIPTide, but engine updates had to be performed in various platform-specific ways, sometimes involving a JTAG programmer.
 
 
 
The SHIPBridge Protocol, included in SHIP Version 5 (SHIPv5), is a new protocol developed by Serious for communications between the SIM and attached host.  It has the following key features:
 
* Light, efficient protocol
 
* Can run over USB, UART, SPI, and in the future, TCP/IP
 
* Remote file access over-the-wire without a file system stack on the host
 
* Firmware, cargo, and boot loader updates over-the-wire
 
* Rich data type exchange over-the-wire
 
* No cost, portable reference source code to be published for the "host" side
 
 
 
== [[SHIPv5_Boot_System|The SHIPv5 Boot System and Over-the-Wire Updates]] ==
 
{{:SHIPv5_Boot_System}}
 
 
 
== Upgrading Projects from SHIP Version 4 ==
 
Just opening a project in SHIPTide V5 will automatically import and update the project to the SHIP Version 5 formats. 
 
 
 
This is a one-way operation, so ensure you've backed up your project before making this transition.
 
 
 
The following elements have changed functionality and may require your attention when you upgrade your project:
 
* the {{Portvar|gpio|pcbTemperature}}property on SHIPv4 was a fixed point number; in SHIPv5 this is renamed {{Portvar|gpio|pcbTemp}} and is a Float
 
* {{Node|text}} nodes cannot be nested in SHIPv5; the {{Node|textframe}} allows far more complex text arrangements, as well as the new multiline and wrap text properties.
 
 
 
As well, you'll want to double check your "target SHIPEngine minimum and maximum versions" within your ''Project Properties'' panel in SHIPTide to make sure you update these to support the appropriate span of SHIPEngine versions.
 
 
 
[[Image:CheckingProjectPropertiesTargetEngineVersion.jpg|300px|center|]]
 

Latest revision as of 05:11, 17 August 2018

Redirect to: