hub.proto

Go to the documentation of this file.

syntax = "proto2";
 
import "dccl/option_extensions.proto";
import "jaiabot/messages/health.proto";
import "goby/middleware/protobuf/coroner.proto";
import "jaiabot/messages/geographic_coordinate.proto";
import "jaiabot/messages/option_extensions.proto";
 
package jaiabot.protobuf;
 
message HubStatus
{
    option (dccl.msg) = {
        unit_system: "si"
    };
 
    required uint32 hub_id = 1 [(jaia.field).rest_api.presence = GUARANTEED];
    required uint32 fleet_id = 2 [(jaia.field).rest_api.presence = GUARANTEED];
    required uint64 time = 3 [
        (dccl.field) = { units { prefix: "micro" derived_dimensions: "time" } },
        (jaia.field).rest_api.presence = GUARANTEED
    ];
 
    optional goby.middleware.protobuf.HealthState health_state = 4
        [(jaia.field).rest_api.presence = GUARANTEED];
    repeated Error error = 5 [
        (dccl.field).max_repeat = 255,
        (jaia.field).rest_api.presence = GUARANTEED
    ];  // set max_repeat to a high value as we're not sending this over DCCL
    // for now, but populate_status_from_health uses this value
    repeated Warning warning = 6 [
        (dccl.field).max_repeat = 255,
        (jaia.field).rest_api.presence = GUARANTEED
    ];
 
    optional GeographicCoordinate location = 10
        [(jaia.field).rest_api.presence = GUARANTEED];
 
    repeated uint32 bot_ids_in_radio_file = 11 [(dccl.field).max_repeat = 255];
 
    optional LinuxHardwareStatus linux_hardware_status = 12;
 
    message BotOffloadData
    {
        required uint32 bot_id = 1;
        optional int32 data_offload_percentage = 2;
        optional bool offload_succeeded = 3;
    }
    optional BotOffloadData bot_offload = 13;
 
    optional uint64 received_time = 14 [
        (dccl.field) = {
            omit: true
            units { prefix: "micro" derived_dimensions: "time" }
        },
        (jaia.field).rest_api.presence = GUARANTEED
    ];
 
    message KnownBot
    {
        required uint32 id = 1 [(jaia.field).rest_api.presence = GUARANTEED];
        required uint64 last_status_time = 2 [
            (dccl.field) = {
                units { prefix: "micro" derived_dimensions: "time" }
            },
            (jaia.field).rest_api.presence = GUARANTEED
        ];
    }
    repeated KnownBot known_bot = 15
        [(jaia.field).rest_api.presence = GUARANTEED];
}