doxygen update
This commit is contained in:
@@ -5,7 +5,6 @@
|
||||
******************************************************************************
|
||||
@addtogroup MODBUS_DEVID Device Identifications Tools
|
||||
@ingroup MODBUS_INTERNAL
|
||||
@{
|
||||
******************************************************************************
|
||||
* @details
|
||||
Модуль реализации функции Read Device Identifications (0x2B):
|
||||
@@ -13,7 +12,7 @@
|
||||
- Расширенная идентификация (URL, Model, User fields)
|
||||
- Поддержка потоковой передачи больших объектов
|
||||
|
||||
@section Объекты идентификации:
|
||||
@section Объекты идентификации:
|
||||
- VendorName, ProductCode, Revision - обязательные
|
||||
- VendorUrl, ProductName, ModelName - опциональные
|
||||
- User objects - пользовательские поля
|
||||
@@ -27,6 +26,11 @@
|
||||
/////////////////////////////////////////////////////////////////////
|
||||
///////////////---DEVICE IDENTIVICATIONS DEFINES---//////////////////
|
||||
|
||||
/**
|
||||
* @addtogroup MODBUS_DEVID
|
||||
* @{
|
||||
*/
|
||||
|
||||
/** @brief Структура для объекта (идентификатора устройства модбас) */
|
||||
typedef struct
|
||||
{
|
||||
@@ -61,15 +65,20 @@ void MB_DeviceInentificationInit(void);
|
||||
* @brief Инициализация объектов
|
||||
* @details С помозью этого дефайна инициализируются объекты в @ref MB_DeviceInentificationInit
|
||||
*/
|
||||
#define MB_ObjectInit(_p_obj_, _userstring_) (_p_obj_)->length = sizeof(_userstring_);\
|
||||
(_p_obj_)->name = _userstring_;
|
||||
/**
|
||||
#define MB_ObjectInit(_p_obj_, _userstring_) \
|
||||
(_p_obj_)->length = sizeof(_userstring_);\
|
||||
(_p_obj_)->name = _userstring_;
|
||||
/**
|
||||
* @brief Инициализация пользовательских объектов
|
||||
* @details С помозью этого дефайна инициализируются пользовательские объекты в MB_DeviceInentificationInit
|
||||
*/
|
||||
#define MB_UserObjectInit(_pinfostruct_, _user_numb_) MB_ObjectInit(&(_pinfostruct_)->User[_user_numb_], MODBUS_USEROBJECT##_user_numb_##_NAME)
|
||||
|
||||
|
||||
|
||||
/** MODBUS_DEVID
|
||||
* @}
|
||||
*/
|
||||
////////////////////---MODBUS MESSAGE DEFINES---/////////////////////
|
||||
|
||||
|
||||
@@ -80,7 +89,7 @@ void MB_DeviceInentificationInit(void);
|
||||
/**
|
||||
* @addtogroup MODBUS_REQ_DEFID_API API for Device Identifications
|
||||
* @ingroup MODBUS_REQUEST_MSG
|
||||
* @brief Макросы для чтения идентификторов из ответа в режиме мастер
|
||||
* @brief API для чтения идентификторов из ответа в режиме мастер
|
||||
* @details Примеры использования:
|
||||
*
|
||||
* @code
|
||||
@@ -107,6 +116,7 @@ void MB_DeviceInentificationInit(void);
|
||||
* }
|
||||
* }
|
||||
* @endcode
|
||||
* @{
|
||||
*/
|
||||
|
||||
/* Получить количество объектов в сообщении */
|
||||
@@ -122,12 +132,19 @@ int MB_RespGet_ObjectByIndex(RS_MsgTypeDef *modbus_msg, int index, uint8_t *obj_
|
||||
*/
|
||||
|
||||
|
||||
/**
|
||||
* @addtogroup MODBUS_DEVID
|
||||
* @{
|
||||
*/
|
||||
|
||||
/* Записать Один Объект Идентификатора в массив данных */
|
||||
void MB_WriteSingleObjectToMessage(char *mbdata, unsigned *ind, MB_DeviceObjectTypeDef *obj);
|
||||
/* Записать Массив Объектов Идентификатора в массив данных */
|
||||
void MB_WriteObjectsToMessage(RS_MsgTypeDef *modbus_msg, unsigned maxidofobj);
|
||||
|
||||
/** MODBUS_DEVID
|
||||
* @}
|
||||
*/
|
||||
//---------PROCESS MODBUS COMMAND FUNCTIONS---------
|
||||
/**
|
||||
* @addtogroup MODBUS_CMD_PROCESS_FUNCTIONS
|
||||
@@ -142,7 +159,3 @@ uint8_t MB_Process_Read_Device_Identifications(RS_MsgTypeDef *modbus_msg);
|
||||
/////////////////////////---FUNCTIONS---/////////////////////////////
|
||||
|
||||
#endif //__MODBUS_DEVID_H_
|
||||
|
||||
/** MODBUS_DEVID
|
||||
* @}
|
||||
*/
|
||||
Reference in New Issue
Block a user