FH_AI45.h File Reference

File Map:
FH_Functions, Section FH_AI (Analog Input), Peripheral FH_AI45 (Analog Input 45)
(The AI45 (Analog Input 45) could be any interested Analog Input of the micro-controller on which FH source code is ported)
More...

#include "../../../../FH_Embedded/FH_Root/FH_Perif/FH_AI/FH_AI_Configs/FH_AI_Configs.h"
#include "../../../../FH_Embedded/FH_Setup/FH_RFCommunication/FH_RFCommunication_GlobalVariables.h"

Go to the source code of this file.

Functions
FH_ErrorInfo	FH_AI_Init_AI45 (FH_RFCommunication_Message *fh_RFCommunication_Message)
	This function initializes the Analog Input 45 The Analog Input 45 could be any interested Analog Input of the micro-controller on which FH source code is ported FH user should call the initialization function of the interested Analog Input here.
FH_ErrorInfo	FH_AI_GetStatus_AI45 (FH_RFCommunication_Message *fh_RFCommunication_Message, uint32_t *Data)
	This function reads the Analog Input 45 The Analog Input 45 could be any interested Analog Input of the micro-controller on which FH source code is ported FH user should call the read function of the interested Analog Input here.

Detailed Description

File Map:
FH_Functions, Section FH_AI (Analog Input), Peripheral FH_AI45 (Analog Input 45)
(The AI45 (Analog Input 45) could be any interested Analog Input of the micro-controller on which FH source code is ported)

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.

For more information refer to FreeHIL.com

Definition in file FH_AI45.h.

Function Documentation

FH_AI_GetStatus_AI45()

FH_ErrorInfo FH_AI_GetStatus_AI45	(	FH_RFCommunication_Message *	fh_RFCommunication_Message,
		uint32_t *	Data )

This function reads the Analog Input 45
The Analog Input 45 could be any interested Analog Input of the micro-controller on which FH source code is ported
FH user should call the read function of the interested Analog Input here.

Parameters

Data	*Data will be set with the value of Analog Input 45

Returns

FH_ErrorInfo is returned

Note

To have a clean code, just include the related header file
Then just call the function here

  ==============================================================================
                        ##### RobotFramework Example #####
  ==============================================================================
  @{MessageData} =    Create List    ${AI45}
  &{Message}     =    Create Dictionary    DeviceAddress=${DeviceAddress_01}    Function=${Function_AI}    Command=${AI_Commands_GetStatus}    Data=@{MessageData}
  ${Result}    SendMessage    &{Message}

  Comments:

  AI45 => It indicates the Analog Input 45
  DeviceAddress_01 => It shall be equal to the address of the device: FH_RFCommunication_DeviceAddress
  Function_AI => It is the function in the message frame
  AI_Commands_GetStatus => It is the command of the function in the message frame

Warning

To be able to read the Analog Input 45 of the micro-controller on which FH source code is ported, the FH_AI_Init_AI45 function shall be invoked once by RobotFramework firstly
In other words, before invoking FH_AI_GetStatus_AI45 function from RobotFramework, FH_AI_Init_AI45 function shall be invoked in order to initialize the Analog Input

Definition at line 140 of file FH_AI45.c.

References FH_ResetErrorInfo(), and fh_RFCommunication_Message.

FH_AI_Init_AI45()

FH_ErrorInfo FH_AI_Init_AI45

(

FH_RFCommunication_Message *

fh_RFCommunication_Message

)

This function initializes the Analog Input 45
The Analog Input 45 could be any interested Analog Input of the micro-controller on which FH source code is ported
FH user should call the initialization function of the interested Analog Input here.

Parameters

None

Returns

FH_ErrorInfo is returned

Note

To have a clean code, just include the related header file
Then just call the function here

  ==============================================================================
                        ##### RobotFramework Example #####
  ==============================================================================
  @{MessageData} =    Create List    ${AI45}
  &{Message}     =    Create Dictionary    DeviceAddress=${DeviceAddress_01}    Function=${Function_AI}    Command=${AI_Commands_Init}    Data=@{MessageData}
  ${Result}    SendMessage    &{Message}

  Comments:

  AI45 => It indicates the Analog Input 45
  DeviceAddress_01 => It shall be equal to the address of the device: FH_RFCommunication_DeviceAddress
  Function_AI => It is the function in the message frame
  AI_Commands_Init => It is the command of the function in the message frame

Warning

To be able to read the Analog Input 45 of the micro-controller on which FH source code is ported, this function shall be invoked once by RobotFramework firstly
In other words, before invoking FH_AI_GetStatus_AI45 function from RobotFramework, this function shall be invoked in order to initialize the Analog Input

Definition at line 89 of file FH_AI45.c.

References FH_ResetErrorInfo(), and fh_RFCommunication_Message.

Referenced by FH_AI_Init_S().