Difference between revisions of "SHIPHarbour:DataTypes:ModuleDetails"

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...")
 
 
Line 1: Line 1:
==Coming Soon==
 
This page is currently under construction. If you need immediate help with this topic, please contact [https://www.seriousintegrated.com/contact Serious Support].
 
  
Thank you for your patience.
+
== Source File ==
 
+
[[SHIPHarbour:DataTypes|SHIPHarbour_DataTypes.proto]]
[[Category:NoIndex]]
 
[[Category:UnderConstruction]]
 
  
 
== Description ==
 
== Description ==
 
<onlyinclude>Used in spontaneous [[SHIPHarbour:Master:ModuleInfo|ModuleInfo]] updates to inform the client about module connections and disconnections in [[SHIPHarbour_Master|SHIPHarbour Master]].</onlyinclude>
 
<onlyinclude>Used in spontaneous [[SHIPHarbour:Master:ModuleInfo|ModuleInfo]] updates to inform the client about module connections and disconnections in [[SHIPHarbour_Master|SHIPHarbour Master]].</onlyinclude>
 +
 +
== Message Fields ==
 +
 +
==== module ====
 +
A [[SHIPHarbour:DataTypes:Module|Module]] used to provide the client with information necessary for routing requests.
 +
 +
==== family ====
 +
Raw integer value of product family portion of serial number.
 +
 +
==== version ====
 +
Raw integer value of product version portion of serial number.
 +
 +
==== variant ====
 +
Raw integer value of product variant portion of serial number.
 +
 +
==== lcdCode ====
 +
Raw integer value of product LCD code portion of serial number.
 +
 +
==== id ====
 +
Raw integer value of product unique id portion of serial number.
 +
 +
==== currentProgram ====
 +
A [[SHIPHarbour:DataTypes:Firmware|Firmware]] used to inform the client about what the module is currently executing.

Latest revision as of 17:50, 31 July 2017

Source File

SHIPHarbour_DataTypes.proto

Description

Used in spontaneous ModuleInfo updates to inform the client about module connections and disconnections in SHIPHarbour Master.

Message Fields

module

A Module used to provide the client with information necessary for routing requests.

family

Raw integer value of product family portion of serial number.

version

Raw integer value of product version portion of serial number.

variant

Raw integer value of product variant portion of serial number.

lcdCode

Raw integer value of product LCD code portion of serial number.

id

Raw integer value of product unique id portion of serial number.

currentProgram

A Firmware used to inform the client about what the module is currently executing.