File Map:
FH_Functions, Section FH_DI (Digital Input), Peripheral FH_DI01 (Digital Input 01)
(The DI01 (Digital Input 01) could be any interested digital Input of the micro-controller on which FH source code is ported)
More...

#include "../../../../FH_Embedded/FH_Root/FH_Perif/FH_DI/FH_DI_Configs/FH_DI_Configs.h"

Functions
FH_ErrorInfo	FH_DI_Init_DI01 ()
	This function initializes the Digital Input 01 The Digital Input 01 could be any interested Digital Input of the micro-controller on which FH source code is ported FH user should call the initialization function of the interested Digital Input here.
FH_ErrorInfo	FH_DI_GetStatus_DI01 (uint8_t *Data)
	This function reads the Digital Input 01 The Digital Input 01 could be any interested Digital Input of the micro-controller on which FH source code is ported FH user should call the read function of the interested Digital Input here.

Detailed Description

File Map:
FH_Functions, Section FH_DI (Digital Input), Peripheral FH_DI01 (Digital Input 01)
(The DI01 (Digital Input 01) could be any interested digital Input of the micro-controller on which FH source code is ported)

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_DI01.h.

Function Documentation

◆ FH_DI_GetStatus_DI01()

FH_ErrorInfo FH_DI_GetStatus_DI01 ( uint8_t * Data )

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

Parameters

Data	If the read data of the Digital Input 01 is 1, Data will be set to 1 If the read data of the Digital Input 01* is 0, *Data will be set to 0

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    ${DI01}
  &{Message}     =    Create Dictionary    DeviceAddress=${DeviceAddress_01}    Function=${Function_DI}    Command=${DI_Commands_GetStatus}    Data=@{MessageData}
  ${Result}    SendMessage    &{Message}

  Comments:

  DI01 => It indicates the Digital Input 01
  DeviceAddress_01 => It shall be equal to the address of the device: FH_RFCommunication_DeviceAddress
  Function_DI => It is the function in the message frame
  DI_Commands_GetStatus => It is the command of the function in the message frame

Warning: To be able to read the Digital Input 01 of the micro-controller on which FH source code is ported, the FH_DI_Init_DI01 function shall be invoked once by RobotFramework firstly
In other words, before invoking FH_DI_GetStatus_DI01 function from RobotFramework, FH_DI_Init_DI01 function shall be invoked in order to initialize the Digital Input

Definition at line 141 of file FH_DI01.c.

References FH_ResetErrorInfo().

◆ FH_DI_Init_DI01()

FH_ErrorInfo FH_DI_Init_DI01 ( )

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

  Comments:

  DI01 => It indicates the Digital Input 01
  DeviceAddress_01 => It shall be equal to the address of the device: FH_RFCommunication_DeviceAddress
  Function_DI => It is the function in the message frame
  DI_Commands_Init => It is the command of the function in the message frame

Warning: To be able to read the Digital Input 01 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_DI_GetStatus_DI01 function from RobotFramework, this function shall be invoked in order to initialize the Digital Input

Definition at line 89 of file FH_DI01.c.

References FH_ResetErrorInfo().

Referenced by FH_DI_Init_S().