Коррекции по синтаксису и doxygen
This commit is contained in:
@@ -1,15 +1,18 @@
|
||||
/**
|
||||
**************************************************************************
|
||||
* @file __modbus_compat.h
|
||||
* @brief Модуль для совместимости библиотеки MODBUS.
|
||||
**************************************************************************
|
||||
*******************************************************************************
|
||||
* @file __modbus_compat.h
|
||||
* @brief Модуль для совместимости библиотеки MODBUS.
|
||||
*******************************************************************************
|
||||
* @details Файл содержит API старых функций, а также заглушки для отключенных модулей:
|
||||
*************************************************************************/
|
||||
#include "modbus.h"
|
||||
******************************************************************************/
|
||||
#include "modbus_core.h"
|
||||
|
||||
|
||||
/** @addtogroup MODBUS_LEGACY_API Legacy API
|
||||
* @ingroup MODBUS_FUNCTIONS
|
||||
* @brief Старые API функций, сохранённые для обратной совместимости.
|
||||
* @note Не используйте эти функции в новом коде. Они могут быть удалены в будущих версиях.
|
||||
* Вместо них используйте функции из основных групп MODBUS API.
|
||||
* @{
|
||||
*/
|
||||
|
||||
|
||||
30
Inc/modbus.h
30
Inc/modbus.h
@@ -1,20 +1,22 @@
|
||||
/**
|
||||
******************************************************************************
|
||||
*******************************************************************************
|
||||
* @file modbus.h
|
||||
* @brief Главный заголовочный файл Modbus библиотеки
|
||||
******************************************************************************
|
||||
*******************************************************************************
|
||||
@addtogroup MODBUS Modbus tools
|
||||
******************************************************************************
|
||||
@brief Библиотека реализующая протокол Modbus
|
||||
*******************************************************************************
|
||||
@addtogroup MODBUS_FUNCTIONS Main API for Modbus Library
|
||||
@ingroup MODBUS
|
||||
@brief Публичные функции библиотеки
|
||||
@{
|
||||
******************************************************************************
|
||||
*******************************************************************************
|
||||
* @details
|
||||
Объединяющий файл для подключения всей функциональности Modbus.
|
||||
Подключает все необходимые модули:
|
||||
|
||||
|
||||
@section init Инструкция по подключению
|
||||
@section Start Инструкция по подключению
|
||||
Для корректной работы надо:
|
||||
- Подключить обработчики RS_UART_Handler(), RS_TIM_Handler(), в соответствубщие
|
||||
низкоуровневые прерывания UART_IRQHandler, TIM_IRQHandler вместо HAL'овского обработчика
|
||||
@@ -23,20 +25,20 @@
|
||||
|
||||
- Инициализировать хендл мобдас. По умолчанию глобально создается hmodbus1
|
||||
- После для запуска Modbus:
|
||||
@verbatim
|
||||
@code
|
||||
//----------------Слейв модбас----------------//
|
||||
#include "modbus.h"
|
||||
|
||||
MODBUS_FirstInit(&hmodbus1, &huart1, &htim3);
|
||||
MODBUS_Config(&hmodbus1, MODBUS_DEVICE_ID, MODBUS_TIMEOUT, MODBUS_MODE_SLAVE);
|
||||
MODBUS_SlaveStart(&hmodbus1, NULL);
|
||||
@endverbatim
|
||||
@verbatim
|
||||
@endcode
|
||||
@code
|
||||
//----------------Мастер модбас----------------//
|
||||
#include "modbus.h"
|
||||
|
||||
MODBUS_FirstInit(&hmodbus1, &huart1, &htim3);
|
||||
MODBUS_Config(&hmodbus1, 0, 1000, MODBUS_MODE_MASTER);
|
||||
MODBUS_Config(&hmodbus1, 0, MODBUS_TIMEOUT, MODBUS_MODE_MASTER);
|
||||
// Запрос на 1 ID, считать холдинг регистры с 0 адреса 10 штук
|
||||
RS_MsgTypeDef msg = MB_REQUEST_READ_HOLDING_REGS(1, 0, 10);
|
||||
MODBUS_MasterRequest(&hmodbus1, &msg, &callback_func);
|
||||
@@ -56,10 +58,10 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
@endverbatim
|
||||
@endcode
|
||||
|
||||
|
||||
@section Подключаемые модули:
|
||||
@section modules Подключаемые модули:
|
||||
- rs_message.h - работа с uart
|
||||
- modbus_core.h - базовые определения
|
||||
- modbus_coils.h - работа с дискретными выходами
|
||||
@@ -69,7 +71,7 @@
|
||||
- modbus_diag.h - диагностика modbus
|
||||
|
||||
|
||||
@section Структура данных Modbus
|
||||
@section data Структура данных Modbus
|
||||
|
||||
#### Holding/Input Registers:
|
||||
- Регистры — 16-битные слова. Доступ к регистрам осуществляется через указатель.
|
||||
@@ -108,11 +110,11 @@
|
||||
|
||||
|
||||
#ifdef MODBUS_ENABLE_MASTER
|
||||
#define MODBUS_MODE_MASTER 1
|
||||
#define MODBUS_MODE_MASTER 1 ///< Псевдо-enum: Режим мастер
|
||||
#endif
|
||||
|
||||
#ifdef MODBUS_ENABLE_SLAVE
|
||||
#define MODBUS_MODE_SLAVE 0
|
||||
#define MODBUS_MODE_SLAVE 0 ///< Псевдо-enum: Режим слейв
|
||||
#endif
|
||||
|
||||
/////////////////////////////////////////////////////////////////////
|
||||
|
||||
@@ -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);
|
||||
|
||||
@@ -1,12 +1,13 @@
|
||||
/**
|
||||
******************************************************************************
|
||||
*******************************************************************************
|
||||
* @file modbus_core.h
|
||||
* @brief Ядро Modbus протокола - определения и структуры
|
||||
******************************************************************************
|
||||
*******************************************************************************
|
||||
@addtogroup MODBUS_INTERNAL Modbus Internal Tools
|
||||
@ingroup MODBUS
|
||||
@brief Внутренние штуки библиотеки
|
||||
@{
|
||||
******************************************************************************
|
||||
*******************************************************************************
|
||||
* @details
|
||||
Базовые определения для реализации Modbus RTU устройства:
|
||||
- Структуры сообщений Modbus
|
||||
@@ -14,7 +15,7 @@
|
||||
Константы размеров полей
|
||||
Вспомогательные макросы
|
||||
|
||||
@section Структура сообщения:
|
||||
@section msg Структура сообщения:
|
||||
[ADDR][FUNC][DATA...][CRC]
|
||||
- Адрес: 1 байт
|
||||
- Функция: 1 байт
|
||||
@@ -28,12 +29,13 @@
|
||||
#include "modbus_config.h"
|
||||
#include "modbus_data.h"
|
||||
#include "__crc_algs.h"
|
||||
#include "__modbus_compat.h"
|
||||
|
||||
/**
|
||||
* @addtogroup MODBUS_MESSAGE_DEFINES Modbus Message Tools
|
||||
* @ingroup MODBUS
|
||||
* @brief Определения протокола модбас
|
||||
@{
|
||||
* @{
|
||||
*/
|
||||
|
||||
/////////////////////////////////////////////////////////////////////
|
||||
@@ -93,7 +95,7 @@ typedef enum //MB_FunctonTypeDef
|
||||
/* COMMANDS */
|
||||
// reading
|
||||
FC_R_COILS = 0x01, ///< Чтение битовых ячеек
|
||||
//FC_R_DISC_IN = 0x02, ///< Чтение дискретных входов
|
||||
FC_R_DISC_IN = 0x02, ///< Чтение дискретных входов
|
||||
#ifndef MODBUS_SWITCH_COMMAND_R_IN_REGS_AND_R_HOLD_REGS
|
||||
FC_R_HOLD_REGS = 0x03, ///< Чтение входных регистров
|
||||
FC_R_IN_REGS = 0x04, ///< Чтение регистров хранения
|
||||
@@ -114,7 +116,7 @@ typedef enum //MB_FunctonTypeDef
|
||||
/* ERRORS */
|
||||
// error reading
|
||||
FC_ERR_R_COILS = FC_R_COILS + FC_ERR_VALUES_START, ///< Ошибка чтения битовых ячеек
|
||||
//FC_ERR_R_DISC_IN = FC_R_DISC_IN + FC_ERR_VALUES_START, ///< Ошибка чтения дискретных входов
|
||||
FC_ERR_R_DISC_IN = FC_R_DISC_IN + FC_ERR_VALUES_START, ///< Ошибка чтения дискретных входов
|
||||
FC_ERR_R_IN_REGS = FC_R_IN_REGS + FC_ERR_VALUES_START, ///< Ошибка чтения регистров хранения
|
||||
FC_ERR_R_HOLD_REGS = FC_R_HOLD_REGS + FC_ERR_VALUES_START, ///< Ошибка чтения входных регистров
|
||||
|
||||
@@ -124,8 +126,8 @@ typedef enum //MB_FunctonTypeDef
|
||||
FC_ERR_W_COILS = FC_W_COILS + FC_ERR_VALUES_START, ///< Ошибка записи нескольких битовых ячеек
|
||||
FC_ERR_W_HOLD_REGS = FC_W_HOLD_REGS + FC_ERR_VALUES_START, ///< Ошибка записи нескольких регистров
|
||||
|
||||
FC_ERR_R_DIAGNOSTIC = FC_R_DIAGNOSTICS + FC_ERR_VALUES_START, ///< Ошибка чтения диагностической информации устройства
|
||||
MB_FC_ERR_R_DEVICE_INFO = FC_R_DEVICE_ID + FC_ERR_VALUES_START, ///< Ошибка чтения информации об устройстве
|
||||
FC_ERR_R_DIAGNOSTIC = FC_R_DIAGNOSTICS + FC_ERR_VALUES_START, ///< Ошибка чтения диагностической информации устройства
|
||||
FC_ERR_R_DEVICE_INFO = FC_R_DEVICE_ID + FC_ERR_VALUES_START, ///< Ошибка чтения информации об устройстве
|
||||
}MB_FunctonTypeDef;
|
||||
|
||||
/** @brief Enum for MEI func codes */
|
||||
@@ -217,7 +219,7 @@ extern RS_MsgTypeDef MODBUS_MSG;
|
||||
* @param _parr_ - массив коилов.
|
||||
* @param _coil_ - Номер коила от начала массива _arr_.
|
||||
* @note Используется вместе с @ref MB_Set_Coil_Mask
|
||||
@verbatim Пояснение выражений
|
||||
@code Пояснение выражений
|
||||
- (_coil_/16) - индекс регистра, в котором содержится коил по адресу _coil_
|
||||
|
||||
Визуальный пример: 30 коил будет в 30/16 = 1 регистре (индексация с 0)
|
||||
@@ -225,14 +227,14 @@ extern RS_MsgTypeDef MODBUS_MSG;
|
||||
|register[0]----| |register[1]----|
|
||||
|skip this------| |get this-------|
|
||||
|shift to 14 bit|
|
||||
@endverbatim
|
||||
@endcode
|
||||
*/
|
||||
#define MB_Set_Coil_Reg_Ptr(_parr_, _coil_) ((uint16_t *)(_parr_)+((_coil_)/16))
|
||||
/**
|
||||
* @brief Макрос для установки маски, чтобы выделить запрашиваемый коил из регистра
|
||||
* @param _coil_ - Номер коила от начала массива _arr_.
|
||||
* @note Используется вместе с @ref MB_Set_Coil_Reg_Ptr
|
||||
@verbatim Пояснение выражений
|
||||
@code Пояснение выражений
|
||||
- (16*(_coil_/16) - сколько коилов нужно пропустить. прим. (16*30/16) - первые 16 коилов находятся вне регистра
|
||||
- _coil_-(16*(_coil_/16)) - сдвинуть бит на место запрашиваемого коила в регистре
|
||||
|
||||
@@ -244,7 +246,7 @@ extern RS_MsgTypeDef MODBUS_MSG;
|
||||
|register[0]----| |register[1]----|
|
||||
|skip this------| |get this-------|
|
||||
|shift to 14 bit|
|
||||
@endverbatim
|
||||
@endcode
|
||||
*/
|
||||
#define MB_Set_Coil_Mask(_coil_) (1 << ( _coil_ - (16*((_coil_)/16)) ))
|
||||
|
||||
@@ -289,7 +291,7 @@ extern RS_MsgTypeDef MODBUS_MSG;
|
||||
|
||||
/**
|
||||
* @addtogroup MODBUS_CMD_PROCESS_FUNCTIONS
|
||||
@{
|
||||
* @{
|
||||
*/
|
||||
|
||||
/* Реализация этих функций лежит в modbus_data.c */
|
||||
|
||||
@@ -1,18 +1,19 @@
|
||||
/**
|
||||
******************************************************************************
|
||||
*******************************************************************************
|
||||
* @file modbus_devid.h
|
||||
* @brief Идентификаторы устройства Modbus
|
||||
******************************************************************************
|
||||
*******************************************************************************
|
||||
@addtogroup MODBUS_DEVID Device Identifications Tools
|
||||
@ingroup MODBUS_INTERNAL
|
||||
******************************************************************************
|
||||
@brief Функции для работы с идентификаторами устройства
|
||||
*******************************************************************************
|
||||
* @details
|
||||
Модуль реализации функции Read Device Identifications (0x2B):
|
||||
- Базовая идентификация (Vendor, Product, Revision)
|
||||
- Расширенная идентификация (URL, Model, User fields)
|
||||
- Поддержка потоковой передачи больших объектов
|
||||
|
||||
@section Объекты идентификации:
|
||||
@section devobj Объекты идентификации:
|
||||
- VendorName, ProductCode, Revision - обязательные
|
||||
- VendorUrl, ProductName, ModelName - опциональные
|
||||
- User objects - пользовательские поля
|
||||
@@ -108,7 +109,7 @@ void MB_WriteObjectsToMessage(RS_MsgTypeDef *modbus_msg, unsigned maxidofobj);
|
||||
|
||||
/**
|
||||
* @addtogroup MODBUS_CMD_PROCESS_FUNCTIONS
|
||||
@{
|
||||
* @{
|
||||
*/
|
||||
|
||||
/* Обработать функцию Read Device Identifications (43/14 - 0x2B/0E) */
|
||||
|
||||
@@ -1,18 +1,19 @@
|
||||
/**
|
||||
******************************************************************************
|
||||
*******************************************************************************
|
||||
* @file modbus_diag.h
|
||||
* @brief Диагностика устройства Modbus
|
||||
******************************************************************************
|
||||
*******************************************************************************
|
||||
@addtogroup MODBUS_DIAG Diagnostics Tools
|
||||
@ingroup MODBUS_INTERNAL
|
||||
******************************************************************************
|
||||
@brief Функции для работы с диагностикой
|
||||
*******************************************************************************
|
||||
* @details
|
||||
Модуль реализации Diagnostics (Serial Line only) (0x08):
|
||||
- Полная поддержка всех подфункций диагностики
|
||||
- Возможность выставить/сбросить любой бит в диагностическом регистре
|
||||
- Сбор статистики работы устройства
|
||||
- Управление режимами работы
|
||||
****************************************** ************************************/
|
||||
******************************************************************************/
|
||||
#ifndef __MODBUS_DIAG_H_
|
||||
#define __MODBUS_DIAG_H_
|
||||
#include "modbus_core.h"
|
||||
@@ -100,7 +101,7 @@ void MB_Diagnostics_SlaveBusyCnt(void);
|
||||
|
||||
/**
|
||||
* @addtogroup MODBUS_CMD_PROCESS_FUNCTIONS
|
||||
@{
|
||||
* @{
|
||||
*/
|
||||
|
||||
/* Обработка команды диагностики (0x08) */
|
||||
|
||||
@@ -1,18 +1,22 @@
|
||||
/**
|
||||
******************************************************************************
|
||||
*******************************************************************************
|
||||
* @file modbus_holdregs.h
|
||||
* @brief Работа с регистрами хранения Modbus
|
||||
******************************************************************************
|
||||
*******************************************************************************
|
||||
@addtogroup MODBUS_INS Input Register Tools
|
||||
@ingroup MODBUS_INTERNAL
|
||||
******************************************************************************
|
||||
@brief Функции для работы с входными регистрами
|
||||
*******************************************************************************
|
||||
* @details
|
||||
Модуль для доступа к регистрам внутри программы:
|
||||
- Функции для доступа к регистрам хранения по глобальным адресам
|
||||
|
||||
Модуль обработки команд для регистров хранения (Holding Registers):
|
||||
- Чтение множества регистров (0x03)
|
||||
- Запись одиночного регистра (0x06)
|
||||
- Запись множества регистров (0x10)
|
||||
|
||||
@section Регистры хранения:
|
||||
@section hold Регистры хранения:
|
||||
- Read/Write доступ
|
||||
- 16-битные значения (uint16_t)
|
||||
******************************************************************************/
|
||||
@@ -41,7 +45,7 @@ uint16_t MB_Holding_Read_Global(uint16_t Addr, MB_ExceptionTypeDef *Exception);
|
||||
|
||||
/**
|
||||
* @addtogroup MODBUS_CMD_PROCESS_FUNCTIONS
|
||||
@{
|
||||
* @{
|
||||
*/
|
||||
/* Обработать функцию Read Holding Registers (03 - 0x03) */
|
||||
uint8_t MB_Process_Read_Hold_Regs(RS_MsgTypeDef *modbus_msg);
|
||||
|
||||
@@ -1,16 +1,20 @@
|
||||
/**
|
||||
******************************************************************************
|
||||
*******************************************************************************
|
||||
* @file modbus_inputregs.h
|
||||
* @brief Работа с входными регистрами Modbus
|
||||
******************************************************************************
|
||||
*******************************************************************************
|
||||
@addtogroup MODBUS_HOLD Holding Registers Tools
|
||||
@ingroup MODBUS_INTERNAL
|
||||
******************************************************************************
|
||||
@brief Функции для работы с регистрами хранения
|
||||
*******************************************************************************
|
||||
* @details
|
||||
Модуль для доступа к регистрам внутри программы:
|
||||
- Функции для доступа к входным регистрам по глобальным адресам
|
||||
|
||||
Модуль обработки команд для входных регистров (Input Registers):
|
||||
- Чтение множества регистров (0x04)
|
||||
|
||||
@section Входные регистры:
|
||||
@section in Входные регистры:
|
||||
- Read-Only доступ
|
||||
- 16-битные значения
|
||||
******************************************************************************/
|
||||
@@ -40,7 +44,7 @@ uint16_t MB_Input_Read_Global(uint16_t Addr, MB_ExceptionTypeDef *Exception);
|
||||
* @addtogroup MODBUS_CMD_PROCESS_FUNCTIONS Internal Process Functions
|
||||
* @ingroup MODBUS_INTERNAL
|
||||
* @brief Функции обработки запросов модбас
|
||||
@{
|
||||
* @{
|
||||
*/
|
||||
/* Обработать функцию Read Input Registers (04 - 0x04) */
|
||||
uint8_t MB_Process_Read_Input_Regs(RS_MsgTypeDef *modbus_msg);
|
||||
|
||||
@@ -1,13 +1,14 @@
|
||||
/**
|
||||
******************************************************************************
|
||||
*******************************************************************************
|
||||
* @file modbus_master.h
|
||||
* @brief Главный заголовочный файл Modbus библиотеки
|
||||
******************************************************************************
|
||||
*******************************************************************************
|
||||
@addtogroup MODBUS_MASTER Modbus master funtions
|
||||
@ingroup MODBUS_CMD_PROCESS_FUNCTIONS
|
||||
******************************************************************************
|
||||
@brief Функции для работы в режиме Master
|
||||
*******************************************************************************
|
||||
* @details
|
||||
Модуль реализации обработки UART сообщение в режиме мастер
|
||||
Модуль реализации Modbus в режиме мастер
|
||||
******************************************************************************/
|
||||
#ifndef __MODBUS_MASTER_H_
|
||||
#define __MODBUS_MASTER_H_
|
||||
@@ -17,7 +18,7 @@
|
||||
/**
|
||||
* @addtogroup MODBUS_REQUEST_MSG API for Master Requests
|
||||
* @ingroup MODBUS_FUNCTIONS
|
||||
* @brief Макросы для создания запросов в режиме мастер
|
||||
* @brief API для формирования фрейма-запроса в режиме мастер
|
||||
* @details Примеры использования:
|
||||
* @code
|
||||
* // Чтение 10 holding registers начиная с адреса 0
|
||||
@@ -80,24 +81,20 @@ RS_MsgTypeDef MB_REQUEST_READ_DEVICE_ID_SPECIFIC(uint8_t slave_addr, uint8_t obj
|
||||
* @code
|
||||
* // Пример: Запросили 10 регистров с адреса 100, хотим получить значение регистра 105
|
||||
* uint16_t reg_value;
|
||||
* if(MB_RespGet_RegisterValue(&MODBUS_MSG, 105, ®_value))
|
||||
* if(MB_RespGet_RegisterValue(modbus_msg, 105, ®_value))
|
||||
* {
|
||||
* printf("Register 105 value: %d\n", reg_value);
|
||||
* }
|
||||
*
|
||||
* // Пример: Получить все запрошенные регистры
|
||||
* for(int addr = MODBUS_MSG.Addr; addr < MODBUS_MSG.Addr + MODBUS_MSG.Qnt; addr++)
|
||||
* {
|
||||
* uint16_t value;
|
||||
* if(MB_RespGet_RegisterValue(&MODBUS_MSG, addr, &value))
|
||||
* {
|
||||
* printf("Register %d: %d\n", addr, value);
|
||||
* }
|
||||
* }
|
||||
* uint16_t reg_value[125];
|
||||
* MB_RespGet_RegisterAll(modbus_msg)
|
||||
* @endcode
|
||||
* @{
|
||||
*/
|
||||
|
||||
/* Получить значение ВСЕХ регистров в ответе */
|
||||
int MB_RespGet_RegisterAll(RS_MsgTypeDef *modbus_msg, uint16_t *reg_arr);
|
||||
/* Получить значение регистра в ответе по его адресу */
|
||||
int MB_RespGet_RegisterValue(RS_MsgTypeDef *modbus_msg, uint16_t reg_addr, uint16_t *reg_value);
|
||||
|
||||
|
||||
@@ -115,7 +112,7 @@ int MB_RespGet_RegisterValue(RS_MsgTypeDef *modbus_msg, uint16_t reg_addr, uint1
|
||||
* @code
|
||||
* // Пример: Запросили 10 coils с адреса 20, хотим узнать состояние coil 25
|
||||
* int coil_state;
|
||||
* if(MB_RespGet_CoilState(&MODBUS_MSG, 25, &coil_state))
|
||||
* if(MB_RespGet_CoilState(modbus_msg, 25, &coil_state))
|
||||
* {
|
||||
* printf("Coil 25 state: %s\n", coil_state ? "ON" : "OFF");
|
||||
* }
|
||||
@@ -124,7 +121,7 @@ int MB_RespGet_RegisterValue(RS_MsgTypeDef *modbus_msg, uint16_t reg_addr, uint1
|
||||
* for(int addr = MODBUS_MSG.Addr; addr < MODBUS_MSG.Addr + MODBUS_MSG.Qnt; addr++)
|
||||
* {
|
||||
* int state;
|
||||
* if(MB_RespGet_CoilState(&MODBUS_MSG, addr, &state))
|
||||
* if(MB_RespGet_CoilState(modbus_msg, addr, &state))
|
||||
* {
|
||||
* printf("Coil %d: %s\n", addr, state ? "ON" : "OFF");
|
||||
* }
|
||||
@@ -132,7 +129,9 @@ int MB_RespGet_RegisterValue(RS_MsgTypeDef *modbus_msg, uint16_t reg_addr, uint1
|
||||
* @endcode
|
||||
* @{
|
||||
*/
|
||||
|
||||
/* Получить состояние ВСЕХ coil в ответе */
|
||||
int MB_RespGet_CoilAll(RS_MsgTypeDef *modbus_msg, int *coil_arr);
|
||||
/* Получить состояние coil в ответе по его адресу */
|
||||
int MB_RespGet_CoilState(RS_MsgTypeDef *modbus_msg, uint16_t coil_addr, int *coil_state);
|
||||
|
||||
/** MODBUS_REQ_COILS_API
|
||||
@@ -150,7 +149,7 @@ int MB_RespGet_CoilState(RS_MsgTypeDef *modbus_msg, uint16_t coil_addr, int *coi
|
||||
* // Пример 1: Получить VendorName (ID = 0x00)
|
||||
* uint8_t length;
|
||||
* char vendor_name[64];
|
||||
* if(MB_RespGet_ObjectById(&MODBUS_MSG, 0x00, vendor_name, &length))
|
||||
* if(MB_RespGet_ObjectById(modbus_msg, 0x00, vendor_name, &length))
|
||||
* {
|
||||
* // получено
|
||||
* }
|
||||
@@ -159,12 +158,12 @@ int MB_RespGet_CoilState(RS_MsgTypeDef *modbus_msg, uint16_t coil_addr, int *coi
|
||||
* uint8_t obj_id, obj_length;
|
||||
* char obj_data[256];
|
||||
*
|
||||
* int obj_count = MB_RespGet_NumberOfObjects(&MODBUS_MSG);
|
||||
* int obj_count = MB_RespGet_NumberOfObjects(modbus_msg);
|
||||
* printf("Total objects: %d\n", obj_count);
|
||||
*
|
||||
* for(int i = 0; i < obj_count; i++)
|
||||
* {
|
||||
* if(MB_RespGet_ObjectByIndex(&MODBUS_MSG, i, &obj_id, obj_data, &obj_length))
|
||||
* if(MB_RespGet_ObjectByIndex(modbus_msg, i, &obj_id, obj_data, &obj_length))
|
||||
* {
|
||||
* // получено
|
||||
* }
|
||||
@@ -196,7 +195,7 @@ int MB_RespGet_ObjectByIndex(RS_MsgTypeDef *modbus_msg, int index, uint8_t *obj_
|
||||
* @code
|
||||
* // Получить данные диагностики (значение счетчика)
|
||||
* uint16_t counter_value;
|
||||
* if(MB_RespGet_Diagnostic(&MODBUS_MSG, &counter_value))
|
||||
* if(MB_RespGet_Diagnostic(modbus_msg, &counter_value))
|
||||
* {
|
||||
* printf("Counter value: %d\n", counter_value);
|
||||
* }
|
||||
@@ -204,6 +203,7 @@ int MB_RespGet_ObjectByIndex(RS_MsgTypeDef *modbus_msg, int index, uint8_t *obj_
|
||||
* @{
|
||||
*/
|
||||
|
||||
/* Получить */
|
||||
int MB_RespGet_Diagnostic(RS_MsgTypeDef *modbus_msg, uint16_t *data);
|
||||
|
||||
/** MODBUS_REQ_DIAG_API
|
||||
|
||||
@@ -1,13 +1,14 @@
|
||||
/**
|
||||
******************************************************************************
|
||||
*******************************************************************************
|
||||
* @file modbus_slave.h
|
||||
* @brief Главный заголовочный файл Modbus библиотеки
|
||||
******************************************************************************
|
||||
*******************************************************************************
|
||||
@addtogroup MODBUS_SLAVE Modbus slave funtions
|
||||
@ingroup MODBUS_CMD_PROCESS_FUNCTIONS
|
||||
******************************************************************************
|
||||
@brief Функции для работы в режиме Slave
|
||||
*******************************************************************************
|
||||
* @details
|
||||
Модуль реализации обработки UART сообщение в режиме слейв
|
||||
Модуль реализации Modbus в режиме слейв
|
||||
******************************************************************************/
|
||||
#ifndef __MODBUS_SLAVE_H_
|
||||
#define __MODBUS_SLAVE_H_
|
||||
|
||||
@@ -1,29 +1,29 @@
|
||||
/**
|
||||
******************************************************************************
|
||||
*******************************************************************************
|
||||
* @file rs_message.h
|
||||
* @brief Библиотека обмена сообщениями по RS-интерфейсу
|
||||
******************************************************************************
|
||||
*******************************************************************************
|
||||
@defgroup RS_TOOLS RS Tools
|
||||
@brief Всякое для работы по UART/RS
|
||||
@{
|
||||
******************************************************************************
|
||||
*******************************************************************************
|
||||
* @details
|
||||
Универсальная библиотека для работы с последовательными протоколами (Modbus, Custom)
|
||||
через UART в режиме прерываний с поддержкой таймаутов.
|
||||
|
||||
@section Основные возможности:
|
||||
@section posibility Основные возможности:
|
||||
- Прием/передача в прерываниях
|
||||
- Обработка IDLE линии для определения конца фрейма
|
||||
- Таймауты приема через TIM
|
||||
- Гибкая настройка размера сообщений
|
||||
|
||||
@section Использование:
|
||||
@section usage Использование:
|
||||
1. Определить структуру сообщения и размеры буфера
|
||||
2. Реализовать weak-функции обработки сообщений
|
||||
3. Добавить вызовы RS_UART_Handler/RS_TIM_Handler в прерывания
|
||||
4. Инициализировать через RS_Init() и запустить прием RS_Receive_IT()
|
||||
|
||||
@section Особенности:
|
||||
@section features Особенности:
|
||||
- Буфер: RS_Buffer[MSG_SIZE_MAX] Общий для приема/передачи
|
||||
- Состояния: отслеживается через флаги в RS_HandleTypeDef
|
||||
- Таймауты: контролируют максимальное время ожидания фрейма
|
||||
@@ -89,6 +89,7 @@
|
||||
/**
|
||||
* @addtogroup RS_DEBUG Tools for debug RS/UART/TIM
|
||||
* @ingroup RS_TOOLS
|
||||
* @brief Дефайны для отладки периферии
|
||||
* @{
|
||||
*/
|
||||
|
||||
|
||||
Reference in New Issue
Block a user