FH_UART_Send_C.c

Go to the documentation of this file.

/**
  * @file
  * @brief
  *       <b>File Map:</b>\n
  *       <b>FH_Root</b>, Section <b>FH_Perif</b>, <b>FH_UART</b>, <b>Cmd</b> (Command), <b>Send</b>, <b>Send_C</b> (Send Call)\n
  *       Functions in this file, Call the related function in <b>FH_Functions</b>, Section <b>FH_UART</b> according to the first parameter of the Data in the message frame
  *
  * @attention <b>FH</b> user could left this file intact
  *
  *******************************************************************************
  * SPDX-License-Identifier: Apache-2.0
 *
 * Copyright 2026 Vahid Hasirchi
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
  ********************************************************************************
 
  *
  * <b>For more information refer to FreeHIL.com</b>
  *
*/
 
/* Includes ------------------------------------------------------------------*/
#include "../../../../../../../FH_Embedded/FH_Root/FH_Perif/FH_UART/Cmd/Send/Send_C/FH_UART_Send_C.h"
 
#include "../../../../../../../FH_Embedded/FH_Root/FH_General/FH_GeneralFunctions/FH_GeneralFunctions.h"
#include "../../../../../../../FH_Embedded/FH_Setup/FH_DeviceAddress/FH_DeviceAddress.h"
 
#if FH_UART_MaxPeripheralNumber > 0    // It is configurable in FH_DevicePeripherals.h
 
/**
 * @brief This function calls the related function in <b>FH_Functions</b>, Section <b>FH_UART</b> according to the first parameter of the Data in the message frame
 *
 * @param  fh_RFCommunication_Message
 *         The message frame set by <b>RobotFramework</b>
 * @param  fH_UART_Send_FuncPtr
 *         The array of function pointers
 *
 * @verbatim
    ==============================================================================
                          ##### RobotFramework Example #####
    ==============================================================================
    @{MessageData} =    Create List    ${UART01}    02    B1     FF
    &{Message}     =    Create Dictionary    DeviceAddress=${DeviceAddress_01}    Function=${Function_UART}    Command=${UART_Commands_Send}    Data=@{MessageData}
    ${Result}    SendMessage    &{Message}
 
    Comments:
 
    UART01 => It indicates the UART 01
    02 => Example length of the data to be sent
    B1     FF => Example data (0xB1, 0xFF) to be sent (or apart from the data to be sent, it may include some other data like ID, Filter, ... to be processed too, if need be) through the <b>UART 01</b>\n
    DeviceAddress_01 => It shall be equal to the address of the device: FH_RFCommunication_DeviceAddress
    Function_UART => It is the function in the message frame
    UART_Commands_Send => It is the command of the function in the message frame
  @endverbatim
 *
 * @return FH_ErrorInfo is returned
 *
 
*/
FH_ErrorInfo FH_UART_Send_C (FH_RFCommunication_Message* fh_RFCommunication_Message, FH_UART_Send_FuncPtrModel *fH_UART_Send_FuncPtr)
{
    FH_ErrorInfo fh_ErrorInfo;    // Error Information
    FH_ResetErrorInfo(&fh_ErrorInfo);    // Reset Error Information to default
 
    for (uint8_t i = 1; i <= FH_UART_MaxPeripheralNumber; i++)    // Iteration through all defined  peripherals
    {
        if (i == fh_RFCommunication_Message -> Data[UART_Send_PeripheralNumber])    // If the PeripheralNumber in the message frame is met
        {
            if (fH_UART_Send_FuncPtr[i-1] != NULL_PTR)    // If the address of the function is truly assigned
            {
                fh_ErrorInfo = fH_UART_Send_FuncPtr[i-1](fh_RFCommunication_Message);    // Call the related function
            }
            else
            {
                fh_ErrorInfo.error_code = FH_ERROR_Root;    // There is Root error
            }
            return fh_ErrorInfo;
        }
    }
    fh_ErrorInfo.error_code = FH_ERROR_MessageFrame;    // There is message frame error
    return fh_ErrorInfo;
}
 
#endif