diff --git a/MyLibsGeneral/Inc/__mylibs_config.h b/MyLibs/Inc/__mylibs_config.h similarity index 100% rename from MyLibsGeneral/Inc/__mylibs_config.h rename to MyLibs/Inc/__mylibs_config.h diff --git a/MyLibsGeneral/Inc/__mylibs_include.h b/MyLibs/Inc/__mylibs_include.h similarity index 100% rename from MyLibsGeneral/Inc/__mylibs_include.h rename to MyLibs/Inc/__mylibs_include.h diff --git a/MyLibsGeneral/Inc/bit_access.h b/MyLibs/Inc/bit_access.h similarity index 100% rename from MyLibsGeneral/Inc/bit_access.h rename to MyLibs/Inc/bit_access.h diff --git a/MyLibsGeneral/Inc/evolve_optimizer.h b/MyLibs/Inc/evolve_optimizer.h similarity index 100% rename from MyLibsGeneral/Inc/evolve_optimizer.h rename to MyLibs/Inc/evolve_optimizer.h diff --git a/MyLibsGeneral/Inc/mylibs_defs.h b/MyLibs/Inc/mylibs_defs.h similarity index 100% rename from MyLibsGeneral/Inc/mylibs_defs.h rename to MyLibs/Inc/mylibs_defs.h diff --git a/MyLibsGeneral/Inc/trace.h b/MyLibs/Inc/trace.h similarity index 100% rename from MyLibsGeneral/Inc/trace.h rename to MyLibs/Inc/trace.h diff --git a/MyLibsGeneral/Inc/trackers.h b/MyLibs/Inc/trackers.h similarity index 100% rename from MyLibsGeneral/Inc/trackers.h rename to MyLibs/Inc/trackers.h diff --git a/README.md b/README.md index 94824ec..7948a42 100644 --- a/README.md +++ b/README.md @@ -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) и просто комментариями в коде. \ No newline at end of file diff --git a/MyLibsGeneral/Inc/__general_flash.h b/STM32_General/Inc/__general_flash.h similarity index 100% rename from MyLibsGeneral/Inc/__general_flash.h rename to STM32_General/Inc/__general_flash.h diff --git a/MyLibsGeneral/Inc/general_gpio.h b/STM32_General/Inc/general_gpio.h similarity index 100% rename from MyLibsGeneral/Inc/general_gpio.h rename to STM32_General/Inc/general_gpio.h diff --git a/MyLibsGeneral/Inc/general_spi.h b/STM32_General/Inc/general_spi.h similarity index 100% rename from MyLibsGeneral/Inc/general_spi.h rename to STM32_General/Inc/general_spi.h diff --git a/MyLibsGeneral/Inc/general_tim.h b/STM32_General/Inc/general_tim.h similarity index 100% rename from MyLibsGeneral/Inc/general_tim.h rename to STM32_General/Inc/general_tim.h diff --git a/MyLibsGeneral/Inc/general_uart.h b/STM32_General/Inc/general_uart.h similarity index 100% rename from MyLibsGeneral/Inc/general_uart.h rename to STM32_General/Inc/general_uart.h diff --git a/MyLibsGeneral/Src/__general_flash.c b/STM32_General/Src/__general_flash.c similarity index 100% rename from MyLibsGeneral/Src/__general_flash.c rename to STM32_General/Src/__general_flash.c diff --git a/MyLibsGeneral/Src/general_gpio.c b/STM32_General/Src/general_gpio.c similarity index 100% rename from MyLibsGeneral/Src/general_gpio.c rename to STM32_General/Src/general_gpio.c diff --git a/MyLibsGeneral/Src/general_spi.c b/STM32_General/Src/general_spi.c similarity index 100% rename from MyLibsGeneral/Src/general_spi.c rename to STM32_General/Src/general_spi.c diff --git a/MyLibsGeneral/Src/general_tim.c b/STM32_General/Src/general_tim.c similarity index 100% rename from MyLibsGeneral/Src/general_tim.c rename to STM32_General/Src/general_tim.c diff --git a/MyLibsGeneral/Src/general_uart.c b/STM32_General/Src/general_uart.c similarity index 100% rename from MyLibsGeneral/Src/general_uart.c rename to STM32_General/Src/general_uart.c diff --git a/MyLibsGeneral/mainpage.h b/mainpage.h similarity index 58% rename from MyLibsGeneral/mainpage.h rename to mainpage.h index 8830bdb..3d88555 100644 --- a/MyLibsGeneral/mainpage.h +++ b/mainpage.h @@ -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 +Актуальная версия +\endhtmlonly + @subsection features Основные возможности @subsubsection utils_module Общие утилиты (@ref MYLIBS_DEFINES) @@ -43,26 +47,41 @@ MyLibs - это набор библиотек для удобной работы @subsection structure Структура проекта @code -MyLibsGeneral -├── 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 Использование Инструкция по подключению: @@ -76,4 +95,4 @@ MyLibsGeneral 3. Используйте нужные модули в своем коде. Примеры использования приведены в соответствующей теме - */ \ No newline at end of file +*/ \ No newline at end of file