# Протокол

## Оглавление

- [deviceapis/device/v1/deviceapis_device_door_schema_v1.proto](#deviceapis_device_v1_deviceapis_device_door_schema_v1-proto)
    - [DoorSchemaService](#deviceapis-device-v1-DoorSchemaService)
  
    - [DoorSchema](#deviceapis-device-v1-DoorSchema)
    - [EditDoorSchemaRequest](#deviceapis-device-v1-EditDoorSchemaRequest)
    - [EditDoorSchemaResponse](#deviceapis-device-v1-EditDoorSchemaResponse)
    - [EditDoorSchemaResponse.Error](#deviceapis-device-v1-EditDoorSchemaResponse-Error)
    - [GetDoorSchemaRequest](#deviceapis-device-v1-GetDoorSchemaRequest)
    - [GetDoorSchemaResponse](#deviceapis-device-v1-GetDoorSchemaResponse)
  
    - [DoorSchema.Type](#deviceapis-device-v1-DoorSchema-Type)
  


## [Схема классов](/svg/protos/key/deviceapis/device/v1/deviceapis_device_door_schema_v1.proto.svg)
<a href="/svg/protos/key/deviceapis/device/v1/deviceapis_device_door_schema_v1.proto.svg"><img src="/svg/protos/key/deviceapis/device/v1/deviceapis_device_door_schema_v1.proto.svg" alt="/svg/protos/key/deviceapis/device/v1/deviceapis_device_door_schema_v1.proto.svg" style="height:100%;"></a>




<a name="deviceapis_device_v1_deviceapis_device_door_schema_v1-proto"></a>

## [deviceapis/device/v1/deviceapis_device_door_schema_v1.proto](/protos/key/deviceapis/device/v1/deviceapis_device_door_schema_v1.proto)
Сервис управления режимом работы контроллера


<a name="deviceapis-device-v1-DoorSchemaService"></a>

### DoorSchemaService
 Сервис управления режимом работы контроллера

| Название метода | Описание | Тип запроса | Тип ответа |
| --------------- | -------- | ----------- | -----------|
| <a id="deviceapis-device-v1-EditDoorSchema"></a> [EditDoorSchema](#deviceapis-device-v1-EditDoorSchema) | Метод редактирования режима работы контроллера | [deviceapis.device.v1.EditDoorSchemaRequest](#deviceapis-device-v1-EditDoorSchemaRequest) | [deviceapis.device.v1.EditDoorSchemaResponse](#deviceapis-device-v1-EditDoorSchemaResponse) |
| <a id="deviceapis-device-v1-GetDoorSchema"></a> [GetDoorSchema](#deviceapis-device-v1-GetDoorSchema) | Метод получения режима работы контроллера | [deviceapis.device.v1.GetDoorSchemaRequest](#deviceapis-device-v1-GetDoorSchemaRequest) | [deviceapis.device.v1.GetDoorSchemaResponse](#deviceapis-device-v1-GetDoorSchemaResponse) |

 <!-- end services -->


<a name="deviceapis-device-v1-DoorSchema"></a>


### [DoorSchema](#deviceapis-device-v1-DoorSchema)
 Режим работы контроллера


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="deviceapis-device-v1-DoorSchema-door_schema_type"></a> [door_schema_type](#deviceapis-device-v1-DoorSchema-door_schema_type) | Тип режима работы контроллера |    [deviceapis.device.v1.DoorSchema.Type](#deviceapis-device-v1-DoorSchema-Type) | REQUIRED|






<a name="deviceapis-device-v1-EditDoorSchemaRequest"></a>


### [EditDoorSchemaRequest](#deviceapis-device-v1-EditDoorSchemaRequest)
 Запрос редактирования режима работы контроллера


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="deviceapis-device-v1-EditDoorSchemaRequest-data"></a> [data](#deviceapis-device-v1-EditDoorSchemaRequest-data) | Режим работы контроллера |    [deviceapis.device.v1.DoorSchema](#deviceapis-device-v1-DoorSchema) | REQUIRED|
| <a id="deviceapis-device-v1-EditDoorSchemaRequest-update_mask"></a> [update_mask](#deviceapis-device-v1-EditDoorSchemaRequest-update_mask) | Маска полей обновления |    [google.protobuf.FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|






<a name="deviceapis-device-v1-EditDoorSchemaResponse"></a>


### [EditDoorSchemaResponse](#deviceapis-device-v1-EditDoorSchemaResponse)
 Ответ на запрос редактирования режима работы контроллера


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="deviceapis-device-v1-EditDoorSchemaResponse-data"></a> [data](#deviceapis-device-v1-EditDoorSchemaResponse-data) | Режим работы контроллера |  optional  [deviceapis.device.v1.DoorSchema](#deviceapis-device-v1-DoorSchema) | <nil>|
| <a id="deviceapis-device-v1-EditDoorSchemaResponse-error"></a> [error](#deviceapis-device-v1-EditDoorSchemaResponse-error) | Ошибка |  optional  [deviceapis.device.v1.EditDoorSchemaResponse.Error](#deviceapis-device-v1-EditDoorSchemaResponse-Error) | <nil>|






<a name="deviceapis-device-v1-EditDoorSchemaResponse-Error"></a>


### [EditDoorSchemaResponse.Error](#deviceapis-device-v1-EditDoorSchemaResponse-Error)
 Ошибка запроса


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="deviceapis-device-v1-EditDoorSchemaResponse-Error-validation"></a> [validation](#deviceapis-device-v1-EditDoorSchemaResponse-Error-validation) | Ошибка валидации |  optional  [deviceapis.device.v1.ValidationError](#deviceapis-device-v1-ValidationError) | <nil>|






<a name="deviceapis-device-v1-GetDoorSchemaRequest"></a>


### [GetDoorSchemaRequest](#deviceapis-device-v1-GetDoorSchemaRequest)
 Запрос получения режима работы контроллера






<a name="deviceapis-device-v1-GetDoorSchemaResponse"></a>


### [GetDoorSchemaResponse](#deviceapis-device-v1-GetDoorSchemaResponse)
 Ответ на запрос получения режима работы контроллера


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="deviceapis-device-v1-GetDoorSchemaResponse-data"></a> [data](#deviceapis-device-v1-GetDoorSchemaResponse-data) | Режим работы контроллера |  optional  [deviceapis.device.v1.DoorSchema](#deviceapis-device-v1-DoorSchema) | <nil>|





 <!-- end messages -->



<a name="deviceapis-device-v1-DoorSchema-Type"></a>

### [DoorSchema.Type](#deviceapis-device-v1-DoorSchema-Type)
 Тип режима работы контроллера

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="deviceapis-device-v1-DoorSchema-Type-TYPE_UNKNOWN"></a> [TYPE_UNKNOWN](#deviceapis-device-v1-DoorSchema-Type-TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="deviceapis-device-v1-DoorSchema-Type-NORMAL"></a> [NORMAL](#deviceapis-device-v1-DoorSchema-Type-NORMAL) | Две независимые двери на вход. Режим по умолчанию. Восстанавливается после обновления прошивки и сброса настроек |
| 2 | <a id="deviceapis-device-v1-DoorSchema-Type-MIXED"></a> [MIXED](#deviceapis-device-v1-DoorSchema-Type-MIXED) | Две совмещенные двери на вход и выход (по кнопке) |


 <!-- end enums -->

 <!-- end HasExtensions -->



## Скалярные типы значений
<a id="scalar-types"></a>

| .proto Type | Примечание | Python | Go | Ruby | C# | C++ | Java | PHP |
| ----------- | ---------- | ------ | -- | ---- | -- | --- | ---- | --- |
| [double](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) |  | float | float64 | Float | double | double | double | float |
| [float](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) |  | float | float32 | Float | float | float | float | float |
| [int32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| [int64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| [uint32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. | int/long | uint32 | Bignum or Fixnum (as required) | uint | uint32 | int | integer |
| [uint64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. | int/long | uint64 | Bignum or Fixnum (as required) | ulong | uint64 | long | integer/string |
| [sint32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| [sint64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| [fixed32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | int | uint32 | Bignum or Fixnum (as required) | uint | uint32 | int | integer |
| [fixed64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | int/long | uint64 | Bignum | ulong | uint64 | long | integer/string |
| [sfixed32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always four bytes. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| [sfixed64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always eight bytes. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| [bool](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) |  | boolean | bool | TrueClass/FalseClass | bool | bool | boolean | boolean |
| [string](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | A string must always contain UTF-8 encoded or 7-bit ASCII text. | str/unicode | string | String (UTF-8) | string | string | String | string |
| [bytes](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | May contain any arbitrary sequence of bytes. | str | []byte | String (ASCII-8BIT) | ByteString | string | ByteString | string |