 |
FreeHIL
|
|
FreeHIL
|
File Map:
FH_Functions, Section FH_UART, Peripheral FH_UART05 (UART 05)
(The UART05 (UART 05) could be any interested UART of the micro-controller on which FH source code is ported)
More...
#include "../../../../FH_Embedded/FH_Functions/FH_UART/FH_UART05/FH_UART05.h"#include "../../../../FH_Embedded/FH_Root/FH_Perif/FH_UART/FH_UART.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"#include "../../../../FH_Embedded/FH_Functions/FH_UART/FH_UART05/FH_UART05_Configs.h"#include "../../../../FH_Embedded/FH_Functions/FH_UART/FH_UART05/FH_UART05_GlobalVariables.h"Go to the source code of this file.
Functions | |
| FH_ErrorInfo | FH_UART_Init_UART05 (FH_RFCommunication_Message *fh_RFCommunication_Message) |
| This function initializes the UART 05 The UART 05 could be any interested UART of the micro-controller on which FH source code is ported FH user should call the initialization function of the interested UART here. | |
| FH_ErrorInfo | FH_UART_Send_UART05 (FH_RFCommunication_Message *fh_RFCommunication_Message) |
| This function sends data through the UART 05 The UART 05 could be any interested UART of the micro-controller on which FH source code is ported FH user should call the send function of the interested UART here. | |
| FH_ErrorInfo | FH_UART_Receive_UART05 (FH_RFCommunication_Message *fh_RFCommunication_Message, uint8_t *DataSize, uint8_t *Data) |
| This function retrieves the ISR (Interrupt Service Routine) receive buffer (FH_UART05_ReceiveBuf) of the UART 05 The UART 05 could be any interested UART of the micro-controller on which FH source code is ported FH user could left the present source code here intact. | |
| FH_ErrorInfo | FH_UART_ReceiveW_UART05 (FH_RFCommunication_Message *fh_RFCommunication_Message, uint8_t *DataSize, uint8_t *Data) |
| This function waits to receive the specified number of bytes of data through the ISR (Interrupt Service Routine) receive buffer (FH_UART05_ReceiveBuf) of the UART 05 A maximum timeout is specified too The UART 05 could be any interested UART of the micro-controller on which FH source code is ported FH user could left the present source code here intact. | |
| FH_ErrorInfo | FH_UART_ResetRB_UART05 (FH_RFCommunication_Message *fh_RFCommunication_Message) |
| This function resets the ISR (Interrupt Service Routine) receive buffer index (FH_UART05_ReceiveBufIndex) of the UART 05 The UART 05 could be any interested UART of the micro-controller on which FH source code is ported FH user could left the present source code here intact. | |
| FH_ErrorInfo | FH_UART_SSD8_UART05 (FH_RFCommunication_Message *fh_RFCommunication_Message) |
| This function sets the shared data buffer (FH_UART05_SharedDataBuf_8Bits) of the UART 05 The UART 05 could be any interested UART of the micro-controller on which FH source code is ported FH_UART05_SharedDataBuf_8Bits is a shared global 8 bit array which is a data bridge between RobotFramework and FH user code FH_UART05_SharedDataBuf_8Bits is optional It could be used by FH user to set some special data like receive filters on ISR (Interrupt Service Routine) of the UART 05 or ... | |
| FH_ErrorInfo | FH_UART_SSD16_UART05 (FH_RFCommunication_Message *fh_RFCommunication_Message) |
| This function sets the shared data buffer (FH_UART05_SharedDataBuf_16Bits) of the UART 05 The UART 05 could be any interested UART of the micro-controller on which FH source code is ported FH_UART05_SharedDataBuf_16Bits is a shared global 8 bit array which is a data bridge between RobotFramework and FH user code FH_UART05_SharedDataBuf_16Bits is optional It could be used by FH user to set some special data like receive filters on ISR (Interrupt Service Routine) of the UART 05 or ... | |
| FH_ErrorInfo | FH_UART_SSD32_UART05 (FH_RFCommunication_Message *fh_RFCommunication_Message) |
| This function sets the shared data buffer (FH_UART05_SharedDataBuf_32Bits) of the UART 05 The UART 05 could be any interested UART of the micro-controller on which FH source code is ported FH_UART05_SharedDataBuf_32Bits is a shared global 8 bit array which is a data bridge between RobotFramework and FH user code FH_UART05_SharedDataBuf_32Bits is optional It could be used by FH user to set some special data like receive filters on ISR (Interrupt Service Routine) of the UART 05 or ... | |
| FH_ErrorInfo | FH_UART_GSD8_UART05 (FH_RFCommunication_Message *fh_RFCommunication_Message, uint8_t *SharedDataLength, uint8_t *SharedData) |
| This function gets the shared data buffer (FH_UART05_SharedDataBuf_8Bits) of the UART 05 The UART 05 could be any interested UART of the micro-controller on which FH source code is ported FH_UART05_SharedDataBuf_8Bits is a shared global 8 bit array which is a data bridge between RobotFramework and FH user code FH_UART05_SharedDataBuf_8Bits is optional It could be used by FH user to set some special data like receive filters on ISR (Interrupt Service Routine) of the UART 05 or ... | |
| FH_ErrorInfo | FH_UART_GSD16_UART05 (FH_RFCommunication_Message *fh_RFCommunication_Message, uint8_t *SharedDataLength, uint8_t *SharedData) |
| This function gets the shared data buffer (FH_UART05_SharedDataBuf_16Bits) of the UART 05 The UART 05 could be any interested UART of the micro-controller on which FH source code is ported FH_UART05_SharedDataBuf_16Bits is a shared global 16 bit array which is a data bridge between RobotFramework and FH user code FH_UART05_SharedDataBuf_16Bits is optional It could be used by FH user to set some special data like receive filters on ISR (Interrupt Service Routine) of the UART 05 or ... | |
| FH_ErrorInfo | FH_UART_GSD32_UART05 (FH_RFCommunication_Message *fh_RFCommunication_Message, uint8_t *SharedDataLength, uint8_t *SharedData) |
| This function gets the shared data buffer (FH_UART05_SharedDataBuf_32Bits) of the UART 05 The UART 05 could be any interested UART of the micro-controller on which FH source code is ported FH_UART05_SharedDataBuf_32Bits is a shared global 32 bit array which is a data bridge between RobotFramework and FH user code FH_UART05_SharedDataBuf_32Bits is optional It could be used by FH user to set some special data like receive filters on ISR (Interrupt Service Routine) of the UART 05 or ... | |
Variables | |
| volatile uint8_t | FH_UART05_ReceiveBuf [FH_UART05_ReceiveBufLength] |
| volatile uint16_t | FH_UART05_ReceiveBufIndex = 0 |
| volatile uint8_t | FH_UART05_SharedDataBuf_8Bits [FH_UART05_SharedDataBufLength_8Bits] |
| volatile uint16_t | FH_UART05_SharedDataBuf_16Bits [FH_UART05_SharedDataBufLength_16Bits] |
| volatile uint32_t | FH_UART05_SharedDataBuf_32Bits [FH_UART05_SharedDataBufLength_32Bits] |
File Map:
FH_Functions, Section FH_UART, Peripheral FH_UART05 (UART 05)
(The UART05 (UART 05) could be any interested UART of the micro-controller on which FH source code is ported)
FH_UART05_SharedDataBuf_8Bits, FH_UART05_SharedDataBuf_16Bits and FH_UART05_SharedDataBuf_32Bits are optional and could be left intact
They could be used by FH user to set some special data like receive filters on ISR (Interrupt Service Routine) of the UART 05 , ...
They are controllable with some commands (described in this file) through RobotFramework
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_UART05.c.
| FH_ErrorInfo FH_UART_GSD16_UART05 | ( | FH_RFCommunication_Message * | fh_RFCommunication_Message, |
| uint8_t * | SharedDataLength, | ||
| uint8_t * | SharedData ) |
This function gets the shared data buffer (FH_UART05_SharedDataBuf_16Bits) of the UART 05
The UART 05 could be any interested UART of the micro-controller on which FH source code is ported
FH_UART05_SharedDataBuf_16Bits is a shared global 16 bit array which is a data bridge between RobotFramework and FH user code
FH_UART05_SharedDataBuf_16Bits is optional
It could be used by FH user to set some special data like receive filters on ISR (Interrupt Service Routine) of the UART 05 or ...
FH user could left the present source code here intact
| fh_RFCommunication_Message | The message frame set by RobotFramework |
| SharedDataLength | *SharedDataLength will be set to FH_UART05_SharedDataBufLength_16Bits |
| SharedData | *SharedData will be set to FH_UART05_SharedDataBuf_16Bits |
==============================================================================
##### RobotFramework Example #####
==============================================================================
@{MessageData} = Create List ${UART05}
&{Message} = Create Dictionary DeviceAddress=${DeviceAddress_01} Function=${Function_UART} Command=${UART_Commands_GSD16} Data=@{MessageData}
${Result} SendMessage &{Message}
Comments:
UART05 => It indicates the UART 05
DeviceAddress_01 => It shall be equal to the address of the device: FH_RFCommunication_DeviceAddress
Function_UART => It is the function in the message frame
UART_Commands_GSD16 => It is the command of the function in the message frame
Definition at line 693 of file FH_UART05.c.
References FH_Uint8Uint16::bytes, FH_ErrorInfo::error_code, FH_ERROR_OK, FH_ResetErrorInfo(), fh_RFCommunication_Message, FH_UART05_SharedDataBuf_16Bits, FH_UART05_SharedDataBufLength_16Bits, and FH_Uint8Uint16::value.
| FH_ErrorInfo FH_UART_GSD32_UART05 | ( | FH_RFCommunication_Message * | fh_RFCommunication_Message, |
| uint8_t * | SharedDataLength, | ||
| uint8_t * | SharedData ) |
This function gets the shared data buffer (FH_UART05_SharedDataBuf_32Bits) of the UART 05
The UART 05 could be any interested UART of the micro-controller on which FH source code is ported
FH_UART05_SharedDataBuf_32Bits is a shared global 32 bit array which is a data bridge between RobotFramework and FH user code
FH_UART05_SharedDataBuf_32Bits is optional
It could be used by FH user to set some special data like receive filters on ISR (Interrupt Service Routine) of the UART 05 or ...
FH user could left the present source code here intact
| fh_RFCommunication_Message | The message frame set by RobotFramework |
| SharedDataLength | *SharedDataLength will be set to FH_UART05_SharedDataBufLength_32Bits |
| SharedData | *SharedData will be set to FH_UART05_SharedDataBuf_32Bits |
==============================================================================
##### RobotFramework Example #####
==============================================================================
@{MessageData} = Create List ${UART05}
&{Message} = Create Dictionary DeviceAddress=${DeviceAddress_01} Function=${Function_UART} Command=${UART_Commands_GSD32} Data=@{MessageData}
${Result} SendMessage &{Message}
Comments:
UART05 => It indicates the UART 05
DeviceAddress_01 => It shall be equal to the address of the device: FH_RFCommunication_DeviceAddress
Function_UART => It is the function in the message frame
UART_Commands_GSD32 => It is the command of the function in the message frame
Definition at line 752 of file FH_UART05.c.
References FH_Uint8Uint32::bytes, FH_ErrorInfo::error_code, FH_ERROR_OK, FH_ResetErrorInfo(), fh_RFCommunication_Message, FH_UART05_SharedDataBuf_32Bits, FH_UART05_SharedDataBufLength_32Bits, and FH_Uint8Uint32::value.
| FH_ErrorInfo FH_UART_GSD8_UART05 | ( | FH_RFCommunication_Message * | fh_RFCommunication_Message, |
| uint8_t * | SharedDataLength, | ||
| uint8_t * | SharedData ) |
This function gets the shared data buffer (FH_UART05_SharedDataBuf_8Bits) of the UART 05
The UART 05 could be any interested UART of the micro-controller on which FH source code is ported
FH_UART05_SharedDataBuf_8Bits is a shared global 8 bit array which is a data bridge between RobotFramework and FH user code
FH_UART05_SharedDataBuf_8Bits is optional
It could be used by FH user to set some special data like receive filters on ISR (Interrupt Service Routine) of the UART 05 or ...
FH user could left the present source code here intact
| fh_RFCommunication_Message | The message frame set by RobotFramework |
| SharedDataLength | *SharedDataLength will be set to FH_UART05_SharedDataBufLength_8Bits |
| SharedData | *SharedData will be set to FH_UART05_SharedDataBuf_8Bits |
==============================================================================
##### RobotFramework Example #####
==============================================================================
@{MessageData} = Create List ${UART05}
&{Message} = Create Dictionary DeviceAddress=${DeviceAddress_01} Function=${Function_UART} Command=${UART_Commands_GSD8} Data=@{MessageData}
${Result} SendMessage &{Message}
Comments:
UART05 => It indicates the UART 05
DeviceAddress_01 => It shall be equal to the address of the device: FH_RFCommunication_DeviceAddress
Function_UART => It is the function in the message frame
UART_Commands_GSD8 => It is the command of the function in the message frame
Definition at line 638 of file FH_UART05.c.
References FH_ErrorInfo::error_code, FH_ERROR_OK, FH_ResetErrorInfo(), fh_RFCommunication_Message, FH_UART05_SharedDataBuf_8Bits, and FH_UART05_SharedDataBufLength_8Bits.
| FH_ErrorInfo FH_UART_Init_UART05 | ( | FH_RFCommunication_Message * | fh_RFCommunication_Message | ) |
This function initializes the UART 05
The UART 05 could be any interested UART of the micro-controller on which FH source code is ported
FH user should call the initialization function of the interested UART here.
| fh_RFCommunication_Message | The message frame set by RobotFramework |
==============================================================================
##### RobotFramework Example #####
==============================================================================
@{MessageData} = Create List ${UART05}
&{Message} = Create Dictionary DeviceAddress=${DeviceAddress_01} Function=${Function_UART} Command=${UART_Commands_Init} Data=@{MessageData}
${Result} SendMessage &{Message}
Comments:
UART05 => It indicates the UART 05
DeviceAddress_01 => It shall be equal to the address of the device: FH_RFCommunication_DeviceAddress
Function_UART => It is the function in the message frame
UART_Commands_Init => It is the command of the function in the message frame
Definition at line 137 of file FH_UART05.c.
References FH_ResetErrorInfo(), and fh_RFCommunication_Message.
| FH_ErrorInfo FH_UART_Receive_UART05 | ( | FH_RFCommunication_Message * | fh_RFCommunication_Message, |
| uint8_t * | DataSize, | ||
| uint8_t * | Data ) |
This function retrieves the ISR (Interrupt Service Routine) receive buffer (FH_UART05_ReceiveBuf) of the UART 05
The UART 05 could be any interested UART of the micro-controller on which FH source code is ported
FH user could left the present source code here intact.
| fh_RFCommunication_Message | The message frame set by RobotFramework |
| DataSize | *DataSize will be set to the ISR (Interrupt Service Routine) receive buffer index (FH_UART05_ReceiveBufIndex) of the UART 05 |
| Data | *Data will be set to the ISR (Interrupt Service Routine) receive buffer (FH_UART05_ReceiveBuf) of the UART 05 |
==============================================================================
##### RobotFramework Example #####
==============================================================================
@{MessageData} = Create List ${UART05}
&{Message} = Create Dictionary DeviceAddress=${DeviceAddress_01} Function=${Function_UART} Command=${UART_Commands_Receive} Data=@{MessageData}
${Result} SendMessage &{Message}
Comments:
UART05 => It indicates the UART 05
DeviceAddress_01 => It shall be equal to the address of the device: FH_RFCommunication_DeviceAddress
Function_UART => It is the function in the message frame
UART_Commands_Receive => It is the command of the function in the message frame
Definition at line 267 of file FH_UART05.c.
References FH_ResetErrorInfo(), fh_RFCommunication_Message, FH_UART05_ReceiveBuf, and FH_UART05_ReceiveBufIndex.
| FH_ErrorInfo FH_UART_ReceiveW_UART05 | ( | FH_RFCommunication_Message * | fh_RFCommunication_Message, |
| uint8_t * | DataSize, | ||
| uint8_t * | Data ) |
This function waits to receive the specified number of bytes of data through the ISR (Interrupt Service Routine) receive buffer (FH_UART05_ReceiveBuf) of the UART 05
A maximum timeout is specified too
The UART 05 could be any interested UART of the micro-controller on which FH source code is ported
FH user could left the present source code here intact.
| fh_RFCommunication_Message | The message frame set by RobotFramework |
| DataSize | *DataSize will be set to the ISR (Interrupt Service Routine) receive buffer index (FH_UART05_ReceiveBufIndex) of the UART 05 |
| Data | *Data will be set to the ISR (Interrupt Service Routine) receive buffer (FH_UART05_ReceiveBuf) of the UART 05 |
==============================================================================
##### RobotFramework Example #####
==============================================================================
@{MessageData} = Create List ${UART05} 05 00 00 0B B8
&{Message} = Create Dictionary DeviceAddress=${DeviceAddress_01} Function=${Function_UART} Command=${UART_Commands_ReceiveW} Data=@{MessageData}
${Result} SendMessage &{Message}
Comments:
UART05 => It indicates the UART 05
05 => The expected number of bytes of data to be received through the <b>ISR</b> (Interrupt Service Routine) receive buffer (FH_UART05_ReceiveBuf) of the <b>UART 05</b>
00 00 0B B8 => Example data (0x00000BB8 mili-seconds) as timeout of receiving the expected number of bytes
FH_GlobalTimeCounter which is a global variable is utilized to calculate the timeout
FH_GlobalTimeCounter shall be incremented every <b>1 mili-second</b> in an interested timer <b>ISR</b> (Interrupt Service Routine) by <b>FH</b> user
For this to happen, <b>FH_GlobalTimerCount.h</b> shall be included in the interested timer <b>ISR</b> (Interrupt Service Routine) file
If the expected number of bytes are received, the function does not wait anymore for the remaining time of the timeout
DeviceAddress_01 => It shall be equal to the address of the device: FH_RFCommunication_DeviceAddress
Function_UART => It is the function in the message frame
UART_Commands_ReceiveW => It is the command of the function in the message frame
Definition at line 338 of file FH_UART05.c.
References FH_ConvertUint8ToUint32(), FH_GlobalTimeCounter, FH_ResetErrorInfo(), fh_RFCommunication_Message, FH_UART05_ReceiveBuf, FH_UART05_ReceiveBufIndex, UART_ReceiveW_ExpectedDataLength, and UART_ReceiveW_MaxTimerCount.
| FH_ErrorInfo FH_UART_ResetRB_UART05 | ( | FH_RFCommunication_Message * | fh_RFCommunication_Message | ) |
This function resets the ISR (Interrupt Service Routine) receive buffer index (FH_UART05_ReceiveBufIndex) of the UART 05
The UART 05 could be any interested UART of the micro-controller on which FH source code is ported
FH user could left the present source code here intact.
| fh_RFCommunication_Message | The message frame set by RobotFramework |
==============================================================================
##### RobotFramework Example #####
==============================================================================
@{MessageData} = Create List ${UART05}
&{Message} = Create Dictionary DeviceAddress=${DeviceAddress_01} Function=${Function_UART} Command=${UART_Commands_ResetRB} Data=@{MessageData}
${Result} SendMessage &{Message}
Comments:
UART05 => It indicates the UART 05
DeviceAddress_01 => It shall be equal to the address of the device: FH_RFCommunication_DeviceAddress
Function_UART => It is the function in the message frame
UART_Commands_ResetRB => It is the command of the function in the message frame
Definition at line 405 of file FH_UART05.c.
References FH_ResetErrorInfo(), fh_RFCommunication_Message, and FH_UART05_ReceiveBufIndex.
| FH_ErrorInfo FH_UART_Send_UART05 | ( | FH_RFCommunication_Message * | fh_RFCommunication_Message | ) |
This function sends data through the UART 05
The UART 05 could be any interested UART of the micro-controller on which FH source code is ported
FH user should call the send function of the interested UART here.
| fh_RFCommunication_Message | The message frame set by RobotFramework |
==============================================================================
##### RobotFramework Example #####
==============================================================================
@{MessageData} = Create List ${UART05} 02 B1 FF
&{Message} = Create Dictionary DeviceAddress=${DeviceAddress_01} Function=${Function_UART} Command=${UART_Commands_Send} Data=@{MessageData}
${Result} SendMessage &{Message}
Comments:
UART05 => It indicates the UART 05
02 => Example length of the data to be sent
B1 FF => Example data (0xB1, 0xFF) to be sent (or apart from the data to be sent, it may include some other data like ID, Filter, ... to be processed too, if need be) through the <b>UART 05</b>\n
DeviceAddress_01 => It shall be equal to the address of the device: FH_RFCommunication_DeviceAddress
Function_UART => It is the function in the message frame
UART_Commands_Send => It is the command of the function in the message frame
Definition at line 190 of file FH_UART05.c.
References FH_ResetErrorInfo(), fh_RFCommunication_Message, UART_Send_Data, and UART_Send_DataLength.
| FH_ErrorInfo FH_UART_SSD16_UART05 | ( | FH_RFCommunication_Message * | fh_RFCommunication_Message | ) |
This function sets the shared data buffer (FH_UART05_SharedDataBuf_16Bits) of the UART 05
The UART 05 could be any interested UART of the micro-controller on which FH source code is ported
FH_UART05_SharedDataBuf_16Bits is a shared global 8 bit array which is a data bridge between RobotFramework and FH user code
FH_UART05_SharedDataBuf_16Bits is optional
It could be used by FH user to set some special data like receive filters on ISR (Interrupt Service Routine) of the UART 05 or ...
FH user could left the present source code here intact
| fh_RFCommunication_Message | The message frame set by RobotFramework |
==============================================================================
##### RobotFramework Example #####
==============================================================================
@{MessageData} = Create List ${UART05} 02 AA BB CC DD
&{Message} = Create Dictionary DeviceAddress=${DeviceAddress_01} Function=${Function_UART} Command=${UART_Commands_SSD16} Data=@{MessageData}
${Result} SendMessage &{Message}
Comments:
UART05 => It indicates the UART 05
02 => Example interested length of the 16 bit data to be set
AA BB CC DD => Example data (0xAABB and 0xCCDD) to be set in <b>FH_UART05_SharedDataBuf_16Bits</b>
DeviceAddress_01 => It shall be equal to the address of the device: FH_RFCommunication_DeviceAddress
Function_UART => It is the function in the message frame
UART_Commands_SSD16 => It is the command of the function in the message frame
Definition at line 511 of file FH_UART05.c.
References FH_ErrorInfo::error_code, FH_ConvertUint8ToUint16(), FH_ERROR_Functions, FH_ERROR_OK, FH_ResetErrorInfo(), fh_RFCommunication_Message, FH_UART05_SharedDataBuf_16Bits, FH_UART05_SharedDataBufLength_16Bits, UART_SSD16_SharedData, and UART_SSD16_SharedDataLength.
| FH_ErrorInfo FH_UART_SSD32_UART05 | ( | FH_RFCommunication_Message * | fh_RFCommunication_Message | ) |
This function sets the shared data buffer (FH_UART05_SharedDataBuf_32Bits) of the UART 05
The UART 05 could be any interested UART of the micro-controller on which FH source code is ported
FH_UART05_SharedDataBuf_32Bits is a shared global 8 bit array which is a data bridge between RobotFramework and FH user code
FH_UART05_SharedDataBuf_32Bits is optional
It could be used by FH user to set some special data like receive filters on ISR (Interrupt Service Routine) of the UART 05 or ...
FH user could left the present source code here intact
| fh_RFCommunication_Message | The message frame set by RobotFramework |
==============================================================================
##### RobotFramework Example #####
==============================================================================
@{MessageData} = Create List ${UART05} 02 AA BB CC DD 01 02 03 04
&{Message} = Create Dictionary DeviceAddress=${DeviceAddress_01} Function=${Function_UART} Command=${UART_Commands_SSD32} Data=@{MessageData}
${Result} SendMessage &{Message}
Comments:
UART05 => It indicates the UART 05
02 => Example interested length of the 32 bit data to be set
AA BB CC DD 01 02 03 04 => Example data (0xAABBCCDD and 0x01020304) to be set in <b>FH_UART05_SharedDataBuf_32Bits</b>
DeviceAddress_01 => It shall be equal to the address of the device: FH_RFCommunication_DeviceAddress
Function_UART => It is the function in the message frame
UART_Commands_SSD32 => It is the command of the function in the message frame
Definition at line 573 of file FH_UART05.c.
References FH_ErrorInfo::error_code, FH_ConvertUint8ToUint32(), FH_ERROR_Functions, FH_ERROR_OK, FH_ResetErrorInfo(), fh_RFCommunication_Message, FH_UART05_SharedDataBuf_32Bits, FH_UART05_SharedDataBufLength_32Bits, UART_SSD32_SharedData, and UART_SSD32_SharedDataLength.
| FH_ErrorInfo FH_UART_SSD8_UART05 | ( | FH_RFCommunication_Message * | fh_RFCommunication_Message | ) |
This function sets the shared data buffer (FH_UART05_SharedDataBuf_8Bits) of the UART 05
The UART 05 could be any interested UART of the micro-controller on which FH source code is ported
FH_UART05_SharedDataBuf_8Bits is a shared global 8 bit array which is a data bridge between RobotFramework and FH user code
FH_UART05_SharedDataBuf_8Bits is optional
It could be used by FH user to set some special data like receive filters on ISR (Interrupt Service Routine) of the UART 05 or ...
FH user could left the present source code here intact
| fh_RFCommunication_Message | The message frame set by RobotFramework |
==============================================================================
##### RobotFramework Example #####
==============================================================================
@{MessageData} = Create List ${UART05} 04 AA BB CC DD
&{Message} = Create Dictionary DeviceAddress=${DeviceAddress_01} Function=${Function_UART} Command=${UART_Commands_SSD8} Data=@{MessageData}
${Result} SendMessage &{Message}
Comments:
UART05 => It indicates the UART 05
04 => Example interested length of the 8 bit data to be set
AA BB CC DD => Example data (0xAA, 0xBB, 0xCC, 0xDD) to be set in <b>FH_UART05_SharedDataBuf_8Bits</b>
DeviceAddress_01 => It shall be equal to the address of the device: FH_RFCommunication_DeviceAddress
Function_UART => It is the function in the message frame
UART_Commands_SSD8 => It is the command of the function in the message frame
Definition at line 453 of file FH_UART05.c.
References FH_ErrorInfo::error_code, FH_ERROR_Functions, FH_ERROR_OK, FH_ResetErrorInfo(), fh_RFCommunication_Message, FH_UART05_SharedDataBuf_8Bits, FH_UART05_SharedDataBufLength_8Bits, UART_SSD8_SharedData, and UART_SSD8_SharedDataLength.
| volatile uint8_t FH_UART05_ReceiveBuf[FH_UART05_ReceiveBufLength] |
FH user shall use FH_UART05_ReceiveBuf in the receive ISR (Interrupt Service Routine) of the UART 05 in a separate c file
For this to happen, FH user shall just include FH_UART05_GlobalVariables.h there
In other word, FH_UART05_ReceiveBuf array shall receive every byte of the received data there
It is configurable in FH_UART05_Configs.h
Definition at line 70 of file FH_UART05.c.
Referenced by FH_UART_Receive_UART05(), and FH_UART_ReceiveW_UART05().
| volatile uint16_t FH_UART05_ReceiveBufIndex = 0 |
FH_UART05_ReceiveBufIndex is the index of FH_UART05_ReceiveBuf
Definition at line 75 of file FH_UART05.c.
Referenced by FH_UART_Receive_UART05(), FH_UART_ReceiveW_UART05(), and FH_UART_ResetRB_UART05().
| volatile uint16_t FH_UART05_SharedDataBuf_16Bits[FH_UART05_SharedDataBufLength_16Bits] |
FH_UART05_SharedDataBuf_16Bits is optional and could be left intact
It could be used by FH user to set some special data like receive filters on ISR (Interrupt Service Routine) of the UART 05 , ... It are controllable with some commands (described in this file) through RobotFramework
It is configurable in FH_UART05_Configs.h
Definition at line 91 of file FH_UART05.c.
Referenced by FH_UART_GSD16_UART05(), and FH_UART_SSD16_UART05().
| volatile uint32_t FH_UART05_SharedDataBuf_32Bits[FH_UART05_SharedDataBufLength_32Bits] |
FH_UART05_SharedDataBuf_32Bits is optional and could be left intact
It could be used by FH user to set some special data like receive filters on ISR (Interrupt Service Routine) of the UART 05 , ... It are controllable with some commands (described in this file) through RobotFramework
It is configurable in FH_UART05_Configs.h
Definition at line 98 of file FH_UART05.c.
Referenced by FH_UART_GSD32_UART05(), and FH_UART_SSD32_UART05().
| volatile uint8_t FH_UART05_SharedDataBuf_8Bits[FH_UART05_SharedDataBufLength_8Bits] |
FH_UART05_SharedDataBuf_8Bits is optional and could be left intact
It could be used by FH user to set some special data like receive filters on ISR (Interrupt Service Routine) of the UART 05 , ... It are controllable with some commands (described in this file) through RobotFramework
It is configurable in FH_UART05_Configs.h
Definition at line 83 of file FH_UART05.c.
Referenced by FH_UART_GSD8_UART05(), and FH_UART_SSD8_UART05().
1.15.0