Files
templates/doc/setcan/README.md

31 lines
1.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Документация 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`.