release 0.2
- stm general перенесена в другой репозиторий - рефакторинг документации
This commit is contained in:
54
README.md
54
README.md
@@ -1,6 +1,22 @@
|
||||
# Инструкция по подключению релиза библиотеки `ExtendedLibs`
|
||||
# Обзор `ExtendedLibs`
|
||||
|
||||
Данный субмодуль подключается напрямую из Git и содержит набор вспомогательных библиотек для работы МК, в частности STM32 и SEGGER RTT.
|
||||
ExtendedLibs - это набор библиотек для удобной работы с STM32. Данный субмодуль подключается напрямую из Git и содержит набор вспомогательных библиотек для работы МК, в частности STM32 и SEGGER RTT.
|
||||
|
||||
## Основные возможности
|
||||
|
||||
|
||||
#### Общие утилиты MyLibs (@ref MYLIBS_TOOLS)
|
||||
- Макросы для задержек (@ref DELAYS_DEFINES)
|
||||
- Утилиты для работы с всяким (@ref UTILS_DEFINES)
|
||||
- Битовый доступ к регистрам через union (@ref BIT_ACCESS_DEFINES)
|
||||
|
||||
#### Отладка* (@ref MYLIBS_DEBUG_TOOLS)
|
||||
- Трассировка (@ref TRACE)
|
||||
- Измерение временных интервалов (@ref BENCH_TIME)
|
||||
- Генетический алгоритм для оптимизации параметров (@ref GEN_OPTIMIZER)
|
||||
- Трекеры для статистики и отладки (@ref TRACKERS)
|
||||
|
||||
_*Модули отладки независимы от MyLibs и могут быть использованы отдельно_
|
||||
|
||||
## Структура библиотеки
|
||||
|
||||
@@ -13,29 +29,17 @@ ProjectRoot/
|
||||
│ │ ├── __mylibs_config.h # Конфигурация библиотек
|
||||
│ │ ├── mylibs_defs.h # Общие определения и макросы
|
||||
│ │ ├── bit_access.h # Битовый доступ к регистрам
|
||||
│ │ ├── evolve_optimizer.h # Оптимизатор (генетический алгоритм)
|
||||
│ │ ├── gen_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
|
||||
└──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
|
||||
```
|
||||
|
||||
## Инструкция по подключению
|
||||
@@ -75,10 +79,4 @@ ProjectRoot/
|
||||
|
||||
```bash
|
||||
git submodule update --remote
|
||||
```
|
||||
|
||||
## Документация
|
||||
|
||||
Библиотека `MyLibs` и `STM32_General` документирована в формате Doxygen. HTML документацию можно [скачать здесь](https://git.arktika.cyou/Razvalyaev/STM32_ExtendedLibs/archive/v0.02.zip)
|
||||
|
||||
Библиотека `RTT` документирована в формате [страницы википедии](https://kb.segger.com/RTT) и просто комментариями в коде.
|
||||
```
|
||||
Reference in New Issue
Block a user