Files
templates/doc/setcan/protocan
Andrey f17c124f0e docs: Согласуй документацию ProtoCAN и инструментов сборки
Обнови спецификацию GAS 0x3/0x4, реестр устройств и описание загрузочных сервисов одновременно в Markdown, HTML и XLSX.

Свяжи новые аппаратные порты, глобальное время и сборку C2000/ПЛИС с корневыми инструкциями, чтобы проекты подключались по одному актуальному контракту.
2026-10-23 14:16:22 +03:00
..

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

Статус комплекта: Draft
Версия комплекта: 2.1
Дата редакции: 2026-10-23
Транспорт: Classic CAN 2.0B, Extended ID, DLC 0…8

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

Документы

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

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

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

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

Сборка HTML

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

./doc/setcan/build-html.bat

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

GAS: регистры 0x3 и слоты 0x4

Адресация GAS: 0x3 — отдельные 16-битные регистры 0…65535, запись 1…4 слов. 0x4 — слот с Word0-маской и тремя значениями; PERIPH сохраняет 200 слов в 67 слотах 0xMM00…0xMM42. Формат определяется MsgType, без настройки профиля.