Compare commits
2 Commits
2b4c00ea92
...
51dc03fcbc
| Author | SHA1 | Date | |
|---|---|---|---|
| 51dc03fcbc | |||
| 17bace0c3d |
@ -1,4 +1,4 @@
|
||||
# Инструкция по подключению релиза библиотеки `MyLibsGeneral`
|
||||
# Инструкция по подключению релиза библиотеки `ExtendedLibs`
|
||||
|
||||
Данный субмодуль подключается напрямую из Git и содержит набор вспомогательных библиотек для работы с STM32, а также поддержку SEGGER RTT.
|
||||
|
||||
@ -38,7 +38,7 @@ RTT
|
||||
1. **Склонируйте субмодуль** в ваш проект:
|
||||
|
||||
```bash
|
||||
git submodule add <URL_субмодуля> path/to/MyLibsGeneral
|
||||
git submodule add https://git.arktika.cyou/Razvalyaev/STM32_ExtendedLibs path/to/ExtendedLibs
|
||||
git submodule update --init --recursive
|
||||
```
|
||||
|
||||
@ -74,6 +74,6 @@ git submodule update --remote
|
||||
|
||||
## Документация
|
||||
|
||||
Библиотека MyLibsGeneral документирована в формате Doxygen. HTML документацию можно скачать [здесь](https://git.arktika.cyou/Razvalyaev/STM32_ExtendedLibs/archive/v0.01.zip)
|
||||
Библиотека MyLibsGeneral документирована в формате Doxygen. HTML документацию можно скачать [здесь](https://git.arktika.cyou/Razvalyaev/STM32_ExtendedLibs/archive/0.02.zip)
|
||||
|
||||
Библиотека RTT документирована в формате [страницы википедии](https://kb.segger.com/RTT) и просто комментариями в коде.
|
||||
@ -1,6 +1,6 @@
|
||||
/*
|
||||
* Скачать HTML документацию можно здесь:
|
||||
* https://git.arktika.cyou/Razvalyaev/STM32_ExtendedLibs/archive/v0.01.zip
|
||||
* https://git.arktika.cyou/Razvalyaev/STM32_ExtendedLibs/archive/v0.02.zip
|
||||
*/
|
||||
/**
|
||||
@mainpage
|
||||
@ -9,6 +9,10 @@
|
||||
@section overview Обзор
|
||||
MyLibs - это набор библиотек для удобной работы с STM32.
|
||||
|
||||
\htmlonly
|
||||
<a href="https://git.arktika.cyou/Razvalyaev/STM32_ExtendedLibs/src/branch/release">Актуальная версия</a>
|
||||
\endhtmlonly
|
||||
|
||||
@subsection features Основные возможности
|
||||
|
||||
@subsubsection utils_module Общие утилиты (@ref MYLIBS_DEFINES)
|
||||
@ -43,25 +47,41 @@ MyLibs - это набор библиотек для удобной работы
|
||||
@subsection structure Структура проекта
|
||||
|
||||
@code
|
||||
├── inc/ # Заголовочные файлы
|
||||
│ ├── mylibs_include.h # Главный include файл
|
||||
│ ├── mylibs_config.h # Конфигурация библиотек
|
||||
│ ├── mylibs_defs.h # Общие определения и макросы
|
||||
│ ├── bit_access.h # Битовый доступ к регистрам
|
||||
│ ├── evolve_optimizer.h # Оптимизатор (генетический алгоритм)
|
||||
│ ├── trackers.h # Трекеры для отладки
|
||||
│ ├── trace.h # Трассировка и логирование
|
||||
│ ├── general_gpio.h # Работа с GPIO
|
||||
├── general_spi.h # Работа с SPI
|
||||
│ └── general_tim.h # Работа с таймерами
|
||||
├── general_uart.h # Работа с UART
|
||||
└── src/ # Исходные файлы
|
||||
├── general_gpio.c # Реализация GPIO
|
||||
├── general_spi.c # Реализация SPI
|
||||
└── general_tim.c # Реализация TIM
|
||||
├── general_uart.c # Реализация UART
|
||||
ProjectRoot/
|
||||
├── MyLibs/ # Общие библиотеки, независимые от платформы (или почти)
|
||||
│ ├── inc/
|
||||
│ │ ├── mylibs_include.h # Главный include файл
|
||||
│ │ ├── mylibs_config.h # Конфигурация библиотек
|
||||
│ │ ├── mylibs_defs.h # Общие определения и макросы
|
||||
│ │ ├── bit_access.h # Битовый доступ к регистрам
|
||||
│ │ ├── evolve_optimizer.h # Оптимизатор (генетический алгоритм)
|
||||
│ │ ├── trackers.h # Трекеры для отладки
|
||||
│ │ └── trace.h # Трассировка и логирование
|
||||
│ └── src/
|
||||
│
|
||||
├──RTT # Библиотека RTT
|
||||
│ ├── __SEGGER_RTT_Conf.h # Конфигурационный файл RTT
|
||||
│ ├── SEGGER_RTT.c # Основной модуль RTT
|
||||
│ ├── SEGGER_RTT.h # Основной заголовок RTT
|
||||
│ ├── SEGGER_RTT_ASM_ARMv7M.S # Ассемблерная оптимизация для ARMv7M
|
||||
│ └── SEGGER_RTT_printf.c # Реализация printf() через RTT
|
||||
│
|
||||
└── STM32_General # Работа с периферией STM32
|
||||
├── inc/
|
||||
│ ├── general_gpio.h # Работа с GPIO
|
||||
│ ├── general_spi.h # Работа с SPI
|
||||
│ ├── general_tim.h # Работа с таймерами
|
||||
│ └── general_uart.h # Работа с UART
|
||||
└── src/
|
||||
├── general_gpio.c # Реализация GPIO
|
||||
├── general_spi.c # Реализация SPI
|
||||
├── general_tim.c # Реализация TIM
|
||||
└── general_uart.c # Реализация UART
|
||||
@endcode
|
||||
|
||||
|
||||
|
||||
|
||||
@subsection usage_basic Использование
|
||||
|
||||
Инструкция по подключению:
|
||||
@ -75,4 +95,4 @@ MyLibs - это набор библиотек для удобной работы
|
||||
|
||||
3. Используйте нужные модули в своем коде. Примеры использования приведены в соответствующей теме
|
||||
|
||||
*/
|
||||
*/
|
||||
Loading…
Reference in New Issue
Block a user