FreeHIL
Loading...
Searching...
No Matches
FH_DO_Configs.h File Reference

File Map:
FH_Root, Section FH_Perif, FH_DO (Digital Output), FH_DO_Configs
In this file, different configurations of FH_DO (Digital Output) could be set More...

#include "../../../../FH_Setup/FH_DevicePeripherals/FH_DevicePeripherals.h"
#include "../../../../../FH_Embedded/FH_Root/FH_General/FH_ErrorInfo/FH_ErrorInfo.h"
#include "../../../../../FH_Embedded/FH_Setup/FH_RFCommunication/FH_RFCommunication_GlobalVariables.h"

Go to the source code of this file.

Macros

#define FH_DO01
#define FH_DO02
#define FH_DO03
#define FH_DO04
#define FH_DO05
#define FH_DO06
#define FH_DO07
#define FH_DO08
#define FH_DO09
#define FH_DO10
#define FH_DO11
#define FH_DO12
#define FH_DO13
#define FH_DO14
#define FH_DO15
#define FH_DO16
#define FH_DO17
#define FH_DO18
#define FH_DO19
#define FH_DO20
#define FH_DO21
#define FH_DO22
#define FH_DO23
#define FH_DO24
#define FH_DO25
#define FH_DO26
#define FH_DO27
#define FH_DO28
#define FH_DO29
#define FH_DO30
#define FH_DO31
#define FH_DO32
#define FH_DO33
#define FH_DO34
#define FH_DO35
#define FH_DO36
#define FH_DO37
#define FH_DO38
#define FH_DO39
#define FH_DO40
#define FH_DO41
#define FH_DO42
#define FH_DO43
#define FH_DO44
#define FH_DO45
#define FH_DO46
#define FH_DO47
#define FH_DO48
#define FH_DO49
#define FH_DO50
#define FH_DO51
#define FH_DO52
#define FH_DO53
#define FH_DO54
#define FH_DO55
#define FH_DO56
#define FH_DO57
#define FH_DO58
#define FH_DO59
#define FH_DO60
#define FH_DO61
#define FH_DO62
#define FH_DO63
#define FH_DO64
#define FH_DO_MULTI_MaxPeripheralNumberLimit   64
#define FH_DO_MinCommandSize_Init   1
#define FH_DO_MinCommandSize_SetStatus   2
#define FH_DO_MinCommandSize_InitMULTI   8
#define FH_DO_MinCommandSize_SetStatusMULTI   16

Typedefs

typedef FH_ErrorInfo(* FH_DO_Init_FuncPtrModel) ()
typedef FH_ErrorInfo(* FH_DO_SetStatus_FuncPtrModel) (uint8_t status)

Enumerations

enum  FH_DO_Commands { FH_DO_Commands_Init = 0 , FH_DO_Commands_SetStatus = 1 , FH_DO_Commands_InitMULTI = 2 , FH_DO_Commands_SetStatusMULTI = 3 }
enum  FH_DO_Commandelements_Init { DO_Init_PeripheralNumber = 0 }
enum  FH_DO_Commandelements_SetStatus { DO_SetStatus_PeripheralNumber = 0 , DO_SetStatus_Status = 1 }
enum  FH_DO_Commandelements_InitMULTI {
  DO_InitMULTI_Byte0 = 0 , DO_InitMULTI_Byte1 = 1 , DO_InitMULTI_Byte2 = 2 , DO_InitMULTI_Byte3 = 3 ,
  DO_InitMULTI_Byte4 = 4 , DO_InitMULTI_Byte5 = 5 , DO_InitMULTI_Byte6 = 6 , DO_InitMULTI_Byte7 = 7
}
enum  FH_DO_Commandelements_SetStatusMULTI {
  DO_SetStatusMULTI_StatusMaskByte0 = 0 , DO_SetStatusMULTI_StatusMaskByte1 = 1 , DO_SetStatusMULTI_StatusMaskByte2 = 2 , DO_SetStatusMULTI_StatusMaskByte3 = 3 ,
  DO_SetStatusMULTI_StatusMaskByte4 = 4 , DO_SetStatusMULTI_StatusMaskByte5 = 5 , DO_SetStatusMULTI_StatusMaskByte6 = 6 , DO_SetStatusMULTI_StatusMaskByte7 = 7 ,
  DO_SetStatusMULTI_StatusByte0 = 8 , DO_SetStatusMULTI_StatusByte1 = 9 , DO_SetStatusMULTI_StatusByte2 = 10 , DO_SetStatusMULTI_StatusByte3 = 11 ,
  DO_SetStatusMULTI_StatusByte4 = 12 , DO_SetStatusMULTI_StatusByte5 = 13 , DO_SetStatusMULTI_StatusByte6 = 14 , DO_SetStatusMULTI_StatusByte7 = 15
}

