Протокол¶
Оглавление¶
Схема классов¶
deviceapis/device/v1/deviceapis_device_ticker_v1.proto¶
Сервис управления настройками Ticker
TickerService¶
Сервис управления настройками Ticker
| Название метода | Описание | Тип запроса | Тип ответа |
|---|---|---|---|
| EditTicker | Метод редактирования настроек Ticker | deviceapis.device.v1.EditTickerRequest | deviceapis.device.v1.EditTickerResponse |
| GetTicker | Метод получения настроек Ticker | deviceapis.device.v1.GetTickerRequest | deviceapis.device.v1.GetTickerResponse |
EditTickerRequest¶
Запрос настройки Ticker
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Настройки Ticker | deviceapis.device.v1.Ticker | REQUIRED |
| update_mask | Маска полей обновления | google.protobuf.FieldMask |
EditTickerResponse¶
Ответ на запрос настройки Ticker
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| error | Ошибка | optional deviceapis.device.v1.EditTickerResponse.Error |
EditTickerResponse.Error¶
Ошибка запроса
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional deviceapis.device.v1.ValidationError |
GetTickerRequest¶
Запрос получения настроек Ticker
GetTickerResponse¶
Ответ на апрос получения настроек Ticker
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Настройки Ticker | optional deviceapis.device.v1.Ticker |
Ticker¶
Настройки Ticker
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| mode_type | Режим строки | deviceapis.device.v1.Ticker.ModeType | |
| speed | Скорость, символов в минуту | int32 | |
| delay | Задержка смены строки, секунд | int32 | |
| lines | Строки | repeated string |
Ticker.ModeType¶
Режим строки
| Номер | Тип | Название |
|---|---|---|
| 0 | MODE_TYPE_UNKNOWN | Значение не указано |
| 1 | OFF | Выключен |
| 2 | RUNNING_LINE | Бегущая строка |
| 3 | LINE_1_BY_1 | Строка одна за другой |
Скалярные типы значений¶
| .proto Type | Примечание | Python | Go | Ruby | C# | C++ | Java | PHP |
|---|---|---|---|---|---|---|---|---|
| double | float | float64 | Float | double | double | double | float | |
| float | float | float32 | Float | float | float | float | float | |
| int32 | 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 | 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 | Uses variable-length encoding. | int/long | uint32 | Bignum or Fixnum (as required) | uint | uint32 | int | integer |
| uint64 | Uses variable-length encoding. | int/long | uint64 | Bignum or Fixnum (as required) | ulong | uint64 | long | integer/string |
| sint32 | 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 | 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 | 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 | 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 | Always four bytes. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| sfixed64 | Always eight bytes. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| bool | boolean | bool | TrueClass/FalseClass | bool | bool | boolean | boolean | |
| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | str/unicode | string | String (UTF-8) | string | string | String | string |
| bytes | May contain any arbitrary sequence of bytes. | str | []byte | String (ASCII-8BIT) | ByteString | string | ByteString | string |