SHIPHarbour:XVars:Exchange

From Serious Documentation
Jump to: navigation, search

Source File

SHIPHarbour_XVars.proto

Description

These messages are used to receive from and transmit to variables available 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.