tool_config.proto

Go to the documentation of this file.

// Copyright 2024-2026:
//   GobySoft, LLC (2013-)
//   Community contributors (see AUTHORS file)
// File authors:
//   Toby Schneider <toby@gobysoft.org>
//
//
// This file is part of the Goby Underwater Autonomy Project Libraries
// ("The Goby Libraries").
//
// The Goby Libraries are free software: you can redistribute them and/or modify
// them under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 2.1 of the License, or
// (at your option) any later version.
//
// The Goby Libraries are distributed in the hope that they will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with Goby.  If not, see <http://www.gnu.org/licenses/>.
 
syntax = "proto2";
import "goby/middleware/protobuf/app_config.proto";
import "goby/protobuf/option_extensions.proto";
import "goby/udpm/protobuf/interprocess_config.proto";
 
package goby.middleware.protobuf;
 
message PublishToolConfig
{
    option (goby.msg).cfg.tool = {
        is_tool: true
        has_subtools: false
        has_help_action: false
    };
 
    optional goby.middleware.protobuf.AppConfig app = 1
        [(goby.field) = { cfg { action: DEVELOPER } }];
    optional goby.udpm.protobuf.InterProcessPortalConfig interprocess = 2
            [(goby.field) = { cfg { env: "GOBY_INTERPROCESS" } }];
 
    required string group = 10 [(goby.field) = {
        description: "Group as string",
        cfg { position: { enable: true }, cli_short: "g" }
    }];
 
    required string type = 11 [(goby.field) = {
        description: "Scheme (as name: PROTOBUF, DCCL, JSON) followed by '/' and type name, if required. For example, 'PROTOBUF/NavigationReport', 'DCCL/NavigationReport', 'JSON/NavigationReport'. For JSON, you can omit '/<typename>' to publish as generic nlohmann::json. If string contains 'protobuf.', you can omit PROTOBUF/; e.g., 'goby.middleware.protobuf.IOData'",
        cfg { position: { enable: true }, cli_short: "t" }
    }];
 
    required string value = 12 [(goby.field) = {
        description: "Value as string",
        cfg { position: { enable: true } }
    }];
 
    repeated string load_shared_library = 20 [(goby.field) = {
        description: "Load this shared library containing compiled Protobuf/DCCL messages.",
        cfg { cli_short: "l" env: "GOBY_TOOL_LOAD_SHARED_LIBRARY" }
    }];
}
 
message SubscribeToolConfig
{
    option (goby.msg).cfg.tool = {
        is_tool: true
        has_subtools: false
        has_help_action: false
    };
 
    optional goby.middleware.protobuf.AppConfig app = 1
        [(goby.field) = { cfg { action: DEVELOPER } }];
    optional goby.udpm.protobuf.InterProcessPortalConfig interprocess = 2
            [(goby.field) = { cfg { env: "GOBY_INTERPROCESS" } }];
 
    optional string group_regex = 10 [
        default = ".*",
        (goby.field) = {
            description: "Group as string or regex",
            cfg { position: { enable: true }, cli_short: "g" }
        }
    ];
 
    optional string type_regex = 11 [
        default = ".*",
        (goby.field) = {
            description: "Type as string or regex",
            cfg { position: { enable: true }, cli_short: "t" }
        }
    ];
 
    optional string scheme = 12 [(goby.field) = {
        description: "Only subscribe to this marshalling scheme as string or integer [PROTOBUF|1, DCCL|2, JSON|7]. If omitted, all supported schemes are used.",
        cfg { position: { enable: true }, cli_short: "s" }
    }];
 
    repeated string load_shared_library = 20 [(goby.field) = {
        description: "Load this shared library containing compiled Protobuf/DCCL messages.",
        cfg { cli_short: "l" env: "GOBY_TOOL_LOAD_SHARED_LIBRARY" }
    }];
 
    optional bool include_internal_groups = 30 [default = false];
}