Storage Messages

Storage Usage

Report of storage usage.

  • Abbreviation: StorageUsage
  • Identification Number: 100
  • Fixed Payload Size: 0
Name Abbreviation Unit Type Description Range
Available available MiB uint32_t The available storage of the reporting device. Same as field type
Usage value % uint8_t The percentage of storage used by the reporting device. Same as field type

Cache Control

Control caching of messages to persistent storage.

  • Abbreviation: CacheControl
  • Identification Number: 101
  • Fixed Payload Size: 0
Name Abbreviation Unit Type Description Range
Control Operation op Enumerated uint8_t Operation to perform. Same as field type
Snapshot destination snapshot - plaintext Destination for the cache snapshot file. Same as field type
Message message - message Message to store. Same as field type

Logging Control

Control logging of messages to persistent storage.

  • Abbreviation: LoggingControl
  • Identification Number: 102
  • Fixed Payload Size: 0
Name Abbreviation Unit Type Description Range
Control Operation op Enumerated uint8_t Operation to perform. Same as field type
Log Label / Path name - plaintext The meaning of this field depends on the operation and is explained in the operation’s description. Same as field type

Log Book Entry

Human readable message reporting an event of interest.

  • Abbreviation: LogBookEntry
  • Identification Number: 103
  • Fixed Payload Size: 0
Name Abbreviation Unit Type Description Range
Type type Enumerated uint8_t Type of message. Same as field type
Timestamp htime s fp64_t Timestamp (Epoch time). Same as field type
Context context - plaintext Message context. Same as field type
Text text - plaintext Message text. Same as field type

Log Book Control

Control history log.

  • Abbreviation: LogBookControl
  • Identification Number: 104
  • Fixed Payload Size: 0
Name Abbreviation Unit Type Description Range
Command command Enumerated uint8_t Command to perform. Same as field type
Timestamp htime s fp64_t Timestamp for command (Epoch time). Same as field type
Messages msg - message-list Argument, currently used only for ‘REPLY’. Same as field type

Replay Control

Control replay of LSF logged data.

  • Abbreviation: ReplayControl
  • Identification Number: 105
  • Fixed Payload Size: 0
Name Abbreviation Unit Type Description Range
Operation op Enumerated uint8_t Operation to perform. Same as field type
File To Replay file - plaintext Pathname of file to replay. Same as field type

Clock Control

Clock control.

  • Abbreviation: ClockControl
  • Identification Number: 106
  • Fixed Payload Size: 0
Name Abbreviation Unit Type Description Range
Operation op Enumerated uint8_t Operation to perform. Same as field type
Clock clock s fp64_t Clock value (Epoch time). Same as field type
Timezone tz - int8_t Timezone. Same as field type

Historic CTD

This message is used to store historic (transmitted afterwards) CTD data .

  • Abbreviation: HistoricCTD
  • Identification Number: 107
  • Fixed Payload Size: 0
Name Abbreviation Unit Type Description Range
Conductivity conductivity S/m fp32_t   Same as field type
Temperature temperature °C fp32_t   Same as field type
Depth depth m fp32_t   Same as field type

Historic Telemetry

This message is used to store historic (transmitted afterwards) telemetry information.

  • Abbreviation: HistoricTelemetry
  • Identification Number: 108
  • Fixed Payload Size: 0
Name Abbreviation Unit Type Description Range
Altitude altitude m fp32_t   Same as field type
Roll roll - uint16_t Roll encoded as α.(65535/(2.π)) Same as field type
Pitch pitch - uint16_t Pitch encoded as α.(65535/(2.π)) Same as field type
Yaw yaw - uint16_t Yaw encoded as α.(65535/(2.π)) Same as field type
Speed speed dm int16_t   Same as field type

Historic Sonar Data

This message is used to store historic (transmitted afterwards) sonar data.

  • Abbreviation: HistoricSonarData
  • Identification Number: 109
  • Fixed Payload Size: 0
Name Abbreviation Unit Type Description Range
Altitude altitude m fp32_t   Same as field type
Width width m fp32_t   Same as field type
Length length m fp32_t   Same as field type
Bearing bearing - fp32_t   Same as field type
Pixels Per Line pxl - int16_t The number of pixels per line as the data in ‘sonar_data’ may correspond to more than one sequential sidescan lines. Same as field type
Encoding encoding Enumerated uint8_t   Same as field type
SonarData sonar_data - rawdata Sonar data encoded as in ‘encoding’. Same as field type

Historic Event

This message is used to store historic event log entries.

  • Abbreviation: HistoricEvent
  • Identification Number: 110
  • Fixed Payload Size: 0
Name Abbreviation Unit Type Description Range
Event text - plaintext   Same as field type
Event Type type Enumerated uint8_t Type of event. Same as field type