# Протокол

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

- [deviceapis/device/v1/deviceapis_device_ticker_v1.proto](#deviceapis_device_v1_deviceapis_device_ticker_v1-proto)
    - [TickerService](#deviceapis-device-v1-TickerService)
  
    - [EditTickerRequest](#deviceapis-device-v1-EditTickerRequest)
    - [EditTickerResponse](#deviceapis-device-v1-EditTickerResponse)
    - [EditTickerResponse.Error](#deviceapis-device-v1-EditTickerResponse-Error)
    - [GetTickerRequest](#deviceapis-device-v1-GetTickerRequest)
    - [GetTickerResponse](#deviceapis-device-v1-GetTickerResponse)
    - [Ticker](#deviceapis-device-v1-Ticker)
  
    - [Ticker.ModeType](#deviceapis-device-v1-Ticker-ModeType)
  


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




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

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


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

### TickerService
 Сервис управления настройками Ticker

| Название метода | Описание | Тип запроса | Тип ответа |
| --------------- | -------- | ----------- | -----------|
| <a id="deviceapis-device-v1-EditTicker"></a> [EditTicker](#deviceapis-device-v1-EditTicker) | Метод редактирования настроек Ticker | [deviceapis.device.v1.EditTickerRequest](#deviceapis-device-v1-EditTickerRequest) | [deviceapis.device.v1.EditTickerResponse](#deviceapis-device-v1-EditTickerResponse) |
| <a id="deviceapis-device-v1-GetTicker"></a> [GetTicker](#deviceapis-device-v1-GetTicker) | Метод получения настроек Ticker | [deviceapis.device.v1.GetTickerRequest](#deviceapis-device-v1-GetTickerRequest) | [deviceapis.device.v1.GetTickerResponse](#deviceapis-device-v1-GetTickerResponse) |

 <!-- end services -->


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


### [EditTickerRequest](#deviceapis-device-v1-EditTickerRequest)
 Запрос настройки Ticker


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






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


### [EditTickerResponse](#deviceapis-device-v1-EditTickerResponse)
 Ответ на запрос настройки Ticker


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






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


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


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






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


### [GetTickerRequest](#deviceapis-device-v1-GetTickerRequest)
 Запрос получения настроек Ticker






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


### [GetTickerResponse](#deviceapis-device-v1-GetTickerResponse)
 Ответ на апрос получения настроек Ticker


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="deviceapis-device-v1-GetTickerResponse-data"></a> [data](#deviceapis-device-v1-GetTickerResponse-data) | Настройки Ticker |  optional  [deviceapis.device.v1.Ticker](#deviceapis-device-v1-Ticker) | <nil>|






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


### [Ticker](#deviceapis-device-v1-Ticker)
 Настройки Ticker


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="deviceapis-device-v1-Ticker-mode_type"></a> [mode_type](#deviceapis-device-v1-Ticker-mode_type) | Режим строки |    [deviceapis.device.v1.Ticker.ModeType](#deviceapis-device-v1-Ticker-ModeType) | <nil>|
| <a id="deviceapis-device-v1-Ticker-speed"></a> [speed](#deviceapis-device-v1-Ticker-speed) | Скорость, символов в минуту |    [int32](#scalar-types) | <nil>|
| <a id="deviceapis-device-v1-Ticker-delay"></a> [delay](#deviceapis-device-v1-Ticker-delay) | Задержка смены строки, секунд |    [int32](#scalar-types) | <nil>|
| <a id="deviceapis-device-v1-Ticker-lines"></a> [lines](#deviceapis-device-v1-Ticker-lines) | Строки |  repeated  [string](#scalar-types) | <nil>|





 <!-- end messages -->



<a name="deviceapis-device-v1-Ticker-ModeType"></a>

### [Ticker.ModeType](#deviceapis-device-v1-Ticker-ModeType)
 Режим строки

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="deviceapis-device-v1-Ticker-ModeType-MODE_TYPE_UNKNOWN"></a> [MODE_TYPE_UNKNOWN](#deviceapis-device-v1-Ticker-ModeType-MODE_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="deviceapis-device-v1-Ticker-ModeType-OFF"></a> [OFF](#deviceapis-device-v1-Ticker-ModeType-OFF) | Выключен |
| 2 | <a id="deviceapis-device-v1-Ticker-ModeType-RUNNING_LINE"></a> [RUNNING_LINE](#deviceapis-device-v1-Ticker-ModeType-RUNNING_LINE) | Бегущая строка |
| 3 | <a id="deviceapis-device-v1-Ticker-ModeType-LINE_1_BY_1"></a> [LINE_1_BY_1](#deviceapis-device-v1-Ticker-ModeType-LINE_1_BY_1) | Строка одна за другой |


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