Difference between revisions of "SHIPHarbour Master"

From Serious Documentation
Jump to: navigation, search
(Supported Connections and Plugins)
Line 1: Line 1:
''SHIPHarbour Master was introduced in SHIPv5.1'' {{v5}}
+
''[[SHIPHarbour Master]] was introduced in SHIPv5.1'' {{v5}}
  
The ''SHIPHarbour Master'' application provides connection management between a PC-based applications and [[SIM|SIMs]]/[[SCM|SCMs]] running the [[SHIPBridge|SHIPBridge Communications Protocol]].
+
The [[SHIPHarbour Master]] application provides connection management between a PC-based applications and [[SIM|SIMs]]/[[SCM|SCMs]] running the [[SHIPBridge|SHIPBridge Communications Protocol]].
  
== Running ''SHIPHarbour Master'' ==
+
== Running [[SHIPHarbour Master]] ==
''SHIPHarbour Master'' can be launched manually, but is launched automatically when any of the SHIP PC-based tools (including the [[SHIPTide]] GUI authoring tool as well as [[SHIPCrane]] and [[SeaShell]] programming tools) require it.  It sits in the system tray on Windows as a background application, and provides a Windows 10 notification pop-up whenever a SIM/SCM running the [[SHIPBridge|SHIPBridge Protocol]] is connected to the PC:
+
[[SHIPHarbour Master]] can be launched manually, but is launched automatically when any of the SHIP PC-based tools (including the [[SHIPTide]] GUI authoring tool as well as [[SHIPCrane]] and [[SeaShell]] programming tools) require it.  It sits in the system tray on Windows as a background application, and provides a Windows 10 notification pop-up whenever a SIM/SCM running the [[SHIPBridge|SHIPBridge Protocol]] is connected to the PC:
  
 
[[Image:SHIPHM_Connected.jpg|center]]
 
[[Image:SHIPHM_Connected.jpg|center]]
  
''SHIPHarbour Master'', as released in SHIPv5.1.0, has minimal functionality in the operator console beyond its inherent connection management features.  The intent, over time, is to increase its functionality so you will be able to (for instance) discover directly in the application what firmware is installed in a given device.  
+
[[SHIPHarbour Master]], as released in SHIPv5.1.0, has minimal functionality in the operator console beyond its inherent connection management features.  The intent, over time, is to increase its functionality so you will be able to (for instance) discover directly in the application what firmware is installed in a given device.  
  
 
Minimizing the app back to the system tray shows this note:
 
Minimizing the app back to the system tray shows this note:
Line 14: Line 14:
 
[[Image:SHIPHM_Docked.jpg|center]]
 
[[Image:SHIPHM_Docked.jpg|center]]
  
== Writing Custom Applications for ''SHIPHarbour Master'' ==
+
== Writing Custom Applications for [[SHIPHarbour Master]] ==
You can write your own applications to talk to the ''SHIPHarbour Master'' application. For example, you may want to integrate functionality similar to the [[SHIPCrane]] programming tool into your own manufacturing framework (written, say, in Python or .net/C#) rather than using the [[SHIPCrane]] tool directly. ''SHIPHarbor Master'' exposes a socket interface to PC-based applications, and supports simultaneous connected applications and simultaneous connected devices. The socket interface is defined in the [[SHIPHarbor API]] documentation.
+
You can write your own applications to talk to the [[SHIPHarbour Master]] application. For example, you may want to integrate functionality similar to the [[SHIPCrane]] programming tool into your own manufacturing framework (written, say, in Python or .net/C#) rather than using the [[SHIPCrane]] tool directly. ''SHIPHarbor Master'' exposes a socket interface to PC-based applications, and supports simultaneous connected applications and simultaneous connected devices. The socket interface is defined in the [[SHIPHarbor API]] documentation.
  
 
== Supported Connections and Plugins ==
 
== Supported Connections and Plugins ==
''SHIPHarbour Master'' supports the concept of plugins for different connections to SIMs/SCMs. Currently plugins are only implementable by Serious, however we expect in 2017 a plugin writers' guide will be available for custom plugins.
+
[[SHIPHarbour Master]] supports the concept of plugins for different connections to SIMs/SCMs. Currently plugins are only implementable by Serious, however we expect in 2017 a plugin writers' guide will be available for custom plugins.
 
=== USB ===
 
=== USB ===
 
USB (via a PCs USB host port to a SIM/SCM's USB Device port) is the normal connection method from a PC to a SIM/SCM, and this plugin is fully implemented and supported. You can use one (or several) multi-port USB hubs and [[SHIPHarbour Master]] will manage these connections in parallel.
 
USB (via a PCs USB host port to a SIM/SCM's USB Device port) is the normal connection method from a PC to a SIM/SCM, and this plugin is fully implemented and supported. You can use one (or several) multi-port USB hubs and [[SHIPHarbour Master]] will manage these connections in parallel.
 
 
=== CAN  ===
 
=== CAN  ===
 
This support is currently in development, and will be initially released on a custom basis to customers in Q3'2016.
 
This support is currently in development, and will be initially released on a custom basis to customers in Q3'2016.

Revision as of 01:59, 3 August 2016

SHIPHarbour Master was introduced in SHIPv5.1 Badge SHIPv5.gif

The SHIPHarbour Master application provides connection management between a PC-based applications and SIMs/SCMs running the SHIPBridge Communications Protocol.

Running SHIPHarbour Master

SHIPHarbour Master can be launched manually, but is launched automatically when any of the SHIP PC-based tools (including the SHIPTide GUI authoring tool as well as SHIPCrane and SeaShell programming tools) require it. It sits in the system tray on Windows as a background application, and provides a Windows 10 notification pop-up whenever a SIM/SCM running the SHIPBridge Protocol is connected to the PC:

SHIPHM Connected.jpg

SHIPHarbour Master, as released in SHIPv5.1.0, has minimal functionality in the operator console beyond its inherent connection management features. The intent, over time, is to increase its functionality so you will be able to (for instance) discover directly in the application what firmware is installed in a given device.

Minimizing the app back to the system tray shows this note:

SHIPHM Docked.jpg

Writing Custom Applications for SHIPHarbour Master

You can write your own applications to talk to the SHIPHarbour Master application. For example, you may want to integrate functionality similar to the SHIPCrane programming tool into your own manufacturing framework (written, say, in Python or .net/C#) rather than using the SHIPCrane tool directly. SHIPHarbor Master exposes a socket interface to PC-based applications, and supports simultaneous connected applications and simultaneous connected devices. The socket interface is defined in the SHIPHarbor API documentation.

Supported Connections and Plugins

SHIPHarbour Master supports the concept of plugins for different connections to SIMs/SCMs. Currently plugins are only implementable by Serious, however we expect in 2017 a plugin writers' guide will be available for custom plugins.

USB

USB (via a PCs USB host port to a SIM/SCM's USB Device port) is the normal connection method from a PC to a SIM/SCM, and this plugin is fully implemented and supported. You can use one (or several) multi-port USB hubs and SHIPHarbour Master will manage these connections in parallel.

CAN

This support is currently in development, and will be initially released on a custom basis to customers in Q3'2016.

UART over USB/CDC

This support is planned.

UART

This support is planned.

TCP/IP over Ethernet or WiFi

This support is planned.