Detailed Description

File Map:
FH_Root, Section FH_Perif, FH_DO (Digital Output), FH_DO_Configs
In this file, different configurations of FH_DO (Digital Output) could be set

Attention
FH user could left this file 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.

For more information refer to FreeHIL.com

Definition in file FH_DO_Configs.h.

Macro Definition Documentation

◆ FH_DO01

#define FH_DO01

FH_DO01 - FH_DO64 shall be defined here to be utilized in different parts of the FH source code
FH_DO_MaxPeripheralNumber is the maximum number of the FH_DO (Digital Output)

Definition at line 47 of file FH_DO_Configs.h.

◆ FH_DO02

#define FH_DO02

Definition at line 50 of file FH_DO_Configs.h.

◆ FH_DO03

#define FH_DO03

Definition at line 53 of file FH_DO_Configs.h.

◆ FH_DO04

#define FH_DO04

Definition at line 56 of file FH_DO_Configs.h.

◆ FH_DO05

#define FH_DO05

Definition at line 59 of file FH_DO_Configs.h.

◆ FH_DO06

#define FH_DO06

Definition at line 62 of file FH_DO_Configs.h.

◆ FH_DO07

#define FH_DO07

Definition at line 65 of file FH_DO_Configs.h.

◆ FH_DO08

#define FH_DO08

Definition at line 68 of file FH_DO_Configs.h.

◆ FH_DO09

#define FH_DO09

Definition at line 71 of file FH_DO_Configs.h.

◆ FH_DO10

#define FH_DO10

Definition at line 74 of file FH_DO_Configs.h.

◆ FH_DO11

#define FH_DO11

Definition at line 77 of file FH_DO_Configs.h.

◆ FH_DO12

#define FH_DO12

Definition at line 80 of file FH_DO_Configs.h.

◆ FH_DO13

#define FH_DO13

Definition at line 83 of file FH_DO_Configs.h.

◆ FH_DO14

#define FH_DO14

Definition at line 86 of file FH_DO_Configs.h.

◆ FH_DO15

#define FH_DO15

Definition at line 89 of file FH_DO_Configs.h.

◆ FH_DO16

#define FH_DO16

Definition at line 92 of file FH_DO_Configs.h.

◆ FH_DO17

#define FH_DO17

Definition at line 95 of file FH_DO_Configs.h.

◆ FH_DO18

#define FH_DO18

Definition at line 98 of file FH_DO_Configs.h.

◆ FH_DO19

#define FH_DO19

Definition at line 101 of file FH_DO_Configs.h.

◆ FH_DO20

#define FH_DO20

Definition at line 104 of file FH_DO_Configs.h.

◆ FH_DO21

#define FH_DO21

Definition at line 107 of file FH_DO_Configs.h.

◆ FH_DO22

#define FH_DO22

Definition at line 110 of file FH_DO_Configs.h.

◆ FH_DO23

#define FH_DO23

Definition at line 113 of file FH_DO_Configs.h.

◆ FH_DO24

#define FH_DO24

Definition at line 116 of file FH_DO_Configs.h.

◆ FH_DO25

#define FH_DO25

Definition at line 119 of file FH_DO_Configs.h.

◆ FH_DO26

#define FH_DO26

Definition at line 122 of file FH_DO_Configs.h.

◆ FH_DO27

#define FH_DO27

Definition at line 125 of file FH_DO_Configs.h.

◆ FH_DO28

#define FH_DO28

Definition at line 128 of file FH_DO_Configs.h.

◆ FH_DO29

#define FH_DO29

Definition at line 131 of file FH_DO_Configs.h.

◆ FH_DO30

#define FH_DO30

Definition at line 134 of file FH_DO_Configs.h.

◆ FH_DO31

#define FH_DO31

Definition at line 137 of file FH_DO_Configs.h.

◆ FH_DO32

#define FH_DO32

Definition at line 140 of file FH_DO_Configs.h.

◆ FH_DO33

#define FH_DO33

Definition at line 143 of file FH_DO_Configs.h.

◆ FH_DO34

#define FH_DO34

Definition at line 146 of file FH_DO_Configs.h.

◆ FH_DO35

#define FH_DO35

