FH_PWMI11.c

Go to the documentation of this file.

/**
  * @file
  * @brief
  *       <b>File Map:</b>\n
  *       <b>FH_Functions</b>, Section <b>FH_PWMI</b> (PWM Input), Peripheral <b>FH_PWMI11</b> (PWM Input 11)\n
  *       (The <b>PWMI11 (PWM Input 11)</b> could be any interested PWM Input of the micro-controller on which <b>FH</b> source code is ported)\n
  *
  * @note To have a clean code, <b>FH</b> user should have the implementation of the initialization and read functions of the <b>PWM Input 11</b> in a separate c file\n
  *       Then <b>FH</b> user should include the header file <b>(.h)</b> of the related source file <b>(.c)</b> here\n
  *       This header file shall include the following items:\n
  *       The declaration of the initialization function of the <b>PWM Input 11</b>\n
  *       The declaration of the read function of the <b>PWM Input 11</b>
  *
  * @attention There are a total number of <b>3 attentions</b> (<b>FH</b> user defined code) in this file where <b>FH</b> user shall insert some code\n
  *            Other parts could be left 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>
  *
*/
/* Primary Includes ------------------------------------------------------------------*/
// Attention 1: FH user defined code (include the mentioned header file here)
 
//
#include "../../../../FH_Embedded/FH_Functions/FH_PWMI/FH_PWMI11/FH_PWMI11.h"
 
#ifdef FH_PWMI11    // It is configurable in FH_PWMI_Configs.h
 
#if FH_PWMI_MaxPeripheralNumber > 0    // It is configurable in FH_DevicePeripherals.h
 
/* Secondary Includes ------------------------------------------------------------------*/
#include "../../../../FH_Embedded/FH_Root/FH_Perif/FH_PWMI/FH_PWMI.h"
#include "../../../../FH_Embedded/FH_Root/FH_General/FH_GlobalTimerCount/FH_GlobalTimerCount.h"
#include "../../../../FH_Embedded/FH_Root/FH_General/FH_GeneralFunctions/FH_GeneralFunctions.h"
 
/**
 * @brief This function initializes the <b>PWM Input 11</b>\n
 *        The <b>PWM Input 11</b> could be any interested PWM Input of the micro-controller on which <b>FH</b> source code is ported\n
 *        <b>FH</b> user should call the initialization function of the interested PWM Input here
 *
 * @param  None
 * @return FH_ErrorInfo is returned
 *
 * @note
 * To have a clean code, just include the related header file\n
 * Then just call the function here
 *
 * @verbatim
    ==============================================================================
                          ##### RobotFramework Example #####
    ==============================================================================
    @{MessageData} =    Create List    ${PWMI11}
    &{Message}     =    Create Dictionary    DeviceAddress=${DeviceAddress_01}    Function=${Function_PWMI}    Command=${PWMI_Commands_Init}    Data=@{MessageData}
    ${Result}    SendMessage    &{Message}
 
    Comments:
 
    PWMI11 => It indicates the PWM Input 11
    DeviceAddress_01 => It shall be equal to the address of the device: FH_RFCommunication_DeviceAddress
    Function_PWMI => It is the function in the message frame
    PWMI_Commands_Init => It is the command of the function in the message frame
  @endverbatim
 *
 *
 * @warning
 * To be able to read the <b>PWM Input 11</b> of the micro-controller on which <b>FH</b> source code is ported, this function shall be invoked once by <b>RobotFramework</b> firstly\n
 * In other words, before invoking <b>FH_PWMI_GetStatus_PWMI11</b> function from <b>RobotFramework</b>, this function shall be invoked in order to initialize the PWM Input
 *
 
*/
FH_ErrorInfo FH_PWMI_Init_PWMI11(FH_RFCommunication_Message* fh_RFCommunication_Message)
{
    FH_ErrorInfo fh_ErrorInfo;    // Error Information
    FH_ResetErrorInfo(&fh_ErrorInfo);    // Reset Error Information to default
 
    // Attention 2: FH user defined code (call the initialization function of the PWM Input 11 here)
 
    // YourInitializationFunctionName ();
 
    //
    
    return fh_ErrorInfo;
}
 
/**
 * @brief This function reads the <b>PWM Input 11</b>\n
 *        The <b>PWM Input 11</b> could be any interested PWM Input of the micro-controller on which <b>FH</b> source code is ported\n
 *        <b>FH</b> user should call the read function of the interested PWM Input here
 *
 * @param  Data
 *         *Data will be set with the value of <b>PWM Input 11</b>\n
 *
 * @return FH_ErrorInfo is returned
 *
 * @note
 * To have a clean code, just include the related header file\n
 * Then just call the function here
 *
 * @verbatim
    ==============================================================================
                          ##### RobotFramework Example #####
    ==============================================================================
    @{MessageData} =    Create List    ${PWMI11}
    &{Message}     =    Create Dictionary    DeviceAddress=${DeviceAddress_01}    Function=${Function_PWMI}    Command=${PWMI_Commands_GetStatus}    Data=@{MessageData}
    ${Result}    SendMessage    &{Message}
 
    Comments:
 
    PWMI11 => It indicates the PWM Input 11
    DeviceAddress_01 => It shall be equal to the address of the device: FH_RFCommunication_DeviceAddress
    Function_PWMI => It is the function in the message frame
    PWMI_Commands_GetStatus => It is the command of the function in the message frame
  @endverbatim
 *
 *
 * @warning
 * To be able to read the <b>PWM Input 11</b> of the micro-controller on which <b>FH</b> source code is ported, the <b>FH_PWMI_Init_PWMI11</b> function shall be invoked once by <b>RobotFramework</b> firstly\n
 * In other words, before invoking <b>FH_PWMI_GetStatus_PWMI11</b> function from <b>RobotFramework</b>, <b>FH_PWMI_Init_PWMI11</b> function shall be invoked in order to initialize the PWM Input
 *
 
*/
FH_ErrorInfo FH_PWMI_GetStatus_PWMI11(FH_RFCommunication_Message* fh_RFCommunication_Message, uint32_t* fh_Frequency, uint8_t* fh_DutyCycle)
{
    FH_ErrorInfo fh_ErrorInfo;    // Error Information
    FH_ResetErrorInfo(&fh_ErrorInfo);    // Reset Error Information to default
 
    // Attention 3: FH user defined code (call the read function the PWM Input 11 here)
    // Hint: The prototype of the get function should be something like YourGetFunctionName(uint32_t* Frequency, uint8_t* DutyCycle);
    // Then *Frequency and *DutyCycle shall be set with the frequency and the duty cycle of the PWM input
 
    //YourGetFunctionName(fh_Frequency,fh_DutyCycle);
 
    //
    
    return fh_ErrorInfo;
}
    
#endif
 
#endif