Difference between revisions of "SHIPHarbour:XVars:Exchange"

From Serious Documentation
Jump to: navigation, search
(Source File)
Line 16: Line 16:
  
 
==== set ====
 
==== set ====
An array of [[SHIPHarbour:XVars:Exchange:Set|Sets]] which will contain associated [[SHIPHarbour:XVars:Exchange:Var|Vars]].
+
An array of [[SHIPHarbour:XVars:Set|Sets]] which will contain associated [[SHIPHarbour:XVars:Var|Vars]].
  
 
----
 
----
Line 24: Line 24:
  
 
==== set ====
 
==== set ====
An array of [[SHIPHarbour:XVars:Exchange:Set|Sets]] which may contain associated [[SHIPHarbour:XVars:Exchange:Var|Vars]].
+
An array of [[SHIPHarbour:XVars:Set|Sets]] which may contain associated [[SHIPHarbour:XVars:Var|Vars]].
  
 
==== id ====
 
==== id ====
Line 43: Line 43:
  
 
==== set ====
 
==== set ====
An array of [[SHIPHarbour:XVars:Exchange:Set|Sets]] which may contain associated [[SHIPHarbour:XVars:Exchange:Var|Vars]].
+
An array of [[SHIPHarbour:XVars:Set|Sets]] which may contain associated [[SHIPHarbour:XVars:Var|Vars]].

Revision as of 16:20, 31 July 2017

Source File

SHIPHarbour_XVars.proto

Description

These messages are used to directly update any firmware on a Serious Integrated module.

Message Fields

Initial Message Fields

No fields should be set in the initial message.


Initial Response Fields

SHIPHarbour Master will respond to the initial request with a message detailing all available XVars on the Serious Integrated module.

set

An array of Sets which will contain associated Vars.


Writing to XVars

One pending write request to any number of output XVars is allowed at a time.

set

An array of Sets which may contain associated Vars.

id

An optional message ID useful for the client to interpret acknowledgement responses.


Responses to XVar writes

SHIPHarbour Master will send a response message for each write request from the client with a matching id.

id

An optional message ID useful for the client to interpret acknowledgement responses.


Updates to XVars

SHIPHarbour Master will spontaneously send messages to the client when the Serious Integrated module updates values.

set

An array of Sets which may contain associated Vars.