TUKS MCU Introductory course / TUKS-COURSE-THERMOMETER

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

Embed: (wiki syntax)

« Back to documentation index

Input and Output operation functions

Input and Output operation functions
[Exported Functions]

Input and Output operation functions. More...

Functions

HAL_StatusTypeDef HAL_TSC_Start (TSC_HandleTypeDef *htsc)
 Start the acquisition.
HAL_StatusTypeDef HAL_TSC_Start_IT (TSC_HandleTypeDef *htsc)
 Start the acquisition in interrupt mode.
HAL_StatusTypeDef HAL_TSC_Stop (TSC_HandleTypeDef *htsc)
 Stop the acquisition previously launched in polling mode.
HAL_StatusTypeDef HAL_TSC_Stop_IT (TSC_HandleTypeDef *htsc)
 Stop the acquisition previously launched in interrupt mode.
HAL_StatusTypeDef HAL_TSC_PollForAcquisition (TSC_HandleTypeDef *htsc)
 Start acquisition and wait until completion.
TSC_GroupStatusTypeDef HAL_TSC_GroupGetStatus (TSC_HandleTypeDef *htsc, uint32_t gx_index)
 Get the acquisition status for a group.
uint32_t HAL_TSC_GroupGetValue (TSC_HandleTypeDef *htsc, uint32_t gx_index)
 Get the acquisition measure for a group.

Detailed Description

Input and Output operation functions.

 ===============================================================================
             ##### IO Operation functions #####
 ===============================================================================  
    [..]  This section provides functions allowing to:
      (+) Start acquisition in polling mode.
      (+) Start acquisition in interrupt mode.
      (+) Stop conversion in polling mode.
      (+) Stop conversion in interrupt mode.
      (+) Poll for acquisition completed.
      (+) Get group acquisition status.
      (+) Get group acquisition value.

Function Documentation

TSC_GroupStatusTypeDef HAL_TSC_GroupGetStatus ( TSC_HandleTypeDef *  htsc,
uint32_t  gx_index 
)

Get the acquisition status for a group.

Parameters:
htsc,:pointer to a TSC_HandleTypeDef structure that contains the configuration information for the specified TSC.
gx_index,:Index of the group
Return values:
Groupstatus

Definition at line 581 of file stm32l4xx_hal_tsc.c.

uint32_t HAL_TSC_GroupGetValue ( TSC_HandleTypeDef *  htsc,
uint32_t  gx_index 
)

Get the acquisition measure for a group.

Parameters:
htsc,:pointer to a TSC_HandleTypeDef structure that contains the configuration information for the specified TSC.
gx_index,:Index of the group
Return values:
Acquisitionmeasure

Definition at line 598 of file stm32l4xx_hal_tsc.c.

HAL_StatusTypeDef HAL_TSC_PollForAcquisition ( TSC_HandleTypeDef *  htsc )

Start acquisition and wait until completion.

Note:
There is no need of a timeout parameter as the max count error is already managed by the TSC peripheral.
Parameters:
htsc,:pointer to a TSC_HandleTypeDef structure that contains the configuration information for the specified TSC.
Return values:
HALstate

Definition at line 554 of file stm32l4xx_hal_tsc.c.

HAL_StatusTypeDef HAL_TSC_Start ( TSC_HandleTypeDef *  htsc )

Start the acquisition.

Parameters:
htsc,:pointer to a TSC_HandleTypeDef structure that contains the configuration information for the specified TSC.
Return values:
HALstatus

Definition at line 386 of file stm32l4xx_hal_tsc.c.

HAL_StatusTypeDef HAL_TSC_Start_IT ( TSC_HandleTypeDef *  htsc )

Start the acquisition in interrupt mode.

Parameters:
htsc,:pointer to a TSC_HandleTypeDef structure that contains the configuration information for the specified TSC.
Return values:
HALstatus.

Definition at line 429 of file stm32l4xx_hal_tsc.c.

HAL_StatusTypeDef HAL_TSC_Stop ( TSC_HandleTypeDef *  htsc )

Stop the acquisition previously launched in polling mode.

Parameters:
htsc,:pointer to a TSC_HandleTypeDef structure that contains the configuration information for the specified TSC.
Return values:
HALstatus

Definition at line 483 of file stm32l4xx_hal_tsc.c.

HAL_StatusTypeDef HAL_TSC_Stop_IT ( TSC_HandleTypeDef *  htsc )

Stop the acquisition previously launched in interrupt mode.

Parameters:
htsc,:pointer to a TSC_HandleTypeDef structure that contains the configuration information for the specified TSC.
Return values:
HALstatus

Definition at line 516 of file stm32l4xx_hal_tsc.c.