MachineReport.proto

/***************************************************************************
 *  MachineReport.proto - LLSF Protocol - Exploration Phase Report
 *
 *  Created: Thu Mar 07 16:07:15 2013
 *  Copyright  2013  Tim Niemueller [www.niemueller.de]
 *             2017  Tobias Neumann
 ****************************************************************************/

/*  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in
 *   the documentation and/or other materials provided with the
 *   distribution.
 * - Neither the name of the authors nor the names of its contributors
 *   may be used to endorse or promote products derived from this
 *   software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 */

syntax = "proto2";

package llsf_msgs;

import "Team.proto";
import "Zone.proto";

option java_package = "org.robocup_logistics.llsf_msgs";
option java_outer_classname = "MachineReportProtos";

message MachineReportEntry {
  enum CompType {
    COMP_ID = 2000;
    MSG_TYPE = 60;
  }

  // Machine name and recognized type
  // and zone the machine is in
  optional string name = 1;
  optional string type = 2;
  optional Zone zone = 3;
  optional uint32 rotation = 4; // [0-360] in deg
}

// Robots send this to announce recognized
// machines to the refbox.
message MachineReport {
  enum CompType {
    COMP_ID = 2000;
    MSG_TYPE = 61;
  }

  // Team for which the report is sent
  required Team team_color = 2;

  // All machines already already recognized
  // or a subset thereof
  repeated MachineReportEntry machines = 1;
}

// The refbox periodically sends this to
// acknowledge reported machines
message MachineReportInfo {
  enum CompType {
    COMP_ID = 2000;
    MSG_TYPE = 62;
  }

  // Names of machines for which the refbox
  // received a report from a robot (which
  // may have been correct or wrong)
  repeated string reported_machines = 1;

  // Team for which the report is sent
  required Team team_color = 2;

  // Responses to reports that were received by the refbox and
  // that contained machine types and zones
  repeated MachineTypeFeedback reported_types = 3;
}

message MachineTypeFeedback {
  enum CompType {
    COMP_ID = 2000;
    MSG_TYPE = 63;
  }

  // Feedback about whether a reported type in a zone is correct
  // "name" and "team_color" are only set if the reported type is
  // located in the zone  and if the number of reported types did not
  // exceed the number of machines with the types
  required string type = 1;
  required Zone zone = 2;
  optional string name = 3;
  optional Team team_color = 4;
}