release 0.3.1

doxygen + refactoring

Inc/modbus_coils.h

@@ -5,7 +5,6 @@
 ******************************************************************************
 @addtogroup MODBUS_COILS Coils Tools
 @ingroup MODBUS_INTERNAL
-@{
 ******************************************************************************
 * @details
 Модуль предоставляет функции и макросы для работы с битовыми данными:
@@ -14,11 +13,11 @@
 - Запись множественных coils (0x0F) - распаковка байтов в биты
 - Макросы для локального доступа к coils
 
-@section Организация битовых данных:
+@section  Организация битовых данных:
 Coils упакованы в 16-битные слова для эффективного использования памяти.
 Биты нумеруются от младшего к старшему внутри каждого слова.
 
-@section Адресация:
+@section  Адресация:
 - Глобальная - абсолютный адрес в пространстве Modbus
 - Локальная - относительный адрес внутри массива coils
 - Макросы автоматически вычисляют смещения и маски
@@ -31,16 +30,15 @@ Coils упакованы в 16-битные слова для эффективн
 /////////////////////////////////////////////////////////////////////
 ////////////////////---MODBUS FUNCTION DEFINES---////////////////////
 
-/** @brief Structure for coils operation */
-typedef enum
-{
-  SET_COIL,
-  RESET_COIL,
-  TOOGLE_COIL,
-}MB_CoilsOpTypeDef;
+
 
 //--------------------------------------------------
 
+/**
+  * @addtogroup MODBUS_COILS
+  * @{
+  */
+
 /** 
   * @brief  Макрос для установки указателя на регистр, содержащий запрашиваемый коил
   * @param  _parr_  - массив коилов.
@@ -77,17 +75,14 @@ typedef enum
   */
 #define MB_Set_Coil_Mask(_coil_)                      (1 << ( _coil_ - (16*((_coil_)/16)) ))
   
+/** MODBUS_COILS
+  * @} 
+  */
+  
 
 /////////////////////////////////////////////////////////////////////
 /////////////////////////---FUNCTIONS---/////////////////////////////
   
-/** 
-* @addtogroup MODBUS_DATA_ACCESS_FUNCTIONS API for Data Access
-* @ingroup    MODBUS_FUNCTIONS
-* @brief      Функции для доступа к данным модбас
-@{
-*/
-
 
 /**
   * @addtogroup MODBUS_REQ_COILS_API API for Coils  
@@ -98,7 +93,7 @@ typedef enum
   * @code
   * // Пример: Запросили 10 coils с адреса 20, хотим узнать состояние coil 25
   * int coil_state;
-  * if(MB_GetCoilState(&MODBUS_MSG, 25, &coil_state))
+  * if(MB_RespGet_CoilState(&MODBUS_MSG, 25, &coil_state))
   * {
   *   printf("Coil 25 state: %s\n", coil_state ? "ON" : "OFF");
   * }
@@ -107,15 +102,16 @@ typedef enum
   * for(int addr = MODBUS_MSG.Addr; addr < MODBUS_MSG.Addr + MODBUS_MSG.Qnt; addr++)
   * {
   *   int state;
-  *   if(MB_GetCoilState(&MODBUS_MSG, addr, &state))
+  *   if(MB_RespGet_CoilState(&MODBUS_MSG, addr, &state))
   *   {
   *     printf("Coil %d: %s\n", addr, state ? "ON" : "OFF");
   *   }
   * }
   * @endcode
+  * @{
   */
 
-int MB_GetCoilState(RS_MsgTypeDef *modbus_msg, uint16_t coil_addr, int *coil_state);
+int MB_RespGet_CoilState(RS_MsgTypeDef *modbus_msg, uint16_t coil_addr, int *coil_state);
 
 /** MODBUS_REQ_COILS_API
   * @} 
@@ -123,6 +119,22 @@ int MB_GetCoilState(RS_MsgTypeDef *modbus_msg, uint16_t coil_addr, int *coil_sta
   
 
   
+  
+/**   
+  * @addtogroup MODBUS_DATA_ACCESS_FUNCTIONS API for Data Access
+  * @ingroup    MODBUS_FUNCTIONS
+  * @brief      Функции для доступа к данным модбас
+  * @{
+  */
+
+/** @brief Structure for coils operation */
+typedef enum
+{
+  SET_COIL,
+  RESET_COIL,
+  TOOGLE_COIL,
+}MB_CoilsOpTypeDef;
+  
 /** 
   * @brief  Считать коил по локальному адресу.
   * @param  _parr_        - массив коилов.
@@ -131,7 +143,7 @@ int MB_GetCoilState(RS_MsgTypeDef *modbus_msg, uint16_t coil_addr, int *coil_sta
   *
   * @details  Позволяет обратиться к коилу по адресу относительно _arr_.
   */
-#define MB_Read_Coil_Local(_parr_, _coil_)          ((  *MB_Set_Coil_Reg_Ptr(_parr_, _coil_)  &   MB_Set_Coil_Mask(_coil_) ) >> (_coil_))
+#define MB_Coil_Read_Local(_parr_, _coil_)          ((  *MB_Set_Coil_Reg_Ptr(_parr_, _coil_)  &   MB_Set_Coil_Mask(_coil_) ) >> (_coil_))
 /** 
   * @brief  Выставить коил по локальному адресу.
   * @param  _parr_        Указатель на массив коилов.
@@ -139,7 +151,7 @@ int MB_GetCoilState(RS_MsgTypeDef *modbus_msg, uint16_t coil_addr, int *coil_sta
   * 
   * @details  Позволяет обратиться к коилу по адресу относительно _arr_.
   */
-#define MB_Set_Coil_Local(_parr_, _coil_)             *MB_Set_Coil_Reg_Ptr(_parr_, _coil_)  |=  MB_Set_Coil_Mask(_coil_)
+#define MB_Coil_Set_Local(_parr_, _coil_)             *MB_Set_Coil_Reg_Ptr(_parr_, _coil_)  |=  MB_Set_Coil_Mask(_coil_)
 /** 
   * @brief  Сбросить коил по локальному адресу.
   * @param  _parr_        Указатель на массив коилов.
@@ -147,7 +159,7 @@ int MB_GetCoilState(RS_MsgTypeDef *modbus_msg, uint16_t coil_addr, int *coil_sta
   *
   * @details  Позволяет обратиться к коилу по адресу относительно _arr_.
   */
-#define MB_Reset_Coil_Local(_parr_, _coil_)           *MB_Set_Coil_Reg_Ptr(_parr_, _coil_)  &= ~(MB_Set_Coil_Mask(_coil_))
+#define MB_Coil_Reset_Local(_parr_, _coil_)           *MB_Set_Coil_Reg_Ptr(_parr_, _coil_)  &= ~(MB_Set_Coil_Mask(_coil_))
 /** 
   * @brief  Переключить состояние коила по локальному адресу.
   * @param  _parr_        Указатель на массив коилов.
@@ -155,12 +167,12 @@ int MB_GetCoilState(RS_MsgTypeDef *modbus_msg, uint16_t coil_addr, int *coil_sta
   * 
   * @details  Позволяет обратиться к коилу по адресу относительно _arr_.
   */
-#define MB_Toogle_Coil_Local(_parr_, _coil_)          *MB_Set_Coil_Reg_Ptr(_parr_, _coil_)  ^=  MB_Set_Coil_Mask(_coil_)
+#define MB_Coil_Toogle_Local(_parr_, _coil_)          *MB_Set_Coil_Reg_Ptr(_parr_, _coil_)  ^=  MB_Set_Coil_Mask(_coil_)
 
 /* Выставить/сбросить коил по глобальному адресу */
-MB_ExceptionTypeDef MB_Write_Coil_Global(uint16_t Addr, MB_CoilsOpTypeDef WriteVal);
+MB_ExceptionTypeDef MB_Coil_Write_Global(uint16_t Addr, MB_CoilsOpTypeDef WriteVal);
 /* Считать коил по глобальному адресу */
-uint16_t MB_Read_Coil_Global(uint16_t Addr, MB_ExceptionTypeDef *Exception);
+uint16_t MB_Coil_Read_Global(uint16_t Addr, MB_ExceptionTypeDef *Exception);
 
 /** MODBUS_DATA_ACCESS_FUNCTIONS
   * @} 
@@ -176,7 +188,7 @@ uint8_t MB_Process_Read_Coils(RS_MsgTypeDef *modbus_msg);
 /*  Обработать функцию Write Single Coils (05 - 0x05) */
 uint8_t MB_Process_Write_Single_Coil(RS_MsgTypeDef *modbus_msg);
 /* Обработать функцию Write Multiple Coils (15 - 0x0F) */
-uint8_t MB_Write_Miltuple_Coils(RS_MsgTypeDef *modbus_msg);
+uint8_t MB_Process_Write_Miltuple_Coils(RS_MsgTypeDef *modbus_msg);
 
 /** MODBUS_CMD_PROCESS_FUNCTIONS
   * @}