Коррекции по синтаксису и doxygen
This commit is contained in:
@@ -1,23 +1,27 @@
|
||||
/**
|
||||
******************************************************************************
|
||||
*******************************************************************************
|
||||
* @file modbus_coils.h
|
||||
* @brief Работа с коилами Modbus
|
||||
******************************************************************************
|
||||
*******************************************************************************
|
||||
@addtogroup MODBUS_COILS Coils Tools
|
||||
@ingroup MODBUS_INTERNAL
|
||||
******************************************************************************
|
||||
@brief Функции для работы с коилами
|
||||
*******************************************************************************
|
||||
* @details
|
||||
Модуль для доступа к coils внутри программы:
|
||||
- Функции для доступа к coils по глобальным адресам
|
||||
- Макросы для доступа к coils по локальным адресам
|
||||
|
||||
Модуль предоставляет функции и макросы для работы с битовыми данными:
|
||||
- Чтение coils (0x01) Упаковка битов в байты
|
||||
- Запись одиночного coil (0x05) Установка/сброс бита
|
||||
- Запись множественных coils (0x0F) - распаковка байтов в биты
|
||||
- Макросы для локального доступа к coils
|
||||
|
||||
@section Организация битовых данных:
|
||||
@section cbits Организация битовых данных:
|
||||
Coils упакованы в 16-битные слова для эффективного использования памяти.
|
||||
Биты нумеруются от младшего к старшему внутри каждого слова.
|
||||
|
||||
@section Адресация:
|
||||
@section caddr Адресация:
|
||||
- Глобальная - абсолютный адрес в пространстве Modbus
|
||||
- Локальная - относительный адрес внутри массива coils
|
||||
- Макросы автоматически вычисляют смещения и маски
|
||||
@@ -44,7 +48,7 @@ Coils упакованы в 16-битные слова для эффективн
|
||||
/**
|
||||
* @addtogroup MODBUS_DATA_ACCESS_FUNCTIONS API for Data Access
|
||||
* @ingroup MODBUS_FUNCTIONS
|
||||
* @brief Функции для доступа к данным модбас
|
||||
* @brief API для доступа к данным модбас внутри программы
|
||||
* @{
|
||||
*/
|
||||
|
||||
@@ -101,7 +105,7 @@ uint16_t MB_Coil_Read_Global(uint16_t Addr, MB_ExceptionTypeDef *Exception);
|
||||
|
||||
/**
|
||||
* @addtogroup MODBUS_CMD_PROCESS_FUNCTIONS
|
||||
@{
|
||||
* @{
|
||||
*/
|
||||
/* Обработать функцию Read Coils (01 - 0x01) */
|
||||
uint8_t MB_Process_Read_Coils(RS_MsgTypeDef *modbus_msg);
|
||||
|
||||
Reference in New Issue
Block a user