driver_base.proto

Go to the documentation of this file.

syntax = "proto2";
import "goby/protobuf/option_extensions.proto";
 
package goby.acomms.protobuf;
 
// known drivers - should make this somehow extensible outside Goby
enum DriverType
{
    DRIVER_NONE = 1;
    DRIVER_WHOI_MICROMODEM = 2;
    DRIVER_ABC_EXAMPLE_MODEM = 3;
    DRIVER_UFIELD_SIM_DRIVER = 4;
    DRIVER_STORE_SERVER = 5;
    DRIVER_UDP = 6;
    DRIVER_BLUEFIN_MOOS = 7;
    DRIVER_IRIDIUM = 8;
    DRIVER_IRIDIUM_SHORE = 9;
    DRIVER_BENTHOS_ATM900 = 10;
    DRIVER_UDP_MULTICAST = 11;
    DRIVER_POPOTO = 12;
    DRIVER_JANUS = 13;
}
 
 
message DriverConfig
{
    oneof driver
    {
        goby.acomms.protobuf.DriverType driver_type = 1 [
            default = DRIVER_NONE,
            (goby.field).description =
                "Driver for the type of physical link used"
        ];
        string driver_name = 2 [(goby.field).description =
                                    "Driver name to load from plugin library"];
    }
 
    optional int32 modem_id = 10 [
        (goby.field).description = "Unique number 1-31 to identify this node",
        (goby.field).example = "1"
    ];
 
    enum ConnectionType
    {
        CONNECTION_SERIAL =
            1;  // Modem is connected by a tty serial line (e.g. RS-232)
        CONNECTION_TCP_AS_CLIENT =
            2;  // Modem is connected by ethernet and is serving clients
        CONNECTION_TCP_AS_SERVER =
            3;  // Modem is connected by ethernet and expects us to serve it
    }
 
    optional ConnectionType connection_type = 20 [
        default = CONNECTION_SERIAL,
        (goby.field).description =
            "Physical connection type from this computer (running Goby) to the "
            "acoustic modem"
    ];
    optional string line_delimiter = 21 [
        default = "\r\n",
        (goby.field).description =
            "String used to delimit new lines for this acoustic modem"
    ];  // delimits lines on the serial or tcp interface
 
    // required if connection_type == CONNECTION_SERIAL
    optional string serial_port = 22 [
        (goby.field).description = "Serial port for CONNECTION_SERIAL",
        (goby.field).example = "/dev/ttyS0"
    ];
    optional uint32 serial_baud = 23 [
        (goby.field).description = "Baud rate for CONNECTION_SERIAL",
        (goby.field).example = "19200"
    ];
 
    // required if connection_type == CONNECTION_TCP_AS_CLIENT
    optional string tcp_server = 24 [
        (goby.field).description =
            "IP Address or domain name for the server if "
            "CONNECTION_TCP_AS_CLIENT",
        (goby.field).example = "192.168.1.111"
    ];
 
    // required if connection_type == CONNECTION_TCP_AS_CLIENT or
    // CONNECTION_TCP_AS_SERVER
    optional uint32 tcp_port = 25 [
        (goby.field).description =
            "Port to serve on (for CONNECTION_TCP_AS_SERVER) or to connect to "
            "(for CONNECTION_TCP_AS_CLIENT)",
        (goby.field).example = "50010"
    ];
 
    optional uint32 reconnect_interval = 26 [
        (goby.field).description = "Seconds between TCP reconnect attempts",
        default = 10
    ];
 
    optional string raw_log = 30
        [(goby.field).description =
             "File to write raw modem log to. If %1% is present, is replaced "
             "with the current timestamp."];
 
    extensions 1000 to max;
    // extension 1000 used by acomms_mm_driver.proto
    // extension 1201 used by acomms_abc_driver.proto (example driver)
    // extension 1300 used by ufield_sim_driver.proto
    // extension 1321 used by store_server_driver.proto
    // extension 1341 used by udp_driver.proto
    // extension 1342 used by udp_multicast_driver.proto
    // extension 1343 used by pluggable udp_multicast_driver (in goby3-examples)
    // extension 1361 used by bluefin_sim_driver.proto
    // extension 1381 used by iridium_driver.proto
    // extensions 1401-1420 used by MOOSSafir (external)
    // extension 1421 used by iridium_shore_driver.proto
    // extension 1441 used by benthos_atm900.proto
    // extension 1442 used by popoto.proto
    // extension 1443 used by Jaiabot XBee
    // extensions 1510-1519 used by Blue Ocean Seismic Services
}