docs: добавь поясняющие комментарии к модулям и инструментам
This commit is contained in:
@@ -1,3 +1,7 @@
|
||||
# Сборка библиотеки led_indicator. Состав исходников и публичные include-пути задают
|
||||
# подключение к проекту потребителя. Файл также собирает и регистрирует хостовые проверки;
|
||||
# запускать их следует через CTest из каталога сборки.
|
||||
|
||||
cmake_minimum_required(VERSION 3.13)
|
||||
project(led_indicator C)
|
||||
|
||||
|
||||
@@ -1,3 +1,9 @@
|
||||
/*
|
||||
* Неблокирующее воспроизведение режимов светодиодной индикации по переданному времени.
|
||||
* Логический уровень канала отделён от полярности вывода; периодический вызов обслуживает
|
||||
* рисунок без задержек в основном цикле.
|
||||
*/
|
||||
|
||||
#include "led_indicator.h"
|
||||
|
||||
#include <limits.h>
|
||||
|
||||
@@ -1,3 +1,9 @@
|
||||
/*
|
||||
* Неблокирующее воспроизведение режимов светодиодной индикации по переданному времени.
|
||||
* Логический уровень канала отделён от полярности вывода; периодический вызов обслуживает
|
||||
* рисунок без задержек в основном цикле.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file led_indicator.h
|
||||
* @brief Неблокирующая индикация состояния устройства на одном или нескольких LED.
|
||||
|
||||
@@ -1,3 +1,9 @@
|
||||
/*
|
||||
* Порт светодиодной индикации через STM32 HAL. Логическое состояние канала преобразуется в
|
||||
* GPIO-уровень с учётом активной полярности; ядро рисунков мигания не знает номера вывода и
|
||||
* семейства MCU.
|
||||
*/
|
||||
|
||||
#include "led_indicator_stm32_hal.h"
|
||||
|
||||
static void stm32_write(void *context, uint8_t channel, uint8_t on)
|
||||
|
||||
@@ -1,3 +1,9 @@
|
||||
/*
|
||||
* Порт светодиодной индикации через STM32 HAL. Логическое состояние канала преобразуется в
|
||||
* GPIO-уровень с учётом активной полярности; ядро рисунков мигания не знает номера вывода и
|
||||
* семейства MCU.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file led_indicator_stm32_hal.h
|
||||
* @brief Порт LED Indicator для STM32F1/F4/G4 HAL и выбранного TIM.
|
||||
|
||||
@@ -1,3 +1,9 @@
|
||||
/*
|
||||
* Конфигурация led-indicator для порта stm32-hal. Макросы задают параметры сборки и
|
||||
* ограничения, используемые исходниками этого модуля. Это образец для проекта: значения
|
||||
* выводов, размеров памяти и параметров устройства необходимо согласовать с целевой платой.
|
||||
*/
|
||||
|
||||
#ifndef LED_INDICATOR_STM32_HAL_CONFIG_H
|
||||
#define LED_INDICATOR_STM32_HAL_CONFIG_H
|
||||
|
||||
|
||||
@@ -1,3 +1,9 @@
|
||||
/*
|
||||
* Конфигурация led-indicator для порта stm32-hal. Макросы задают параметры сборки и
|
||||
* ограничения, используемые исходниками этого модуля. Это образец для проекта: значения
|
||||
* выводов, размеров памяти и параметров устройства необходимо согласовать с целевой платой.
|
||||
*/
|
||||
|
||||
#ifndef LED_INDICATOR_STM32_HAL_CONFIG_H
|
||||
#define LED_INDICATOR_STM32_HAL_CONFIG_H
|
||||
|
||||
|
||||
@@ -1,3 +1,9 @@
|
||||
/*
|
||||
* Конфигурация led-indicator для порта stm32-hal. Макросы задают параметры сборки и
|
||||
* ограничения, используемые исходниками этого модуля. Это образец для проекта: значения
|
||||
* выводов, размеров памяти и параметров устройства необходимо согласовать с целевой платой.
|
||||
*/
|
||||
|
||||
#ifndef LED_INDICATOR_STM32_HAL_CONFIG_H
|
||||
#define LED_INDICATOR_STM32_HAL_CONFIG_H
|
||||
|
||||
|
||||
@@ -1,3 +1,10 @@
|
||||
/*
|
||||
* Проверки led_indicator_stm32_hal_config: фиксируют ожидаемое поведение на воспроизводимых
|
||||
* входных данных.
|
||||
* Тестовые значения и подмены окружения относятся к проверке контракта; они не являются
|
||||
* настройками рабочего устройства.
|
||||
*/
|
||||
|
||||
#ifndef LED_INDICATOR_STM32_HAL_CONFIG_H
|
||||
#define LED_INDICATOR_STM32_HAL_CONFIG_H
|
||||
|
||||
|
||||
@@ -1,3 +1,9 @@
|
||||
/*
|
||||
* Проверки led_indicator: фиксируют ожидаемое поведение на воспроизводимых входных данных.
|
||||
* Тестовые значения и подмены окружения относятся к проверке контракта; они не являются
|
||||
* настройками рабочего устройства.
|
||||
*/
|
||||
|
||||
#include "led_indicator.h"
|
||||
|
||||
#include <stdio.h>
|
||||
|
||||
@@ -1,3 +1,9 @@
|
||||
/*
|
||||
* Проверки stm32_port: фиксируют ожидаемое поведение на воспроизводимых входных данных.
|
||||
* Тестовые значения и подмены окружения относятся к проверке контракта; они не являются
|
||||
* настройками рабочего устройства.
|
||||
*/
|
||||
|
||||
#include "led_indicator_stm32_hal.h"
|
||||
|
||||
#include <stdio.h>
|
||||
|
||||
Reference in New Issue
Block a user