File Map:
FH_Functions, Section FH_AO (Analog Output), Peripheral FH_AO37 (Analog Output 37)
(The AO37 (Analog Output 37) could be any interested Analog Output of the micro-controller on which FH source code is ported)
More...

#include "../../../../FH_Embedded/FH_Functions/FH_AO/FH_AO37/FH_AO37.h"
#include "../../../../FH_Embedded/FH_Root/FH_Perif/FH_AO/FH_AO.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"

Functions
FH_ErrorInfo	FH_AO_Init_AO37 (FH_RFCommunication_Message *fh_RFCommunication_Message)
	This function initializes the Analog Output 37 The Analog Output 37 could be any interested Analog Output of the micro-controller on which FH source code is ported FH user should call the initialization function of the interested Analog Output here.
FH_ErrorInfo	FH_AO_SetStatus_AO37 (FH_RFCommunication_Message *fh_RFCommunication_Message)
	This function sets the Analog Output 37 The Analog Output 37 could be any interested Analog Output of the micro-controller on which FH source code is ported FH user should call the set function of the interested Analog Output here.

Detailed Description

File Map:
FH_Functions, Section FH_AO (Analog Output), Peripheral FH_AO37 (Analog Output 37)
(The AO37 (Analog Output 37) could be any interested Analog Output of the micro-controller on which FH source code is ported)

Note: To have a clean code, FH user should have the implementation of the initialization and set function of the Analog Output 37 in a separate c file
Then FH user should include the header file (.h) of the related source file (.c) here
This header file shall include the following items:
The declaration of the initialization function of the Analog Output 37
The declaration of the set function of the Analog Output 37

Attention: There are a total number of 3 attentions (FH user defined code) in this file where FH user shall insert some code
Other parts could be left intact

SPDX-License-Identifier: Apache-2.0

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_AO37.c.

Function Documentation

◆ FH_AO_Init_AO37()

FH_ErrorInfo FH_AO_Init_AO37 ( FH_RFCommunication_Message * fh_RFCommunication_Message )

This function initializes the Analog Output 37
The Analog Output 37 could be any interested Analog Output of the micro-controller on which FH source code is ported
FH user should call the initialization function of the interested Analog Output 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    ${AO37}
  &{Message}     =    Create Dictionary    DeviceAddress=${DeviceAddress_01}    Function=${Function_AO}    Command=${AO_Commands_Init}    Data=@{MessageData}
  ${Result}    SendMessage    &{Message}

  Comments:

  AO37 => It indicates the Analog Output 37
  DeviceAddress_01 => It shall be equal to the address of the device: FH_RFCommunication_DeviceAddress
  Function_AO => It is the function in the message frame
  AO_Commands_Init => It is the command of the function in the message frame

Warning: To be able to set or reset the Analog Output 37 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_AO_SetStatus_AO37 function from RobotFramework, this function shall be invoked in order to initialize the Analog Output

Definition at line 89 of file FH_AO37.c.

References FH_ResetErrorInfo(), and fh_RFCommunication_Message.

Referenced by FH_AO_Init_S().

◆ FH_AO_SetStatus_AO37()

FH_ErrorInfo FH_AO_SetStatus_AO37 ( FH_RFCommunication_Message * fh_RFCommunication_Message )

This function sets the Analog Output 37
The Analog Output 37 could be any interested Analog Output of the micro-controller on which FH source code is ported
FH user should call the set function of the interested Analog Output here.

Parameters

fh_RFCommunication_Message The message frame set by RobotFramework

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    ${AO37}    F1    C2    01    08
  &{Message}     =    Create Dictionary    DeviceAddress=${DeviceAddress_01}    Function=${Function_AO}    Command=${AO_Commands_SetStatus}    Data=@{MessageData}
  ${Result}    SendMessage    &{Message}

  Comments:

  AO37 => It indicates the Analog Output 37
  F1    C2    01    08 => Example data as analog value (0xF1C20108) to be set through the <b>Analog Output 37</b>\n
  DeviceAddress_01 => It shall be equal to the address of the device: FH_RFCommunication_DeviceAddress
  Function_AO => It is the function in the message frame
  AO_Commands_SetStatus => It is the command of the function in the message frame

Warning: To be able to set the Analog Output 37 of the micro-controller on which FH source code is ported, the FH_AO_Init_AO37 function shall be invoked once by RobotFramework firstly
In other words, before invoking FH_AO_SetStatus_AO37 function from RobotFramework, FH_AO_Init_AO37 function shall be invoked in order to initialize the Analog Output

Definition at line 141 of file FH_AO37.c.

References FH_ResetErrorInfo(), and fh_RFCommunication_Message.