# Протокол

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

- [keyapis/iot_connect_sber/v1/keyapis_iot_connect_command_v1.proto](#keyapis_iot_connect_sber_v1_keyapis_iot_connect_command_v1-proto)
    - [CommandService](#keyapis-iot_connect_sber-v1-CommandService)
  
    - [DeviceCommand](#keyapis-iot_connect_sber-v1-DeviceCommand)
    - [DeviceCommand.Value](#keyapis-iot_connect_sber-v1-DeviceCommand-Value)
    - [DeviceCommandArray](#keyapis-iot_connect_sber-v1-DeviceCommandArray)
    - [PostCommandRequest](#keyapis-iot_connect_sber-v1-PostCommandRequest)
    - [PostCommandRequest.DevicesEntry](#keyapis-iot_connect_sber-v1-PostCommandRequest-DevicesEntry)
    - [PostCommandResponse](#keyapis-iot_connect_sber-v1-PostCommandResponse)
  
    - [DeviceCommand.KeyType](#keyapis-iot_connect_sber-v1-DeviceCommand-KeyType)
    - [DeviceCommand.Value.Type](#keyapis-iot_connect_sber-v1-DeviceCommand-Value-Type)
    - [DeviceCommand.Value.ValueEnumType](#keyapis-iot_connect_sber-v1-DeviceCommand-Value-ValueEnumType)
  


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




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

## [keyapis/iot_connect_sber/v1/keyapis_iot_connect_command_v1.proto](/protos/key/keyapis/iot_connect_sber/v1/keyapis_iot_connect_command_v1.proto)
Сервис реализует функционал взаимодействия с Умным домом Sber


<a name="keyapis-iot_connect_sber-v1-CommandService"></a>

### CommandService
 Сервис для приема комманд от Умного дома Sber

| Название метода | Описание | Тип запроса | Тип ответа |
| --------------- | -------- | ----------- | -----------|
| <a id="keyapis-iot_connect_sber-v1-PostCommand"></a> [PostCommand](#keyapis-iot_connect_sber-v1-PostCommand) | Метод приема команд на изменение состояния устройства. Поддерживается только открытие домофона. Метод доступен для: TokenACF: Scope: sber_iot | [keyapis.iot_connect_sber.v1.PostCommandRequest](#keyapis-iot_connect_sber-v1-PostCommandRequest) | [keyapis.iot_connect_sber.v1.PostCommandResponse](#keyapis-iot_connect_sber-v1-PostCommandResponse) |

 <!-- end services -->


<a name="keyapis-iot_connect_sber-v1-DeviceCommand"></a>


### [DeviceCommand](#keyapis-iot_connect_sber-v1-DeviceCommand)
 Команды на изменение статуса устройства


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-iot_connect_sber-v1-DeviceCommand-command_key_type"></a> [command_key_type](#keyapis-iot_connect_sber-v1-DeviceCommand-command_key_type) | Тип команды на изменение статуса устройства |    [keyapis.iot_connect_sber.v1.DeviceCommand.KeyType](#keyapis-iot_connect_sber-v1-DeviceCommand-KeyType) | <nil>|
| <a id="keyapis-iot_connect_sber-v1-DeviceCommand-value"></a> [value](#keyapis-iot_connect_sber-v1-DeviceCommand-value) | Значение команды на изменение статуса устройства |    [keyapis.iot_connect_sber.v1.DeviceCommand.Value](#keyapis-iot_connect_sber-v1-DeviceCommand-Value) | <nil>|






<a name="keyapis-iot_connect_sber-v1-DeviceCommand-Value"></a>


### [DeviceCommand.Value](#keyapis-iot_connect_sber-v1-DeviceCommand-Value)
 Значение команды на изменение статуса устройства


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-iot_connect_sber-v1-DeviceCommand-Value-type"></a> [type](#keyapis-iot_connect_sber-v1-DeviceCommand-Value-type) | Тип значения команды на изменение статуса устройства |    [keyapis.iot_connect_sber.v1.DeviceCommand.Value.Type](#keyapis-iot_connect_sber-v1-DeviceCommand-Value-Type) | <nil>|
| <a id="keyapis-iot_connect_sber-v1-DeviceCommand-Value-value_enum_type"></a> [value_enum_type](#keyapis-iot_connect_sber-v1-DeviceCommand-Value-value_enum_type) | Значения команды на изменение статуса устройства типа перечисление |  optional  [keyapis.iot_connect_sber.v1.DeviceCommand.Value.ValueEnumType](#keyapis-iot_connect_sber-v1-DeviceCommand-Value-ValueEnumType) | <nil>|






<a name="keyapis-iot_connect_sber-v1-DeviceCommandArray"></a>


### [DeviceCommandArray](#keyapis-iot_connect_sber-v1-DeviceCommandArray)
 Массив команд на изменение статуса устройства


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-iot_connect_sber-v1-DeviceCommandArray-states"></a> [states](#keyapis-iot_connect_sber-v1-DeviceCommandArray-states) | Команды на изменение статуса устройства |  repeated  [keyapis.iot_connect_sber.v1.DeviceCommand](#keyapis-iot_connect_sber-v1-DeviceCommand) | <nil>|






<a name="keyapis-iot_connect_sber-v1-PostCommandRequest"></a>


### [PostCommandRequest](#keyapis-iot_connect_sber-v1-PostCommandRequest)
 Запрос на изменение состояния устройства


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-iot_connect_sber-v1-PostCommandRequest-devices"></a> [devices](#keyapis-iot_connect_sber-v1-PostCommandRequest-devices) | Массив домофонов со статусами |  repeated  [keyapis.iot_connect_sber.v1.PostCommandRequest.DevicesEntry](#keyapis-iot_connect_sber-v1-PostCommandRequest-DevicesEntry) | <nil>|






<a name="keyapis-iot_connect_sber-v1-PostCommandRequest-DevicesEntry"></a>


### [PostCommandRequest.DevicesEntry](#keyapis-iot_connect_sber-v1-PostCommandRequest-DevicesEntry)
 


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-iot_connect_sber-v1-PostCommandRequest-DevicesEntry-key"></a> [key](#keyapis-iot_connect_sber-v1-PostCommandRequest-DevicesEntry-key) |  |    [string](#scalar-types) | <nil>|
| <a id="keyapis-iot_connect_sber-v1-PostCommandRequest-DevicesEntry-value"></a> [value](#keyapis-iot_connect_sber-v1-PostCommandRequest-DevicesEntry-value) |  |    [keyapis.iot_connect_sber.v1.DeviceCommandArray](#keyapis-iot_connect_sber-v1-DeviceCommandArray) | <nil>|






<a name="keyapis-iot_connect_sber-v1-PostCommandResponse"></a>


### [PostCommandResponse](#keyapis-iot_connect_sber-v1-PostCommandResponse)
 Ответ на запрос на изменение состояния устройства





 <!-- end messages -->



<a name="keyapis-iot_connect_sber-v1-DeviceCommand-KeyType"></a>

### [DeviceCommand.KeyType](#keyapis-iot_connect_sber-v1-DeviceCommand-KeyType)
 Список ключей команд на изменение статуса устройства

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-iot_connect_sber-v1-DeviceCommand-KeyType-KEY_TYPE_UNKNOWN"></a> [KEY_TYPE_UNKNOWN](#keyapis-iot_connect_sber-v1-DeviceCommand-KeyType-KEY_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-iot_connect_sber-v1-DeviceCommand-KeyType-REJECT_CALL"></a> [REJECT_CALL](#keyapis-iot_connect_sber-v1-DeviceCommand-KeyType-REJECT_CALL) | Отклонение звонка |
| 2 | <a id="keyapis-iot_connect_sber-v1-DeviceCommand-KeyType-UNLOCK"></a> [UNLOCK](#keyapis-iot_connect_sber-v1-DeviceCommand-KeyType-UNLOCK) | Открытие замка |




<a name="keyapis-iot_connect_sber-v1-DeviceCommand-Value-Type"></a>

### [DeviceCommand.Value.Type](#keyapis-iot_connect_sber-v1-DeviceCommand-Value-Type)
 Тип значения команд на изменение статуса устройства

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-iot_connect_sber-v1-DeviceCommand-Value-Type-TYPE_UNKNOWN"></a> [TYPE_UNKNOWN](#keyapis-iot_connect_sber-v1-DeviceCommand-Value-Type-TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-iot_connect_sber-v1-DeviceCommand-Value-Type-ENUM"></a> [ENUM](#keyapis-iot_connect_sber-v1-DeviceCommand-Value-Type-ENUM) | Перечисление |




<a name="keyapis-iot_connect_sber-v1-DeviceCommand-Value-ValueEnumType"></a>

### [DeviceCommand.Value.ValueEnumType](#keyapis-iot_connect_sber-v1-DeviceCommand-Value-ValueEnumType)
 Значения команд на изменение статуса устройства типа перечисление

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-iot_connect_sber-v1-DeviceCommand-Value-ValueEnumType-VALUE_ENUM_TYPE_UNKNOWN"></a> [VALUE_ENUM_TYPE_UNKNOWN](#keyapis-iot_connect_sber-v1-DeviceCommand-Value-ValueEnumType-VALUE_ENUM_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-iot_connect_sber-v1-DeviceCommand-Value-ValueEnumType-REJECT"></a> [REJECT](#keyapis-iot_connect_sber-v1-DeviceCommand-Value-ValueEnumType-REJECT) | Отклонение звонка |
| 2 | <a id="keyapis-iot_connect_sber-v1-DeviceCommand-Value-ValueEnumType-UNLOCK"></a> [UNLOCK](#keyapis-iot_connect_sber-v1-DeviceCommand-Value-ValueEnumType-UNLOCK) | Открытие замка |


 <!-- 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 |