TUKS MCU Introductory course / TUKS-COURSE-THERMOMETER

Fork of TUKS-COURSE-TIMER by TUKS MCU Introductory course

Embed: (wiki syntax)

« Back to documentation index

Peripheral State and Error functions

Peripheral State and Error functions
[IRDA Exported Functions]

IRDA State and Errors functions. More...

Functions

HAL_IRDA_StateTypeDef HAL_IRDA_GetState (IRDA_HandleTypeDef *hirda)
 Return the IRDA handle state.
uint32_t HAL_IRDA_GetError (IRDA_HandleTypeDef *hirda)
 Return the IRDA handle 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 handle.
     (+) HAL_IRDA_GetError() checks in run-time errors that could occur during
         communication.


Function Documentation

uint32_t HAL_IRDA_GetError ( IRDA_HandleTypeDef *  hirda )

Return the IRDA handle error code.

Parameters:
hirda,:Pointer to a IRDA_HandleTypeDef structure that contains the configuration information for the specified IRDA module.
Return values:
IRDAError Code

Definition at line 1087 of file stm32l4xx_hal_irda.c.

HAL_IRDA_StateTypeDef HAL_IRDA_GetState ( IRDA_HandleTypeDef *  hirda )

Return the IRDA handle state.

Parameters:
hirda,:Pointer to a IRDA_HandleTypeDef structure that contains the configuration information for the specified IRDA module.
Return values:
HALstate

Definition at line 1071 of file stm32l4xx_hal_irda.c.