Переструктурирование:

- MyLibs - максимально платформонезависимые библиотеки (кроме разве что RTT)
- RTT
- STM32_General - библиотеки для периферии stm32
This commit is contained in:
Razvalyaev 2025-10-21 05:08:27 +03:00
parent 17bace0c3d
commit 51dc03fcbc
19 changed files with 40 additions and 21 deletions

View File

@ -74,6 +74,6 @@ git submodule update --remote
## Документация ## Документация
Библиотека MyLibsGeneral документирована в формате Doxygen. HTML документацию можно скачать [здесь](https://git.arktika.cyou/Razvalyaev/STM32_ExtendedLibs/archive/0.01.zip) Библиотека MyLibsGeneral документирована в формате Doxygen. HTML документацию можно скачать [здесь](https://git.arktika.cyou/Razvalyaev/STM32_ExtendedLibs/archive/0.02.zip)
Библиотека RTT документирована в формате [страницы википедии](https://kb.segger.com/RTT) и просто комментариями в коде. Библиотека RTT документирована в формате [страницы википедии](https://kb.segger.com/RTT) и просто комментариями в коде.

View File

@ -1,6 +1,6 @@
/* /*
* Скачать HTML документацию можно здесь: * Скачать HTML документацию можно здесь:
* https://git.arktika.cyou/Razvalyaev/STM32_ExtendedLibs/archive/v0.01.zip * https://git.arktika.cyou/Razvalyaev/STM32_ExtendedLibs/archive/v0.02.zip
*/ */
/** /**
@mainpage @mainpage
@ -9,6 +9,10 @@
@section overview Обзор @section overview Обзор
MyLibs - это набор библиотек для удобной работы с STM32. MyLibs - это набор библиотек для удобной работы с STM32.
\htmlonly
<a href="https://git.arktika.cyou/Razvalyaev/STM32_ExtendedLibs/src/branch/release">Актуальная версия</a>
\endhtmlonly
@subsection features Основные возможности @subsection features Основные возможности
@subsubsection utils_module Общие утилиты (@ref MYLIBS_DEFINES) @subsubsection utils_module Общие утилиты (@ref MYLIBS_DEFINES)
@ -43,26 +47,41 @@ MyLibs - это набор библиотек для удобной работы
@subsection structure Структура проекта @subsection structure Структура проекта
@code @code
MyLibsGeneral ProjectRoot/
inc/ # Заголовочные файлы MyLibs/ # Общие библиотеки, независимые от платформы (или почти)
mylibs_include.h # Главный include файл inc/
mylibs_config.h # Конфигурация библиотек mylibs_include.h # Главный include файл
mylibs_defs.h # Общие определения и макросы mylibs_config.h # Конфигурация библиотек
bit_access.h # Битовый доступ к регистрам mylibs_defs.h # Общие определения и макросы
evolve_optimizer.h # Оптимизатор (генетический алгоритм) bit_access.h # Битовый доступ к регистрам
trackers.h # Трекеры для отладки evolve_optimizer.h # Оптимизатор (генетический алгоритм)
trace.h # Трассировка и логирование trackers.h # Трекеры для отладки
general_gpio.h # Работа с GPIO trace.h # Трассировка и логирование
general_spi.h # Работа с SPI src/
general_tim.h # Работа с таймерами
general_uart.h # Работа с UART RTT # Библиотека RTT
src/ # Исходные файлы __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_gpio.c # Реализация GPIO
general_spi.c # Реализация SPI general_spi.c # Реализация SPI
general_tim.c # Реализация TIM general_tim.c # Реализация TIM
general_uart.c # Реализация UART general_uart.c # Реализация UART
@endcode @endcode
@subsection usage_basic Использование @subsection usage_basic Использование
Инструкция по подключению: Инструкция по подключению:
@ -76,4 +95,4 @@ MyLibsGeneral
3. Используйте нужные модули в своем коде. Примеры использования приведены в соответствующей теме 3. Используйте нужные модули в своем коде. Примеры использования приведены в соответствующей теме
*/ */