Difference between revisions of "SHIPHarbour:XVars"

From Serious Documentation
Jump to: navigation, search
(Created page with "==Coming Soon== This page is currently under construction. If you need immediate help with this topic, please contact [https://www.seriousintegrated.com/contact Serious Suppor...")
 
(→‎Source File)
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
==Coming Soon==
+
== Source File ==
−
This page is currently under construction. If you need immediate help with this topic, please contact [https://www.seriousintegrated.com/contact Serious Support].
+
[[SHIPHarbour:XVars|SHIPHarbour_XVars.proto]]
  
−
Thank you for your patience.
+
== Description ==
 +
The [[SHIPHarbour]] API allows access to remote variables on a Serious Integrated module. On modules running [[SHIPEngine]], the [[SHIP:Sail_Overview|Sail]] GUI must allow these variables to be accessed via a [[SHIP:Node:link|link]] using the [[Protocol:SHIPBridge|SHIPBridge]] protocol.
  
−
[[Category:NoIndex]]
+
== Enums ==
−
[[Category:UnderConstruction]]
+
==== [[SHIPHarbour:XVars:Type|Type]] ====
 +
{{:SHIPHarbour:XVars:Type|Type}}
 +
 
 +
== Types ==
 +
==== [[SHIPHarbour:XVars:Set|Set]] ====
 +
{{:SHIPHarbour:XVars:Set|Set}}
 +
 
 +
==== [[SHIPHarbour:XVars:Var|Var]] ====
 +
{{:SHIPHarbour:XVars:Var}}
 +
 
 +
== Routines ==
 +
 
 +
==== [[SHIPHarbour:XVars:Exchange|Exchange]] ====
 +
{{:SHIPHarbour:XVars:Exchange}}
 +
 
 +
[[Category:SHIPHarbour]]

Latest revision as of 19:11, 31 July 2017

Source File

SHIPHarbour_XVars.proto

Description

The SHIPHarbour API allows access to remote variables on a Serious Integrated module. On modules running SHIPEngine, the Sail GUI must allow these variables to be accessed via a link using the SHIPBridge protocol.

Enums

Type

Used in XVar requests to strictly define the type of data being transmitted and received.

Types

Set

Directly relates to a SHIPBridge linkset definable in Sail.

Var

Directly relates to a SHIPBridge linkvar definable in Sail.

Routines

Exchange

These messages are used to receive from and transmit to variables available on a Serious Integrated module.

Retrieved from "https://techref.myserious.com/index.php?title=SHIPHarbour:XVars&oldid=7389"