STM32F4xx_HAL_Driver  1.8.3
Peripheral State and Errors functions

IRDA State and Errors functions. More...

+ Collaboration diagram for Peripheral State and Errors functions:

Functions

HAL_IRDA_StateTypeDef HAL_IRDA_GetState (const IRDA_HandleTypeDef *hirda)
 Return the IRDA state. More...
 
uint32_t HAL_IRDA_GetError (const IRDA_HandleTypeDef *hirda)
 Return the IRDA error code. More...
 

Detailed Description

IRDA State and Errors functions.

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

Function Documentation

◆ HAL_IRDA_GetError()

uint32_t HAL_IRDA_GetError ( const IRDA_HandleTypeDef hirda)

Return the IRDA error code.

Parameters
hirdaPointer to a IRDA_HandleTypeDef structure that contains the configuration information for the specified IRDA.
Return values
IRDAError Code

Definition at line 2041 of file stm32f4xx_hal_irda.c.

◆ HAL_IRDA_GetState()

HAL_IRDA_StateTypeDef HAL_IRDA_GetState ( const IRDA_HandleTypeDef hirda)

Return the IRDA state.

Parameters
hirdaPointer to a IRDA_HandleTypeDef structure that contains the configuration information for the specified IRDA.
Return values
HALstate

Definition at line 2026 of file stm32f4xx_hal_irda.c.