Arrow / Mbed OS DAPLink Reset
Embed: (wiki syntax)

« Back to documentation index

Peripheral State and Errors functions

Peripheral State and Errors functions
[UART Exported Functions]

UART State and Errors functions. More...

Functions

HAL_UART_StateTypeDef HAL_UART_GetState (UART_HandleTypeDef *huart)
 Returns the UART state.
uint32_t HAL_UART_GetError (UART_HandleTypeDef *huart)
 Return the UART error code.

Detailed Description

UART State and Errors functions.

  ==============================================================================
                 ##### Peripheral State and Errors functions #####
  ==============================================================================  
 [..]
   This subsection provides a set of functions allowing to return the State of 
   UART communication process, return Peripheral Errors occurred during communication 
   process
   (+) HAL_UART_GetState() API can be helpful to check in run-time the state of the UART peripheral.
   (+) HAL_UART_GetError() check in run-time errors that could be occurred during communication. 


Function Documentation

uint32_t HAL_UART_GetError ( UART_HandleTypeDef *  huart )

Return the UART error code.

Parameters:
huart,:Pointer to a UART_HandleTypeDef structure that contains the configuration information for the specified UART.
Return values:
UARTError Code

Definition at line 1529 of file stm32f1xx_hal_uart.c.

HAL_UART_StateTypeDef HAL_UART_GetState ( UART_HandleTypeDef *  huart )

Returns the UART state.

Parameters:
huart,:Pointer to a UART_HandleTypeDef structure that contains the configuration information for the specified UART module.
Return values:
HALstate

Definition at line 1518 of file stm32f1xx_hal_uart.c.