popoto_driver.proto

Go to the documentation of this file.

/* Copyright (c) 2020 mission systems pty ltd */
 
syntax = "proto2";
import "goby/protobuf/option_extensions.proto";
import "dccl/option_extensions.proto";
import "goby/acomms/protobuf/driver_base.proto"; // load up message DriverBaseConfig
import "goby/acomms/protobuf/modem_message.proto";
 
package goby.acomms.popoto.protobuf;
 
message Config
{
    optional int32 start_timeout = 1 [
        default = 30,
        (goby.field).description =
            "Number of seconds to initialize the modem before giving up"
    ];
 
    optional int32 payload_mode = 2 [
        default = 0,
        (dccl.field).min = 0,
        (dccl.field).max = 5,
        (goby.field).description =
            "The modulation rate of the payload portion of the waveform, 0-5"
    ];
 
    optional double modem_power = 3 [
        default = 1,
        (dccl.field).min = 0.1,
        (dccl.field).max = 100,
        (dccl.field).precision = 2,
        (goby.field).description = "Modem Tx strength 1-100W"
    ];
 
    optional int32 application_type = 5 [
        default = 0,
        (dccl.field).min = 0,
        (dccl.field).max = 5,
        (goby.field).description = "Application type for JANUS message"
    ];
}
// added 1442 in modem driver
extend goby.acomms.protobuf.DriverConfig
{
    optional Config config = 1442;
}
 
enum TransmissionType
{
    BASE_TYPE = 0;
 
    // POPOTO_TWO_WAY_PING = 1;  // replaced by POPOTO_TWO_WAY_RANGE_REQUEST / POPOTO_TWO_WAY_RANGE_RESPONSE
 
    
    POPOTO_PLAY_FILE = 2;
    POPOTO_TWO_WAY_RANGE_REQUEST = 3;  // Ranging request
    POPOTO_TWO_WAY_RANGE_RESPONSE =
        4;  // Response that you receive to a ranging request
    POPOTO_DEEP_SLEEP = 5;
    POPOTO_WAKE = 6;
    POPOTO_SET_TX = 7;
}
message RangingReply
{
    required double one_way_travel_time = 1
        [(dccl.field).units.unit =
             "si::second"];  // Popoto doesn't give this. This will be
                             // calculated by the driver using TWTT
    optional double two_way_travel_time = 2
        [(dccl.field).units.unit = "si::second"];
    optional double modem_range = 3;        // meters
    optional double modem_sound_speed = 4;  // m/s
}
message Transmission
{
    optional TransmissionType type = 1 [
        (goby.field).description =
            "Type of transmission if base `type` == DRIVER_SPECIFIC",
        default = BASE_TYPE
    ];
    optional RangingReply ranging_reply = 3;
    optional string file_location = 4;
    optional double transmit_power = 5;
}
 
extend goby.acomms.protobuf.ModemTransmission
{
    optional Transmission transmission = 1441;
}