SHIPHarbour:Generic:Routine

From Serious Documentation
Jump to: navigation, search

Source File

SHIPHarbour_Generic.proto

Description

All requests that are directly targeted at interacting with a Serious Integrated module are encapsulated in this message type.

Message Fields

info

Appears in all Routine requests, used to create and route a request to perform an operation on a specific Endpoint inside of SHIPHarbour Master.

routine

Holds exactly one of the following types:

  • cancel - Used to request that SHIPHarbour Master abort execution of an existing request.
  • installed - These messages are used to retrieve the information of all firmware currently installed on the Serious Integrated module.
  • update - These messages are used to directly update any firmware on a Serious Integrated module.
  • remove - These messages are used to uninstall certain firmware files on a Serious Integrated module.
  • setState - These messages are used to change the currently executing program or the state of the program on a Serious Integrated module.
  • exchange - These messages are used to receive from and transmit to variables available on a Serious Integrated module.
  • transmit - These messages are used to upload any arbitrary file to a Serious Integrated module.
  • receive - These messages are used to download any arbitrary file from a Serious Integrated module.
  • delete - These messages are used to remove any arbitrary file from a Serious Integrated module.