docs: перевести документацию на русский
This commit is contained in:
81
protocol.md
81
protocol.md
@@ -1,45 +1,46 @@
|
||||
# BVK Exchange Protocol
|
||||
# Протокол Обмена С БВК
|
||||
|
||||
Based on `Протокол_обмена_медиакомплекса_и_БВК.pdf`.
|
||||
Документ основан на файле
|
||||
`Протокол_обмена_медиакомплекса_и_БВК.pdf`.
|
||||
|
||||
## Role
|
||||
## Роли
|
||||
|
||||
- BVK is the HTTP client.
|
||||
- Media complex is the HTTP server.
|
||||
- Default address from the document: `172.16.16.2:13280`.
|
||||
- БВК — HTTP-клиент.
|
||||
- Медиакомплекс — HTTP-сервер.
|
||||
- Адрес по документу: `172.16.16.2:13280`.
|
||||
|
||||
## Set Content
|
||||
## Установка Контента
|
||||
|
||||
```text
|
||||
GET /set-content?route=<R>&str=<S>&tpl_name=<T>
|
||||
```
|
||||
|
||||
Parameters are URL-encoded.
|
||||
Параметры передаются в query string и должны быть URL-encoded.
|
||||
|
||||
| Parameter | Meaning |
|
||||
| Параметр | Описание |
|
||||
| --- | --- |
|
||||
| `route` | Route number, 1 to 3 characters |
|
||||
| `str` | Ticker/running text |
|
||||
| `tpl_name` | Media content template name |
|
||||
| `route` | номер маршрута, от 1 до 3 символов |
|
||||
| `str` | текст бегущей строки |
|
||||
| `tpl_name` | название шаблона медиаконтента |
|
||||
|
||||
Current library defaults:
|
||||
Текущие значения по умолчанию в библиотеке:
|
||||
|
||||
| Field | Default limit |
|
||||
| Поле | Лимит по умолчанию |
|
||||
| --- | ---: |
|
||||
| `route` | 3 characters |
|
||||
| `str` | 200 characters |
|
||||
| `tpl_name` | 200 characters |
|
||||
| `route` | 3 символа |
|
||||
| `str` | 200 символов |
|
||||
| `tpl_name` | 200 символов |
|
||||
|
||||
The exact text/template limits must be confirmed with the integrator because the
|
||||
PDF text layer is ambiguous for the original value.
|
||||
Точные лимиты для `str` и `tpl_name` нужно подтвердить у интегратора, потому что
|
||||
текстовый слой PDF неоднозначно распознает исходное значение.
|
||||
|
||||
## Get Content
|
||||
## Запрос Контента
|
||||
|
||||
```text
|
||||
GET /get-content
|
||||
```
|
||||
|
||||
Response:
|
||||
Ответ:
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -49,15 +50,37 @@ Response:
|
||||
}
|
||||
```
|
||||
|
||||
Mila keeps `updated_at` internally, but the HTTP response is strict and exposes
|
||||
only the fields defined by the protocol.
|
||||
Mila хранит `updated_at` внутри состояния, но HTTP-ответ оставляет строгим и
|
||||
отдает только поля, описанные в протоколе.
|
||||
|
||||
## Status Codes
|
||||
## Коды Ответов
|
||||
|
||||
| Code | Meaning |
|
||||
| Код | Значение |
|
||||
| ---: | --- |
|
||||
| 200 | OK |
|
||||
| 400 | Bad request / validation error |
|
||||
| 404 | Path not found |
|
||||
| 500 | Internal server error |
|
||||
| 503 | State is not ready or dependency unavailable |
|
||||
| 400 | ошибка в запросе или валидации |
|
||||
| 404 | путь не найден |
|
||||
| 405 | метод не поддерживается |
|
||||
| 500 | внутренняя ошибка сервера |
|
||||
| 503 | состояние еще не готово или зависимость недоступна |
|
||||
|
||||
## Важное Ограничение
|
||||
|
||||
Протокол БВК передает только:
|
||||
|
||||
- номер маршрута;
|
||||
- текст бегущей строки;
|
||||
- название шаблона медиаконтента.
|
||||
|
||||
Он не передает:
|
||||
|
||||
- координаты;
|
||||
- направление движения;
|
||||
- текущий сегмент маршрута;
|
||||
- процент прохождения маршрута;
|
||||
- ближайшую остановку;
|
||||
- ближайшие достопримечательности.
|
||||
|
||||
Поэтому Mila не должна использоваться как источник геопозиции или route
|
||||
progress. Эти данные должны приходить из отдельного источника: NMEA, API,
|
||||
симулятора или другого механизма геолокации.
|
||||
|
||||
Reference in New Issue
Block a user