Definition at line 149 of file FH_DO_Configs.h.

◆ FH_DO36

#define FH_DO36

Definition at line 152 of file FH_DO_Configs.h.

◆ FH_DO37

#define FH_DO37

Definition at line 155 of file FH_DO_Configs.h.

◆ FH_DO38

#define FH_DO38

Definition at line 158 of file FH_DO_Configs.h.

◆ FH_DO39

#define FH_DO39

Definition at line 161 of file FH_DO_Configs.h.

◆ FH_DO40

#define FH_DO40

Definition at line 164 of file FH_DO_Configs.h.

◆ FH_DO41

#define FH_DO41

Definition at line 167 of file FH_DO_Configs.h.

◆ FH_DO42

#define FH_DO42

Definition at line 170 of file FH_DO_Configs.h.

◆ FH_DO43

#define FH_DO43

Definition at line 173 of file FH_DO_Configs.h.

◆ FH_DO44

#define FH_DO44

Definition at line 176 of file FH_DO_Configs.h.

◆ FH_DO45

#define FH_DO45

Definition at line 179 of file FH_DO_Configs.h.

◆ FH_DO46

#define FH_DO46

Definition at line 182 of file FH_DO_Configs.h.

◆ FH_DO47

#define FH_DO47

Definition at line 185 of file FH_DO_Configs.h.

◆ FH_DO48

#define FH_DO48

Definition at line 188 of file FH_DO_Configs.h.

◆ FH_DO49

#define FH_DO49

Definition at line 191 of file FH_DO_Configs.h.

◆ FH_DO50

#define FH_DO50

Definition at line 194 of file FH_DO_Configs.h.

◆ FH_DO51

#define FH_DO51

Definition at line 197 of file FH_DO_Configs.h.

◆ FH_DO52

#define FH_DO52

Definition at line 200 of file FH_DO_Configs.h.

◆ FH_DO53

#define FH_DO53

Definition at line 203 of file FH_DO_Configs.h.

◆ FH_DO54

#define FH_DO54

Definition at line 206 of file FH_DO_Configs.h.

◆ FH_DO55

#define FH_DO55

Definition at line 209 of file FH_DO_Configs.h.

◆ FH_DO56

#define FH_DO56

Definition at line 212 of file FH_DO_Configs.h.

◆ FH_DO57

#define FH_DO57

Definition at line 215 of file FH_DO_Configs.h.

◆ FH_DO58

#define FH_DO58

Definition at line 218 of file FH_DO_Configs.h.

◆ FH_DO59

#define FH_DO59

Definition at line 221 of file FH_DO_Configs.h.

◆ FH_DO60

#define FH_DO60

Definition at line 224 of file FH_DO_Configs.h.

◆ FH_DO61

#define FH_DO61

Definition at line 227 of file FH_DO_Configs.h.

◆ FH_DO62

#define FH_DO62

Definition at line 230 of file FH_DO_Configs.h.

◆ FH_DO63

#define FH_DO63

Definition at line 233 of file FH_DO_Configs.h.

◆ FH_DO64

#define FH_DO64

Definition at line 236 of file FH_DO_Configs.h.

◆ FH_DO_MinCommandSize_Init

#define FH_DO_MinCommandSize_Init   1

Minimum size of the Data part in the message frame (FH_RFCommunication_Message) for the Init command of DO Function, are defined here

Definition at line 275 of file FH_DO_Configs.h.

Referenced by FH_DO_Init_H().

◆ FH_DO_MinCommandSize_InitMULTI

#define FH_DO_MinCommandSize_InitMULTI   8

Minimum size of the Data part in the message frame (FH_RFCommunication_Message) for the InitMULTI command of DO Function, are defined here

Definition at line 285 of file FH_DO_Configs.h.

Referenced by FH_DO_InitMULTI_H().

◆ FH_DO_MinCommandSize_SetStatus

#define FH_DO_MinCommandSize_SetStatus   2

Minimum size of the Data part in the message frame (FH_RFCommunication_Message) for the SetStatus command of DO Function, are defined here

Definition at line 280 of file FH_DO_Configs.h.

◆ FH_DO_MinCommandSize_SetStatusMULTI

#define FH_DO_MinCommandSize_SetStatusMULTI   16

Minimum size of the Data part in the message frame (FH_RFCommunication_Message) for the SetStatusMULTI command of DO Function, are defined here

Definition at line 290 of file FH_DO_Configs.h.

◆ FH_DO_MULTI_MaxPeripheralNumberLimit

