Difference between revisions of "SHIPHarbour:XVars"

From Serious Documentation
Jump to: navigation, search
Line 4: Line 4:
 
== Description ==
 
== 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.
 
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.
 +
 +
== Enums ==
 +
==== [[SHIPHarbour:XVars:Type|Type]] ====
 +
{{:SHIPHarbour:XVars:Type|Type}}
  
 
== Types ==
 
== Types ==

Revision as of 16:56, 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=7344"