Peripheral State and Errors functions

IRDA State and Errors functions. More...

Functions
HAL_IRDA_StateTypeDef	HAL_IRDA_GetState (IRDA_HandleTypeDef *hirda)
	Returns the IRDA state.
uint32_t	HAL_IRDA_GetError (IRDA_HandleTypeDef *hirda)
	Return the IARDA error code.

---

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

uint32_t HAL_IRDA_GetError

(

IRDA_HandleTypeDef *

hirda

)

Return the IARDA error code.

Parameters:

hirda

pointer to a IRDA_HandleTypeDef structure that contains the configuration information for the specified IRDA.

Return values:

IRDA	Error Code

Definition at line 1747 of file stm32f4xx_hal_irda.c.

References IRDA_HandleTypeDef::ErrorCode.

HAL_IRDA_StateTypeDef HAL_IRDA_GetState

(

IRDA_HandleTypeDef *

hirda

)

Returns the IRDA state.

Parameters:

hirda

pointer to a IRDA_HandleTypeDef structure that contains the configuration information for the specified IRDA module.

Return values:

HAL

state

Definition at line 1732 of file stm32f4xx_hal_irda.c.

References IRDA_HandleTypeDef::gState, and IRDA_HandleTypeDef::RxState.