TUKS MCU Introductory course / TUKS-COURSE-2-LED
Embed: (wiki syntax)

« Back to documentation index

Time One Pulse functions

Time One Pulse functions
[TIM Exported Functions]

Time One Pulse functions. More...

Functions

HAL_StatusTypeDef HAL_TIM_OnePulse_Init (TIM_HandleTypeDef *htim, uint32_t OnePulseMode)
 Initializes the TIM One Pulse Time Base according to the specified parameters in the TIM_HandleTypeDef and initialize the associated handle.
HAL_StatusTypeDef HAL_TIM_OnePulse_DeInit (TIM_HandleTypeDef *htim)
 DeInitialize the TIM One Pulse.
__weak void HAL_TIM_OnePulse_MspInit (TIM_HandleTypeDef *htim)
 Initializes the TIM One Pulse MSP.
__weak void HAL_TIM_OnePulse_MspDeInit (TIM_HandleTypeDef *htim)
 DeInitialize TIM One Pulse MSP.
HAL_StatusTypeDef HAL_TIM_OnePulse_Start (TIM_HandleTypeDef *htim, uint32_t OutputChannel)
 Starts the TIM One Pulse signal generation.
HAL_StatusTypeDef HAL_TIM_OnePulse_Stop (TIM_HandleTypeDef *htim, uint32_t OutputChannel)
 Stops the TIM One Pulse signal generation.
HAL_StatusTypeDef HAL_TIM_OnePulse_Start_IT (TIM_HandleTypeDef *htim, uint32_t OutputChannel)
 Starts the TIM One Pulse signal generation in interrupt mode.
HAL_StatusTypeDef HAL_TIM_OnePulse_Stop_IT (TIM_HandleTypeDef *htim, uint32_t OutputChannel)
 Stops the TIM One Pulse signal generation in interrupt mode.

Detailed Description

Time One Pulse functions.

  ==============================================================================
                        ##### Time One Pulse functions #####
  ==============================================================================
  [..]
    This section provides functions allowing to:
    (+) Initialize and configure the TIM One Pulse.
    (+) De-initialize the TIM One Pulse.
    (+) Start the Time One Pulse.
    (+) Stop the Time One Pulse.
    (+) Start the Time One Pulse and enable interrupt.
    (+) Stop the Time One Pulse and disable interrupt.
    (+) Start the Time One Pulse and enable DMA transfer.
    (+) Stop the Time One Pulse and disable DMA transfer.


Function Documentation

HAL_StatusTypeDef HAL_TIM_OnePulse_DeInit ( TIM_HandleTypeDef *  htim )

DeInitialize the TIM One Pulse.

Parameters:
htim,:TIM One Pulse handle
Return values:
HALstatus

Definition at line 2027 of file stm32l4xx_hal_tim.c.

HAL_StatusTypeDef HAL_TIM_OnePulse_Init ( TIM_HandleTypeDef *  htim,
uint32_t  OnePulseMode 
)

Initializes the TIM One Pulse Time Base according to the specified parameters in the TIM_HandleTypeDef and initialize the associated handle.

Parameters:
htim,:TIM OnePulse handle
OnePulseMode,:Select the One pulse mode. This parameter can be one of the following values:

  • TIM_OPMODE_SINGLE: Only one pulse will be generated.
  • TIM_OPMODE_REPETITIVE: Repetitive pulses will be generated.
Return values:
HALstatus

Definition at line 1981 of file stm32l4xx_hal_tim.c.

__weak void HAL_TIM_OnePulse_MspDeInit ( TIM_HandleTypeDef *  htim )

DeInitialize TIM One Pulse MSP.

Parameters:
htim,:TIM handle
Return values:
None

Definition at line 2069 of file stm32l4xx_hal_tim.c.

__weak void HAL_TIM_OnePulse_MspInit ( TIM_HandleTypeDef *  htim )

Initializes the TIM One Pulse MSP.

Parameters:
htim,:TIM handle
Return values:
None

Definition at line 2054 of file stm32l4xx_hal_tim.c.

HAL_StatusTypeDef HAL_TIM_OnePulse_Start ( TIM_HandleTypeDef *  htim,
uint32_t  OutputChannel 
)

Starts the TIM One Pulse signal generation.

Parameters:
htim: TIM One Pulse handle
OutputChannel: 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
Return values:
HALstatus

Definition at line 2088 of file stm32l4xx_hal_tim.c.

HAL_StatusTypeDef HAL_TIM_OnePulse_Start_IT ( TIM_HandleTypeDef *  htim,
uint32_t  OutputChannel 
)

Starts the TIM One Pulse signal generation in interrupt mode.

Parameters:
htim: TIM One Pulse handle
OutputChannel: 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
Return values:
HALstatus

Definition at line 2160 of file stm32l4xx_hal_tim.c.

HAL_StatusTypeDef HAL_TIM_OnePulse_Stop ( TIM_HandleTypeDef *  htim,
uint32_t  OutputChannel 
)

Stops the TIM One Pulse signal generation.

Parameters:
htim: TIM One Pulse handle
OutputChannel: TIM Channels to be disable This parameter can be one of the following values:

  • TIM_CHANNEL_1: TIM Channel 1 selected
  • TIM_CHANNEL_2: TIM Channel 2 selected
Return values:
HALstatus

Definition at line 2124 of file stm32l4xx_hal_tim.c.

HAL_StatusTypeDef HAL_TIM_OnePulse_Stop_IT ( TIM_HandleTypeDef *  htim,
uint32_t  OutputChannel 
)

Stops the TIM One Pulse signal generation in interrupt mode.

Parameters:
htim: TIM One Pulse handle
OutputChannel: 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
Return values:
HALstatus

Definition at line 2202 of file stm32l4xx_hal_tim.c.