docs: move SETCAN documentation into templates

This commit is contained in:
2026-08-31 19:30:54 +03:00
parent de180750aa
commit 2fd51a1d7e
16 changed files with 28480 additions and 1 deletions

30
doc/setcan/README.md Normal file
View File

@@ -0,0 +1,30 @@
# Документация SETCAN / ProtoCAN
Комплект перенесён из отдельного репозитория `SETCAN` (commit `ab60e58`) в
единый репозиторий `templates`. Здесь сохранены нормативные документы,
тестовые векторы, исходный реестр ОАП в Excel и автономная HTML-версия.
## Актуальное расположение кода
| Область | Модуль templates |
|---|---|
| Однокадровые SETTINGS и bxCAN STM32F1 | [`c/can-sensor`](../../c/can-sensor) |
| Единый SET protocol v2 | [`c/set-protocol`](../../c/set-protocol) |
| Транспорт ProtoCAN | [`c/protocan-transport`](../../c/protocan-transport) |
| CAN-загрузчик | [`c/protocan-boot`](../../c/protocan-boot) |
Файлы `Inc/protocan.h` и `Src/protocan.c`, упомянутые в историческом
[руководстве](index.html), больше не являются подключаемым исходным кодом.
В новых проектах используются нормализованные модули из таблицы выше.
## Документы
- [Интерактивное руководство](index.html)
- [Базовый протокол](protocan/PROTOCOL.md)
- [Загрузчик](protocan/BOOTLOADER.md)
- [Общее адресное пространство](protocan/OAP.md)
- [Редактируемый реестр ОАП](Протокол%20CAN%20и%20ОАП.xlsx)
- [Тестовые векторы](protocan/examples/test-vectors.json)
Для пересборки HTML запустите `doc/setcan/build-html.bat` из корня
репозитория `templates`.