#define FH_DO_MULTI_MaxPeripheralNumberLimit   64

By default, in InitMULTI (Which is mass initialization of up to 64 DO (Digital Output)) and SetStatusMULTI (Which is mass status set of up to 64 DO (Digital Output)) commands, 8 bytes which is 64 bits (which means 64 DO (Digital Output)) is used in these commands
This value is set here as FH_DO_MULTI_MaxPeripheralNumberLimit
On the other hand, FH_DO_MaxPeripheralNumber is the maximum number of the FH_DO (Digital Output)

Warning
To use InitMULTI (Which is mass initialization of up to 64 DO (Digital Output)) and SetStatusMULTI (Which is mass status set of up to 64 DO (Digital Output)) commands, FH_DO_MaxPeripheralNumber and FH_DO_MULTI_MaxPeripheralNumberLimit shall be set to 64

Definition at line 270 of file FH_DO_Configs.h.

Referenced by FH_DO_InitMULTI_C().

Typedef Documentation

◆ FH_DO_Init_FuncPtrModel

typedef FH_ErrorInfo(* FH_DO_Init_FuncPtrModel) ()

FH_DO_Init_FuncPtrModel Function pointer definition

Definition at line 244 of file FH_DO_Configs.h.

◆ FH_DO_SetStatus_FuncPtrModel

typedef FH_ErrorInfo(* FH_DO_SetStatus_FuncPtrModel) (uint8_t status)

FH_DO_SetStatus_FuncPtrModel Function pointer definition

Definition at line 249 of file FH_DO_Configs.h.

Enumeration Type Documentation

◆ FH_DO_Commandelements_Init

enum FH_DO_Commandelements_Init

Different elements of the Data part in the message frame (FH_RFCommunication_Message) for the Init command of DO Function, are defined here

Enumerator
DO_Init_PeripheralNumber 

Definition at line 295 of file FH_DO_Configs.h.

◆ FH_DO_Commandelements_InitMULTI

enum FH_DO_Commandelements_InitMULTI

Different elements of the Data part in the message frame (FH_RFCommunication_Message) for the InitMULTI command of DO Function, are defined here

Enumerator
DO_InitMULTI_Byte0 
DO_InitMULTI_Byte1 
DO_InitMULTI_Byte2 
DO_InitMULTI_Byte3 
DO_InitMULTI_Byte4 
DO_InitMULTI_Byte5 
DO_InitMULTI_Byte6 
DO_InitMULTI_Byte7 

Definition at line 312 of file FH_DO_Configs.h.

◆ FH_DO_Commandelements_SetStatus

enum FH_DO_Commandelements_SetStatus

Different elements of the Data part in the message frame (FH_RFCommunication_Message) for the SetStatus command of DO Function, are defined here

Enumerator
DO_SetStatus_PeripheralNumber 
DO_SetStatus_Status 

Definition at line 303 of file FH_DO_Configs.h.

◆ FH_DO_Commandelements_SetStatusMULTI

enum FH_DO_Commandelements_SetStatusMULTI

Different elements of the Data part in the message frame (FH_RFCommunication_Message) for the SetStatusMULTI command of DO Function, are defined here

Enumerator
DO_SetStatusMULTI_StatusMaskByte0 
DO_SetStatusMULTI_StatusMaskByte1 
DO_SetStatusMULTI_StatusMaskByte2 
DO_SetStatusMULTI_StatusMaskByte3 
DO_SetStatusMULTI_StatusMaskByte4 
DO_SetStatusMULTI_StatusMaskByte5 
DO_SetStatusMULTI_StatusMaskByte6 
DO_SetStatusMULTI_StatusMaskByte7 
DO_SetStatusMULTI_StatusByte0 
DO_SetStatusMULTI_StatusByte1 
DO_SetStatusMULTI_StatusByte2 
DO_SetStatusMULTI_StatusByte3 
DO_SetStatusMULTI_StatusByte4 
DO_SetStatusMULTI_StatusByte5 
DO_SetStatusMULTI_StatusByte6 
DO_SetStatusMULTI_StatusByte7 

Definition at line 327 of file FH_DO_Configs.h.

◆ FH_DO_Commands

enum FH_DO_Commands

Different commands for DO (Digital Output) Function

Enumerator
FH_DO_Commands_Init 
FH_DO_Commands_SetStatus 
FH_DO_Commands_InitMULTI 
FH_DO_Commands_SetStatusMULTI 

Definition at line 254 of file FH_DO_Configs.h.