# Документация ProtoCAN

Статус комплекта: **Draft**<br>
Версия комплекта: **1.0**<br>
Дата редакции: **2026-08-29**<br>
Транспорт: **Classic CAN 2.0B, Extended ID, DLC 0…8**

Этот каталог разделяет нормативное описание протокола, загрузчик и реестр
общего адресного пространства. Большой исходный документ
[`Протокол CAN и ОАП.md`](../Протокол%20CAN%20и%20ОАП.md) сохранён как
совместимое представление таблиц из Excel.

## Документы

| Документ | Назначение | Статус источника |
|---|---|---|
| [PROTOCOL.md](PROTOCOL.md) | 29-битный CAN ID, адресация, реестр `MsgType`, порядок байтов | нормативный |
| [BOOTLOADER.md](BOOTLOADER.md) | обновление прошивки, кадры, состояния, ошибки и A/B-слоты | нормативный draft |
| [OAP.md](OAP.md) | правила ведения общего адресного пространства | нормативный индекс |
| [../Протокол CAN и ОАП.xlsx](../Протокол%20CAN%20и%20ОАП.xlsx) | редактируемый реестр ОАП | источник таблиц |
| [examples/test-vectors.json](examples/test-vectors.json) | машинные эталоны CAN ID и payload | нормативные примеры |
| [CHANGELOG.md](CHANGELOG.md) | история версий документа | нормативный |

## Приоритет источников

При расхождении данных действует следующий порядок:

1. `PROTOCOL.md` — структура ProtoCAN и реестр типов сообщений.
2. `BOOTLOADER.md` — загрузочный сервис `0x9…0xD`.
3. XLSX — адреса и свойства регистров ОАП.
4. Сгенерированный [`../index.html`](../index.html) — только представление, не самостоятельный источник.

## Сборка HTML

Из корня проекта:

```powershell
./doc/setcan/build-html.bat
```

Все документы и тестовые векторы включаются в единый файл
`doc/setcan/index.html`.
Скрипт не изменяет исходные Markdown/XLSX и пригоден для запуска в CI.