Difference between revisions of "SHIPHarbour:DataTypes:UpdateStage"

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==
+
== Description ==
This page is currently under construction. If you need immediate help with this topic, please contact [https://www.seriousintegrated.com/contact Serious Support].
+
<onlyinclude>Used in responses to [[SHIPHarbour:Firmware:Update|Update]] requests to notify the step of the update process being performed.</onlyinclude>
 +
 
 +
=== UNSET_UPDATESTAGE ===
 +
Must not be used, indicates the field was not set properly.
 +
 
 +
=== INVALID_UPDATESTAGE ===
 +
May be used internally to indicate an error when encountering an unexpected value.
 +
 
 +
=== STARTING ===
 +
Indicates the operation is just starting and no data has been transmitted.
 +
 
 +
=== RECEIVING ===
 +
Indicates SHIPHarbour Master is receiving the file data.
  
Thank you for your patience.
+
=== FORMATTING ===
 +
Indicates the module is currently formatting the destination storage device.
  
[[Category:NoIndex]]
+
=== WRITING ===
[[Category:UnderConstruction]]
+
Indicates SHIPHarbour Master is transmitting the file data to the module.
  
== Description ==
+
=== WRITING_DIRECT ===
<onlyinclude>Used in responses to [[SHIPHarbour:Firmware:Update|Update]] requests to notify the step of the update process being performed.</onlyinclude>
+
Indicates the module must write file data received from SHIPHarbour Master directly to the storage device, instead of to RAM first.

Latest revision as of 18:26, 31 July 2017

Description

Used in responses to Update requests to notify the step of the update process being performed.

UNSET_UPDATESTAGE

Must not be used, indicates the field was not set properly.

INVALID_UPDATESTAGE

May be used internally to indicate an error when encountering an unexpected value.

STARTING

Indicates the operation is just starting and no data has been transmitted.

RECEIVING

Indicates SHIPHarbour Master is receiving the file data.

FORMATTING

Indicates the module is currently formatting the destination storage device.

WRITING

Indicates SHIPHarbour Master is transmitting the file data to the module.

WRITING_DIRECT

Indicates the module must write file data received from SHIPHarbour Master directly to the storage device, instead of to RAM first.