35 lines
2.1 KiB
Markdown
35 lines
2.1 KiB
Markdown
# Документация 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/set-protocol`](../../c/set-protocol) |
|
||
| STM32 HAL bxCAN/RTC/TIM, API `PROTOCAN_*` | [`c/set-protocol/ports/stm32-bxcan`](../../c/set-protocol/ports/stm32-bxcan/README.md) |
|
||
| CAN-загрузчик | [`c/protocan-boot`](../../c/protocan-boot) |
|
||
|
||
Файлы `Inc/protocan.h` и `Src/protocan.c`, упомянутые в историческом
|
||
[руководстве](index.html), перенесены в `c/set-protocol/ports/stm32-bxcan`
|
||
с сохранением имён и API. Общий `pcan_id` подключается из этого же `templates`.
|
||
Отдельный репозиторий SETCAN больше не требуется. Его история до `c8eec55`
|
||
включена в Git-историю `templates`; документация здесь сохранена без
|
||
перезаписи старым снимком.
|
||
|
||
## Документы
|
||
|
||
- [Интерактивное руководство](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`.
|