/*
  Сервис управления оповещением
*/
syntax = "proto3";

import "protoc-gen-openapiv2/options/annotations.proto";
import "google/api/field_behavior.proto";
import "google/api/annotations.proto";
import "deviceapis/device/v1/deviceapis_device_common_v1.proto";

package deviceapis.device.v1;

option java_package = "ru.deviceapis.device.v1";
option java_outer_classname = "DeviceapisDeviceV1Proto";
option java_multiple_files = false;
option java_string_check_utf8 = true;
option go_package = "/deviceapis_device_v1";
option cc_enable_arenas = true;
option csharp_namespace = "Deviceapis.Device.V1";
option objc_class_prefix = "DEVICEAPISDEVICEV1";
option php_namespace = "Deviceapis\\Device\\V1";
option ruby_package = "Deviceapis::Device::V1";
option optimize_for = LITE_RUNTIME;

// Сервис управления оповещением
service SafeCityEmergencyService {
  // Старт оповещения.
  // Где Tick - один цикл оповещения на одном или двух направлениях (трубка, динамик или трубка и динамик).
  // playbacks_per_tick - Количество воспроизведений файла в каждом цикле оповещения на одном направлении (трубка или динамик).
  // tick_count - Количество воспроизведений циклов оповещения.
  // Длительность оповещения = tick_count * (Х * playbacks_per_tick (трубка) + Х * playbacks_per_tick (динамик)).
  // total_duration - Максимальная общая длительность оповещения. По истечении total_duration секунд оповещение прекращается независимо от количества циклов
  rpc PostSafeCityEmergencyStart(PostSafeCityEmergencyStartRequest) returns (PostSafeCityEmergencyStartResponse) {
    option (google.api.http) = {
      post: "/device/api/v1/safe_city/emergency/start"
      body: "*"
    };
  }
  // Прекращение оповещения
  rpc PostSafeCityEmergencyStop(PostSafeCityEmergencyStopRequest) returns (PostSafeCityEmergencyStopResponse) {
    option (google.api.http) = {
      post: "/device/api/v1/safe_city/emergency/stop"
      body: "*"
    };
  }
  // Получение статуса оповещения
  rpc GetSafeCityEmergencyStatus(GetSafeCityEmergencyStatusRequest) returns (GetSafeCityEmergencyStatusResponse) {
    option (google.api.http) = {
      get: "/device/api/v1/safe_city/emergency/status"
    };
  }
}


// Запрос на прекращение оповещения через домофон
message PostSafeCityEmergencyStopRequest {
}

// Ответ на запрос на прекращение оповещения через домофон
message PostSafeCityEmergencyStopResponse {
}

// Запрос на получение статуса оповещения
message GetSafeCityEmergencyStatusRequest {
}

// Ответ на запрос на получение статуса оповещения
message GetSafeCityEmergencyStatusResponse {
  // Статус оповещения
  message CurrentStatus {
    // Признак работающего оповещения в текущий момент
    bool is_running = 1 [(google.api.field_behavior) = REQUIRED];
    // Тип проигрывания
    EmergencyScenario.PlayOrderType emergency_scenario_play_order_type = 2;
    // Имя файла
    string file_name = 3 [
      (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
        example: "\"Happy_new_year.wav\""
      }
    ];
  }
  // Статус оповещения
  CurrentStatus data = 1;
}

// Сценарий оповещения
message EmergencyScenario {
  // Имя файла
  string file_name = 1 [
    (google.api.field_behavior) = REQUIRED,
    (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
      example: "\"Happy_new_year.wav\""
    }
  ];
  // Максимальная общая длительность оповещения, в секундах.
  // # Диапазон: 0..65536
  int32 total_duration = 2 [
    (google.api.field_behavior) = REQUIRED,
    (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
      example: "3600"
    }
  ];
  // Количество воспроизведений файла в каждом цикле оповещения на одном направлении (трубка или динамик).
  // # Диапазон: 0..65536
  int32 playback_per_tick = 3 [
    (google.api.field_behavior) = REQUIRED,
    (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
      example: "3"
    }
  ];
  // Количество воспроизведений циклов оповещения.
  // # Диапазон: 0..65536
  int32 tick_count = 4 [
    (google.api.field_behavior) = REQUIRED,
    (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
      example: "10"
    }
  ];
  // Тип проигрывания.
  // # Тип: byte
  enum PlayOrderType {
    // Значение не указано
    PLAY_ORDER_TYPE_UNKNOWN = 0;
    // Только на аналоговые трубки
    HANDSET_ONLY = 1;
    // Tолько на динамик домофона
    SPEAKER_ONLY = 2;
    // Сначала на аналоговые трубки проигрываем заданное количество тактов, затем на динамик домофона
    HANDSET_FIRST = 3;
    // Сначала на динамик домофона проигрываем заданное количество тактов, затем на аналоговые трубки
    SPEAKER_FIRST = 4;
    // Одновременно на аналоговые трубки проигрываем заданное количество тактов, затем на динамик домофона
    HANDSET_AND_SPEAKER = 5;
  }
  // Тип проигрывания
  PlayOrderType play_order_type = 5 [
    (google.api.field_behavior) = REQUIRED,
    (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
      example: "\"SPEAKER_ONLY\""
    }
  ];
}

// Запрос на старт оповещения
message PostSafeCityEmergencyStartRequest {
  // Сценарий оповещения
  EmergencyScenario data = 1 [(google.api.field_behavior) = REQUIRED];
}

// Ответ на запрос на старт оповещения
message PostSafeCityEmergencyStartResponse {
  // Ошибка запроса
  message Error {
    // Звуковой файл не найден
    message SoundFileNotFound {}
    // Причина ошибки
    oneof reason {
      // Ошибка валидации
      ValidationError validation = 1;
      // Звуковой файл не найден
      SoundFileNotFound sound_file_not_found = 2;
    }
  }
  // Тип результата
  oneof type {
    // Ошибка
    Error error = 1;
  }
}