ST STM32F2 - Hal_Tim_Encoder_Mspdeinit; Hal_Tim_Encoder_Start; Hal_Tim_Encoder_Start_It; Hal_Tim_Encoder_Stop

HAL TIM Generic Driver
UM1940
596/1371
DocID028236 Rev 2
Return values
None:
HAL_TIM_Encoder_MspDeInit
Function name
void HAL_TIM_Encoder_MspDeInit (TIM_HandleTypeDef *
htim)
Function description
DeInitializes TIM Encoder Interface MSP.
Parameters
htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values
None:
HAL_TIM_Encoder_Start
Function name
HAL_StatusTypeDef HAL_TIM_Encoder_Start
(TIM_HandleTypeDef * htim, uint32_t Channel)
Function description
Starts the TIM Encoder Interface.
Parameters
htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Channel: TIM Channels to be enabled. This parameter can
be one of the following values:
TIM_CHANNEL_1: TIM Channel 1 selected
TIM_CHANNEL_2: TIM Channel 2 selected
TIM_CHANNEL_ALL: TIM Channel 1 and TIM Channel 2
are selected
Return values
HAL: status
HAL_TIM_Encoder_Stop
Function name
HAL_StatusTypeDef HAL_TIM_Encoder_Stop
(TIM_HandleTypeDef * htim, uint32_t Channel)
Function description
Stops the TIM Encoder Interface.
Parameters
htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Channel: TIM Channels to be disabled. This parameter can
be one of the following values:
TIM_CHANNEL_1: TIM Channel 1 selected
TIM_CHANNEL_2: TIM Channel 2 selected
TIM_CHANNEL_ALL: TIM Channel 1 and TIM Channel 2
are selected
Return values
HAL: status
HAL_TIM_Encoder_Start_IT
Function name
HAL_StatusTypeDef HAL_TIM_Encoder_Start_IT
(TIM_HandleTypeDef * htim, uint32_t Channel)
Function description
Starts the TIM Encoder Interface in interrupt mode.
Parameters
htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.