Difference between revisions of "SHIP Overview"

From Serious Documentation
Jump to: navigation, search
(→‎SHIP Versions)
 
(30 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
−
====The Serious Human Interface™ Platform====
+
Using the [[SHIP|Serious Human Interface™ Platform]] you can develop and deploy a modern GUI in a fraction of the time of traditional C-based development.
−
The Serious Human Interface™ Platform (SHIP) is a rapid GUI development and deployment system with five main ingredients:
+
 
−
* SHIP Total IDE ('''SHIPTide'''), the PC/Mac/Linux based IDE for developing your GUI
+
==What is the Serious Human Interface™ Platform (SHIP)? ==
 +
 
 +
SHIP includes five main ingredients:
 +
* SHIP Total IDE ('''SHIPTide'''), the PC-based IDE for developing your GUI
 
* the '''cargo''' binary data file that SHIPTide exports, containing your whole GUI including fonts, images, layout, audio, compiled scripts, communications, and more
 
* the '''cargo''' binary data file that SHIPTide exports, containing your whole GUI including fonts, images, layout, audio, compiled scripts, communications, and more
 
* the Serious Integrated Module ('''SIM''') hardware that hosts your GUI and becomes your new front panel, communicating typically by UART to the rest of your system
 
* the Serious Integrated Module ('''SIM''') hardware that hosts your GUI and becomes your new front panel, communicating typically by UART to the rest of your system
 
* SHIPEngine, the embedded runtime firmware on your SIM that runs GUIs that SHIPTide exports
 
* SHIPEngine, the embedded runtime firmware on your SIM that runs GUIs that SHIPTide exports
 
* Communications, including the upcoming SHIPBridge Protocol, enabling communications between the SIM and your system
 
* Communications, including the upcoming SHIPBridge Protocol, enabling communications between the SIM and your system
−
{| class="wikitable" style="margin: 1em auto 1em auto;"
+
 
−
|[[Image:SHIPTideFlow.png|600px|center|SHIP Elements]]
+
Developing with SHIP takes embedded GUI development to a completely different level.  You can have a prototype GUI up in running in a few days, even if you've never used SHIP before.  Once you're up to speed with SHIP, you can knock out new GUI pages in as little as a few minutes.  And you'll be stunned at how little code is involved in creating a modern looking GUI that is completely functional.  That's what SHIP does: great looking GUIs, lots of flexibility on what you end up with, and as little coding for you as we can enable.
−
|}
+
 
 +
== The SHIP GUI Development Process: Design, Export, Try ==
 +
 
 +
[[File:GUI-flow.png|600px|center|Developing a GUI with SHIP]]
 +
 
 +
'''Design'''
 +
 
 +
SHIPTide is the SHIP Total IDE... the rapid GUI development tool that runs on Windows.  You develop your GUI on the PC with very little coding -- SHIPTide helps you with screen layout, importing fonts and images (there are no  font/image converters needed outside SHIPTide -- it does all that), and arranging your snippets of code that wires the GUI together.
 +
 
 +
'''Export'''
 +
 
 +
When you want to try your GUI on a SIM, export the '''cargo''' file from [[SHIPTide]].  This processes all your fonts, images, text, multi-language, layout, script (you get the picture) and builds a single data file we call the "cargo".
 +
 
 +
'''Try'''
 +
 
 +
Connect the SIM to your PC and [[SHIPTide]] downloads the GUI cargo file over the USB port into the FLASH of the SIM.  The SIM reboots, and instantly your GUI appears.  The SHIPEngine firmware on the SIM "runs" your GUI and makes it come alive.
 +
 
 
== First Steps ==
 
== First Steps ==
 
Want to learn a bit more about SHIP?  Here are a few resources that can get you familiar with SHIP concepts and capabilities before you dive deeper:
 
Want to learn a bit more about SHIP?  Here are a few resources that can get you familiar with SHIP concepts and capabilities before you dive deeper:
 
*{{SeriousDoc|31-ship-technical-overview-presentation|SHIP Technical Overview Presentation}}
 
*{{SeriousDoc|31-ship-technical-overview-presentation|SHIP Technical Overview Presentation}}
−
*[[AN0301_-_SHIPTide_First_Look|AN0301 - SHIPTide First Look (video 4m27s)]]
+
*[https://www.seriousintegrated.com/SHIPTide Intro to SHIPTide]
 
*[[SHIP:BoxModel|Overview of the Box Model... all about SHIP containers]]
 
*[[SHIP:BoxModel|Overview of the Box Model... all about SHIP containers]]
 
== SHIP Versions ==
 
== SHIP Versions ==
−
SHIP Version 4 (SHIPv4) has been available since 2012 and works well in many applications.  <br/>SHIP Version 5 (SHIPv5) is scheduled for April 2014 beta release and includes many new capabilities:
+
{{:SHIP_Version_5}}
−
* Major communications enhancements, including the SHIPBridge Protocol with firmware updates and data movement over USB/SPI/UART
 
−
* Runtime drawing on "canvas" objects
 
−
* Larger font support and enhanced text placement with "textframe" objects
 
−
* 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
 
−
* Built-in bootloader for firmware (engine, cargo, etc.) updates
 
−
<!-- See the [[SHIPv4|SHIPv4]] and [[SHIPv5|SHIPv5]] landing pages for more information. -->
 
  
 
== Training and Applications Notes ==
 
== Training and Applications Notes ==
Line 30: Line 41:
 
* [[SHIP:Application_Notes|SHIP Application Notes]] including example [[SHIPTide]] projects and training notes
 
* [[SHIP:Application_Notes|SHIP Application Notes]] including example [[SHIPTide]] projects and training notes
 
== Technical Reference  ==
 
== Technical Reference  ==
 +
*[[SHIP:Project Properties|Project Properties]]
 
*[[SHIP:Port|Platform and Port Reference]] (includes property reference)
 
*[[SHIP:Port|Platform and Port Reference]] (includes property reference)
 
*[[SHIP:Node|Node Reference]] (includes property reference)
 
*[[SHIP:Node|Node Reference]] (includes property reference)
−
*The [[SHIP:BoxModel|Box Model]], the [[SHIP:TextModel|Text Model]], and [[SHIP:Fonts|Fonts]]
+
*Layout Concepts: the [[SHIP:BoxModel|Box Model]] and [[SHIP:TextModel|Text Model]]
−
*[[SHIP:Language Support|Multi-Language Support]]
+
*[[SHIP:Language_Support|Multi-Language]] and [[SHIP:Fonts|Font]] support
 
*[[SHIP:Data_Types|Data Types]]
 
*[[SHIP:Data_Types|Data Types]]
 
*[[SHIP:Communications|Communications]]
 
*[[SHIP:Communications|Communications]]
 
*[[SHIP:GRMs|GUI Reference Manuals for SIMs]]
 
*[[SHIP:GRMs|GUI Reference Manuals for SIMs]]
 +
 +
[[Category:SHIP Overview]]

Latest revision as of 13:30, 20 February 2020

Using the Serious Human Interface™ Platform you can develop and deploy a modern GUI in a fraction of the time of traditional C-based development.

What is the Serious Human Interface™ Platform (SHIP)?

SHIP includes five main ingredients:

  • SHIP Total IDE (SHIPTide), the PC-based IDE for developing your GUI
  • the cargo binary data file that SHIPTide exports, containing your whole GUI including fonts, images, layout, audio, compiled scripts, communications, and more
  • the Serious Integrated Module (SIM) hardware that hosts your GUI and becomes your new front panel, communicating typically by UART to the rest of your system
  • SHIPEngine, the embedded runtime firmware on your SIM that runs GUIs that SHIPTide exports
  • Communications, including the upcoming SHIPBridge Protocol, enabling communications between the SIM and your system

Developing with SHIP takes embedded GUI development to a completely different level. You can have a prototype GUI up in running in a few days, even if you've never used SHIP before. Once you're up to speed with SHIP, you can knock out new GUI pages in as little as a few minutes. And you'll be stunned at how little code is involved in creating a modern looking GUI that is completely functional. That's what SHIP does: great looking GUIs, lots of flexibility on what you end up with, and as little coding for you as we can enable.

The SHIP GUI Development Process: Design, Export, Try

Developing a GUI with SHIP

Design

SHIPTide is the SHIP Total IDE... the rapid GUI development tool that runs on Windows. You develop your GUI on the PC with very little coding -- SHIPTide helps you with screen layout, importing fonts and images (there are no font/image converters needed outside SHIPTide -- it does all that), and arranging your snippets of code that wires the GUI together.

Export

When you want to try your GUI on a SIM, export the cargo file from SHIPTide. This processes all your fonts, images, text, multi-language, layout, script (you get the picture) and builds a single data file we call the "cargo".

Try

Connect the SIM to your PC and SHIPTide downloads the GUI cargo file over the USB port into the FLASH of the SIM. The SIM reboots, and instantly your GUI appears. The SHIPEngine firmware on the SIM "runs" your GUI and makes it come alive.

First Steps

Want to learn a bit more about SHIP? Here are a few resources that can get you familiar with SHIP concepts and capabilities before you dive deeper:

SHIP Versions

SHIP Version 5 (SHIPv5), released in 2014, has three major platform versions:

SHIPv5 Major Versions
Version Status HW Platform Support
v5.2 beta New SIMx52 and SIMx62 high performance HMI platforms; Contact Serious for more information.
v5.1 mature All production and legacy platforms, including SIM115, SIM225, SIM231, SIM243, SIM535, and SIM543
v5.0 retired None; projects should be migrated forward to the lastest revision of SHIPv5.1

For more information on SHIPv5:


Training and Applications Notes

Technical Reference

Retrieved from "https://techref.myserious.com/index.php?title=SHIP_Overview&oldid=8003"