File Map:
FH_Functions, Section FH_DO (Digital Output), Peripheral FH_DO01 (Digital Output 01)
(The DO01 (Digital Output 01) could be any interested digital output of the micro-controller on which FH source code is ported)
More...

#include "../../../../FH_Embedded/FH_Root/FH_Perif/FH_DO/FH_DO_Configs/FH_DO_Configs.h"

Functions
FH_ErrorInfo	FH_DO_Init_DO01 ()
	This function initializes the Digital Output 01 The Digital Output 01 could be any interested digital output of the micro-controller on which FH source code is ported FH user should call the initialization function of the interested digital output here.
FH_ErrorInfo	FH_DO_SetStatus_DO01 (uint8_t Status)
	This function sets or resets the Digital Output 01 The Digital Output 01 could be any interested digital output of the micro-controller on which FH source code is ported FH user should call the set and reset functions of the interested digital output here.

Detailed Description

File Map:
FH_Functions, Section FH_DO (Digital Output), Peripheral FH_DO01 (Digital Output 01)
(The DO01 (Digital Output 01) could be any interested digital output 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_DO01.h.

Function Documentation

◆ FH_DO_Init_DO01()

FH_ErrorInfo FH_DO_Init_DO01 ( )

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

  Comments:

  DO01 => It indicates the Digital Output 01
  DeviceAddress_01 => It shall be equal to the address of the device: FH_RFCommunication_DeviceAddress
  Function_DO => It is the function in the message frame
  DO_Commands_Init => It is the command of the function in the message frame

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

Definition at line 89 of file FH_DO01.c.

References FH_ResetErrorInfo().

Referenced by FH_DO_Init_S().

◆ FH_DO_SetStatus_DO01()

FH_ErrorInfo FH_DO_SetStatus_DO01 ( uint8_t Status )

This function sets or resets the Digital Output 01
The Digital Output 01 could be any interested digital output of the micro-controller on which FH source code is ported
FH user should call the set and reset functions of the interested digital output here.

Parameters

Status If Status is 1, the set function of the Digital Output 01 shall be called
If Status is 0, the reset function of the Digital Output 01 shall be called

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    ${DO01}    ${DO_Set}
  &{Message}     =    Create Dictionary    DeviceAddress=${DeviceAddress_01}    Function=${Function_DO}    Command=${DO_Commands_SetStatus}    Data=@{MessageData}
  ${Result}    SendMessage    &{Message}

  Comments:

  DO01 => It indicates the Digital Output 01
  DO_Set => It indicates the Digital Output 01 shall be Set (DO_Reset indicates the Digital Output 01 shall be Reset)
  DeviceAddress_01 => It shall be equal to the address of the device: FH_RFCommunication_DeviceAddress
  Function_DO => It is the function in the message frame
  DO_Commands_SetStatus => It is the command of the function in the message frame

Warning: To be able to set or reset the Digital Output 01 of the micro-controller on which FH source code is ported, the FH_DO_Init_DO01 function shall be invoked once by RobotFramework firstly
In other words, before invoking FH_DO_SetStatus_DO01 function from RobotFramework, FH_DO_Init_DO01 function shall be invoked in order to initialize the digital output

Definition at line 141 of file FH_DO01.c.

References FH_ErrorInfo::error_code, FH_ERROR_MessageFrame, and FH_ResetErrorInfo().